Skip to main content

In the EHR

Staff book appointments on the Calendar, choosing the patient, provider, appointment type, and location, then move each appointment through statuses such as Checked In and In Room as the visit progresses. See the Calendar Guide.

Working with appointments via the API

telehealth_details is deprecated. It returns the value of instructions on VIDEO appointments and null on all others, and a request that sends both fields with different values is rejected. Remove telehealth_details before sending a retrieved appointment back in a PUT.
A reason that matches no appointment type creates one. When no active appointment type in the practice has the name given in reason, a new appointment type with that name is added to the practice. An update that omits appointment_type_id matches the appointment’s type again by name, so an appointment whose type has since been deleted gains a new type of the same name on its next update. Send appointment_type_id to keep an appointment on a specific type. The appointment type sets mode and instructions when mode is omitted. Assigning a type marked is_telehealth sets mode to VIDEO and fills instructions with the provider’s custom virtual visit instructions, and assigning any other type sets mode to IN_PERSON and clears instructions. Setting mode to VIDEO without instructions also fills in the provider’s default. Send mode and instructions together when the appointment needs specific values. Updating billing_details leaves an existing bill unchanged. The billing note, referring provider, and prior authorization are saved on the appointment only, and a bill already created for the visit keeps its earlier values. When the bill needs to match, update its notes, prior_authorization, and referring_provider as well. See The Bill Object. Deleted appointments are no longer returned. DELETE archives the appointment, after which it is left out of list results and returns 404 when retrieved by id, so deleted_date is null on every appointment that list and retrieve return. To learn about deletions, subscribe to appointment events, which report them with the deleted action. See Webhooks.

Field notes