PreEncounterAppointmentsV1

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

IMPORTANT: This endpoint requires a date filter on appointment.startTimestamp to ensure acceptable query performance. Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.

Example filters:

  • appointment.startTimestamp|gt|2024-01-01 - appointments after January 1, 2024
  • appointment.startTimestamp|eq|2024-12-08 - appointments on December 8, 2024
  • appointment.startTimestamp|lt|2024-12-31 - appointments before December 31, 2024

You can combine the date filter with other filters using commas:

  • appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING
get/appointments/v1/visits

Request

  • Base URL: https://api.taigabilling.com
  • URL: https://api.taigabilling.com/appointments/v1/visits
  • Auth: HTTP bearer

Query parameters

page_tokenstring

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

limitinteger nullable
sort_fieldstring

The field to order by. Valid values are either keys on the list item object or a special ordering "similar_name:<search_string>" (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match patient name to the search criteria. Path names are camelCase.

Defaults to appointment.start_time.

sort_direction'asc' | 'desc'

Defaults to ascending.

filtersstring

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.

Required: Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators). Example: appointment.startTimestamp|gt|2024-01-01

Response

next_page_tokenstring

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

prev_page_tokenstring

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

totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.