JOjoincandidhealth
v1

Get Appointment List

Changed on

Searches for appointments that match the query parameters.

get/lists/v1/appointment

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.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

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', '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.

include_deactivatedboolean

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

include_merged_patient_databoolean

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

Response with status 200

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

  • d8b0a61873e2Revision changes
    • warning

      added the new ABA enum value to the ////// response property for the response status

    • warning

      added the new ABA enum value to the ////// response property for the response status

    • warning

      added the new CES enum value to the ////// response property for the response status

    • warning

      added the new CES enum value to the ////// response property for the response status

    • warning

      added the new EEG enum value to the ////// response property for the response status

    • warning

      added the new EEG enum value to the ////// response property for the response status

    • warning

      added the new FWC enum value to the ////// response property for the response status

    • warning

      added the new FWC enum value to the ////// response property for the response status

    • warning

      added the new OT enum value to the ////// response property for the response status

    • warning

      added the new OT enum value to the ////// response property for the response status

    • warning

      added the new PT enum value to the ////// response property for the response status

    • warning

      added the new PT enum value to the ////// response property for the response status

    • warning

      added the new SLP enum value to the ////// response property for the response status

    • warning

      added the new SLP enum value to the ////// response property for the response status

    • 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 optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 4074901c170fRevision changes
    • info

      added the optional property /// to the response with the status