Versions Compared

Key

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

...

The Match Connect system acts as a central broker of information exchange between registries participating in the Match Connect ecosystem, also called central hub from here on.  The Match Connect system central hub bears responsibility to:

  1. Route information from the sending registry to the receiving registry and maintain information integrity
    1. Provide meta information to aid in the investigation of message failures or data synchronization problems
    2. Provide meta information for traceability 
  2. Ensure integrity of the data in the Search & Match Service
    1. Perform syntactic validation of the information (e.g. appropriate information structure, allowable values, valid dates, etc)
    2. Validate the HLA of patient data for fields which are contained in the Search & Match Service and update these accordingly. This applies to 
      1. Patient HLA

In performing these duties, the Match Connect system will inspect the contents of messages to determine who to route messages to and to perform basic validation.  This content is not intended to be reviewed by administrators of the system except in cases of investigating message failures or data synchronization problems.  Original message contents will never be modified by the central system but additional meta information "blocks" will be added to ensure the receiving registry is aware of:

...

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

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.

...

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