Calendars on doctor profiles are closely linked to addresses. Each premium (paid) address can have a calendar activated. These calendars aggregate slots, allowing patients to book visits with a selected professional.

Feeding calendars

The first step after activating an integration for a given professional should be feeding a full set of availabilities (slots) and bookings. This ensures the calendar in Docplanner reflects the partner system’s state 1:1.

The activation process should be run under isolated conditions. We recommend contacting local specialists who support initial activations for clinics.

Updating calendars

To maintain the most up-to-date configuration, we strongly encourage updating the doctors' calendars based on events in the partner system. Every change in availability should be immediately reflected via an API call.

Currently, the API supports 3 operations to modify the set of available slots:

• Bookings – For a booking, cancellation, or reschedule, use the corresponding method in the API.
• Breaks – For adding non-specific events or breaks during the day, use the calendar break method to block availability.
• Availability modification – For schedule changes, trigger the updateSlots operation to update the current availability configuration.

See the detailed description of these actions and related objects in the Resources section.

Validating schedule coverage

A recommended practice to ensure proper setup for each doctor is to regularly (daily or hourly) cross-check available slots using the getSlots endpoint. To perform this, call the following endpoint:

https://www.{domain}/api/v3/integration/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/slots

In response, the API will return the list of all currently added slots

{
  "_items": [
    {
      "start": "2020-12-16T14:00:00+01:00"
    },
    {
      "start": "2020-12-16T14:30:00+01:00"
    }
  ]
}

To get the complete picture, you should also perform
getBookings and
getCalendarBreaks operations to retrieve all items affecting the schedule.

The combination of these results provides the list of all currently available slots in the marketplace.
This list should be compared against the actual availability in the partner system.
If any inconsistencies are found, the Docplanner configuration should be updated accordingly.