...
| Send |
|---|
| RetrievePatient |
Request | wmdaId* | integer
example: 123456
nullable: false |
Response | 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. | | 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: 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 | | 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 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 |
|---|
| 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: P1234XXOrganisation 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: 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
...
There is no registerPatientRequest endpoint. A patient is registered with a partner registry at the time of request in the form of an embedded Patient block - described in the Admin chapter.
3.9 - Update Registered
...
Patient (PAT_UPD)
The updateRegisteredPatientRequest is used to update a registered patient with a partner registry. The central hub will review the contents and update any values that are already stored in the Search & Match system.
| Send | Retrieve |
|---|
| UpdateRegisteredPatient | UpdateRegisteredPatientRetrieve |
Request | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | Patient |
|---|
| wmdaId* | integer
nullable: false
example: 1234ID provided by the WMDA | | patientId* | string
maxLength: 17
nullable: false
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 [ 20 ] | | poolCountryCode | string
maxLength: 2
pattern: ^[A-Z]{2}
nullable: true
example: NLISO 3166-1 alpha-2 Country Code (capitalized) | | 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 ] | | firstName | string
maxLength: 30
nullable: true
example: JohnFirst (given name) of the patient | | lastName | string
maxLength: 30
nullable: true
example: DoeLast (family name) of the patient |
Response | deliveredAtUtc | string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue | | referenceMessageId | string($uuid) | | responseType | stringEnum:
Array [ 3 ] | | remark | [...] |
| - MetaInformation
- Sent payload
|
...