API ReferencePre EncounterListsV1

Get Appointment List

Beta
Searches for appointments that match the query parameters.

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

sort_fieldstringOptional
Defaults to appointment.startTimestamp.
sort_directionenumOptional
Defaults to asc.
Allowed values:
limitintegerOptional
Defaults to 100.
page_tokenstringOptional
A token that can be used to retrieve the next or previous page of results
filtersstringOptional

A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form ‘path:operator:value’. Example: ‘patient.mrn|eq|12345’. Filters are separated by commas. Example: ‘patient.mrn|eq|12345,appointment.startDate|gt|67890’. All filters are ANDed together. Valid operators are ‘eq’, ‘gt’, ‘lt’, ‘contains’. Path values are camelCase.

Response

This endpoint returns an object.
itemslist of objects
totalinteger
next_page_tokenstring or null
A token that can be used to retrieve the next or previous page of results
prev_page_tokenstring or null
A token that can be used to retrieve the next or previous page of results