Searches for patients that match the query parameters.
Query parameters
limitintegerOptional
mrnstringOptional
page_tokenstringOptional
A token that can be used to retrieve the next or previous page of results
sort_fieldstringOptional
The field to order by. Valid values are either keys on the patient object or a special ordering "similar_name:<search_string>" (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match patient names to the search criteria.
sort_direction"asc" or "desc"Optional
Defaults to ascending.
Allowed values: ascdesc
Response
This endpoint returns an object.
itemslist of objects
A patient object with immutable server-owned properties.
next_page_tokenstringOptional
A token that can be used to retrieve the next or previous page of results
prev_page_tokenstringOptional
A token that can be used to retrieve the next or previous page of results