...
A patient registration embedded block will be is sent together with each request. This block contains both wmdaId and patientId of the patient.
- Next to the actual request information, whenever the institutions are needed, they are sent explicitly as an Embedded Address Block.
The requested donor requested has to be reserved at the remote hub and reported back to the requesting hub / patient registry by an embedded donor block with the donor status reflecting the change (a.k.a. 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.
- ReferenceCode: In order to couple messages to the same request, e.g. VT request (SMP_REQ) Sample Request and its results (SMP_ARR, SMP_RES) all messages following the initial request must have a referenceCode as part of the message.
The message ID (correlationGUIDcorrelationGuid) of the request message (TYP_REQ, IDM_REQ, SMP_REQ, RSV_REQ, etc...) will be is used as the ' referenceCode ' for the rest of the request related message flow.
- Each field inherited from EMDIS Semantics contains a comment describing its purpose in EMDIS and its original name to assist in transition from EMDIS to Match-Connect.
- Paragraph Request + Response Flows depicts the new message flows.
5.1 - Extended Typing Request
This message is used to request an extended typing of a donor (adult, adcuADCU, cbu?CBU). It will primarily contain contains information about what to type and for which donor.
Added to that a patient block (ref?) containing up-to-date information about the patient, and an address block (ref?) containing up-to-date contact-information about the needed institution(s).
Expected return message is 'typing result' (5.2) or 'request rejected' (5.14).
Check paragraph '5.18 Extended Typing' for the related message flow. Extended Typing Results or Request Rejected.
| Send | Retrieve |
| Send | Retrieve |
| extendedTypingRequestRequest | extendedTypingRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request | | Expand |
|---|
| | Field | Details |
|---|
| requestDate* | string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd] | | resolutionRequired* | string
maxLength: 11
minLength: 11
example: HHHHMMM-H-HCharacter string with fixed length in which each position represents a an HLA locus. The coding of the resolution required for every position is: S = serological L = DNA low resolution M = DNA medium resolution H = DNA high resolution - (hyphen) = not requested. The character string is interpreted from left to right, with position 1 as the leftmost position. The positions for the HLA loci are defined as: Position 1: HLA-A Position 2: HLA-B Position 3: HLA-C Position 4: HLA-DRB1 Position 5: HLA-DRB3 Position 6: HLA-DRB4 Position 7: HLA-DRB5 Position 8: HLA-DQA1 Position 9: HLA-DQB1 Position 10: HLA-DPA1 Position 11: HLA-DPB1 | | urgent* | boolean Urgent request URGENT Opt 1 | | remark | string
maxLength: 120
nullable: true
example: patient case is very urgentRemark REMARK Opt 120 |
|
| | address | Embedded Address Block | | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient | Embedded Patient Block | | donor | Embedded Donor BlockID |
|
| | Expand |
|---|
| | No parameters specified |
|
...
This message is used to send the results of the initial ET request Extended Typing Request back to the requesting registry.
Check paragraph '5.18 Extended Typing' for the related message flows.
| Send | Retrieve |
| extendedTypingResponseRequest | extendedTypingResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response | | Expand |
|---|
| | Field | Details |
|---|
| referenceCode | string($uuid) | | hlaNomenclatureVersion | string
default: 3Major version of HLA Nomenclature HLA_NOM_VER Req 7 | | etSampleType | string
nullable: trueType 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: patient case is very urgentRemark REMARK Opt 120 |
|
| | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | donor | Embedded Donor Block | | patient | Embedded Patient BlockID |
|
| | Expand |
|---|
| | No parameters specified |
|
Rules
After the TypingResults Extended Typing Results (TYP_RES) message, which includes an embedded donor (DONOR_CB) block, 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.
5.3 - Sample Request
The SampleRequestRequest (and SampleRequestRetrieve) This message is used to request a VT for (verification typing) of a specific donor/product for a patient. The message, as all requests, has an embedded 'register_patient' part. Next to the actual request information the institutions needed are sent explicitly as an embedded 'addressBlock' (6.1).
The messageId of this message will be used as 'referenceCode' for the rest of the request related message flow.
EMDIS Semantic:
The fields ”earliest and latest date of sample reception” represent the lower and upper limit of a 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 field ACC_DAYS is a binary field with position 1 corresponding to Monday and position 7 corresponding to Sunday. A set bit means acceptable day, an unset bit means not acceptable day. For example, 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday and Sunday. The default value is 1111100 (accept all working days).
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.
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. If the number of tubes is unassigned, not given in the request, the default value number of tubes is one.
| Send | Retrieve |
|---|
| sampleRequestRequest (comments refer to changes to the current API definition) | sampleRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request | | Expand |
|---|
| | requestDate | string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd] | | prod1 | {...} | | prod2 | {...} | | prod3 | {...} | | prod4 | {...} | | earliestDateCanReceive | string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd] | | latestDateCanReceive | string($date-time)
nullable: trueLatest date of sample reception REC_DATE2 Opt |
|
|
|
|
| Send | Retrieve |
|---|
| sampleRequestRequest (comments refer to changes to the current API definition) | sampleRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request | | Expand |
|---|
| | requestDate | string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd] | | prod1 | {...} | | prod2 | {...} | | prod3 | {...} | | prod4 | {...} | | earliestDateCanReceive | string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd] | | latestDateCanReceive | string($date-time)
nullable: trueLatest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd] | | acceptableReceptionDaysOfWeek | integer
nullable: true
minLength: 7
maxLength: 7
example: 1111100Weekdays 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. | | institutionToSendSampleTo | Embedded Address Block | | institutionPaying | Embedded Address Block | | urgent | boolean Urgent request URGENT Opt 1 | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
maxLength: 120 | acceptableReceptionDaysOfWeek | integer
nullable: true
minLengthexample: 7
maxLength: 7
example: 1111100Weekdays acceptable for reception. Binary fixed length string for the 7 days in the week. 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday or Sunday. | | institutionToSendSampleTo | Embedded Address Block | | institutionPaying | Embedded Address Block | | urgent | boolean Urgent request URGENT Opt 1 | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
maxLength: 120
nullable: true
example: patient case is very urgentRemark REMARK Opt 120 | | patient case is very urgent Remark REMARK Opt 120 |
|
| | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient* | Embedded Patient Block | | donor* | Embedded Donor BlockID |
|
| | Expand |
|---|
| No parameters specified |
|
5.4 - Sample Information
The SampleInfoRequest (and SampleInfoRetrieve) is used to sent relevant secondary information which may arise in the context of sample request.
The referenceCode is the 'messageId' from the request message.
EMDIS Semantic:
...
Rules:
The fields ”earliest and latest date of sample reception” represent the lower and upper limit of a 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.
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.
If the number of tubes is unassigned, not given in the request, the default value number of tubes is one.
5.4 - Sample Information
This message is used to send relevant secondary information which may arise in the context of sample request.
| Send | Retrieve |
| sampleInfoRequest (comments refer to changes to the current API definition) | sampleInfoRetrieve |
| Expand |
|---|
| | referenceCode* | string($uuid) | | informationType* | string
maxLength: 3
minLength: 3Information Type INFO_TYPE Req 3 Enum:
Array [ 12 ] | | remark | string
nullable: trueRemark REMARK Opt 120 | | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient* | Embedded Patient BlockID | | donor* | Embedded Donor Block |
|
| | Expand |
|---|
| | No parameters specified |
|
5.5 - Sample Arrival
The SampleArrivalRequest (and SampleArrivalRetrieve) is used to transmit proposed date of sample arrival.
The messageId of this message will be used as 'referenceCode' for the rest of the request related message flow.
EMDIS Semantic:
This message is sent in response to a SMP_REQ and indicates the arrival date of the sample.
Rules:
The message can only be exchanged in one direction: from donor side to patient side.
Sample information is always referencing a sample request.
Sample information is only valid as long as the referenced sample request is considered as ”open” and the donor is reserved for this patient after the sample request.
A request is considered as ”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
This message is used to transmit the proposed date of the sample arrival.
| Send | Retrieve |
sampleArrivalRequest (comments | refer to changes to the current API definition) | sampleArrivalRetrieve |
| Expand |
|---|
| | Field | Details | | message | | Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | arrivalDate* | string($date-time) Proposed date of sample arrival ARRV_DATE Req 8 | | collectionDate | string($date-time)
nullable: trueDonor blood collection date COLL_DATE Opt 8 | | labelId* | string
maxLength: 19Verbatim verification typing (VT) sample label ID D_LABEL_ID Req 19 | | etSampleType | string
nullable: trueType 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: patient case is very urgentRemark REMARK Opt 120 |
|
| | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient* |
|
|
Embedded Block | | Expand |
|---|
| | No parameters specified |
|
5.6 - Sample Results
The SampleResponseRequest (and SampleResponseRetrieve) This message is used to transmit the results of the sample requesttesting.
The messageId of this message will be used as 'referenceCode' for the rest of the request related message flow.
DON_ACCPT = ”N” means: donor can be released immediately.
DON_ACCPT = ”Y” means: please reserve the donor according to your national rules. If possible, the donor should be reserved at the remote hub and reported back to the requesting hub by adding a DONOR_DIFF block to the message STATUS = ”RS”. For all the other patients the donor should be updated by sending a DIFF update to S&M. A delta search will then update the search results for those patients.
Suggested text: "Y" means: please prolong donor reservation according to your national rules.
EMDIS Semantic:
The fields for the infectious disease markers are included in this message in order to give the transplant centres the possibility to report the results of IDMs they might have tested.
If no SMP_RES can be sent then a NO_RES should be sent with the reason field populated to explain why.
| Send | Retrieve |
| sampleResponseRequest (comments refer to changes to the current API definition) | sampleResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response | | Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | hlaNomenclatureVersion* | string
default: 3Major version of HLA Nomenclature HLA_NOM_VER Req 7 | | hla | {...} | | idm | {...} | | abo | string
nullable: trueEnum:
Array [ 4 ] | | rhesus | string
nullable: trueEnum:
Array [ 2 ] | | donorStillOfInterest | string
maxLength: 1Donor still of interest DON_ACCPT Req 1 Enum:
Array [ 2 ] |
|
| | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient* | Patient ID | | donor* | Donor ID |
|
|
| Send | Retrieve |
| sampleResponseRequest (comments refer to changes to the current API definition) | sampleResponseRetrieve |
| Expand |
|---|
| |
| Field | Details |
|---|
response | | Expand |
|---|
title | | | Field | Details |
|---|
| referenceCode* | string($uuid) | | hlaNomenclatureVersion* | string
default: 3Major version of HLA Nomenclature HLA_NOM_VER Req 7 | | hla | {...} | idm| wmdaResponse | Embedded WMDA Response Block |
|
| | Expand |
|---|
| | No parameters specified |
| abo | string | nullable: trueEnum:
Array [ 4 ]
| rhesus | string
nullable: trueEnum:
Array [ 2 ] |
| donorStillOfInterest | string
maxLength: 1Donor still of interest DON_ACCPT Req 1 Enum:
Array [ 2 ] |
| recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient |
| patient | Embedded Patient Block |
| donor | Embedded Donor Block |
| Expand |
|---|
| | No parameters specified |
|
5.7 - Infectious Disease Marker Request
This message is used to request infectious disease marker test results of the selected donor. Expected return message is 'idm result' (5.8) or 'request rejected' (5.15).
Rules:
donorStillOfInterest = ”N” means: 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
This message is used to request infectious disease marker test results of the selected donor.
| Send | Retrieve |
| infectiousDiseaseMarkerRequest | infectiousDiseaseMarkerRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | markerAsArray | [...] | | marker* | integer
maxLength: 19
minLength: 19
example: 111110000111Binary fixed length string in which each position represents a test to be requested: details in Data Dictionary | | institutionPaying* | Embedded Address Block |
|
|
| Send | Retrieve |
| infectiousDiseaseMarkerRequest | infectiousDiseaseMarkerRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | markerAsArray | [...] | | marker* | integer
maxLength: 19
minLength: 19
example: 111110000111Binary fixed length string in which each position represents a test to be requested: Position 1: Blood group and rhesus Position 2: CMV status Position 3: Toxoplasmosis Position 4: EBV Position 5: HIV status Position 6: HIV P24 Position 7: Hepatitis B surface antigen Position 8: Antibody to Hepatitis B surface antigen Position 9: Antibody to Hepatitis B core antigen Position 10: Antibody to Hepatitis C virus Position 11: Lues status (Treponema pallidum) Position 12: ALT status Position 13: Antibody to HTLV1.V2 | | institutionPaying* | {...} | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
maxLength: 120
nullable: true
example: Please also test for SARS-CoV-2Remark REMARK Opt 120 | | recipient* | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient* | Embedded Patient Block | | donorEmbedded Donor Block* | Donor ID |
|
| | Expand |
|---|
| | No parameters specified |
| wmdaResponse| originalMessage | {...} | | metaInformation | Embedded |
|
| WMDA Response | Expand |
|---|
| | No parameters specified |
| Expand |
|---|
| | Field | Details |
|---|
| originalMessage | {...} | metaInformation | Embedded Meta Block |
Rules:
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
This message is used to send the results of the IDM request back to the requesting registry.
Check paragraph '5.18 Infectious Disease Marker' for the related message flow.
| Send | Retrieve |
| infectiousDiseaseMarkerResultRequest | infectiousDiseaseMarkerResultRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | markerAsArray | [...] | | marker | integer
maxLength: 19
minLength: 19
example: 111110000111Binary fixed length string in which each position represents a test to be requested: Position 1: Blood group and rhesus Position 2: CMV status Position 3: Toxoplasmosis Position 4: EBV Position 5: HIV status Position 6: HIV P24 Position 7: Hepatitis B surface antigen Position 8: Antibody to Hepatitis B surface antigen Position 9: Antibody to Hepatitis B core antigen Position 10: Antibody to Hepatitis C virus Position 11: Lues status (Treponema pallidum) Position 12: ALT status Position 13: Antibody to HTLV1.V2represents a test to be requested: details are in Data Dictionary | | sampleExtractionDate | string($date-time)
nullable: trueDate of sample extraction D_EXTR_DATE Opt 8 | | donorCcr5Status | string
maxLength: 2
nullable: trueDonor CCR5 status D_CCR5 Opt 2 | | donorWeightKg | integer($int32)
maximum: 999
minimum: 0
nullable: trueDonor weight in kilograms D_WEIGHT Opt 3 | | donorHeightCm | integer($int32)
maximum: 999
minimum: 0
nullable: true
example: 175Donor height in centimetres D_HEIGHT Opt 3 | | numberOfTransfusions | integer($int32)
maximum: 9
minimum: 0
nullable: trueNumber of transfusions D_NMBR_TRANS Opt 1 | | numberOfPregnancies | integer($int32)
maximum: 9
minimum: 0
nullable: trueNumber of pregnancies D_NMBR_PREG Opt 1 | | idm | {...} | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 | | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | donor* | Embedded Donor Block | | patient* | Embedded Patient Block |
|
| | Expand |
|---|
| | No parameters specified |
|
Rules
| | Expand |
|---|
| | No parameters specified |
|
Rules
The common use of IDM Results message is in response to Sample Request message, in addition to shipment of the donor blood sample. Please note there may be 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 referenceCode as the Sample Request message.
IDM Results message can be generated in response to two different message requests:
1. Sample Request does not specify what set of infectious disease markers to be tested
2. 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 be also reported.
IDM results can be also reported as a part of 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 testedAfter the IDM_RES message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data.
5.9 - Reservation Request
...
| Send | Retrieve |
| reservationRequestRequest | reservationRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient Block | | donor | Embedded Donor BlockID | | requestDate* | string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd] | | referenceCode* | string($uuid) | | expirationDate | string($date-time)
nullable: trueRequest date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd] | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement |
|
| | Expand |
|---|
| | No parameters specified |
|
...
| Send | Retrieve |
| reservationResponseRequest | reservationResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | sentAtUtc* | string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest. | | deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | | payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | {...}Patient ID | | donor*{...} | Embedded Donor Block | | referenceCode* | string($uuid) | | expirationDate | string($date-time)
nullable: trueDate expiration of reservation EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd] | | confirmed* | boolean Confirmation of reservation CONFIRM Req 1 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement | | messageType | string Message types supported by WmdaConnect Enum:
Array [ 21 ] |
|
| | Expand |
|---|
| | No parameters specified |
|
Rules
After the ReservationResult (RSV_RES) message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data.
5.11 - Donor Release Request (Reservation Release)
This message is used so sent by the patient registry can notify to inform the donor registry to release that a donor can be released from the reservation when it is no longer needed (e.g. patient deceased or was transplanted with another donor). This should be used if the Reservation Request has been fulfilled, if the Reservation Request donor reservation was confirmed in a response to some request. If the reservation has not been fulfilled 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 systemsit has implications on local systems.
There is no response to this message except for the automated acknowledgement.
| Send | Retrieve |
| reservationReleaseRequest | reservationReleaseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | sentAtUtc* | string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest. | | deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | | payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient BlockID | | donor* | Embedded Donor BlockID | | referenceCode* | string($uuid) | | requestType* | string
maxLength: 3Type of request REQ_TYPE Req 3 | | reason | string
maxLength: 3
minLength: 3
nullable: trueReason of request cancellation REASON_CNCL Opt 3 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement | | messageType | string Message types supported by WmdaConnect Enum:
Array [ 21 ] |
|
| | Expand |
|---|
| | No parameters specified |
|
Rules
After the Reservation Release message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data.
5.12 - Workup Request
Future Phase
...
This message is used to cancel a previous request that has been sent to the donor registry. The Request It Request must have a preceding request that is being cancelled.
| Send | Retrieve |
| requestCancellationRequest | requestCancellationRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | sentAtUtc* | string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest. | | deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | | payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient BlockID | | donor* | Embedded Donor BlockID | | referenceCode* | string($uuid) | | requestType* | string
maxLength: 3Type of request REQ_TYPE Req 3 | | reason | string
maxLength: 3
minLength: 3
nullable: trueReason of request cancellation REASON_CNCL Opt 3 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement | | messageType | string Message types supported by WmdaConnect Enum:
Array [ 21 ] |
|
| | Expand |
|---|
| | No parameters specified |
|
...
This message is used to notify the requesting registry when a request request cannot be fulfilled (service cannot be fulfilledprovided).
| Send | Retrieve |
| requestRejectedRequest | requestRejectedRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient BlockID | | donor* | Embedded Donor Block | | referenceCode* | string($uuid) | | requestType* | string
maxLength: 3Type of request REQ_TYPE Req 3 | | reason* | string
maxLength: 3
minLength: 2Reason REASON Req 3 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement |
|
| | Expand |
|---|
| | No parameters specified |
|
Rules
After the Request Rejected message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data
5.16 - Result Reminder
This message is sent by the requesting registry to the receiving registry to remind the receiving registry of an outstanding results result from a previous request.
| Send | Retrieve |
| resultReminderRequest | resultReminderRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | sentAtUtc* | string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest. | | deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | | payload* | |
|
|
Embedded BlockEmbedded Block| ID | | requestDate | string($date-time)
nullable: trueRequest date REQ_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd] | | referenceCode* | string($uuid) | | resultType* | string
maxLength: 9Type of result reminded RES_TYPE Req 9 | | expirationDate | string($date-time)
nullable: trueRequest date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd] | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement | | messageType | string Message types supported by WmdaConnect Enum:
Array [ 21 ] |
|
| | Expand |
|---|
| | No parameters specified |
|
5.17 - Generic Request
Used This message is used for registering a patient (by the embedded patientBlockpatient block).
Is used This may be required for example for direct WU requests until 5.11 is available or to reactivate a closed patient case on receiving registry side.
Embedded Block| ID | | reason | string reason for the generic request |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient |
|
| | Expand |
|---|
| | No parameters specified |
|
5.18 Request + Response Flows
Generic
Extended Typing
Infectious Disease Marker
Image Modified
Sample Request
Image Modified