Skip to main content

In the EHR

Appointment types are managed in a practice’s Calendar & Booking settings. Each type sets a default duration, a color, and the visit note templates and patient forms that come with it, and staff choose a type when they book an appointment on the Calendar. See How to set up the provider calendar.

Working with appointment types via the API

Deleting an appointment type archives it. DELETE marks the type archived rather than removing it. The type stays retrievable by its id and continues to appear in list results with deleted_date set, and appointments already booked with it keep it, but it can no longer be assigned with appointment_type_id. Check deleted_date when you need only the types a practice currently offers. patient_form_hours_prior is saved only alongside patient_forms. A request that sets patient_form_hours_prior without patient_forms leaves the stored value unchanged. Include both fields whenever you change when patient forms are sent.

Field notes

  • is_telehealth marks the type as a virtual visit rather than an in-person one.
  • patient_bookable controls whether patients can choose the type on the practice’s Booking Site.
  • visit_note_templates are the templates of the visit note created automatically for appointments of this type.