Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: replaced the steerco part in links to P1MCPUB and v2.x to v2.0

...

Send (Post)Retrieve (Post)
MessageResponseRequest
Expand
titleRequest...
FieldDetails
receivingRegistry*
integer
ION
organisationResponse*
Expand
title...
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
titleRequest...
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
titleResponse...
Field Details
generalInformation* Embedded General Information Response Block
messagesoriginalMessage*

metaInformation*

...

Send (Post)Retrieve (Post)
textMessageRequest


Expand
titleRequest...

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

patientwmdaId
donor*Embedded Donor Block (donor in request)
Expand
titleResponse...
Field Details
metaInformation Embedded Meta Block
Expand
titleRequest...
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
titleResponse...
Field Details
generalInformation* Embedded General Information Response Block
messagesoriginalMessage*

metaInformation*

...

Send (Post)
Retrieve (Post)
genericDocumentExchangeRequestRequestgenericDocumentExchangeRequestRetrieve
Expand
titleRequest...
Field Details
request*
Expand
titleDetails...
FieldDetails
referenceMessagestring($uuid)
attachment*Embedded Attachment Block
receivingRegistry*

integer

ION of the receivingRegistry

patient*wmdaId
donor*

Embedded Donor Block (donor in request)

Expand
titleResponse...
Field Details
metaInformation* Embedded Meta Block
Expand
titleRequest...
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
titleResponse...
Field Details
generalInformation* Embedded General Information Response Block
messagesoriginalMessage*

metaInformation*

...

SendRetrieve (Post)

AlertRetrieve
Alerts can only be sent by the WMDA's central system
Expand
titleRequest...
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
titleResponse...
Field Details
generalInformation* Embedded General Information Block
messages*originalMessage 
Expand
title...
FieldDetails
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.

...

SendRetrieve (Post)

AlertUpdateRetrieve
Alert updates can only be sent by the WMDA's central system
Expand
titleRequest...
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
titleResponse...
Field Details
generalInformation* Embedded General Information Block
messages*originalMessage 
Expand
title...
FieldDetails
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

...