Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 nameformatDescription
messageIdstring($uuid)ID of the originally sent message
sentAtUtcstring($date-time)Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue.
senderstring
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 5678
4 digit ION of the sender
messageTypestringTo 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 3
  • Institution Identification INST_ID Req 10
  • Address Line 1 ADDR_1 Req 40
  • Address Line 2 ADDR_2 Opt 40
  • Address Line 3 ADDR_3 Opt 40
  • Contact person PERSON Opt 40
  • ZIP code ZIP Req 10
  • City CITY Req 40
  • Country COUNTRY Req 2
  • Phone Number PHONE Req 20
  • Fax Number FAX Opt 20
  • Email address EMAIL Opt 60
  • Accreditations obtained ACCREDITATION Opt 5
    • Position 1: NetCord-FACT
    • Position 2: AABB
    • Position 3: to be defined
    • Position 4: to be defined
    • Position 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: 1234

    ID provided by the WMDA

    patientId*string
    maxLength: 17

    nullable: false

    example: P1234XX

    Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here.

    hla*{...}
    idm{...}
    dateOfBirthstring($date)
    nullable: true

    maxLength: 10

    example: 1961-05-27
    diagnosis{...}
    diseasePhasestring
    nullable: true
    Enum:
    Array [ 48 ]
    ethnicitystring
    nullable: true
    Enum:
    Array [ 20 ]
    poolCountryCodestring
    maxLength: 2

    pattern: ^[A-Z]{2}

    nullable: true

    example: NL

    ISO 3166-1 alpha-2 Country Code (capitalized)

    abostring
    nullable: true
    Enum:
    Array [ 4 ]
    rhesusstring
    nullable: true
    Enum:
    Array [ 2 ]
    weightinteger
    nullable: true

    minimum: 1

    maximum: 999

    example: 76
    sexstring
    nullable: true
    Enum:
    Array [ 2 ]
    firstNamestring
    maxLength: 30

    nullable: true

    example: John

    First (given name) of the patient

    lastNamestring
    maxLength: 30

    nullable: true

    example: Doe

    Last (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:

...

SendRetrieve
post_api_v1_TextMessageRequest
  • Patient
  • Donor
  • Text

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.

...

SendRetrieve

get_api_v1_AlertRetrieve
Alerts can only be sent by the WMDA's central system

Alert Payload:

  • Level
  • Status
  • Message

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.

...