NEnexhealth
Appointments

View appointment (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: Changes query param include[]; adds response fields data.patient.address, data.patient.address.city, data.patient.address.line_1, data.patient.address.line_2 (+34 more); and other schema changes.

This endpoint returns a single appointment by its NexHealth ID, with optional sideloading of patient, guarantor, descriptors, procedures, operatory, and appointment_type.

get/appointments/{id}

Request

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

Path parameters

idinteger required

ID of the appointment

Query parameters

subdomainstring required

Used to scope the request to the specified institution

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.

countinteger

Number of total objects, in case of collection.

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"
      }
    ],
    "patient": {
      "id": 415,
      "email": "anthony.smith@nexhealth.com",
      "first_name": "John",
      "middle_name": "Anthony",
      "last_name": "Smith",
      "name": "John Smith",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "institution_id": 1,
      "foreign_id": "532e7f8c",
      "foreign_id_type": "--DataSource-",
      "cell_phone_number": "5163042196",
      "preferred_phone_number": "5163042196",
      "billing_type": "Standard Billing - finance charges",
      "chart_id": "017407",
      "preferred_language": "es",
      "gender": "Female",
      "non_patient": true,
      "date_of_birth": "1964-05-03",
      "address": {
        "line_1": "333 Bush Street",
        "line_2": "Apt 4B",
        "postal_code": "20814",
        "city": "New York",
        "region": "NY"
      },
      "guarantor": {
        "id": 415,
        "email": "anthony.smith@nexhealth.com",
        "first_name": "John",
        "middle_name": "Anthony",
        "last_name": "Smith",
        "name": "John Smith",
        "created_at": "2020-06-05T20:16:57.007Z",
        "updated_at": "2020-06-05T20:16:57.007Z",
        "institution_id": 1,
        "foreign_id": "532e7f8c",
        "foreign_id_type": "--DataSource-",
        "cell_phone_number": "5163042196",
        "preferred_phone_number": "5163042196",
        "billing_type": "Standard Billing - finance charges",
        "chart_id": "017407",
        "preferred_language": "es",
        "gender": "Female",
        "non_patient": true,
        "date_of_birth": "1964-05-03",
        "address": {
          "line_1": "333 Bush Street",
          "line_2": "Apt 4B",
          "postal_code": "20814",
          "city": "New York",
          "region": "NY"
        }
      }
    },
    "operatory": {
      "id": 1,
      "name": "op1",
      "foreign_id": "1",
      "foreign_id_type": "--DataSource-",
      "location_id": 4,
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "display_name": "op1",
      "active": true,
      "bookable_online": true
    },
    "appointment_type": {
      "id": 1,
      "name": "Medical",
      "parent_type": "Institution",
      "parent_id": 1,
      "minutes": 15
    },
    "procedures": [
      {
        "id": 11,
        "location_id": 21,
        "patient_id": 162,
        "provider_id": 84,
        "appointment_id": 283,
        "code": "D6100",
        "name": "Implant Removal",
        "status": "completed",
        "updated_at": "2020-06-05T20:16:57.007Z",
        "body_site": {
          "tooth": [
            "3",
            "14"
          ],
          "surface": "MOD"
        },
        "fee": {
          "amount": "62.00",
          "currency": "USD"
        },
        "start_date": "2022-06-24",
        "end_date": "2022-06-24"
      }
    ]
  },
  "count": 2
}

Changes

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