Sign in

v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Available Slots

View available slots

This endpoint returns the bookable slots for the requested locations over the given date range, computed from provider availabilities and existing appointments. At least one of pids or appointment_type_id must be provided.

get/available_slots

Query parameters

subdomainstring required

Used to scope the request to the specified institution

start_datestring date required

Date string you want results to start at, format YYYY-MM-DD

daysinteger required

Number of days to include, counting the start date. For best performance, this value should not exceed 14 days.

appointment_type_idinteger

Specify an appointment type to filter returned slots and set slot_length to appointment_type.minutes

working_hour_label_idinteger

Filter by specific working hour label

working_hour_source'manual' | 'synced'

Filter by source of working hours

slot_lengthinteger

Manually specify slot length in minutes. Defaults to 15 minutes

slot_intervalinteger

Manually specify the time in minutes between returned slot start times when a contiguous opening exists longer than the slot_length

overlapping_operatory_slotsboolean

Return all available slots for operatories at a given time instead of returning only the first found. Default is false

appointments_per_timeslotinteger

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

lids[]integer[] required

Array of Location Ids

pids[]integer[]

Array of Provider Ids

operatory_ids[]integer[]

Specify this if booking is mapped to operatory in this location

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": [
    {
      "lid": 1,
      "pid": 83,
      "operatory_id": 54,
      "slots": [
        {
          "time": "2017-10-09T07:00:00.000-04:00",
          "end_time": "2017-10-09T07:30:00.000-04:00",
          "operatory_id": 54,
          "provider_id": 83,
          "working_hour_label_id": 11
        }
      ],
      "next_available_date": "2022-11-17"
    }
  ],
  "count": 2
}