API ReferencePre EncounterAppointmentsV1

Get Visits

Beta

Gets all Visits within a given time range. The return list is ordered by start_time ascending.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

page_tokenstringOptional
A token that can be used to retrieve the next or previous page of results
limitintegerOptional
sort_fieldstringOptional

Defaults to appointment.start_time.

sort_directionenumOptional
Defaults to ascending.
Allowed values:
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', '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.

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

Errors