status'' | 'Arrived' | 'Checked In' | 'Checked In Online' | 'In Room' | 'In Session' | 'Complete' | 'Confirmed' | 'Not Confirmed' | 'Rescheduled' | 'Cancelled' | 'No Show'
One of ``, Arrived, Checked In, In Room, Cancelled, Complete, Confirmed, In Session, No Show, Not Confirmed, or Rescheduled. Or one of the custom statuses.
base_recurring_appointmentstring
ID of base appointment of a recurring series
billing_statusstring
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
primary_insurer_payer_idstring
durationinteger
Length of the appointment in minutes. Optional if profile is provided.
is_membership_appointmentboolean
Whether the appointment is a membership plan charge rather than a real visit. DrChrono creates one future dated placeholder appointment per billing cycle of a patient's membership plan so the charge has something to attach to. They are hidden from the DrChrono calendar and never trigger DrChrono reminders, so appointment reminder integrations should skip them, or pass exclude_membership=true to leave them out of the response.
idstring
Unique identifier. Usually numeric, but not always
scheduled_timestring required
The starting time of the appointment
secondary_insurer_namestring
recur_start_datestring
For recurring appointments, the start date of the recurring series
primary_insurance_id_numberstring
ins2_status'' | 'Incomplete Information' | 'In Process Emdeon' | 'Rejected Emdeon' | 'Rejected EPS' | 'Rejected Jopari' | 'In Process Payor' | 'Rejected Waystar Professional' | 'Rejected Waystar Institutional' | 'In Process Payer' | 'Payer Acknowledged' | 'Rejected Payor' | 'Rejected Payer' | 'Paid in Full' | 'Partially Paid' | 'Coordination of Benefits' | 'ERA Received' | 'ERA Denied' | 'HCFA Form Faxed'
Billing status of secondary insurer
is_walk_inboolean
Whether the appointment is a walk-in appointment
reminder_profilestring
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.
primary_insurer_namestring
profileinteger
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.
resubmit_claim_original_idinteger
patientinteger required
ID of this appointment's patient. Breaks have a null patient field.
recurrence_instance_keystring nullable
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.
cloned_frominteger
ID of the original appointment which this appointment cloned from. Will be null if the appointment is not cloned.
extended_updated_atstring
The most recent update time among appointment itself, its vitals and its custom vitals
exam_roominteger required
Index of the exam room that this appointment occurs in. See /api/offices
secondary_insurer_payer_idstring
payment_profilestring
Appointment Payment Profile
secondary_insurance_id_numberstring
recurring_appointmentboolean
Whether the appointment is a recurring appointment or not
supervising_providerstring
Supervising provider of appointment if set.
ins1_status'' | 'Incomplete Information' | 'In Process Emdeon' | 'Rejected Emdeon' | 'Rejected EPS' | 'Rejected Jopari' | 'In Process Payor' | 'Rejected Waystar Professional' | 'Rejected Waystar Institutional' | 'In Process Payer' | 'Payer Acknowledged' | 'Rejected Payor' | 'Rejected Payer' | 'Paid in Full' | 'Partially Paid' | 'Coordination of Benefits' | 'ERA Received' | 'ERA Denied' | 'HCFA Form Faxed'
Billing status of primary insurer
recur_end_datestring
For recurring appointments, the end date of the recurring series
deleted_flagboolean
Whether the appointment is deleted.
recurs_everyinteger
For recurring appointments, the number of weeks between recurrences. For example, if this is 2, the appointment recurs every other week.