Versions Compared

Key

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

...

  • A message identifier
  • A timestamp
  • What registry sent the information (sendersending registry)
  • What type of response is provided by the WMDA Match Connect system
  • Any failed validations detected by the Match Connect system

...

FieldDetails
referenceMessageIdstring($uuid)
deliveredAtUtcstring($date-time)

Server-supplied timestamp showing UTC time of Message delivery to recipientreceiving registry's inbox s inbox queue.

sendersendingRegistrystring
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 5678

4-digit ION of the sendersending registry

messageType

string

the type of message just sent by calling this endpoint

responseType

string

Enum:
Array [ Warning, Acknowledge, Deny]

wmdaRemark

One or more remarks, each in its own object


Expand
title...
FieldDetails
remarkTypestring
descriptionstring

...

FieldDetails
deliveredAtUtc*string($date-time)

Server-supplied timestamp showing time of Message delivery to recipientreceiving registry's inbox queue

referenceMessageId*string($uuid)
responseType*

stringEnum:
Array [ Warning, Acknowledge, Failed]

messages can be failed, if the message has a structure or information that prevent delivery to recipient organisationthe receiving registry. This could be incorrect JSON structure and non-existent recipient ION existent ION or because the receiving organisation registry does not allow messages from your registry. 

wmdaRemark[...]

...

SendRetrieve
textMessageRequest
Expand
titleRequest...
Field

Details

message*
Expand
title...
FieldDetails
textstring
nullable: true

Text. Message for a human at recipient organisationreceiving registry

sentDatestring($date-time)
nullable: true

Date sent SENT_DATE Opt 8

recipientreceivingRegistry*string
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4 digit ION of recipientthe receiving registry

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

...