Appointment Slot

The Appointment slot APIs allows users to view and manage the appointment slots. These practice facing admin APIs allows you to perform the following actions:

  1. Create a new Appointment slot (for patients to book their appointments against)
  2. Freeze an existing Appointment slot (to ensure patients cannot book this slot)
  3. View all Appointment slots (using filters such as booked, un-booked)
  4. View all Appointment slots across all departments and providers
  5. Delete an existing Appointment slot (to ensure patients do not book against this slot)
  6. Cancel an existing patient Appointment in an Appointment Slot.

Two flags allow you to bypass the permissions set up around Web scheduling:

  • ignoreschedulablepermission
  • bypassscheduletimechecks

The open appointment slots functionality, designed for a patient scheduling an appointment online, looks, by default, for appointment reasons and obeys the practice's configuration around those reasons. (This configuration is generally done as part of the athenaCommunicator setup.) In cases where scheduling is done for other reasons (e.g., telemedicine, walk-in appointments via Digital Check-in, or other use cases), you may want to book by appointment type and to ignore the setup that was done controlling what appointments can be booked.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Get list of booked appointment slots
GET
/v1/{practiceid}/appointments/booked

Retrieves a list of booked appointments Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

Output Parameters

Expand all
Example Code
departments/providers
GET
/v1/{practiceid}/appointments/booked/multipledepartment

Retrieves a list of booked appointments across multiple providers and departments Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

Output Parameters

Expand all
Example Code
Freeze appointment slot
PUT
/v1/{practiceid}/appointments/{appointmentid}/freeze

Freezes an appointment slot so that patients can no longer schedule an appointment in that slot. Once frozen, the time slot will not be listed for booking an appointment.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all
Example Code
Get list of open appointment slots
GET
/v1/{practiceid}/appointments/open

Retrieves access to open appointment slots

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

Output Parameters

Expand all
Example Code
departments/providers
GET
/v1/{practiceid}/appointments/booked/multipledepartment

Retrieves a list of booked appointments across multiple providers and departments Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

Output Parameters

Expand all
Example Code
Delete open appointment slot
DELETE
/v1/{practiceid}/appointments/{appointmentid}

Deletes an open appointment slot, which will no longer allow appointments to be scheduled in that timeslot.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all
Example Code