Versions Compared

Key

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

...

SendRetrieve
reservationReleaseRequestreservationReleaseRetrieve
Expand
titleRequest...
FieldDetails
sender*string
maxLength: 4

minLength: 4

example: 5678

4 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
title...
FieldDetails
patient*Embedded Patient Block
donor*Embedded Donor Block
referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reasonstring
maxLength: 3

minLength: 3

nullable: true

Reason of request cancellation REASON_CNCL Opt 3

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 recipient

correlationGuid*string($uuid)

Sender generated GUID used to correlate response acknowledgement

messageTypestring

Message types supported by WmdaConnect

Enum:
Array [ 21 ]
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

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.


SendRetrieve
RequestCancellationRequestrequestCancellationRequestRequestCancellationRetrieverequestCancellationRetrieve
Expand
titleRequest...
FieldDetails
sender*string
maxLength: 4

minLength: 4

example: 5678

4 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
title...
FieldDetails
patient*Embedded Patient Block
donor*Embedded Donor Block
referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reasonstring
maxLength: 3

minLength: 3

nullable: true

Reason of request cancellation REASON_CNCL Opt 3

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 recipient

correlationGuid*string($uuid)

Sender generated GUID used to correlate response acknowledgement

messageTypestring

Message types supported by WmdaConnect

Enum:
Array [ 21 ]
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

This message is used to notify the requesting registry when a request cannot be fulfilled.


SendRetrieve
RequestRejectedRequestrequestRejectedRequestRequestRejectedRetrieverequestRejectedRetrieve
Expand
titleRequest...
FieldDetails
payload*
Expand
title...
FieldDetails
patient*Embedded Patient Block
donor*Embedded Donor Block
referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reason*string
maxLength: 3

minLength: 2

Reason REASON Req 3

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 recipient

correlationGuid*string($uuid)

Sender generated GUID used to correlate response acknowledgement

Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

...

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.

SendRetrieve
ResultReminderRequestresultReminderRequestResultReminderRetrieveresultReminderRetrieve
Expand
titleRequest...
FieldDetails
sender*string
maxLength: 4

minLength: 4

example: 5678

4 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
title...
FieldDetails
patientEmbedded Patient Block
donorEmbedded Donor Block
requestDatestring($date-time)
nullable: true

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

referenceCode*string($uuid)
resultType*string
maxLength: 9

Type of result reminded RES_TYPE Req 9

expirationDatestring($date-time)
nullable: true

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

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 recipient

correlationGuid*string($uuid)

Sender generated GUID used to correlate response acknowledgement

messageTypestring

Message types supported by WmdaConnect

Enum:
Array [ 21 ]
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...

Is used for example for direct WU requests until 5.11 is available or to reactivate a closed patient case on receiving registry side.


SendRetrieve
genericRequestRequestgenericRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
patientEmbedded Patient Block
donorEmbedded Donor Block
reason

string

reason for the generic request

recipient*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4 digit ION of recipient

Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block


5.18 Request + Response Flows

...