...
| Send (Post) | Retrieve (Post) |
|---|
| MessageResponseRequest | |
| Expand |
|---|
| | Field | Details |
|---|
| 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 warning, acknowledge, deny ]
| | remark | string maxLength: 1000
nullable: true
|
|
|
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
6.3 Text message [TXT_MSG]
...
| Send (Post) | Retrieve (Post) |
|---|
| textMessageRequest | |
| Expand |
|---|
| | Field | Details |
|---|
| requestingRegistryReferenceCoderequestId | string
maxLength: 1519
example:XX12345
nullable: true
| | text* | string
nullable: true
example: Would it be possible to also perform IDM test for SARS-CoV-23? Text. Message for a human at receiving registry. | | receivingRegistry* | string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of the receiving registry | | patient* | Patient ID | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
nullable: false
example: 1234 ID provided by the WMDA |
|
| | donor* | Embedded Donor Block (donor in request) | donor* | Donor ID |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
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 (Post) |
|---|
| AlertRetrieve |
| Alerts can only be sent by the WMDA's central system | | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
| Expand |
|---|
| | Field | Details |
|---|
| generalInformation* | Embedded General Information Block | | originalMessagemessages* | | | 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 |
|
|
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.
...
This endpoint allows end users to retrieve an overview of all messages that are ready to be downloaded, including their corresponding sequence numbers. This information can be used to retrieve the messages from their respective *retrieve endpoints. If desired, the messages can be pulled in chronological order, given by the sequence numbers. Each "retrieve" endpoint will have the optional parameter "sequenceNumber", that allows for an indivual collection of the corresponding message(s). If that parameter is left empty all available messages are retrieved (according to the limit set in the parameters).
...