AppointmentType
An object containing information about the type of appointment
Fields
advance_pricing_for_clients_count
· String · The number of clients with advance pricing for this appointment type advance_pricing_for_providers_count
· String · The number of providers with advance pricing for this appointment type appointment_autocomplete_form
· AppointmentAutocompleteForm · The autocomplete form for AI-generated charting notes associated with this appointment type appointment_setting
· AppointmentSetting · The appointment setting associated with this appointment type. An associated appointment setting overrides the providers general one. appointment_type_cpt_code
· AppointmentTypeCptCodeType · The cpt code and units for this appointment type auto_increase_charge_for_actual_duration
· Boolean · When true, the appointment pricing will be automatically increase based on actual duration availability_exists_for
· Boolean · Is true if upcoming availability exists available_contact_types
· [String] · List of available contact types for this appointment type bookable_by_groups
· Boolean · When true, this appointment type is bookable by user groups associated through appointment_type_user_groups and appointment type is NOT bookable by ALL users bookable_groups
· [UserGroup!] · user groups that can book this appointment type. Associated through appointment_type_user_groups bookable_without_group
· Boolean!
· required · When true, this appointment type is bookable by users without a user group client_call_provider
· Boolean · Checks to see if the client call to provider client_display_name
· String · A name to use in the client scheduling widget instead of the default name field. Falls back to name if not set. clients_can_book
· Boolean!
· required · The status of whether the client can self-book this type of appointment clients_have_credit
· Boolean · Checks to see if the client has enough credit to book custom_text_reminder_body
· String · If the provider's organization has this feature, this will customize the content of SMS reminder's Healthie sends. deleted_at
· String · Date time appointment type was deleted dont_ask_for_reason
· Boolean · When true, the client will not be asked to add a reason when booking an appointment of this type embed_question_form_id
· String · ID of the embedded custom module form form_requests_after_appointment
· [AppointmentTypeFormConnection!] · All form requests which should be created after appointment form_requests_after_appointment_booking
· [AppointmentTypeFormConnection!] · All form requests which should be created after appointment booking form_requests_before_appointment
· [AppointmentTypeFormConnection!] · All form requests which should be created before appointment has_available_group_appts
· Boolean · Is true if group appointment available has_specific_appointment_settings
· Boolean · When true, this appointment type has specific appointment settings that override the general ones insurance_billing_enabled
· Boolean · Whether or not this appointment type will have insurance billing enabled is_waitlist_enabled
· Boolean!
· required · The status of whether waitlist is enabled for an appointment or not no_availability_message
· String · A custom message to display if there are no available slots on a given day for an appointment type. price_and_cpt_price
· PriceAndCptPriceType · The price and cpt_code_price pricing_info
· AppointmentPricingInfoType · Get the pricing info for this appointment type pricing_option
· String · Pricing option for this appointment type provider_appt_type_connections
· [ProviderApptTypeConnection!] · providers associated with appointment type require_cc_at_booking
· Boolean · When true, certain clients (limited to non-established clients only and does not include provider-booked appointments) will be required to provide a credit card for booking require_in_state_clients
· Boolean · When this setting is turned on, provider state licensing requirements will be enforced when clients try to schedule appointments. require_specific_providers
· Boolean!
· required · Whether or not appointment type should use specific providers time_on_label
· String · A label that includes the length of the appointment user_group
· UserGroup · The user group associated with this appointment type. user_group_id
· String · The ID of the group clients are placed in after booking valid_state_licensing_for
· Boolean · If provider state matches users or appointment type doesn't require state license restrictions. Used By
Definition
"""An object containing information about the type of appointment"""type AppointmentType { """ The number of clients with advance pricing for this appointment type """ advance_pricing_for_clients_count: String
""" The number of providers with advance pricing for this appointment type """ advance_pricing_for_providers_count: String
""" The autocomplete form for AI-generated charting notes associated with this appointment type """ appointment_autocomplete_form: AppointmentAutocompleteForm
""" The appointment setting associated with this appointment type. An associated appointment setting overrides the providers general one. """ appointment_setting: AppointmentSetting
""" The cpt code and units for this appointment type """ appointment_type_cpt_code: AppointmentTypeCptCodeType
""" When true, the appointment pricing will be automatically increase based on actual duration """ auto_increase_charge_for_actual_duration: Boolean
""" Is true if upcoming availability exists """ availability_exists_for( """ The appointment location id """ appointment_location_id: String
""" The org level """ org_level: Boolean = false
""" The provider id """ provider_id: String
""" The list of provider ids """ provider_ids: [String] ): Boolean
""" List of available contact types for this appointment type """ available_contact_types: [String]
""" When true, this appointment type is bookable by user groups associated through appointment_type_user_groups and appointment type is NOT bookable by ALL users """ bookable_by_groups: Boolean
""" user groups that can book this appointment type. Associated through appointment_type_user_groups """ bookable_groups: [UserGroup!]
""" When true, this appointment type is bookable by users without a user group """ bookable_without_group: Boolean!
""" Checks to see if the client call to provider """ client_call_provider: Boolean
""" A name to use in the client scheduling widget instead of the default name field. Falls back to name if not set. """ client_display_name: String
""" The status of whether the client can self-book this type of appointment """ clients_can_book: Boolean!
""" Checks to see if the client has enough credit to book """ clients_have_credit: Boolean
""" The date the Appointment Type was created """ created_at: String!
""" Pagination cursor """ cursor: Cursor!
""" If the provider's organization has this feature, this will customize the content of SMS reminder's Healthie sends. """ custom_text_reminder_body: String
""" Date time appointment type was deleted """ deleted_at: String
""" When true, the client will not be asked to add a reason when booking an appointment of this type """ dont_ask_for_reason: Boolean
""" ID of the embedded custom module form """ embed_question_form_id: String
""" All form requests which should be created after appointment """ form_requests_after_appointment: [AppointmentTypeFormConnection!]
""" All form requests which should be created after appointment booking """ form_requests_after_appointment_booking: [AppointmentTypeFormConnection!]
""" All form requests which should be created before appointment """ form_requests_before_appointment: [AppointmentTypeFormConnection!]
""" Is true if group appointment available """ has_available_group_appts( """ The appointment location id """ appointment_location_id: String
""" The provider id """ provider_id: String ): Boolean
""" When true, this appointment type has specific appointment settings that override the general ones """ has_specific_appointment_settings: Boolean
""" The unique identifier of the appointment type """ id: ID!
""" Whether or not this appointment type will have insurance billing enabled """ insurance_billing_enabled: Boolean
""" The status of whether appointments of this types are group appointments or not """ is_group: Boolean!
""" The status of whether waitlist is enabled for an appointment or not """ is_waitlist_enabled: Boolean!
""" The length of the appointment type (in minutes) """ length: Int
""" A serialized JSON string of metadata. Maximum character limit of 128,000. Only accessible by staff and providers """ metadata: String
""" the name of the appointment type """ name: String
""" A custom message to display if there are no available slots on a given day for an appointment type. """ no_availability_message: String
""" The position of the appointment type when shown in a list of other appointment types """ position: Int
""" The price and cpt_code_price """ price_and_cpt_price: PriceAndCptPriceType
""" The pricing for this appointment type """ pricing: String
""" Get the pricing info for this appointment type """ pricing_info: AppointmentPricingInfoType
""" Pricing option for this appointment type """ pricing_option: String
""" providers associated with appointment type """ provider_appt_type_connections: [ProviderApptTypeConnection!]
""" When true, certain clients (limited to non-established clients only and does not include provider-booked appointments) will be required to provide a credit card for booking """ require_cc_at_booking: Boolean
""" When this setting is turned on, provider state licensing requirements will be enforced when clients try to schedule appointments. """ require_in_state_clients: Boolean
""" Whether or not appointment type should use specific providers """ require_specific_providers: Boolean!
""" position of appointment type when displayed in packages list """ row_order: String
""" A label that includes the length of the appointment """ time_on_label: String
""" The date the Appointment Type was updated """ updated_at: String!
""" The user group associated with this appointment type. """ user_group: UserGroup
""" The ID of the group clients are placed in after booking """ user_group_id: String
""" The creator of the appointment type """ user_id: Int
""" If provider state matches users or appointment type doesn't require state license restrictions. """ valid_state_licensing_for( """ The client state of residence """ client_state_of_residence: String
""" The org level """ org_level: Boolean = false
""" The provider id """ provider_id: String
""" The list of provider ids """ provider_ids: [String] ): Boolean}