...
| Send | Retrieve |
| TypingRequestRequest | TypingRequestRetrieve |
| 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 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 Block |
|
| | Expand |
|---|
| | No parameters specified |
|
...
This message is used to send the results of the initial ET request back to the requesting registry.
Check paragraph '5.18 Extended Typing' for the related message flows.
| Send | Retrieve |
| TypingResponseRequest | TypingResponseRetrieve |
| 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 Block |
|
|
{...} | | Expand |
|---|
| | No parameters specified |
|
Rules
After the TypingResults (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.
...
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 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. 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 |
|
| | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient* | Embedded Patient Block | | donor | Embedded Donor Block |
|
|
| deliveredAtUtc | string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue | | referenceMessageId | string($uuid) | | responseType | stringEnum:
Array [ 3 ] | | remark | [...] |
|
| | 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.
...
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.
| 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 Block | | 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.
...
| 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 Patient Block | | donor | Embedded Donor Block |
|
| | Expand |
|---|
| | No parameters specified |
|
...
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 | 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).
| 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 | | donor | Embedded Donor Block |
|
|
{...} | | Expand |
|---|
| | No parameters specified |
|
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.V2 | | 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
After 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.
...
This message is used to request the reservation of a donor for transplant at the receiving registry.
| Send | Retrieve |
| ReservationRequestRequest | ReservationRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient Block | | donor | Embedded Donor Block | | 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 |
|
5.10 - Reservation Result
This message is used to notify the requesting patient registry if the Reservation Request has been confirmed by the donor registry.
| Send | Retrieve |
| ReservationResultRequest | ReservationResultRetrieve |
| 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* | {...} | | donor* | {...} | | 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.
...
This message is used to cancel a previous request that has been sent to the donor registry. The Request It 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* | {...} | | 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.15 - Request Rejected
This message is used to notify the requesting registry when a request cannot be fulfilled.
| Send | Retrieve |
| RequestRejectedRequest | RequestRejectedRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient Block | | 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
...
This message is sent by the requesting registry to the receiving registry to remind the receiving registry of an outstanding results 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* | {...} | | 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 for registering a patient (by the embedded patientBlock).
...