Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.
  • It’s not only useless but forbidden to give a postbox (POB) in a LAB address since this address is used for delivery of samples. For the same reason ZIP code, City and Country are required in the address block.

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

...

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

Note: The concept of the REF_CODE field used in EMDIS is replaced by the GUID assigned by the central system to each message. The Message Response is supposed to be using the GUID of the original message as the Reference ID in its structure.

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

Additional fields to be added:

...

  • Reference ID (GUID)
  • Response type
    • message acknowledgment
    • warning
    • message denial
  • Remark - a string explaining the reason for a denial or a warning, empty for acknowledgment

MessageResponse payload

Meta block

...

6.3 Text message [TXT_MSG]

...

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/

SendRetrieve
post_api_v1_TextMessageRequest
  • Patient
  • Donor
  • Text

TextMessage payload

Meta block

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::

SendRetrieve

get_api_v1_AlertRetrieve
Alerts can only be sent by the WMDA's central system

Alert Payload:

  • Level
  • Status
  • Message

Meta block

6.5 Alert Update message

The Alert  Update message is used to broadcast an update about some previous alert. Messages are generated centrally by WMDA. Members are expected to display them to the users.

Message structure:

SendRetrieve

get_api_v1_AlertUpdateRetrieve
Alert updates can only be sent by the WMDA's central system

Alert Update Payload:

  • Alert reference ID (GUID)
  • Level
  • Status
  • Message

Meta block

Field name descriptionField nameNullableLengthText of the alert, informative messagealertno120?