Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Clinical

Submit patient list request. Use the UUID returned in the response to retrieve the batch of patients.

post/api/patients_list

Query parameters

order_bystring

Order results by a specific field. Valid options include [id, updated_at]. Default: id.

page_sizeinteger

Number of results to return per page. Number between 1 and 1000.

first_namestring

Filter the list for the patient's first name.

last_namestring

Filter the list for the patient's last name.

preferred_languagestring

Filter the list for the patient's preferred language.

genderstring

Filter the list for the patient's gender.

sincestring

Filter the list for when the patient was created or updated. The value should be a date in the format YYYY-MM-DD. For example, to filter for patients created or updated on or after 2019-01-01, use the value 2019-01-01.

date_of_birthstring

Filter the list for the patient's date of birth. The value should be a date in the format YYYY-MM-DD. For example, to filter for patients born on 2019-01-01, use the value 2019-01-01.

racestring

Filter the list for the patients' race.

chart_idstring

Filter the list for the patients' chart id.

emailstring

Filter the list for the patients' email.

ethnicitystring

Filter the list for the patients' ethnicity.

verboseboolean

when true include additional verbose fields in the response.

Response

Created

statusstring

Status of the request. Possible values are "In progress" or "Complete".

uuidstring

UUID of the batch of patients.

descriptionstring

Contains link to load the batch by UUID