Versions Compared

Key

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

...

Send
CreatePatient

Request

Patient

patientIdstring
maxLength: 17

nullable: true

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 [ 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: 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 ]
legalTermsboolean
nullable: true

default: false

example: true

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




Response

wmdaIdinteger
example: 123456

nullable: false

3.3 - Update Patient

The UpdatePatientRequest is used to update a patient with the Search & Match Service.

...

The UpdatePatientStatusRequest is used to update a patient's search status with the Search & Match Service.  Allowable statuses are SUS, PRE, ACT and STP.  A new patient is defaulted to the new (NEW) state.  Under the NEW state, searches must be requested explicitly.  When doing so, the patient is moved to the PRE state. Under the ACT state, searches will be kept up to date automatically.  SUS will stop automatic updates to searches but results will remain for 42 days.  STP will terminate the search and delete all search results.

This endpoint does not affect the patient status at the donor registry or cord blood bank. For that please use endpoint UpdateRegisteredPatientStatus


Send
UpdatePatientStatus

Request

wmdaId*integer
example: 123456

nullable: false
newStatus*string
maxLength: 3

nullable: false
Enum:
Array [ 4 ]
changeReasonstring
maxLength: 3

nullable: true

Reason why the change was made. Mandatory when changing to "STP"

Enum:
Array [ 21 ]


Response

wmdaId*integer
example: 123456

nullable: false
newStatus*string
maxLength: 3

nullable: false
Enum:
Array [ 4 ]
changeReasonstring
maxLength: 3

nullable: true

Reason why the change was made. Mandatory when changing to "STP"

Enum:
Array [ 21 ]

3.5 - Retrieve Patient

The retrievePatientRequest is used to retrieve an individual patient's information from the Search & Match Service.

...

Send
AssignUserToPatient

Request

wmdaId*integer
example: 123456

nullable: false
userName*string
minLength: 4

maxLength: 100

nullable: true

example: janethesearchcoordinator@lunarregistry.com

typically the e-mail address of the user

Response

succeededboolean
default: true
messagestring
example: Successfully assigned janethesearchcoordinator@lunarregistry.com

3.8 - Register Patient   

...