OBJECT
AppointmentSetting
Appointment Setting options that a provider can customize
link GraphQL Schema definition
- type AppointmentSetting {
- # Insurance plans that are accepted by the provider
- AcceptedInsurancePlan] : [
- # Whether or not providers will be able to set pricing per appointment type
- Boolean :
- # If true, clients will be able to cancel an appointment
- Boolean :
- # If true, clients will be able to reschedule an appointment
- Boolean :
- # When true, providers can specify external url (e.g., Doxy, VSee) for Video Call
- # appointments.
- Boolean :
- # When true, a client can reschedule a past appointment (on the Web/API only)
- Boolean :
- # Whether or not clients will have specific pricing for appointment types
- Boolean :
- # Whether or not providers will have specific pricing for appointment types
- Boolean :
- # Always notify the provider when the client books
- Boolean :
- # Appointment Locations for this Appointment Setting
- AppointmentLocation] : [
- # Have different appointment confirmation emails for each appointment type
- Boolean :
- # Have different appointment reminder emails for each appointment type
- Boolean :
- # When true, and when the appointment setting is associated to a specific
- # appointment type, the reminder settings will override the provider's normal ones
- Boolean :
- # Have different website booking emails for each appointment type
- Boolean :
- # Seperate confirmation emails for different appointment types
- Boolean :
- # Seperate reminder emails for different appointment types
- Boolean :
- # Seperate website booking emails for different appointment types
- Boolean :
- # Ask clients to confirm their appointment
- Boolean :
- # If true, clients can confirm their appointment via text
- Boolean :
- # Auto-generate a payment request when an appointment is scheduled
- Boolean :
- # Allow clients to book appointments at none, 20, 30, 60 intervals
- Int :
- # The amount of minutes to maintain between appointments
- #
- # (prevent back to back appointments)
- String :
- # The color schemes defined for this appointment setting
- CalendarColorScheme] : [
- # Calendar interval
- String :
- # Text to display above the client's calendar within Healthie
- String :
- # Message to show clients when they are not allowed to cancel
- String :
- # Message to show clients when they are not allowed to cancel
- String :
- # Whether or not client with valid payment method will be charged for occured
- # appointments
- Boolean :
- # If true, clients will be able to call to provider
- Boolean :
- # When false, the billing tab is hidden from clients
- Boolean :
- # Confirm all client-created appointments by default
- Boolean :
- # Contact type overrides for this appointment setting
- ContactType] : [
- # Show the group appointment form first
- Boolean :
- # The template selected will automatically appear when a new chart note is started
- String :
- # The template name selected
- String :
- # The form that should be pre-selected when creating a new group charting note
- CustomModuleForm :
- # Use Zoom for all telehealth appointments
- Boolean :
- # Video service to use for telehealth appointments ('internal', 'zoom', or
- # 'external')
- String :
- # Prevent the client from rescheduling a past appointment with one of these
- # statuses
- String] : [
- # The end time to show when setting weekly availability
- String :
- # Facebook pixel code that runs when the client completes the embdedded
- # scheduler/purchaser
- String :
- # Assign a name to chart notes
- Boolean @deprecated( reason: "This now always returns true" ) :
- # If true, hide insurance getting started info
- Boolean :
- # Hide links to Healthie from appointment reminders
- Boolean :
- ID! :
- # Whether or not to send invoice to client without a valid payment card/method
- Boolean :
- # The maximum number of days in advance a client can book
- String :
- # Maximum time a client must wait before being able to reschedule a past
- # appointment
- Int :
- # Minimum time before the appointment when client still can cancel it (in minutes)
- Int :
- # Minimum time before the appointment when client still can reschedule it (in
- # minutes)
- Int :
- # Minimum time before the despired appointment type where client still can
- # schedule it (in minutes)
- Int :
- # The minimum days in advance a client has to book
- String :
- # Minimum time a client must wait before being able to reschedule a past
- # appointment
- Int :
- # Deprecated. Use booking_interval_restriction instead
- String :
- # Deprecated. Use booking_interval_restriction instead
- Boolean :
- # Deprecated. Use booking_interval_restriction instead
- Boolean :
- # Owner of this appointment_setting
- User :
- # The maximum number of times a patient can self reschedule
- String :
- # Appointment statuses that can be applied to an appointment. Includes default
- # ones plus any custom
- String] : [
- # Prevent clients from booking an appointment
- Boolean :
- # Prevent clients from booking if they do not have the needed credit
- Boolean :
- # When true, replies to automatic notifications will go to the provider
- Boolean :
- # When true, providers and staff will always be asked to select an appointment
- # location when scheduling, even if its a video chat.
- Boolean :
- # The minimum number of days beyond the current appointment date that the patient
- # can reschedule to
- String :
- # The maximum number of days beyond the current appointment date that the patient
- # can reschedule to
- String :
- # Give clients their credit back when an appointment is cancelled
- Boolean :
- # When true, clients are prevented from scheduling appointments the day of
- Boolean :
- # When false, no appointment cancel emails are sent to patients.
- Boolean :
- # When false, no appointment update emails are sent to patients.
- Boolean :
- # Send clients an email when a provider schedules an appointment
- Boolean :
- # Send an email 5 minutes before a video chat starts
- Boolean :
- # Send email reminder to complete intake forms two days before
- Boolean :
- # Send a push notification 5 minutes before a video chat starts
- Boolean :
- # Send an email reminder four days before the appointment
- Boolean :
- # Send an email reminder one day before the appointment
- Boolean :
- # Send an email reminder one hour before the appointment
- Boolean :
- # Send an email reminder three days before the appointment
- Boolean :
- # Send an email reminder two days before the appointment
- Boolean :
- # Send an email reminder two hours before the appointment
- Boolean :
- # Send a text reminder four days before the appointment
- Boolean :
- # Send a text reminder one day before the appointment
- Boolean :
- # Send a text reminder one hour before the appointment
- Boolean :
- # Send a text reminder three days before the appointment
- Boolean :
- # Send a text reminder two days before the appointment
- Boolean :
- # Send a text reminder two hours before the appointment
- Boolean :
- # When true, providers can set a default external link for video call sessions.
- Boolean :
- # If True, provider will see Care Plans option on a Client profile page
- Boolean :
- # If true, show cms1500s
- Boolean :
- # When false, the faxing tab on the left hand side is hidden from providers
- Boolean :
- # If true, show the insurance authorization section on the clients profile
- Boolean :
- # If true, show office ally
- Boolean :
- # If true, show superbills
- Boolean :
- # Facebook pixel code that runs when the client starts the embdedded
- # scheduler/purchaser
- String :
- # The start time to show when setting weekly availability
- String :
- # Set different availability for each appointment type
- Boolean :
- # Set different availability for each contact type
- Boolean :
- # Set different availability for each appointment location
- Boolean :
- # The last date and time that the appointment setting was updated
- String :
- # Whether or not to use the client credit system
- Boolean :
- # If true, you can see where each client came from
- Boolean :
- # If true, clients will be placed in a waiting room instead of joining the Zoom
- # call directly
- Boolean :
- # The id of the user
- String :
- # Default video url settings
- VideoUrlDefault :
- }
link Require by
- AppointmentTypeAn object containing information about the type of appointment
- createAcceptedInsurancePlanPayloadAutogenerated return type of createAcceptedInsurancePlan
- createAppointmentSettingPayloadAutogenerated return type of createAppointmentSetting
- deleteAcceptedInsurancePlanPayloadAutogenerated return type of deleteAcceptedInsurancePlan
- QueryThe query root of this schema. See available queries.
- updateAppointmentSettingPayloadAutogenerated return type of updateAppointmentSetting
- UserAn user entry, returns basic user information