One of ``, Arrived, Checked In, In Room, Cancelled, Complete, Confirmed, In Session, No Show, Not Confirmed, or Rescheduled. Or one of the custom statuses.

Office ID

ID of base appointment of a recurring series

Should be one of Auto Accident Claim, Balance Due, Bill Insurance, Bill Secondary Insurance, Durable Medical Equipment Claim, Internal Review, Paid In Full, Settled, Worker's Comp Claim or one of the custom billing status

Length of the appointment in minutes. Optional if profile is provided.

Unique identifier. Usually numeric, but not always

The starting time of the appointment

Doctor ID

For recurring appointments, the start date of the recurring series

Billing status of secondary insurer

Whether the appointment is a walk-in appointment

Write-only. ID of an /api/reminder_profiles instance. Set this to apply a reminder profile to the appointment. Cannot be applied to an appointment with reminders.

ID of an /api/appointment_profiles instance. The profile sets default values for color, duration, and reason on creation, which can be overriden by setting these values explicitly.

ID of this claim id.

ID of this appointment's patient. Breaks have a null patient field.

A stable identifier for a recurring appointment instance, in the format {rootSeriesId}_{YYYYMMDD} where YYYYMMDD is the original occurrence date, not the current scheduled date. This value remains consistent across materialization, series splits, and rescheduling, so it should be treated as an opaque identifier rather than a source for display dates. Returns null for non-recurring appointments. Only present when the consistent_recurrence_id feature flag is enabled.

ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned.

The most recent update time among appointment itself, its vitals and its custom vitals

Index of the exam room that this appointment occurs in. See /api/offices

Default to ""

Bypass overlap check.

Appointment Payment Profile

Whether the appointment is a recurring appointment or not

Supervising provider of appointment if set.

Billing status of primary insurer

AppointmentStatus Name

For recurring appointments, the end date of the recurring series

Whether the appointment is deleted.

For recurring appointments, the number of weeks between recurrences. For example, if this is 2, the appointment recurs every other week.