Skip to content

Appointment

An appointment object containing information about the appointment, including the attendees, date, location, and more.

Fields

actual_duration · String · The actual length of the appointment (in minutes). Filled in by the provider after the appointment
add_to_gcal_link · String · Get link to add appointment to google calendar
appointment_category · String · Category of the appointment: expected values are "Individual" and "Group"
appointment_inclusions_count · Int · The number of people (both providers and attendees) who are in the appointment
appointment_label · String · A label for the appointment
appointment_location_id · String · the ID of the appointment location
appointment_request_id · ID · The ID of the appointment request this appointment fulfills
appointment_type · AppointmentType · The type of the appointment
appointment_type_id · Int · The ID of the type of appointment this is
assigned_groups · [UserGroup!] · List of assigned user groups to the group appointment
attended_clients · [AppointmentInclusionType!] · Client inclusions which includes all attendees even if they didnt show up for the appointment
attendees · [User!]! · required · All attendees for the appointment.
attendees_on_waitlist · [User!] · Pending Appointment inclusions
backgroundColor · String · The backgroundColor color of the appointment
can_be_rescheduled · Boolean · Returns true if the patient can reschedule the appointment
can_client_cancel · Boolean · True if client able to cancel an appointment
can_client_reschedule · Boolean · True if client able to reschedule an appointment
cancellation_reason · CancellationReason · The cancellation reason for this appointment
client_confirmed · Boolean · false if the client needs to confirm the appointment, and has not
client_updating · Boolean · Whether the appointment updating on client side or not
confirmed · Boolean · The status of whether the provider has confirmed the appointment or not
connected_chart_note_locked · Boolean · True if appointment is locked
connected_chart_note_string · String · The status of the connected chart note
contact_type · String · How the provider and attendees will connect (i.e In-Person or through the phone)
conversation_id · ID · The ID of conversation related to the current appointment(only for group appts 10/2020)
created_at · String! · required · The date and time that the appointment was created
credit_was_used · Boolean · True if a credit was used for this appointment
current_position_in_recurring_series · Int · The position of the appointment in the recurring series
cursor · Cursor! · required · Pagination cursor
date · String · The date and time of the appointment
default_color · String · default color of appointment based on confirmation/type
deleted_at · String · The time the appointment was deleted. It is blank if the appointment is not deleted.
effective_pricing_method · AppointmentPricingMethod · The effective pricing method for this appointment (calculated or stored)
end · String · The end time of the appointment
external_id_type · String · The type of connection to an external calendar
external_videochat_url · String · A URL to an external video chat site for the session
filled_embed_form · FormAnswerGroup · The custom answers filled out by the booker of the appointment
form_answer_group · FormAnswerGroup · The Form answer group first associated with the appointment
form_answer_groups · [FormAnswerGroup!] · All Form answer groups associated with the appointment
generated_form_answer_group · GeneratedFormAnswerGroupType · The AI Scribe generated form answer group associated with the appointment
generated_summary · GeneratedSummary · The latest AI-generated encounter summary for the appointment
generated_token · String · open tok token
has_expanded_vbc_charting_fields · Boolean · When true, additional group charting fields are visible in the Healthie UI
has_in_progress_job · Boolean · Returns true if the appointment has in progress job
id · ID! · required · The unique identifier of the appointment
initiator_id · ID · ID of user that created of appointment
insurance_billing_enabled · Boolean · When true, insurance billing will be enabled for this appointment
is_blocker · Boolean · The status of whether this appointment is specifically meant to block availability
is_group · Boolean · Indicates whether it's a group appointment
is_zoom_chat · Boolean · The status of whether the video chat uses Zoom or Healthie Default telehealth
last_client_conversation_id · ID · id of last conversation between provider and client in appointment
last_updated_by_id · ID · The ID of the provider who last updated the appointment record, if available
late_cancellation_fee · Int · The Late Cancellation Fee (in cents) for this appointment
length · Int · The length of the appointment (in minutes)
location · String · The plaintext location of the appointment (only used for in-person appointments)
locationResource · String · Location Resource
max_attendees · String · How many attendees can register for an appointment (only used for Group Appointments)
metadata · JSON · a serialized JSON string of metadata
minimum_advance_cancel_time · Int · Minimum time before the appointment when client can still cancel it
minimum_advance_reschedule_time · Int · Minimum time (in minutes) before the appointment when client can still reschedule it
no_show_fee · Int · The No Show Fee (in cents) for this appointment
notes · String · Quick notes on the appointment (only visible to providers)
organization_id · ID · The ID of the organization the appointment belongs to
other_cancellation_reason · String · Free text reason when "Other" cancellation reason is selected
other_party_id · Int · The id of the provider
patient_reschedule_count · Int · The number of times a patient rescheduled an appointment
pm_status · String · The status of the appointment. Can be one of "Occurred", "No-Show", "Re-Scheduled", "Cancelled." If enabled, "Late Cancellation" and "Checked-In" are also valid.
pm_status_changed_at · String · The date and time the status of the appointment was last updated
pm_status_last_changed_by_id · ID · The ID of the user who last changed the status of the appointment, if available
pricing_info · AppointmentPricingInfoType · Get the pricing info for this appointment
provider · User · The provider for the appointment
provider_name · String · Provider name
providers · [User!]! · required · All providers for the appointment.
reason · String · The clients reason for scheduling the appointment
recurring_appointment · RecurringAppointment · The related recurring appointment series
recurring_appointment_id · String · The ID of the recurring appointment
deprecated Use recurring_appointment instead
repeat · Boolean · The status of whether this is a repeating appointment or not
deprecated Use recurring_appointment instead
repeat_interval · String · How often to repeat the appointment (e.g Daily or Monthly)
deprecated Use recurring_appointment instead
repeat_times · Int · How many times does the appointment repeat
deprecated Use recurring_appointment instead
requested_payment · RequestedPayment · A requested payment for this appointment
resourceId · String · The ID of the user, used for the calendar
room_id · ID · the ID of the room
scheduled_by · String · A string containing info on how the appointment was scheduled
session_id · String · The OpenTok session ID for the appointment
should_create_cms1500_for_occurred_appointments · Boolean · When true, a cms1500 should be created when the appointment status is set to occurred
start · String · The start time of the appointment
textColor · String · The font color of the appointment
time_recurring_override · Boolean · The status of whether the time of this appointment has been separated from the other recurring appointments in the series
timezone_abbr · String · Timezone abbreviation of the date of the appointment
title · String · The title of the appointment
transcripts · [Transcript!] · Can only be returned via querying a single appointment, not a collection. Transcripts for the appointment (in VTT format)
unauthenticated_ics_link · String · Unauthenticated link to download an ICS file for the appointment
updated_at · String · The last date and time that the appointment was updated
use_embedded_zoom · Boolean · Whether the appointment should use embedded Zoom in browser
use_zoom · Boolean · Whether the appointment is through Zoom or not
user · User · The client in a 1:1 appointment
user_id · Int · The id of the client (if a 1:1 appointment). If a group appointment, will be nil
will_be_scribed · Boolean! · required · True if this appointment is configured to be summarized by AI Scribe
zoom_appointment · ZoomAppointment · Zoom meeting info for the session that started between 1 hour before the appointment and 1 hour after its scheduled end, choosing the one with the most participants. Appointment should have a valid zoom link and the user should have the permission to access the meeting. Returns null otherwise, when no session started in that window, or when Zoom can't be reached
zoom_cloud_recording_files · [ZoomCloudRecordingFile!] · Detailed information about Zoom cloud recording files for this appointment
zoom_cloud_recording_urls · [String] · URLs for Zoom cloud recordings for this appointment
zoom_co_host_links · [ZoomCoHostLink!] · ZAK tokens for the org member co-hosts of this Zoom group appointment
zoom_dial_in_info · String · The dial-in info provided by zoom if appoint has zoom links.(separated by newline characters)
zoom_dial_in_info_html · String · The dial-in info provided by zoom if appoint has zoom links.(separated by break tags)
zoom_dial_in_numbers_json · [String] · An array of JSON objects containing the different dial in numbers for the Zoom call
zoom_join_url · String · The join link for other attendees of the Zoom call
zoom_meeting_id · String · The Meeting ID for the Zoom call
zoom_start_url · String · The host link to start the Zoom call

Used By

Definition

"""
An appointment object containing information about the appointment, including the attendees, date, location, and more.
"""
type Appointment {
"""
The actual length of the appointment (in minutes). Filled in by the provider after the appointment
"""
actual_duration: String
"""
Get link to add appointment to google calendar
"""
add_to_gcal_link: String
"""
Category of the appointment: expected values are "Individual" and "Group"
"""
appointment_category: String
"""
The number of people (both providers and attendees) who are in the appointment
"""
appointment_inclusions_count: Int
"""
A label for the appointment
"""
appointment_label: String
"""
the ID of the appointment location
"""
appointment_location_id: String
"""
The ID of the appointment request this appointment fulfills
"""
appointment_request_id: ID
"""
The type of the appointment
"""
appointment_type: AppointmentType
"""
The ID of the type of appointment this is
"""
appointment_type_id: Int
"""
List of assigned user groups to the group appointment
"""
assigned_groups: [UserGroup!]
"""
Client inclusions which includes all attendees even if they didnt show up for the appointment
"""
attended_clients: [AppointmentInclusionType!]
"""
All attendees for the appointment.
"""
attendees: [User!]!
"""
Pending Appointment inclusions
"""
attendees_on_waitlist: [User!]
"""
The backgroundColor color of the appointment
"""
backgroundColor(
"""
The time the appointment setting was last updated
"""
appointment_setting_updated_at: String
): String
"""
Returns true if the patient can reschedule the appointment
"""
can_be_rescheduled: Boolean
"""
True if client able to cancel an appointment
"""
can_client_cancel: Boolean
"""
True if client able to reschedule an appointment
"""
can_client_reschedule: Boolean
"""
The cancellation reason for this appointment
"""
cancellation_reason: CancellationReason
"""
false if the client needs to confirm the appointment, and has not
"""
client_confirmed(
"""
Whether or not the appointment requires client confirmation
"""
known_requires_client_confirmed: Boolean
): Boolean
"""
Whether the appointment updating on client side or not
"""
client_updating: Boolean
"""
The status of whether the provider has confirmed the appointment or not
"""
confirmed: Boolean
"""
True if appointment is locked
"""
connected_chart_note_locked: Boolean
"""
The status of the connected chart note
"""
connected_chart_note_string: String
"""
How the provider and attendees will connect (i.e In-Person or through the phone)
"""
contact_type: String
"""
The ID of conversation related to the current appointment(only for group appts 10/2020)
"""
conversation_id: ID
"""
The date and time that the appointment was created
"""
created_at: String!
"""
True if a credit was used for this appointment
"""
credit_was_used: Boolean
"""
The position of the appointment in the recurring series
"""
current_position_in_recurring_series: Int
"""
Pagination cursor
"""
cursor: Cursor!
"""
The date and time of the appointment
"""
date: String
"""
default color of appointment based on confirmation/type
"""
default_color: String
"""
The time the appointment was deleted. It is blank if the appointment is not deleted.
"""
deleted_at: String
"""
The effective pricing method for this appointment (calculated or stored)
"""
effective_pricing_method: AppointmentPricingMethod
"""
The end time of the appointment
"""
end: String
"""
The type of connection to an external calendar
"""
external_id_type: String
"""
A URL to an external video chat site for the session
"""
external_videochat_url: String
"""
The custom answers filled out by the booker of the appointment
"""
filled_embed_form: FormAnswerGroup
"""
The Form answer group first associated with the appointment
"""
form_answer_group: FormAnswerGroup
"""
All Form answer groups associated with the appointment
"""
form_answer_groups: [FormAnswerGroup!]
"""
The AI Scribe generated form answer group associated with the appointment
"""
generated_form_answer_group: GeneratedFormAnswerGroupType
"""
The latest AI-generated encounter summary for the appointment
"""
generated_summary: GeneratedSummary
"""
open tok token
"""
generated_token: String
"""
When true, additional group charting fields are visible in the Healthie UI
"""
has_expanded_vbc_charting_fields: Boolean
"""
Returns true if the appointment has in progress job
"""
has_in_progress_job: Boolean
"""
The unique identifier of the appointment
"""
id: ID!
"""
ID of user that created of appointment
"""
initiator_id: ID
"""
When true, insurance billing will be enabled for this appointment
"""
insurance_billing_enabled: Boolean
"""
The status of whether this appointment is specifically meant to block availability
"""
is_blocker: Boolean
"""
Indicates whether it's a group appointment
"""
is_group: Boolean
"""
The status of whether the video chat uses Zoom or Healthie Default telehealth
"""
is_zoom_chat: Boolean
"""
id of last conversation between provider and client in appointment
"""
last_client_conversation_id: ID
"""
The ID of the provider who last updated the appointment record, if available
"""
last_updated_by_id: ID
"""
The Late Cancellation Fee (in cents) for this appointment
"""
late_cancellation_fee: Int
"""
The length of the appointment (in minutes)
"""
length: Int
"""
The plaintext location of the appointment (only used for in-person appointments)
"""
location: String
"""
Location Resource
"""
locationResource: String
"""
How many attendees can register for an appointment (only used for Group Appointments)
"""
max_attendees: String
"""
a serialized JSON string of metadata
"""
metadata: JSON
"""
Minimum time before the appointment when client can still cancel it
"""
minimum_advance_cancel_time: Int
"""
Minimum time (in minutes) before the appointment when client can still reschedule it
"""
minimum_advance_reschedule_time: Int
"""
The No Show Fee (in cents) for this appointment
"""
no_show_fee: Int
"""
Quick notes on the appointment (only visible to providers)
"""
notes: String
"""
The ID of the organization the appointment belongs to
"""
organization_id: ID
"""
Free text reason when "Other" cancellation reason is selected
"""
other_cancellation_reason: String
"""
The id of the provider
"""
other_party_id: Int
"""
The number of times a patient rescheduled an appointment
"""
patient_reschedule_count: Int
"""
The status of the appointment. Can be one of "Occurred", "No-Show", "Re-Scheduled", "Cancelled." If enabled, "Late Cancellation" and "Checked-In" are also valid.
"""
pm_status(
"""
Check if client cancelled the appointment
"""
check_for_client_cancel: Boolean = false
): String
"""
The date and time the status of the appointment was last updated
"""
pm_status_changed_at: String
"""
The ID of the user who last changed the status of the appointment, if available
"""
pm_status_last_changed_by_id: ID
"""
Get the pricing info for this appointment
"""
pricing_info: AppointmentPricingInfoType
"""
The provider for the appointment
"""
provider: User
"""
Provider name
"""
provider_name: String
"""
All providers for the appointment.
"""
providers(
"""
Return an empty array unless there is more than one provider
"""
empty_unless_multiple: Boolean = false
): [User!]!
"""
The clients reason for scheduling the appointment
"""
reason: String
"""
The related recurring appointment series
"""
recurring_appointment: RecurringAppointment
"""
The ID of the recurring appointment
"""
recurring_appointment_id: String
@deprecated(reason: "Use recurring_appointment instead")
"""
The status of whether this is a repeating appointment or not
"""
repeat: Boolean @deprecated(reason: "Use recurring_appointment instead")
"""
How often to repeat the appointment (e.g Daily or Monthly)
"""
repeat_interval: String
@deprecated(reason: "Use recurring_appointment instead")
"""
How many times does the appointment repeat
"""
repeat_times: Int @deprecated(reason: "Use recurring_appointment instead")
"""
A requested payment for this appointment
"""
requested_payment: RequestedPayment
"""
The ID of the user, used for the calendar
"""
resourceId: String
"""
the ID of the room
"""
room_id: ID
"""
A string containing info on how the appointment was scheduled
"""
scheduled_by: String
"""
The OpenTok session ID for the appointment
"""
session_id: String
"""
When true, a cms1500 should be created when the appointment status is set to occurred
"""
should_create_cms1500_for_occurred_appointments: Boolean
"""
The start time of the appointment
"""
start: String
"""
The font color of the appointment
"""
textColor: String
"""
The status of whether the time of this appointment has been separated from the other recurring appointments in the series
"""
time_recurring_override: Boolean
"""
Timezone abbreviation of the date of the appointment
"""
timezone_abbr: String
"""
The title of the appointment
"""
title: String
"""
Can only be returned via querying a single appointment, not a collection. Transcripts for the appointment (in VTT format)
"""
transcripts(
"""
Filter by specific transcript type. If not provided, returns all transcript types.
"""
transcript_type: TranscriptTypeEnum
"""
Filter by transcript statuses. If not provided, just returns completed.
"""
status: [TranscriptStatusEnum]
): [Transcript!]
"""
Unauthenticated link to download an ICS file for the appointment
"""
unauthenticated_ics_link: String
"""
The last date and time that the appointment was updated
"""
updated_at: String
"""
Whether the appointment should use embedded Zoom in browser
"""
use_embedded_zoom: Boolean
"""
Whether the appointment is through Zoom or not
"""
use_zoom: Boolean
"""
The client in a 1:1 appointment
"""
user: User
"""
The id of the client (if a 1:1 appointment). If a group appointment, will be nil
"""
user_id: Int
"""
True if this appointment is configured to be summarized by AI Scribe
"""
will_be_scribed: Boolean!
"""
Zoom meeting info for the session that started between 1 hour before the appointment and 1 hour after its scheduled end, choosing the one with the most participants. Appointment should have a valid zoom link and the user should have the permission to access the meeting. Returns null otherwise, when no session started in that window, or when Zoom can't be reached
"""
zoom_appointment: ZoomAppointment
"""
Detailed information about Zoom cloud recording files for this appointment
"""
zoom_cloud_recording_files: [ZoomCloudRecordingFile!]
"""
URLs for Zoom cloud recordings for this appointment
"""
zoom_cloud_recording_urls: [String]
"""
ZAK tokens for the org member co-hosts of this Zoom group appointment
"""
zoom_co_host_links: [ZoomCoHostLink!]
"""
The dial-in info provided by zoom if appoint has zoom links.(separated by newline characters)
"""
zoom_dial_in_info: String
"""
The dial-in info provided by zoom if appoint has zoom links.(separated by break tags)
"""
zoom_dial_in_info_html: String
"""
An array of JSON objects containing the different dial in numbers for the Zoom call
"""
zoom_dial_in_numbers_json: [String]
"""
The join link for other attendees of the Zoom call
"""
zoom_join_url: String
"""
The Meeting ID for the Zoom call
"""
zoom_meeting_id: String
"""
The host link to start the Zoom call
"""
zoom_start_url: String
}