6.1 Embedded blocks
6.1.1 Embedded Meta block
The additional meta-information "blocks" are added to ensure the receiving registry is aware of:
- A message identifier
- A timestamp
- Which registry sent the information (sending registry)
- What type of response is provided by the WMDA Match Connect system
- Any failed validations detected by the Match Connect system
- A sequence number, so that the receiving registry knows if any message is missing.
| Field | Details |
|---|---|
| referenceMessageId* | string($uuid) |
| deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to receiving registry's inbox queue. |
| sendingRegistry* | integer maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 5678 4-digit ION of the sending registry |
| responseType | string Enum: |
| wmdaRemarks | One or more remarks, each in its own object |
| messageSequenceNumber* | integer Incrementing integer set by WMDA MatchConnect system that indicates the order in which the messages were received by the WMDA and therefore the order in which messages should be processed. Each receiving registry has its own unique sequence. |
| messageType* | string the type of message just sent by calling this endpoint |
6.1.2 Embedded Address block (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.
- 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 the delivery of samples. For the same reason ZIP code, City, and Country are required in the address block.
- The contactPerson is required if the INST_TYPE is ”LAB”.
The organisationId (formerly known as INST_ID) of an institution should remain stable over time and should not be assigned to different institutions.Organisation unique identifier for the institution (formerly known as INST_ID):
- Should remain stable over time and must not be assigned to different institutions
- Is a unique reference to an institution
- Allows local address management if needed (e.g. for other use cases) by receiving registry and backward compatibility to existing EMDIS implementations.
- Provided by the local registry system.
- Should be worldwide unique.
- Should follow the construct of ION + local address id.
- asd
- Should follow the construct of ION + local address id.
- Should be provided as a user-friendly (displayable) id for use on screens and on documentation.
In the Match-Connect system, the addresses will be embedded in the donor requests. See Chapter Requests for details.
Message structure:
| Send | Retrieve |
|---|---|
| addressRequest | |
6.1.3 Embedded Patient Block
There is no "register patient" endpoint. Instead, an embedded patient block will accompany all requests. The embedded patient block looks as follows:
| Field | Details |
|---|---|
| wmdaId* | integer nullable: false example: 1234 ID provided by the WMDA |
| patientId* | string maxLength: 17 nullable: false example: XY1234P Organisation unique identifier for the patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. |
| hla* | {...} |
| idm | {...} |
| dateOfBirth | string($date) nullable: true maxLength: 10 example: 1961-05-27 |
| diagnosis | {...} |
| diseasePhase | string Enum: |
| ethnicity | string Enum: |
| poolCountryCode | string maxLength: 2 pattern: ^[A-Z]{2} nullable: true example: NL ISO 3166-1 alpha-2 Country Code (capitalized) |
| abo | string Enum: |
| rhesus | string Enum: |
| weight | integer nullable: true minimum: 1 maximum: 999 example: 76 |
| sex | string Enum: |
| firstName | string maxLength: 30 nullable: true example: John First (given name) of the patient |
| lastName | string maxLength: 30 nullable: true example: Doe Last (family name) of the patient |
6.1.4 Embedded Donor Block
In EMDIS, the following messages are linked to the donor updates:
- IDM_RES
- TYP_RES
- NO_RES
- RSV_RES
These four will be replaced with the Match-Connect API endpoints that have the donor details embedded in the message. Respective endpoints of IDM_RES and TYP_RES will deliver new IDM and new typing details, and all the mentioned endpoints will also inform the patient registry of the new donor status.
These donor updates are for the receiving registry (patient registry) only and will not be updated in the central HUB. So the sending (donor) registry is responsible for sending a DIFF upload to the S&M system in parallel to keep information in sync.
| Donor type | Details |
|---|---|
| Adult donor | |
| CBU | |
| ADCU |
Here is the comparison of the DONOR_CB and the API endpoints: EMDIS vs API.xlsx
6.1.5 Embedded WMDA Response block
The WMDA will provide a standard response to request messages sent to Match-Connect. Its structure is as follows:
| Field | Details |
|---|---|
| deliveredAtUtc* | string($date-time) Server-supplied timestamp showing time of Message delivery to receiving registry's inbox queue |
| referenceMessageId* | string($uuid) |
| responseType* | stringEnum: messages can be failed, if the message has a structure or information that prevent delivery to the receiving registry. This could be incorrect JSON structure and non-existent ION or because the receiving registry does not allow messages from your registry. |
| receivingRegistryMessageSequenceNumber | integer Incrementing integer set by WMDA MatchConnect systems that indicates the order in which the messages were received by the WMDA and therefore the order in which messages should be processed. Each receiving registry has its own unique sequence. |
| wmdaRemarks | [...] |
6.1.6 Embedded 'generalInformation' Response block
The WMDA will provide a standard response to retrieve messages sent to Match-Connect. Its structure is as follows:
| Field | Details |
|---|---|
| limit* | integer default: 100 |
| shouldPeek | boolean default: false |
| totalCount* | integer minimum: 0 example: 1 |
| remainingCount* | integer minimum: 0 |
| isSuccessful* | boolean default: true |
| summary* | string |
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.
Note: The concept of the REF_CODE field used in EMDIS is replaced by the referenceMessageId assigned by the central system to each message. The Message Response is supposed to be using the referenceMessageId of the original message as the Reference ID in its structure.
Message structure:
| Send (Post) | Retrieve (Post) |
|---|---|
| MessageResponse | |
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:
| Send (Post) | Retrieve (Post) |
|---|---|
| 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:
| Send | Retrieve (Post) |
|---|---|
| AlertRetrieve | |
| Alerts can only be sent by the WMDA's central system |
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:
| Send | Retrieve (Post) |
|---|---|
| AlertUpdateRetrieve | |
| Alert updates can only be sent by the WMDA's central system |
6.6 Available Messages
This endpoint allows end users to retrieve an overview of all messages that are ready to be downloaded, including their corresponding sequence numbers. This information can be used to retrieve the messages from their respective *retrieve endpoints. If desired, the messages can be pulled in chronological order, given by the sequence numbers. Each "retrieve" endpoint will have the optional parameter "sequenceNumber", that allows for an indivual collection of the corresponding message(s). If that parameter is left empty all available messages are retrieved (according to the limit set in the parameters).
6.7 All Available Messages /* Proposed - not yet implemented */
This endpoint allows end users to retrieve an array of all messages that are ready to be downloaded, including their content. This would allow a registry to call just one endpoint to collect all messages.
Limitations:
This option does not work for all applications/tooling, like defining custom API connectors in the 365 PowerPlatform. In those cases the same static structure for all call responses on a specific endpoint is not only IBP, but also required.
| Retrieve (Post) |
| availableMessagesAll |