NEnexhealth
Appointments

View appointments (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query params confirmed, include[]; adds response fields data[].descriptors, data[].descriptors[].active, data[].descriptors[].code, data[].descriptors[].created_at (+8 more); and other schema changes.

This endpoint returns appointments starting within the requested time window, narrowed down by the optional filters configured.

get/appointments

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/appointments
  • Auth
    API key in header Authorization

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

IANA time zone name, such as America/New_York. Validated only: start and end are absolute instants, so it does not change which appointments are returned

cancelledboolean

Filter by cancelled status.

unavailableboolean

true returns only scheduling blocks (unavailable appointments that block time on the schedule), false only real appointments

nex_onlyboolean

true returns only appointments booked through NexHealth

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.

confirmedboolean

Is appointment confirmed

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

include[]string[]

Resources to be included in the response

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,
      "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
      },
      "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",
      "is_past_patient": true,
      "timezone_offset": "-4:00",
      "descriptors": [
        {
          "id": 1822,
          "descriptor_type": "Procedure Code",
          "name": "EHR Descriptor Name",
          "code": "EHR Descriptor Code",
          "location_id": 13,
          "foreign_id": "94",
          "foreign_id_type": "msg-dentrix-DataSource-100",
          "data": {},
          "active": true,
          "created_at": "2021-05-21T16:23:03.046Z",
          "updated_at": "2021-05-21T16:23:03.046Z"
        }
      ]
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

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