PreEncounterListsV1

Searches for appointments that match the query parameters.

get/lists/v1/appointment

Request

  • Base URL: https://api.taigabilling.com
  • URL: https://api.taigabilling.com/lists/v1/appointment
  • Auth: HTTP bearer

Query parameters

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.startTimestamp.

sort_direction'asc' | 'desc'

Defaults to asc.

limitinteger nullable

Defaults to 100.

page_tokenstring

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

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.

include_deactivatedboolean nullable

If true, includes deactivated appointments in the results. Defaults to false.

include_merged_patient_databoolean nullable

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

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.