v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Appointments

View appointments

This endpoint returns the appointments starting within the requested time window, narrowed down by the optional filters configured. At least one of location_id or foreign_id must be provided.

get/appointments

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger

Used to scope the request to the specified location

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

updated_at
-updated_at

startstring date-time required

A parseable date string defining the earliest returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000

endstring date-time required

A parseable date string defining the last returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000

timezonestring

Timezone for the appointment clinic

cancelledboolean

Filter by cancelled status.

unavailableboolean

Unavailable appointments are used to block availability on a schedule, specify to set the filter

nex_onlyboolean

Only show appointments booked via NexHealth API

updated_sincestring date-time

Query appointments whose records have updated since the specified datetime in ISO8601 format. Must be a parseable date/time, recommended formats are YYYY-MM-DD or YYYY-MM-DDT00:00:00+0000

appointment_type_idinteger

Get appointments for a specific appointment type

foreign_idstring

Unique appointment id from the EHR

created_byinteger

Query appointments that were created by a specific user

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

patient_ids[]integer[]

Get appointments for specific patients (up to 25 ids)

provider_ids[]integer[]

Query appointments that are booked with the specified providers only

operatory_ids[]integer[]

Query appointments that are booked in the specified operatories only

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 1822,
      "patient_id": 2897,
      "provider_id": 104,
      "provider_name": "Dr. John Smith",
      "start_time": "2020-06-05T20:16:57.007Z",
      "confirmed": true,
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "note": "Patient has been having a cough for 3 days",
      "end_time": "2020-06-05T20:16:57.007Z",
      "timezone": "America/New_York",
      "institution_id": 1,
      "appointment_type_id": 27,
      "checkin_at": "2020-06-05T20:16:57.007Z",
      "location_id": 1,
      "foreign_id": "94",
      "foreign_id_type": "msg-dentrix-DataSource-100",
      "misc": {
        "is_booked_on_nexhealth": true
      },
      "last_sync_time": "2020-06-05T20:16:57.007Z",
      "created_by_user_id": 197,
      "patient_confirmed_at": "2020-06-05T20:16:57.007Z",
      "cancelled_at": "2020-06-05T20:16:57.007Z",
      "confirmed_at": "2020-06-05T20:16:57.007Z",
      "operatory_id": 181,
      "checked_out_at": "2020-06-05T20:16:57.007Z",
      "referrer": "http://mypractice.com/book",
      "is_past_patient": true,
      "timezone_offset": "-4:00"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}