JOjoincandidhealth
v1

Get Counts

Changed on

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://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.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', 'notIn'. 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'). notIn excludes values that match any item in a semicolon-separated list (e.g., 'appointment.locationResourceId|notIn|foo;bar'); rows with no value for that field are still returned. 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

Response with status 200

not_ready_reason_countsobject

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      for the query request parameter filters, the type was generalized from no type to string

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property / to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id get_counts removed and replaced with v1_get_counts