...
A POST to the patients endpoint is used to submit a patient to the Search & Match Service. This call returns a wmdaId for the patient.
| Post |
|---|
| /patients |
| Expand |
|---|
| | Field | Details |
|---|
| patientId | string
maxLength: 17
nullable: true
example: XY1234POrganisation 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: true Enum:
Array [ 48 ] | | ethnicity | string
nullable: true Enum:
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: true Enum:
Array [ 4 ] | | rhesus | string
nullable: true Enum:
Array [ 2 ] | | weight | integer
nullable: true
minimum: 1
maximum: 999
example: 76 | | sex | string
nullable: true Enum:
Array [ 2 ] | | legalTerms | boolean
nullable: true
default: false
example: trueIf not set to true, then patientId will not be stored. |
|
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId | integer
example: 123456
nullable: false |
|
|
...
A PUT to the patients endpoint is used to update a patient with the Search & Match Service.
| Put |
|---|
| /patients |
| Expand |
|---|
| | Field | Details |
|---|
| patientId | string
maxLength: 17
nullable: true
example: XY1234POrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. A patient ID can only be updated when it was not set before. | | hla* | {...} | | idm | {...} | | dateOfBirth | string($date)
nullable: true
maxLength: 10
example: 1961-05-27 | | diagnosis | {...} | | diseasePhase | string
nullable: true Enum:
Array [ 48 ] | | ethnicity | string
nullable: true Enum:
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: true Enum:
Array [ 4 ] | | rhesus | string
nullable: true Enum:
Array [ 2 ] | | weight | integer
nullable: true
minimum: 1
maximum: 999
example: 76 | | sex | string
nullable: true Enum:
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 |
|
|
...
A PUT to the patients/status endpoint is used to update a patient's search status with the Search & Match Service. Allowable status values 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.
| Put |
|---|
| /patients/status |
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
example: 123456
nullable: false | | newStatus* | string
nullable: false Enum:
Array [ 4 ] | | changeReason | string
nullable: trueReason why the change was made. Mandatory when changing to "STP" Enum:
Array [ 21 ] |
|
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
example: 123456
nullable: false | | status* | string
maxLength: 3
nullable: false Enum:
Array [ 4 ] | | changeReason | string
maxLength: 3
nullable: trueReason why the change was made. Mandatory when changing to "STP" Enum:
Array [ 21 ] |
|
|
...
(DO NOT USE, TO BE DEPRECATED in V3. See the Retrieve Patient(s) section just below)
| Get |
|---|
| /patients |
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
example: 123456
nullable: false |
|
| Expand |
|---|
| | Field | Details |
|---|
| patientId* | string
maxLength: 17
nullable: true
example: XY1234POrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | | status* | string
nullable: false Enum:
Array [ 5 ] | | hla* | {...} | | idm* | {...} | | dateOfBirth* | string($date)
nullable: true
maxLength: 10
example: 1961-05-27 | | diagnosis* | {...} | | diseasePhase* | string
nullable: true Enum:
Array [ 48 ] | | ethnicity* | string
nullable: true Enum:
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: true Enum:
Array [ 4 ] | | rhesus* | string
nullable: true Enum:
Array [ 2 ] | | weight* | integer
nullable: true
minimum: 1
maximum: 999
example: 76 | | sex* | string
nullable: true Enum:
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 | | lastUpdated* | string($date-time)
nullable: false
maxLength: 255needed to help determine when patient can be automatically moved to STP state | | lastViewed* | string($date-time)
nullable: false
maxLength: 255needed for sorting patients in the patient list | | assignedUserName* | string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.comtypically the e-mail address of the user |
|
|
...
A GET to the patients/list endpoint is used to retrieve multiple patient's information from the Search & Match Service. You may define a page size, a specific page number, a series of allowable statuses and may limit to only patients assigned to you.
| Post |
|---|
| /patients/list |
| Expand |
|---|
| Field | Details |
|---|
patientId | string
maxLength: 17
nullable: true
example: NL12345P Organisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | limit | integer
nullable: true
default: 100
example:250
| offset | integer
nullable: true
default: 0 | onlyMyPatients | boolean
default: 0
nullable: true
example: true
Only return patients assigned to current user.
|
|
| Expand |
|---|
| | Field | |
|---|
| paging | | Expand |
|---|
| | Field | Details |
|---|
| limit* | integer
default: 100 | | offset* | integer
default: 0 | | totalCount* | integer
minimum: 0 |
|
| | patients | | Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
example: 123456
nullable: false | | patientId* | string
maxLength: 17
nullable: true
example: XY1234POrganisation unique identifier for patient. Cannot be set unless "legalTerms" is set to "true". Do not use real names here. | | status* | string
nullable: false Enum:
Array [ 5 ] | | dateOfBirth* | string($date)
nullable: true
maxLength: 10
example: 1961-05-27 | | ethnicity* | string
nullable: true Enum:
Array [ 21 ] | | lastUpdated* | string($date-time)
nullable: false
maxLength: 255needed to help determine when patient can be automatically moved to STP state | | lastViewed* | string($date-time)
nullable: false
maxLength: 255needed for sorting patients in the patient list | | assignedUserName* | string
minLength: 4
maxLength: 100
nullable: true
example: janethesearchcoordinator@lunarregistry.comtypically the e-mail address of the user | | requests* | [...] |
|
|
|
|
...
A PUT to the patients/user endpoint is used to assign a particular user name to a patient within the Search & Match Service.
...