...
This is a change request with respect to the current procedure and should be handled as such as it has implications on local systems.
| Send | Retrieve |
| RequestCancellationRequest | RequestCancellationRetrieve |
| Expand |
|---|
|
| Field | Details |
|---|
sender| Send | Retrieve |
| ReservationReleaseRequest | ReservationReleaseRetrieve |
- Reservation Release
- patient (wmdaId)
- referenceCode
- requestDate
- reason
- remark
- Donor Block (6.1.4)
| - Meta Block (6.1.1)
- Payload Reservation Release
|
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
5.13 - Workup Status
Future Phase
5.14 - Request Cancellation
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.
| 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* | |
|
|
4| 3 Type of request REQ_TYPE Req 3 | | reason | string
maxLength: 3
|
|
|
|
|
4example56784 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* | {...} |
Reason of request cancellation REASON_CNCL Opt 3 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
|
|
|
recipient* | stringmaximum: 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.
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
5.13 - Workup Status
Future Phase
5.14 - Request Cancellation
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 |
| 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 |
reason32Reason REASON Req 3
| remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
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 |
| Expand |
|---|
|
| Field | Details |
|---|
wmdaResponse | Embedded WMDA Response BlockRequestNo parameters specifiedexpand |
|
Rules
| 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: 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 |
|
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 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 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 from a previous request.
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* |
|
|
| Send | Retrieve |
| ResultReminderRequest | ResultReminderRetrieve | Request | | 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. | | Field | Details |
|---|
| patient | Embedded Patient Block | | donor | Embedded Donor Block | | 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 |
|
deliveredAtUtc*Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | payload* |
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 |
|
...