Sign in

v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Appointments

Create appointment

This endpoint books an appointment for the given patient with the given provider at the specified location. When is_guardian is true, the booking is made by a guardian and a patient object with the dependent's details must be provided. Set unavailable to true to create a block instead of a patient appointment.

post/appointments

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

notify_patientboolean

Send NexHealth appointment created notifications to patient

Headers

Nex-Api-Versionstring required

The NexHealth API version

Request body

appointments_per_timeslotinteger

Number of appointments (default:1, max:5) that can be booked in a single slot. Only supported for eClinicalWorks and NextGen.

Example request

{
  "appt": {
    "patient_id": 2897,
    "provider_id": 104,
    "operatory_id": 181,
    "start_time": "2024-04-15T15:00:00Z",
    "end_time": "2024-04-15T15:30:00Z",
    "appointment_type_id": 27,
    "note": "Patient has been having a cough for 3 days",
    "referrer": "http://mypractice.com/book",
    "patient": {
      "first_name": "John",
      "last_name": "Smith",
      "bio": {
        "date_of_birth": "2015-05-03",
        "gender": "Female"
      }
    },
    "descriptor_ids": [
      12,
      13
    ]
  }
}

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": {
    "appt": {
      "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"
    }
  },
  "count": 2
}