...
| Send |
|---|
| updatePatientStatus |
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
example: 123456
nullable: false | | newStatus* | 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 ] |
|
| Expand |
|---|
| | Field | Details |
|---|
| wmdaId* | integer
example: 123456
nullable: false | | newStatus* | 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 ] |
|
|
3.5 - Retrieve Patient
The retrievePatientRequest retrievePatient is used to retrieve an individual patient's information from the Search & Match Service.
| Send |
|---|
| RetrievePatientretrievePatient |
| 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 |
|
|
3.6 - Retrieve Patient List
The listPatientsRequest retrievePatientList 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.
| Send |
|---|
| ListPatientsretrievePatientList |
| Expand |
|---|
| Field | Details |
|---|
limit | integer Maximum number of patients per page. Default value : 100 | offset | integer Starting position of the requested page. Default value : 0 | status | array[string] the statuses that the patients are allowed to have Available values : NEW, PRE, ACT, SUS, STP Default value : null Example : ACT|NEW | onlyMyPatients | boolean Only return patients assigned to current user. Based on username property in JSON Web Token (JWT token). Does not work with machine credentials (direct API connection without WMDA frontend). Default value : false |
|
| 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* | [...] |
|
|
|
|
3.7 - Assign User To Patient
The AssignUserToPatient assignUserToPatient endpoint is used to assign a particular user name to a patient within the Search & Match Service.
...
3.9 - Update Registered Patient (PAT_UPD)
The updateRegisteredPatientRequest updateRegisteredPatient endpoint is used to update a registered patient with a partner registry.
...