Versions Compared

Key

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

...

SendRetrieve
MessageResponse
Expand
titleRequest...
FieldDetails
WMDAResponsewmdaResponse
Expand
title...
FieldDetails
deliveredAtUtcstring($date-time)

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

referenceMessageIdstring($uuid)
responseType

string

Enum:
Array [ 3 ]

wmdaRemark[...]
Expand
titleResponse...
FieldDetails
WMDAResponsewmdaResponse
Expand
title...
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)
responseType

string

Enum:
Array [ 3 ]

wmdaRemark[...]
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage
Expand
title...
FieldDetails
wmdaResponse...
metaInformation*Embedded Meta Block

...

Note: Since Warnings are going to be automated, we must keep Text Messages as the only means for user communication left.

Message structure:

SendRetrieve
TextMessageRequest
Expand
titleRequest...
Field

Details

payload*
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 EMDIS

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

correlationGuid*string($uuid)

Sender generated GUID used to correlate response acknowledgement

Expand
titleResponse...
Expand
titleWMDAResponse payload...
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[...]

TextMessage payload

Meta block (6.1.1)
Expand
titleRequest...
No parameters specified
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.

...