Versions Compared

Old Version 88

changes.mady.by.user Mark Melchers

Saved on

compared with

New Version 89

changes.mady.by.user Mark Melchers

Saved on

Key

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

...

SendRetrieve
MessageResponse

MessageResponseRetrieve

Expand
titleRequest...
FieldDetails
organisationResponse
Expand
title...
FieldDetails
retrievedAtUtc*string($date-time)

Server-supplied timestamp showing time of Message retrieval and storage in organisation's own systems

referenceMessageId*string($uuid)
responseType*

string

Enum:
Array [ 3 ]

remark

string


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

...

SendRetrieve
textMessageRequest

textMessageRetrieve

Expand
titleRequest...
Field

Details

message*
Expand
title...
FieldDetails
patientEmbedded Patient Block
donorEmbedded Donor Block
textstring
nullable: true

Text. Note that text over 1200 characters will be truncated if recipient is EMDISMessage for a human at recipient organisation. 

sentDatestring($date-time)
nullable: true

Date sent SENT_DATE Opt 8

recipient*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of recipient

patient*Patient ID
donor*Donor ID



FieldDetails
wmdaResponseEmbedded WMDA Response Block
wmdaResponseNo parameters specified
Expand
titleResponseRequest...
FieldDetails
Expand
titleResponse...
FieldDetails
senderstring
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 5678

4 digit ION of sender

deliveredAtUtcstring($date-time)

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

referenceMessageIdstring($uuid)
responseTypestringEnum:
Array [ 3 ]
wmdaRemark[...]
Expand
titleRequest...
No parameters specified
originalMessage{...}
metaInformationEmbedded Meta Block
Expand
titleResponse...
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*{...}
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 ]

6.4 Alert message

The Alert message is used to broadcast an important information about the system, like planned service outage. Messages are generated centrally by WMDA. Members are expected to display them to the users.

...