...
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 | Expand |
|---|
| | limit* | integer
default: 100 | | offset* | integer
default: 0 | | totalCount* | integer
minimum: 0 |
|
| Expand |
|---|
| | 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* | [...] |
|
| 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: 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
...