...
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.
- 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.
- Paragraph Request + Response Flows depicts the new message flows.
...
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 Result Extended Typing Results and/or Request Rejected.
Send (Post)
| Retrieve (Post)
|
| extendedTypingRequestRequest | extendedTypingRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string
maxLength: 19
example:XX12345
| | resolutionRequired* | string
example: "a": highReplacement of the single string based resolutionRequired. | | address* | Embedded Address Block | | isUrgent | boolean Urgent request URGENT Opt 1 | | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4 digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| extendedTypingResponseRequest | extendedTypingResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string
maxLength: 19
example:XX12345 | | referenceMessageId* | 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: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | donor* | Embedded Donor Block (donor in response) | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
|
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
| Send (Post) | Retrieve (Post) |
|---|
| sampleRequestRequest | sampleRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | requestId | string
maxLength: 19
example:XX12345 | | 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
pattern: ^[01]{7}$
example: 1111100 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. | | institutionToSendSampleTo* | Embedded Address Block | | institutionPaying* | Embedded Address Block | | isUrgent | boolean Urgent request URGENT Opt 1 | | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 12344-digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| sampleInfoRequest (comments refer to changes to the current API definition) | sampleInfoRetrieve |
| Expand |
|---|
| | message* | | Expand |
|---|
| | requestId | string
maxLength: 19
example:XX12345 | | referenceMessageId* | string($uuid) | | informationType* | string
maxLength: 3
minLength: 3Information Type INFO_TYPE Req 3 Enum: Array [ BMP, BMM, SCP, SCM, ABS, MUL, UBC, RPE, CMV, ROI, MED, OTH ]
| | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| sampleArrivalRequest (comments refer to changes to the current API definition) | sampleArrivalRetrieve |
| Expand |
|---|
| | Field | Details | | message* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string
maxLength: 19
example:XX12345 | | referenceMessageId* | 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 | | ctSampleType* | 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 [ AS, WB, RC, FP, ED ] | | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4 digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| sampleResponseRequest (comments refer to changes to the current API definition) | sampleResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string
maxLength: 19
example:XX12345 | | referenceMessageId* | string($uuid) | | hlaNomenclatureVersion* | string
default: 3Major version of HLA Nomenclature HLA_NOM_VER Req 7 | | hla | {...} | | idm | {...} | | abo | string
nullable: trueEnum:
Array [ A, B, O, AB ] | | rhesus | string
nullable: trueEnum:
Array [ P, N ] | | donorStillOfInterest | string
maxLength: 1Donor still of interest DON_ACCPT Req 1 Enum:
Array [ Y, N ] |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4 digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| infectiousDiseaseMarkerRequest | infectiousDiseaseMarkerRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string
maxLength: 19
example:XX12345 | | 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 | | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| infectiousDiseaseMarkerResultRequest | infectiousDiseaseMarkerResultRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string
maxLength: 19
example:XX12345 | | referenceMessageId* | 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 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: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | donor* | Embedded Donor Block (donor in response) | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
|
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| reservationRequestRequest | reservationRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string maxLength: 19 | | expirationDate | string($date-time)
nullable: trueRequest date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd] | | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| reservationResponseRequest | reservationResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string maxLength: 19 | | referenceMessageId* | 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: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in response) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| reservationReleaseRequest | reservationReleaseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string maxLength: 19 | | referenceMessageId* | string($uuid) | | reason* | string
maxLength: 3
minLength: 3
nullable: trueReason of request cancellation REASON_CNCL Opt 3 | | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| requestCancellationRequest | requestCancellationRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| message* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string maxLength: 19 | | referenceMessageId* | 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: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| requestRejectedRequest | requestRejectedRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| message* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string maxLength: 19 | | referenceMessageId* | string($uuid) | | requestType* | string
maxLength: 3Type of request REQ_TYPE Req 3 | | reason* | string
maxLength: 3
minLength: 2Reason REASON Req 3 | | remark | string
maxLength: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| resultReminderRequest | resultReminderRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| message* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string maxLength: 19 | | referenceMessageId* | 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: 1000
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
Send (Post)
| Retrieve (Post)
|
| genericRequestRequest | genericRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| requestId | string maxLength: 19 | | reason | string reason for the generic request |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 1000
maxLength: 4
minLength: 4
example: 1234
4-digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Embedded Donor Block (donor in request) |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...