Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Clinical

List all instances (materialized and virtual) within a recurring appointment series.

Returns the same appointment response format as /api/appointments. Materialized instances have a real id; virtual instances have id: null. The recurrence_instance_key field is included when the consistent_recurrence_id feature flag is enabled.

get/api/recurring_appointment_instances

Query parameters

base_recurring_appointmentinteger required

ID of the base recurring appointment.

start_datestring date

Start of date range (YYYY-MM-DD). Defaults to the first appointment in the series.

end_datestring date

End of date range (YYYY-MM-DD). Defaults to 1 year from start_date.

fieldsstring

Comma-separated list of fields to include in the response.

verboseboolean

Include expensive fields (reminders, vitals, clinical_note, custom_fields, custom_vitals, status_transitions).

Response

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.

icd9_codesstring[]
officeinteger required

Office ID

base_recurring_appointmentstring

ID of base appointment of a recurring series

colorstring
first_billed_datestring
last_billed_datestring
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.

appt_is_breakboolean
idstring

Unique identifier. Usually numeric, but not always

scheduled_timestring required

The starting time of the appointment

secondary_insurer_namestring
doctorinteger required

Doctor ID

recur_start_datestring

For recurring appointments, the start date of the recurring series

primary_insurance_id_numberstring
created_bystring
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

first_edi_datestring
is_walk_inboolean

Whether the appointment is a walk-in appointment

billing_providerstring
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

ID of this claim id.

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

updated_atstring
reasonstring

Default to ""

last_edi_datestring
secondary_insurer_payer_idstring
allow_overlappingboolean

Bypass overlap check.

payment_profilestring

Appointment Payment Profile

secondary_insurance_id_numberstring
is_virtual_baseboolean
recurring_appointmentboolean

Whether the appointment is a recurring appointment or not

supervising_providerstring

Supervising provider of appointment if set.

created_atstring
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

custom_statusstring

AppointmentStatus Name

recur_end_datestring

For recurring appointments, the end date of the recurring series

icd10_codesstring[]
deleted_flagboolean

Whether the appointment is deleted.

notesstring
recurs_everyinteger

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