...
Send (Post) | Retrieve (Post) |
---|
MessageResponseRequest | |
Expand |
---|
| Field | Details |
---|
receivingRegistry* | integer ION | organisationResponse* | Expand |
---|
| Field | Details |
---|
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 |
---|
| limit | integer | shouldPeek | boolean
Set to true if you want messages to remain available after retrieval | messageSequenceNumber | integer Optional field to request a message with a specific messageSequenceNumber. |
|
|
...
Send (Post) | Retrieve (Post) |
---|
textMessageRequest | |
Expand |
---|
|
| Details |
---|
referenceMessageId | string ($uuid) can be used to refer to message that has been sent previously
| text* | string Text. Message for a human at receiving registry. | receivingRegistry * | string 4 digit ION of the receiving registry | patient | wmdaId | donor* | Embedded Donor Block (donor in request) |
|
| Expand |
---|
| limit | integer | shouldPeek | boolean
Set to true if you want messages to remain available after retrieval | messageSequenceNumber | integer Optional field to request a message with a specific messageSequenceNumber. |
|
|
...
Send (Post)
| Retrieve (Post)
|
genericDocumentExchangeRequestRequest | genericDocumentExchangeRequestRetrieve |
| Expand |
---|
| limit | integer | shouldPeek | boolean
Set to true if you want messages to remain available after retrieval | messageSequenceNumber | integer Optional field to request a message with a specific messageSequenceNumber. |
|
|
...
Send | Retrieve (Post) |
---|
| AlertRetrieve |
Alerts can only be sent by the WMDA's central system | Expand |
---|
| limit | integer | shouldPeek | boolean
Set to true if you want messages to remain available after retrieval | messageSequenceNumber | integer Optional field to request a message with a specific messageSequenceNumber. |
|
Expand |
---|
| Field | Details |
---|
generalInformation* | Embedded General Information Block | messages* | originalMessage Expand |
---|
| Field | Details |
---|
level | string alert level. enums may change Enum: Array [ 3 ] | status | string check later Enum: Array [ 2 ] | messageText | 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.
...
Send | Retrieve (Post) |
---|
| AlertUpdateRetrieve |
Alert updates can only be sent by the WMDA's central system | Expand |
---|
| limit | integer | shouldPeek | boolean
Set to true if you want messages to remain available after retrieval | messageSequenceNumber | integer e xamplet: 12345 Optional field to request a message with a specific messageSequenceNumber. |
|
Expand |
---|
| Field | Details |
---|
generalInformation* | Embedded General Information Block | messages* | originalMessage Expand |
---|
| Field | Details |
---|
level | string alert level. enums may change Enum: Array [ 3 ] | status | string check later Enum: Array [ 2 ] | messageText | string maxLength: 1024 example: WMDA will do maintenance on SMC system on the weekend of 10 march |
|
|
| metaInformation* Embedded Meta Block |
|
|
6.6 Available Messages
6.6.1 Available Messages
...