Versions Compared

Key

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

...

This message is used to cancel a previous request that has been sent to the donor registry. The Request must have a preceding request that is being canceled.

SendRetrieverequestRejectedRequestrequestRejectedRetrieve
Expand
titleRequest...
FieldDetails
payload*
Expand
title...
FieldDetails
patient*Patient ID
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 the recipient

correlationGuid*string($uuid)

Sender generated GUID used to correlate response acknowledgment

Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
SendRetrieve
requestCancellationRequestrequestCancellationRetrieve
Expand
titleRequest...
patient*
FieldDetails
message*sender*
Expand
title...
FieldDetails
referenceCode*string($uuid)
requestType*string
maxLength: 3

Type of request REQ_TYPE Req 3

reason
string
maxLength: 
4
3
minLength: 
4
3
example
nullable: 
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.

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 the recipient

patientpayload*
Expand
title...
FieldDetails
Patient ID
donor*Donor ID
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 the recipient

correlationGuid*string($uuid)

Sender generated GUID used to correlate response acknowledgment

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

5.15 - Request Rejected (NO_RES)

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

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

5.

...

15 -

...

Request Rejected (NO_RES

...

)

This message is sent by used to notify the requesting registry to the receiving registry to remind the receiving registry of an outstanding result from a previous requestwhen a request cannot be fulfilled (service cannot be provided).


SendRetrieve
resultReminderRequestresultReminderRetrieve
requestRejectedRequestrequestRejectedRetrieve
Expand
titleRequest...
FieldDetails
message*
Expand
title
Request
...
FieldDetails
sender*string
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: 
5678
1234

4-digit ION of the recipient

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

5.16 - Result Reminder (RES_REM)

This message is sent by the requesting registry to the receiving registry to remind the receiving registry of an outstanding result from a previous request.

senderpayload*
SendRetrieve
resultReminderRequestresultReminderRetrieve
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.

Expand
titleRequest...
FieldDetails
message*
Expand
title...
Donor ID
FieldDetails
patientPatient ID
donor
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 the recipient

correlationGuidpatient*string($uuid)

The sender generated GUID used to correlate response acknowledgment

Patient ID
donor*Donor IDmessageTypestring

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

...

SendRetrieve
genericRequestRequestgenericRequestRetrieve
Expand
titleRequest...
FieldDetails
request*
Expand
title...
FieldDetails
patientEmbedded Patient Block
donorDonor ID
reason

string

reason for the generic request

recipient*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the recipient

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

...