NEnexhealth
Available Slots

View available slots (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 location_id[], only_active_providers, operatory_id[], provider_id[] (+1 more); removes query params lids[], operatory_ids[], pids[]; changes query param slot_interval; and other schema changes.

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 provider_id or appointment_type_id must be provided.

get/available_slots

Request

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

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.

schedule_template_idinteger

Only consider working hours that belong to this schedule template

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

only_active_providersboolean

Only return availabilities for active providers, omitting slots for providers marked as inactive. Default is false

appointments_per_timeslotinteger

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

location_id[]integer[]

NexHealth IDs of the locations

provider_id[]integer[]

NexHealth IDs of the providers

operatory_id[]integer[]

NexHealth IDs of the operatories. 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,
          "working_hour_id": 1234,
          "schedule_template_id": 7,
          "appointment_type_id": 27
        }
      ],
      "next_available_date": "2022-11-17"
    }
  ],
  "count": 2
}

Changes

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