PreEncounterAppointmentsV1

Gets aggregate counts for the visits matching the given filters.

The counts respect all provided filters but are independent of pagination, so this can be fetched once when filters change instead of on every page of get_visits.

IMPORTANT: Like get_visits, this endpoint requires a date filter on appointment.startTimestamp to ensure acceptable query performance.

get/appointments/v1/visits/counts

Request

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

Query parameters

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

not_ready_reason_countsobject nullable

Changes

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