You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

<title>

<Narrative>

<Swagger - API reference>

<temporary - document any differences needing implementation in swagger>

<Specific rules / expectations>

6.1 Embedded Address block

Original message: Address to broadcast [NEW_ADD]

With this message block, the contact information of the hub's institutions, namely Financial institutions, Transplant Centers and Laboratories are shared with the partner hubs. Thus a partner hub has all the required contact information for the Institute IDs, ”INST_ID”, contained in Donor Requests. 

Hubs are required to keep this contact information up to date.

In the Match-Connect system, the addresses will be embedded in the donor requests. See chapter Requests for details.

Address block structure:

  • Institution Type INST_TYPE Req 3
  • Institution Identification INST_ID Req 10
  • Address Line 1 ADDR_1 Req 40
  • Address Line 2 ADDR_2 Opt 40
  • Address Line 3 ADDR_3 Opt 40
  • Contact person PERSON Opt 40
  • ZIP code ZIP Req 10
  • City CITY Req 40
  • Country COUNTRY Req 2
  • Phone Number PHONE Req 20
  • Fax Number FAX Opt 20
  • Email address EMAIL Opt 60
  • Accreditations obtained ACCREDITATION Opt 5
    • Position 1: NetCord-FACT
    • Position 2: AABB
    • Position 3: to be defined
    • Position 4: to be defined
    • Position 5: to be defined

6.2 Message Response

The message response is intended as an automated response to every user generated message. It serves three purposes:

  • message acknowledgment
  • warning
  • message denial

This is a purely machine-to-machine type of message, as compared to EMDIS where such responses can be user generated. 

Message structure:

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/General/post_api_v1_MessageResponse

Additional fields to be added:

Field name descriptionField nameNullableLength
Original message IDGUIDno?
Remark (required for warning and denial)remarkyes120
Original message type ???
seems not needed, if we get the original message by its ID




6.3 Text message [TXT_MSG]

The TXT_MSG is useful to convey notes or comments pertaining to a particular patient, donor, or patient/donor pair.

Note: Since Warnings are going to be automated, we must keep Text Messages as the only means for user communication left.

Message structure:

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_TextMessageRequest

6.4 Alert message

The Alert message is used to broadcast an important information about the system, like planned service outage. Messages are generated centrally by WMDA. Members are expected to display them to the users.

Message structure:

Field name descriptionField nameNullableLength
Text of the alert, informative messagealertno120?

6.5 Error Handling

???

  • No labels