<title>

<Narrative>

<Swagger - API reference>

<temporary - document any differences needing implementation in swagger>

<Specific rules / expectations>


6.1 Embedded Meta block

The additional meta-information "blocks" are added to ensure the receiving registry is aware of:


metaInformation{

Field nameformatDescription
messageIdstring($uuid)ID of the originally sent message
sentAtUtcstring($date-time)Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.
senderstring
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 5678
4 digit ION of the sender
messageTypestringTo be designed and described. The idea is to help registry's MC admin to analyze possible issues reported in validationDetails field. AM: I think this is an excessive information, as messageId should be sufficient. 
validationDetails
To be designed and described. The idea is to supply the concerns of the central hub validation system that are acceptable but require attention of the receiving registry.

}

6.2 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 Institution contained in Donor Requests. 

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

Address block structure (HP's suggestion, requires discussion regarding the accreditation):

https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/org/hl7/fhir/r4/model/Address.html

6.3 Message Response

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

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:

SendRetrieve
post_api_v1_MessageResponse
  • 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.4 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:

SendRetrieve
post_api_v1_TextMessageRequest
  • Patient
  • Donor
  • Text

TextMessage payload

Meta block

6.5 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.6 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