| Table of Contents |
|---|
6.1 Embedded blocks
6.1.1 Embedded Meta block
The additional meta-information "blocks" are added to ensure the receiving registry is aware of:
...
| Field name | format | Description |
|---|---|---|
| messageId | string($uuid) | ID of the originally sent message |
| sentAtUtc | string($date-time) | Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. |
| sender | string maximum: 9999 minimum: 0 maxLength: 4 minLength: 4 example: 5678 | 4 digit ION of the sender |
| messageType | string | To be designed and described. The idea is to help registry's MC admin to analyze possible issues reported in validationDetails field. AM: I think this is an excessive information, as messageId should be sufficient. |
| validationDetails | To be designed and described. The idea is to supply the concerns of the central hub validation system that are acceptable but require attention of the receiving registry. |
}
6.1.2 Embedded Address block
Original message: Address to broadcast [NEW_ADD]
...
Institution Type INST_TYPE Req 3Institution Identification INST_ID Req 10Address Line 1 ADDR_1 Req 40Address Line 2 ADDR_2 Opt 40Address Line 3 ADDR_3 Opt 40Contact person PERSON Opt 40ZIP code ZIP Req 10City CITY Req 40Country COUNTRY Req 2Phone Number PHONE Req 20Fax Number FAX Opt 20Email address EMAIL Opt 60Accreditations obtained ACCREDITATION Opt 5Position 1: NetCord-FACTPosition 2: AABBPosition 3: to be definedPosition 4: to be definedPosition 5: to be defined
6.1.3 Embedded Patient Block
There is no register patient endpoint. Instead, an embedded patient block will accompany all requests. The embedded patient block looks as follows:
- Request
Patient
wmdaId* integer
nullable: false
example: 1234ID provided by the WMDA
patientId* string
maxLength: 17
nullable: false
example: P1234XXOrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.
hla* {...} idm {...} dateOfBirth string($date)
nullable: true
maxLength: 10
example: 1961-05-27diagnosis {...} diseasePhase string
nullable: trueEnum:
Array [ 48 ]ethnicity string
nullable: trueEnum:
Array [ 20 ]poolCountryCode string
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NLISO 3166-1 alpha-2 Country Code (capitalized)
abo string
nullable: trueEnum:
Array [ 4 ]rhesus string
nullable: trueEnum:
Array [ 2 ]weight integer
nullable: true
minimum: 1
maximum: 999
example: 76sex string
nullable: trueEnum:
Array [ 2 ]firstName string
maxLength: 30
nullable: true
example: JohnFirst (given name) of the patient
lastName string
maxLength: 30
nullable: true
example: DoeLast (family name) of the patient
6.1.4 Embedded Donor Block
In EMDIS, the following messages are linked to the donor updates:
...
Here is the comparison of the DONOR_CB and the API endpoints: EMDIS vs API.xlsx
6.
...
2 Message Response
The message response is intended as an automated response to every user generated message. It serves three purposes:
...
| Send | Retrieve |
|---|---|
| post_api_v1_TextMessageRequest | |
| TextMessage payload Meta block |
6.
...
3 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 |
|---|---|
| get_api_v1_AlertRetrieve | |
| Alerts can only be sent by the WMDA's central system | Alert Payload:
Meta block |
6.
...
4 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.
...