The additional meta-information "blocks" are added to ensure the receiving registry is aware of:
|
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.
Consider to use address block structure according to HL7-FHIR standard with extensions (https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/org/hl7/fhir/r4/model/Address.html), e.g.
Suggested format | Suggested field | Description | Mapping to NEW_ADD |
The name of the city, town, suburb, village or other community or delivery center. | City CITY Req 40 | ||
Country - a nation as commonly understood or generally accepted. | Country COUNTRY Req 2 | ||
The name of the administrative area (county). | Address Line 2 ADDR_2 Opt 40 | ||
This component contains the house number, apartment number, street name, street direction, P.O. | Address Line 3 ADDR_3 Opt 40 | ||
Time period when address was/is in use. | new - Opt | ||
A postal code designating a region defined by the postal service. | ZIP code ZIP Req 10 | ||
Sub-unit of a country with limited sovereignty in a federally organized country. | new - Opt | ||
Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. | Address Line 1 to Address Line 3, City, Country, Zip code - Opt | ||
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses. Most addresses are both.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value. | new - Req | ||
The purpose of this address. | Institution Type INST_TYPE Req 3 | ||
contactPerson | The name of the contact person. | Contact person PERSON Opt 40 | |
The value is a telephone number used for voice calls. | Phone Number PHONE Req 20 | ||
The value is a fax machine. | Fax Number FAX Opt 20 | ||
The value is an email address. | Email address EMAIL Opt 60 | ||
Not needed anymore, as the full address will be sent embedded in every request. | INST_ID Req 10 | ||
Obsolete. Accreditation is provided by S&M on the match list. | Accreditation Opt 5 |
There is no register patient endpoint. Instead, an embedded patient block will accompany all requests. The embedded patient block looks as follows:
|
In EMDIS, the following messages are linked to the donor updates:
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 to send a DIFF upload to the S&M system in parallel to keep information in sync.
In the future a block for ADCUs may come to play.
Donor type | Payload | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Adult donor |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CBU |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ADCU |
Here is the comparison of the DONOR_CB and the API endpoints: EMDIS vs API.xlsx
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:
Send | Retrieve | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
MessageResponse | ||||||||||||||||||||||||||||||||||||
|
|
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 | Retrieve |
---|---|
TextMessageRequest | |
TextMessage payload Meta block (6.1.1) |
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 |
---|---|
AlertRetrieve | |
Alerts can only be sent by the WMDA's central system | Alert Payload:
Meta block (6.1.1) |
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 |
---|---|
AlertUpdateRetrieve | |
Alert updates can only be sent by the WMDA's central system | Alert Update Payload:
Meta block (6.1.1) |