...
The CreatePatientRequest is used to submit a patient to the Search & Match Service. This call returns a wmdaId for the patient.
| Send |
|---|
| CreatePatient |
Request Patient | patientId | string
maxLength: 17
nullable: true
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-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: NLISO 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: trueIf not set to true, then patientId will not be stored. |
Response | wmdaId | integer
example: 123456
nullable: false |
|
3.3 - Update Patient
The UpdatePatientRequest is used to update a patient with the Search & Match Service.
| Send |
|---|
| UpdatePatient |
Request Patient | patientId | string
maxLength: 17
nullable: true
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-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: NLISO 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: trueIf not set to true, then patientId will not be stored. | | wmdaId* | integer
example: 123456
nullable: false |
Response None specified |
3.4 - Update Patient Status
...
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: falseEnum:
Array [ 4 ] | | changeReason | string
maxLength: 3
nullable: trueReason 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: falseEnum:
Array [ 4 ] | | changeReason | string
maxLength: 3
nullable: trueReason 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.
...
The AssignUserToPatient is used to assign a particular user name to a patient within the Search & Match Service.
3.8 - Register Patient
...