...
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 message is messages are Reservation Response, Extended Typing Results and/or Request Rejected.
Send (Post)
| Retrieve (Post)
|
| extendedTypingRequestRequest | extendedTypingRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| requestingRegistryReferenceCode | string
maxLength: 15
example:XX12345
| | resolutionRequired* | string
maxLength: 11
minLength: 11
example: HHHHMMM-H-HA character string with a fixed length in which each position represents 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 | | address | Embedded Address Block | | isUrgent* | boolean Urgent request URGENT Opt 1 | | remark | string
maxLength: 120
nullable: true
example: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Donor ID |
|
| | 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. |
|
|
...
This message is used to request the reservation of a donor for a specific patient for a upcomming transplantion at the receiving registry. The patient registry can ask for a specific reservation period by making use of the optional field expirationDate.
Send (Post)
| Retrieve (Post)
|
| reservationRequestRequest | reservationRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| requestingRegistryReferenceCode | string maxLength: 15 | | 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 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344-digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Donor ID |
|
| | 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. |
|
|
...
This message is used to notify the requesting patient registry if the Reservation Request has been confirmed by the donor registry. 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.
Send (Post)
| Retrieve (Post)
|
| reservationResponseRequest | reservationResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response* | | Expand |
|---|
| | Field | Details |
|---|
| requestingRegistryReferenceCode | string maxLength: 15 | | 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 |
|
| | receivingRegistry* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344-digit ION of the receiving registry | | patient* | Patient ID | | donor* | Embedded Donor Block |
|
| | 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. |
|
|
...