OBJECT

AppointmentType

An object containing information about the type of appointment

link GraphQL Schema definition

  • 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 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
  • #
  • # Arguments
  • # appointment_location_id: The appointment location id
  • # org_level: The org level
  • # provider_id: The provider id
  • # provider_ids: The list of provider ids
  • availability_exists_for(
  • appointment_location_id: String,
  • org_level: Boolean,
  • provider_id: String,
  • 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
  • # 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
  • # 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!]
  • # 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!
  • # 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
  • # 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 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 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 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.
  • #
  • # Arguments
  • # client_state_of_residence: The client state of residence
  • # org_level: The org level
  • # provider_id: The provider id
  • # provider_ids: The list of provider ids
  • valid_state_licensing_for(
  • client_state_of_residence: String,
  • org_level: Boolean,
  • provider_id: String,
  • provider_ids: [String]
  • ): Boolean
  • }