Versions Compared

Old Version 111

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 112

changes.mady.by.user Matt Prestegaard

Saved on

Key

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

...

Send
CreatePatient

Request

Patient
patientIdstring
maxLength: 17
nullable: true
example: P1234XXXY1234P

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: trueEnum:
Array [ 48 ]
ethnicitystring
nullable: trueEnum:
Array [ 21 ]
poolCountryCodestring
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

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

transplantCentreIdstring
maxLength: 10
nullable: true
example: TC X
abostring
nullable: trueEnum:
Array [ 4 ]
rhesusstring
nullable: trueEnum:
Array [ 2 ]
weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
sexstring
nullable: trueEnum:
Array [ 2 ]
legalTermsboolean
nullable: true
default: false
example: true

If not set to true, then patientId will not be stored.


Response

wmdaIdinteger
example: 123456
nullable: false

...

Send
UpdatePatient

Request

Patient
patientIdstring
maxLength: 17
nullable: true
example: P1234XXXY1234P

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: trueEnum:
Array [ 48 ]
ethnicitystring
nullable: trueEnum:
Array [ 21 ]
poolCountryCodestring
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

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

transplantCentreIdstring
maxLength: 10
nullable: true
example: TC X
abostring
nullable: trueEnum:
Array [ 4 ]
rhesusstring
nullable: trueEnum:
Array [ 2 ]
weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
sexstring
nullable: trueEnum:
Array [ 2 ]
legalTermsboolean
nullable: true
default: false
example: true

If not set to true, then patientId will not be stored.

wmdaId*integer
example: 123456
nullable: false


Response

None specified

...

Send
RetrievePatient

Request

wmdaId*integer
example: 123456
nullable: false

Response

patientId*string
maxLength: 17
nullable: true
example: P1234XXXY1234P

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

status*string
nullable: falseEnum:
Array [ 5 ]
hla*{...}
idm*{...}
dateOfBirth*string($date)
nullable: true
maxLength: 10
example: 1961-05-27
diagnosis*{...}
diseasePhase*string
nullable: trueEnum:
Array [ 48 ]
ethnicity*string
nullable: trueEnum:
Array [ 21 ]
poolCountryCode*string
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

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

transplantCentreId*string
maxLength: 10
nullable: true
example: TC X
abo*string
nullable: trueEnum:
Array [ 4 ]
rhesus*string
nullable: trueEnum:
Array [ 2 ]
weight*integer
nullable: true
minimum: 1
maximum: 999
example: 76
sex*string
nullable: trueEnum:
Array [ 2 ]
legalTerms*boolean
nullable: true
default: false
example: true

If not set to true, then patientId will not be stored.

wmdaId*integer
example: 123456
nullable: false
lastUpdated*string($date-time)
nullable: false
maxLength: 255

needed to help determine when patient can be automatically moved to STP state

lastViewed*string($date-time)
nullable: false
maxLength: 255

needed for sorting patients in the patient list

assignedUserName*string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.com

typically the e-mail address of the user

...

Send
ListPatients

Request

limit
integer

(query)

Maximum number of patients per page.

Default value : 100

offset
integer

(query)

Starting position of the requested page.

Default value : 0

status
array[string]

(query)

the statuses that the patients are allowed to have

Available values : NEW, PRE, ACT, SUS, STP

Default value : null

Example : ACT|NEW

onlyMyPatients
boolean

(query)

Only return patients assigned to current user. Based on username property in JWT token. Does not work with machine credentials (direct API connection without WMDA frontend).

Default value : false


Response

Paging
limit*integer
default: 100
offset*integer
default: 0
totalCount*integer
minimum: 0
Patients
wmdaId*integer
example: 123456
nullable: false
patientId*string
maxLength: 17
nullable: true
example: P1234XXXY1234P

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

status*string
nullable: falseEnum:
Array [ 5 ]
dateOfBirth*string($date)
nullable: true
maxLength: 10
example: 1961-05-27
ethnicity*string
nullable: trueEnum:
Array [ 21 ]
lastUpdated*string($date-time)
nullable: false
maxLength: 255

needed to help determine when patient can be automatically moved to STP state

lastViewed*string($date-time)
nullable: false
maxLength: 255

needed for sorting patients in the patient list

assignedUserName*string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.com

typically the e-mail address of the user

requests*[...]

...

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: P1234XXXY1234P

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: trueEnum:
Array [ 48 ]
ethnicitystring
nullable: trueEnum:
Array [ 20 ]
poolCountryCodestring
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NL

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

abostring
nullable: trueEnum:
Array [ 4 ]
rhesusstring
nullable: trueEnum:
Array [ 2 ]
weightinteger
nullable: true
minimum: 1
maximum: 999
example: 76
sexstring
nullable: trueEnum:
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


Response

deliveredAtUtcstring($date-time)

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

referenceMessageIdstring($uuid)
responseTypestringEnum:
Array [ 3 ]
remark[...]
  • MetaInformation
  • Sent payload

...