...
| addressRequest - example of request with the block named institutionPaying |
| Expand |
|---|
| title | institutionPaying block in Request... |
|---|
| | Field | Details |
|---|
| organisationId | string
Organisation unique identifier for the institution. - Unique reference to an institution
- Allows local address management if needed (e.g. for other use cases) by receiving registry and backward compatibility to existing EMDIS implementations.
- Provided by the local registry system.
- Should be worldwide unique.
- Should follow the construct of ION + local organisation id.
- The ION to be used is the ION of the patient registering registry (PR).
- Should be provided as a user-friendly (displayable) id for use on screens and on documentation.
| | organisation* | | Expand |
|---|
| | name* | string Name of the destination organisation | | addressLine1* | string first line of address. Generally the street and house number. | | addressLine2 | string second line of address | | addressLine3 | string third line of address | | postalCode* | string | | city* | string The name of the city, town, suburb, village or other community or delivery center. | | country* | string Country - a nation as commonly understood or generally accepted. | | phone | string The value is a telephone number used for voice calls. | | fax | string The value is the number for a fax machine. | | email | string ($email) The value is an email address. | | type* | string Type of organisation. node = MatchConnect node. Formerly known as "HUB". collectionCentre is formerly known as HAR. Enum:
|
|
| | contactPerson* | | Expand |
|---|
| | name* | string The name of the contact person. | | phone* | string The value is a telephone number used for voice calls. | | fax | string The value is the number for a fax machine. | | email | string ($email) The value is an email address. |
|
|
|
|
6.1.4 Embedded Patient Block
...
| donor | | Expand |
|---|
| | Field | Type |
|---|
| grid* | string | | dateOfBirth* | string ($date) | | sex | string
| | hla* | ... | | abo | string
| | rhesus | string
| | donorRegistryIon* | integer ($int32) Unique number provided by ICCBBA for the registry that is responsible for the donor/CBU | | status* | string
| | ethnicity | string
| | idm | ... | | lastContactDate | string ($date) | | marrowDonationsCount | integer ($int32) | | pbscDonationsCount | integer ($int32) | | donorAttribute | string | | weight | integer | | height | integer ($int32) | | kir | ... | | collectionType | string Collection type, i.e. the willingness of the donor to donate in a specific manner. M = Marrow P = PBSC B = Both PBSC & Marrow Enum:
| | transfusionsCount | integer ($int32) | | pregnanciesCount | integer ($int32) | | reservedPatientConnectId | string this field will be replaced by the reservedPatientWmdaId field | | reservedPatientWmdaId | integer The wmdaId of the patient for whom this donor is reserved | | statusEndDate | string ($date) | | statusReason | string Enum:
| | mic | ... | | ccr5 | string
| | lastMedicalCheckupDate | string ($date) |
|
|
|---|
...
These CBU updates are for the receiving registry (patient registry) only. So the sending (donor) registry is responsible for sending a DIFF upload to the Search & Match system in parallel to keep information in sync.
| cbu | | Expand |
|---|
| | Field | Type |
|---|
| cbuId* | string CBU Identification2 (formerly CB_ID) | | dateCollected* | string ($date) | | hla* | ... | | cbbIon* | integer ($int32) Unique number provided by ICCBBA for the registry that is responsible for the donor/CBU | | status* | string
| | idm | ... | | reservedPatientConnectId | string this field will be replaced by the reservedPatientWmdaId field | | reservedPatientWmdaId | integer The wmdaId of the patient for whom this donor is reserved | | statusEndDate | string ($date) | | statusReason | string
|
|
|
|---|
...
| 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
...