...
Note: Since Warnings are going to be automated, we must keep Text Messages as the only means for user communication left.
Message structure:
| Send | Retrieve |
|---|
| TextMessageRequest | |
| Expand |
|---|
| | Field | Details |
|---|
| payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient | Embedded Patient Block | | donor | Embedded Donor Block | | text | string
nullable: trueText. Note that text over 1200 characters will be truncated if recipient is EMDIS | | sentDate | string($date-time)
nullable: trueDate sent SENT_DATE Opt 8 |
|
| | recipient* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement |
|
| Expand |
|---|
| | Expand |
|---|
| title | WMDAResponse payload... |
|---|
| | sender | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | deliveredAtUtc | string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue | | referenceMessageId | string($uuid) | | responseType | stringEnum:
Array [ 3 ] | | wmdaRemark | [...] |
|
|
| | Expand |
|---|
| | No parameters specified |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 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: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement | | messageType | string 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.
...
| Send | Retrieve |
|---|
| AlertRetrieve |
| Alerts can only be sent by the WMDA's central system | Alert Payload: Meta block (6.1.1) |
6.5 Alert Update message
The Alert Update message is used to broadcast an update about some previous alert. Messages are generated centrally by WMDA. Members are expected to display them to the users.
Message structure:
| Expand |
|---|
| | Field | Details |
|---|
| level | string alert level. enums may change Enum:
Array [ 3 ] | | status | string check later Enum:
Array [ 2 ] | | message | string
maxLength: 1024
example: WMDA will do maintenance on SMC system on the weekend of 10 march | | metaInformation | Embedded Meta Block |
|
|
6.5 Alert Update message
The Alert Update message is used to broadcast an update about some previous alert. Messages are generated centrally by WMDA. Members are expected to display them to the users.
Message structure:
| Send | Retrieve |
|---|
| AlertUpdateRetrieve |
| Alert updates can only be sent by the WMDA's central system | | Expand |
|---|
| | No parameters specified |
| Expand |
|---|
| | Field | Details |
|---|
| alertReferenceIdentifier | string($uuid) | | level | string alert level. enums may change Enum:
Array [ 3 ] | | status | string check later Enum:
Array [ 2 ] | | message | string
maxLength: 1024
example: WMDA will do maintenance on SMC system on the weekend of 10 march | | metaInformation | Embedded Meta Block |
|
|
| Send | Retrieve |
|---|
| AlertUpdateRetrieve | Alert updates can only be sent by the WMDA's central system | Alert Update Payload: - Alert reference ID (GUID)
- Level
- Status
- Message
Meta block (6.1.1) |