A patient registration Embedded Patient Block is sent together with each request. This block contains both the wmdaId and the patientId of the patient.
Next to the actual request information, whenever institutions are needed, they are sent explicitly as an Embedded Address Block.
The requested donor has to be reserved at the remote hub and reported back to the requesting registry by an Embedded Donor Block (donor in response) within a Reservation Response reflecting the changed donor status (c.f. DONOR_CB with D_STATUS = ”RS”).
All changes in the donors (change of status, updated typing, or IDMs) resulting from the requests are reported back in an Embedded Donor Block (donor in response) within the respective message, e.g. updated HLA information resulting from an Extended Typing Request in an Extended Typing Result. A separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data. More information on how to do so may be found here.
requestId: In order to couple messages to the same request, e.g. Sample Request and its results, all the request-related messages responding to the original request must have a referenceMessageId as part of the message.
The message ID (referenceMessageId) of the request message is used as a reference code for the rest of the request-related message flow.
Next to the technical referenceMessageId requests, a human-readable reference code (requestId) is used for end-user recognition (communication outside the automated system)
The requestId is optional
The requestId is part of the original message block
The requestId will be generated by the sending registry
The requestId will only be used for human-to-human communication (e.g. could be used on printed invoices)
Once requestId is sent, it must be used in all subsequent request message exchanges
Each field inherited from EMDIS Semantics contains a comment describing its purpose in EMDIS and its original name to assist in the transition from EMDIS to Match-Connect.
This message is used to request an extended typing of a donor (adult, ADCU, CBU). It primarily contains information about what to type and for which donor. The expected return messages are Reservation Response, Extended Typing Resultand/or Request Rejected.
resolutionRequired: string-enum with the following options
low = DNA low resolution
medium = DNA medium (intermediate) resolution
high = DNA high resolution
Intermediate resolution (medium) translates to non-high resolution.
Combinations are possible, i.e. several loci may be requested in one message.
The address block must provide the necessary details for the donor registry to send an invoice for the service. In EMDIS, this used to be the address of the financial institution.
The appropriate action if the typing request cannot be accepted or has to be changed by the receiving registry, e.g. due to national rules, is to inform the requesting side what was done. If only the resolution was changed (the sending registry will receive something different than ordered - either more or less) or only a part of the requested loci were accepted (the sending registry will only receive parts of what was ordered): send a message response (see 6 - Administration v1.0) containing the warning.
5.2 - Extended Typing Results (TYP_RES)
This message is used to send the results of the Extended Typing Request back to the requesting registry.
Major version of HLA Nomenclature HLA_NOM_VER Req 7
etSampleType
string nullable:true
Type of sample. AS = CBU Contiguous Attached Segment WB = Whole Blood Sample RC = Red Cell Fraction (pellet) FP = Blood Spotted Filter Paper ED = Extracted DNA
Enum: Array [ 5 ]
remark
string maxLength:120 nullable:true example: the patient case is very urgent
Weekdays acceptable for reception. Binary fixed length string for the 7 days in the week. E.g., 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday or Sunday.
The fields ”earliest and latest date of sample reception” represent the lower and upper limit of the period of time in which the blood sample has to be received. If the second date is missing, the sample may be received any time after the first date.
The quantity for the first product is optional when requesting DNA from a cord blood unit. In all other requests, the quantity fields for any of the corresponding product fields are required if a product is requested.
A number of tubes requested in a sample request or marrow request:
The maximum amount of material, requested in one sample request or pre-collection sample request is 100 ml, if not stated otherwise in the national rules of the donor registry.
If the number of tubes is unassigned, and not given in the request, the default value number of tubes is one.
A typical response to the Sample Request message is the Sample Arrival Date message. In addition to that, it is mandatory (by the accreditation standards) that the donor registry also sends an IDM Result message to inform the patient registry of the known diseases of the donor.
5.4 - Sample Information (SMP_INFO)
This message is used to send relevant secondary information that may arise in the context of the sample request.
Send (Post)
Retrieve (Post)
sampleInfoRequest(comments refer to changes to the current API definition)
The message can only be exchanged in one direction: from the donor side to the patient side.
Sample information is always referencing a sample request.
Sample information is only valid as long as the referenced sample request is considered ”open” and the donor is reserved for this patient after the sample request.
A request is considered ”open” as long as the patient registry has neither reported the sample results nor a Request Rejected message nor a request cancellation.
There might be several sample information messages within the context of one sample request. Subsequent sample information is regarded as new or additional information and not as updates.
5.5 - Sample Arrival (SMP_ARR)
This message is used to transmit the proposed date of the sample arrival.
Verbatim verification typing (VT) sample label ID D_LABEL_ID Req 19
ctSampleType*
string nullable:false
Type of sample. AS = CBU Contiguous Attached Segment WB = Whole Blood Sample RC = Red Cell Fraction (pellet) FP = Blood Spotted Filter Paper ED = Extracted DNA
Enum: Array [ AS, WB, RC, FP, ED ]
remark
string maxLength:1000 nullable:true example: the patient case is very urgent
donorStillOfInterest = ”N” means: the donor can be released immediately.
donorStillOfInterest = ”Y” means: please prolong donor reservation according to your national rules.
The fields for the infectious disease markers are included in this message in order to give the transplant centers the possibility to report the results of IDMs they might have tested.
If Sample Results cannot be sent then a Request Rejected message should be sent with the reason field populated to explain why.
5.7 - Infectious Disease Marker Request (IDM_REQ)
This message is used to request infectious disease marker test results of the selected donor.
Several distinct requests for the same patient/donor pair at a time are possible, for example, a verification typing and a CMV status, but each request has to be answered by an individual IDM Results, i.e. results must not be ”concatenated” to a single result message. Multiple IDM requests for the same patient/donor pair have to be disjoint (i.e. may not contain identical markers). The occurrence of multiple requests should be an exception. Normally, all markers required should be requested within one message.
5.8 - Infectious Disease Marker Results (IDM_RES)
This message is used to send the results of the IDM request back to the requesting registry.
The common use of the IDM Results message is in response to the Sample Request message, in addition to the shipment of the donor blood sample. Please note there may be a charge involved with this service. If a fee is charged, it may come as a separate item or might be included in the price of the sample shipment. Such IDM Results messages can be sent via a regular EMDIS message - the remote hub must be able to handle it appropriately. The IDM Results must have the same requestId as the Sample Request message.
IDM Results message can be generated in response to two different message requests:
Sample Request does not specify what set of infectious disease markers to be tested
IDM Request does specify what set of infectious disease markers to be tested
The field marker is a required field.
For those hubs reporting infectious disease markers during verification typing, the marker field should contain the IDMs actually tested. There is a fixed-length binary field for the IDM Results message. The blood group may also be reported.
IDM results can also be reported as a part of the Sample Results message by the hub (transplant center) that requested the blood sample. This is to give the transplant centers the possibility to report the results of IDMs they might have tested.
5.9 - Reservation Request (RSV_REQ)
This message is used to request the reservation of a donor for a specific patient for a upcoming transplantation at the receiving registry. The patient registry can ask for a specific reservation period by making use of the optional field expirationDate.
This message is used to notify the requesting patient registry if the Reservation Request has been confirmed by the donor registry OR if the donor reservation was performed after another request. The donor registry reports back the expirationDate. This might differ from the expirationDate of the Reservation Request message due to local rules or regulations at the donor registry side. The expirationDate in the Reservation Response reflects the "true" reservation period.
The patient registry sends this message to inform the donor registry that a donor can be released from the reservation when it is no longer needed (e.g. patient is deceased or was transplanted with another donor). This should be used if the donor reservation was confirmed in response to some request. If the reservation has not been confirmed then a Request Cancellation message should be used.
This is a change request with respect to the current procedure and should be handled as such as it has implications on local systems.
There is no response to this message except for the automated acknowledgment.
This message is used to cancel a previous request that has been sent to the donor registry. The Request must have a preceding request that is being canceled.
This message is sent by the requesting registry to the receiving registry to remind the receiving registry of an outstanding result from a previous request.
The requested donor has to be reserved at the remote hub and reported back to the requesting registry by an Embedded Donor Block (donor in response) within a Reservation Response reflecting the changed donor status (c.f. DONOR_CB with D_STATUS = ”RS”).
v1.0.1