6.1 Embedded blocks
6.1.1 Embedded Meta Information block
The additional meta-information "blocks" are added to the response to a submitted request and to the retrieved message to ensure that both registries are aware of:
- Assigned 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.
- A message type
| 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 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* | stringEnum the type of message just sent by calling this endpoint |
6.1.2 Embedded 'generalInformation' Response block
In addition to the meta block, WMDA will provide a standard response to each retrieve-type message sent to Match-Connect. Its structure is as follows:
| Field | Details |
|---|---|
| limit* | integer Limit as stated in request. Default 100 |
| totalCount* | integer Number of messages retrieved (0 or 1) |
| remainingCount* | integer Number of messages remaining (not yet retrieved) for this endpoint |
| isSuccessful* | boolean Was the retrieval of the message successful? |
| summary* | string example: "1 message retrieved successfully. 7 remaining messages." summary of retrieval. |
6.1.3 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”.
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.
- The ION to be used is the ION of the patient registering registry (PR).
- 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:
| addressRequest - example of request with the block named institutionPaying |
6.1.4 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:
Note: in Connect API the following fields (firstName, lastName, dateOfBirth, sex) are optional compared to EMDIS
| patient | Field | Details |
|---|---|---|
| wmdaId* | integer ID provided by the WMDA | |
| connectPatientId* | string MUST Start with ION of patient registry. Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | |
| emdisPatientId | string MUST start with two letter EMDIS hub code. The value comprises the EMDIS patient identification, where the patient search centre is an EMDIS member, otherwise the value is empty. | |
| hla* | {...} | |
| idm | {...} | |
| dateOfBirth | string ($date) | |
| diagnosis | {...} | |
| diseasePhase | string | |
| ethnicity | string | |
| poolCountryCode | string ISO 3166-1 alpha-2 Country Code (capitalized) | |
| abo | string | |
| rhesus | string | |
| weight | integer | |
| sex | string | |
| firstName | string First (given name) of the patient | |
| lastName | string Last (family name) of the patient | |
| mic | string gl-string like format containing the MIC-A or MIC-B typing |
6.1.5 Embedded Donor Block (donor in request)
If the embedded donor block is part of a message type that may not result in updates of donor-related data, the "embedded donor block (donor in request" block is used.
Only sending a grid, cordId or adcuId for message types with static donor information enhances privacy and security through data minimization.
| donor* |
|
6.1.6 Embedded Adult Donor Block (donor in response)
In EMDIS, the following messages are linked to the donor updates:
- TYP_RES
- IDM_RES
- NO_RES
These three 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.
The corresponding endpoints in Match-Connect are:
- extendedTypingDonorResponseRequest
- infectiousDiseaseMarkerDonorResponseRequest
- requestRejectedRequest
These donor updates are for the receiving registry (patient registry) only. 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 |
|---|
6.1.7 Embedded CBU Donor Block (donor in response)
In EMDIS, the following messages are linked to the CBU updates:
- TYP_RES
- IDM_RES
- NO_RES
These three will be replaced with the Match-Connect API endpoints that have the CBU 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 CBU status.
The corresponding endpoints in Match-Connect are:
- extendedTypingCbuResponseRequest
- infectiousDiseaseMarkerCbuResponseRequest
- requestRejectedRequest
These CBU updates are for the receiving registry (patient registry) only. So the sending (donor) registry is responsible for sending a DIFF upload to the Search & Match system in parallel to keep information in sync.
| cbu |
|---|
6.1.8 Embedded Attachment block
The embedded attachment block provides all the information needed by the receiving registry to download the attachments stored at MC. The block can be part of a request message or the explicit Document Exchange message.
The embedded attachment block allows for multiple files to be sent simultaneously, with a limit of 10 different documents. Only PDFs are permitted to be sent. The size limit of each message is 10 MB. The respective AttachmentGuids must be retrieved from WMDA by the sending registry
beforehand, during the upload process of the document(s).
Its structure is as follows:
| Field | Details |
|---|---|
| attachmentGuid* | string($uuid) |
| attachmentDescription* | string Enum: TBD Describes the purpose of the attachment/file |
| fileName * | string maxLength : 255 example: test.txt |
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 must use the referenceMessageId of the original message as the Reference ID in its structure.
Message structure:
| Send (Post) | Retrieve (Post) |
|---|---|
| MessageResponseRequest | |
6.3 Instruments
6.3.1 Text message [TXT_MSG]
The TXT_MSG is useful for conveying notes or comments about a particular donor, patient/donor pair, or request. To reflect this, the text message must contain a 'donor in request' block that can be supported by a patient and or referenceMessageId.
Note: Since Warnings are going to be automated, we must keep Text Messages as the only means for user communication.
Message structure:
| Send (Post) | Retrieve (Post) |
|---|---|
| textMessageRequest | |
6.3.2 - Upload and download attachment
The uploadAttachment endpoint is used to store a document in the WMDA blob storage for later retrieval of that document by the receiving registry via the downloadAttachment endpoint. Both API calls are between a registry and WMDA. For the document exchange between the registries, we use the API endpoints: genericDocumentExchangeRequestRequest and genericDocumentExchangeRequestRetrieve.
A document is stored in the WMDA storage for a maximum of 90 days after upload. If it was not picked up after 90 days, it will be automatically deleted and must be uploaded again, if still needed to be sent. Once picked up, it can be re-retrieved via the recoverMessage capability within a maximum of 72 hours. After that, the document must be resent if needed.
| Send (Post) | Send (Post) |
| uploadAttachment | downloadAttachment |
6.3.6 - Document Exchange (new message)
This message is used to send the information that a document is available at the WMDA blob storage for the receiver. The document can be connected to a patient, a donor, or a request.
| Send (Post) | Retrieve (Post) |
| genericDocumentExchangeRequestRequest | genericDocumentExchangeRequestRetrieve |
6.4 Alert message
The Alert message is used to broadcast some important information about the system, like a 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
6.6.1 Available Messages
This endpoint allows end users to retrieve an overview of all messages 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", which allows for an individual 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.6.2 All Available Messages /* Proposed - not yet implemented */
This endpoint allows end users to retrieve an array of all messages 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 |
6.7 Recover Messages
To recover or "restore" a soft-deleted message, users can call the "recoverMessages" endpoint. This endpoint allows users to bring back messages that were soft-deleted within a 72-hour timeframe.
This approach provides an additional safety measure for end users. If a message was mistakenly deleted during the retrieval process, or if there is a need to recover soft-deleted data, this mechanism allows for data recovery without permanent loss.
Users should be aware that the functionality to restore messages is limited to 72 hours. After this window, the soft-deleted messages are permanently removed from the system. Also see: section 2.4.7 Message storage retention policies in the Technical Guidelines chapter.
| POST |
| recoverMessages |