Get Appointment List
Searches for appointments that match the query parameters.
Authentication
AuthorizationBearer
OAuth authentication of the form <token>.
Query parameters
sort_field
Defaults to appointment.startTimestamp.
sort_direction
Defaults to asc.
Allowed values:
limit
Defaults to 100.
page_token
A token that can be used to retrieve the next or previous page of results
filters
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', 'ieq', 'in'. ieq is a case-insensitive equality operator. in allows searching for values that match any item in a semicolon-separated list (e.g., 'patient.id|in|foo;bar;baz'). Path values are camelCase.
include_deactivated
If true, includes deactivated appointments in the results. Defaults to false.
include_merged_patient_data
If true and a patient id is specified, then also include appointments from any alternative patients that are merged into this patient. Defaults to false.
Response
This endpoint returns an object.
items
total
next_page_token
A token that can be used to retrieve the next or previous page of results
prev_page_token
A token that can be used to retrieve the next or previous page of results
