API Reference

Operatories

An operatory represents a chair, column, or room in a practice where providers service patients.

While the majority of practices make use of the concept of Operatories, not all of them do. To check this, you need to view the location's attributes via GET /locations/:id and see the map_by_operatory attribute. If set to true, then working with that location requires that an operatory_id is specified when booking an appointment.

📘

Double Booking

In the Nexhealth API, operatories are treated as the limiting resource when it comes to calculating availability. Providers can be booked in more than one operatory at the same time, but operatories cannot have more than one appointment booked in them at the same time.

Operatories Response

{
  "code": false,
  "description": [
    [
      "Description"
    ]
  ],
  "error": [
    [
      "Error"
    ]
  ],
  "data": {
    "id": 1,
    "name": "op1",
    "foreign_id": "1",
    "foreign_id_type": "--DataSource-",
    "location_id": 4,
    "last_sync_time": "2020-06-17T19:23:49.176Z",
    "created_at": "2020-06-05T20:16:57.007Z",
    "updated_at": "2020-06-05T20:16:57.007Z",
    "display_name": "op1",
    "active": true,
    "static_image_url": "string",
    "profile_url": "https://storage.googleapis.com/nexassets/app/img/icon/avatar.svg",
    "appointment_types": [
      {
        "id": 1,
        "name": "medical",
        "category": "medical",
        "parent_type": "Institution",
        "parent_id": 1,
        "minutes": 15,
        "position": 30,
        "bookable_online": false
      }
    ]
  },
  "count": 2
}