Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SendRetrieve
reservationRequestRequestreservationRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
requestDate*string($date-time)

Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]

referenceCode*string($uuid)
expirationDatestring($date-time)
nullable: true

Request date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

acknowledgementIdstring
maxLength: 17

nullable: true

example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
maxLength: 120

nullable: true

Remark REMARK Opt 120

recipient*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the recipient

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

5.10 - Reservation

...

Response (RSV_RES)

This message is used to notify the requesting patient registry if the Reservation Request has been confirmed by the donor registry.

SendRetrieve
reservationResponseRequestreservationResponseRetrieve
Expand
titleRequest...
string

Message types supported by WmdaConnect

Enum:
Array [ 21 ]
FieldDetails
sender*string
maxLength: 4

minLength: 4

example: 5678

4 digit ION of the 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.

payloadresponse*
Expand
title...
FieldDetails
patient*Patient ID
donor*Embedded Donor Block
referenceCode*string($uuid)
expirationDatestring($date-time)
nullable: true

Date expiration of reservation EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd]

confirmed*boolean

Confirmation of reservation CONFIRM Req 1

remarkstring
maxLength: 120

nullable: true

Remark REMARK Opt 120

recipient*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the recipient

correlationGuidpatient*string($uuid)

The sender generated GUID used to correlate response acknowledgement

messageTypePatient ID
donor*Embedded Donor Block
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...