Versions Compared

Key

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

...

SendRetrieve
UpdateRegisteredPatientUpdateRegisteredPatientRetrieve

Request

recipientinteger
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4 digit ION of recipient

Patient
wmdaId*integer
nullable: false

example: 1234

ID provided by the WMDA

patientId*string
maxLength: 17

nullable: false

example: XY1234P

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{...}
diseasePhase

string
nullable: true

Enum:
Array [ 48 ]

ethnicity

string
nullable: true

Enum:
Array [ 20 ]

poolCountryCodestring
maxLength: 2

pattern: ^[A-Z]{2}

nullable: true

example: NL

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

abo

string
nullable: true

Enum:
Array [ 4 ]

rhesus

string
nullable: true

Enum:
Array [ 2 ]

weightinteger
nullable: true

minimum: 1

maximum: 999

example: 76
sex

string
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

Embedded Patient Block


Response

deliveredAtUtcstring($date-time)

Server-supplied timestamp showing time of Message delivery to recipient's inbox queue

referenceMessageIdstring($uuid)
responseType

string

Enum:
Array [ 3 ]

remark[...]

Request

No parameters specified

Response

patientPatient*Embedded Patient Block
MetaInformation*Embedded Meta Block{...}metaInformation*{...}

3.10 - Message Flows