OBJECT
Appointment
An appointment object containing information about the appointment, including the attendees, date, location, and more.
link GraphQL Schema definition
- type Appointment {
- # The actual length of the appointment (in minutes). Filled in by the provider
- # after the appointment
- String :
- # Get link to add appointment to google calendar
- String :
- # The category of the appointment
- String :
- # The number of people (both providers and attendees) who are in the appointment
- Int :
- # A label for the appointment
- String :
- # the ID of the appointment location
- String :
- # The type of the appointment
- AppointmentType :
- # The ID of the type of appointment this is
- Int :
- # List of assigned user groups to the group appointment
- UserGroup!] : [
- # Client inclusions
- AppointmentInclusionType!] : [
- # All attendees for the appointment.
- User!]! : [
- # Pending Appointment inclusions
- User!] : [
- # The backgroundColor color of the appointment
- #
- # Arguments
- # appointment_setting_updated_at: The time the appointment
- # setting was last updated
- String): String ( :
- # Returns true if the patient can reschedule the appointment
- Boolean :
- # True if client able to cancel an appointment
- Boolean :
- # True if client able to reschedule an appointment
- Boolean :
- # false if the client needs to confirm the appointment, and has not
- #
- # Arguments
- # known_requires_client_confirmed: Whether or not the appointment
- # requires client confirmation
- Boolean): Boolean ( :
- # Whether the appointment updating on client side or not
- Boolean :
- # The status of whether the provider has confirmed the appointment or not
- Boolean :
- # True if appointment is locked
- Boolean :
- # The status of the connected chart note
- String :
- # How the provider and attendees will connect (i.e In-Person or through the phone)
- String :
- # The ID of conversation related to the current appointment(only for group appts
- # 10/2020)
- ID :
- # The date and time that the appointment was created
- String :
- # The position of the appointment in the recurring series
- Int :
- # The date and time of the appointment
- String :
- # default color of appointment based on confirmation/type
- String :
- # The time the appointment was deleted. It is blank if the appointment is not
- # deleted.
- String :
- # The end time of the appointment
- String :
- # The type of connection to an external calendar
- String :
- # A URL to an external video chat site for the session
- String :
- # The custom answers filled out by the booker of the appointment
- FormAnswerGroup :
- # Form answer group associated with appointment
- FormAnswerGroup :
- # open tok token
- String :
- # The unique identifier of the appointment
- ID! :
- # ID of user that created of appointment
- ID :
- # The status of whether this appointment is specifically meant to block
- # availability
- Boolean :
- # Indicates whether it's a group appointment
- Boolean :
- # The status of whether the video chat uses Zoom or Healthie Default telehealth
- Boolean :
- # id of last conversation between provider and client in appointment
- ID :
- # The length of the appointment (in minutes)
- Int :
- # The plaintext location of the appointment (only used for in-person appointments)
- String :
- # Location Resource
- String :
- # How many attendees can register for an appointment (only used for Group
- # Appointments)
- String :
- # a serialized JSON string of metadata
- JSON :
- # Minimum time before the appointment when client can still cancel it
- Int :
- # Minimum time (in minutes) before the appointment when client can still
- # reschedule it
- Int :
- # Quick notes on the appointment (only visisble to providers)
- String :
- # The id of the provider
- Int :
- # The number of times a patient rescheduled an appointment
- Int :
- # The status of the appointment. Can be one of “Occurred”, “No-Show”,
- # “Re-Scheduled”, “Cancelled”
- #
- # Arguments
- # check_for_client_cancel: Check if client cancelled the
- # appointment
- Boolean): String ( :
- # The date and time the status of the appointment was last updated
- String :
- # Get the pricing info for this appointment
- AppointmentPricingInfoType :
- # The provider for the appointment
- User :
- # Provider name
- String :
- # All providers for the appointment.
- #
- # Arguments
- # empty_unless_multiple: Return an empty array unless there is
- # more than one provider
- Boolean): [User!]! ( :
- # The clients reason for scheduling the appointment
- String :
- # The related recurring appointment series
- RecurringAppointment :
- # The ID of the recurring appointment
- String @deprecated( reason: "Use recurring_appointment instead" ) :
- # The status of whether this is a repeating appointment or not
- Boolean @deprecated( reason: "Use recurring_appointment instead" ) :
- # How often to repeat the appointment (e.g Daily or Monthly)
- String @deprecated( reason: "Use recurring_appointment instead" ) :
- # How many times does the appointment repeat
- Int @deprecated( reason: "Use recurring_appointment instead" ) :
- # A requested payment for this appointment
- RequestedPayment :
- # The ID of the user, used for the calendar
- String :
- # the ID of the room
- ID :
- # A string containing info on how the appointment was scheduled
- String :
- # The OpenTok session ID for the appointment
- String :
- # The start time of the appointment
- String :
- # The font color of the appointment
- String :
- # The status of whether the time of this appointment has been separated from the
- # other recurring appointments in the series
- Boolean :
- # Timezone abbreviation of the date of the appointment
- String :
- # The title of the appointment
- String :
- # Unauthenticated link to download an ICS file for the appointment
- String :
- # The last date and time that the appointment was updated
- String :
- # Whether the appointment is through Zoom or not
- Boolean :
- # The client in a 1:1 appointment
- User :
- # The id of the client (if a 1:1 appointment). If a group appointment, will be nil
- Int :
- # Zoom meeting info. Appointment should have a valid zoom link and the user should
- # have the permission to access the meeting. Otherwise returns nil
- ZoomAppointment :
- # URLs for Zoom cloud recordings for this appointment
- String] : [
- # The dial-in info provided by zoom if appoint has zoom links.(separated by
- # newline characters)
- String :
- # The dial-in info provided by zoom if appoint has zoom links.(separated by break
- # tags)
- String :
- # An array of JSON objects containing the different dial in numbers for the Zoom
- # call
- String] : [
- # The join link for other attendees of the Zoom call
- String :
- # The Meeting ID for the Zoom call
- String :
- # The host link to start the Zoom call
- String :
- }
link Require by
- AppointmentCreditChangeAn object containing appointment type credit change event
- AppointmentInclusionTypeProvider/Client to Appointment connection
- completeCheckoutPayloadAutogenerated return type of completeCheckout.
- createAppointmentPayloadAutogenerated return type of createAppointment.
- deleteAppointmentPayloadAutogenerated return type of deleteAppointment.
- FormAnswerGroupA completed form, with metadata about the completion, and the saved answers
- QueryThe query root of this schema. See available queries.
- RequestedPaymentA request, from a provider to a client, to make a payment
- SubscriptionSubscriptions for events tracking
- updateAppointmentPayloadAutogenerated return type of updateAppointment.
- UserAn user entry, returns basic user information