SCALAR
Boolean
Represents true
or false
values.
link GraphQL Schema definition
- scalar Boolean
link Require by
- AllergySensitivityAn allergy/sensitivity/preference for a client
- AnnouncementAnnouncements created by providers for client consumption
- AppointmentAn appointment object containing information about the appointment, including the attendees, date, location, and more.
- AppointmentInclusionTypeProvider/Client to Appointment connection
- AppointmentLocationA location where appointments are held
- AppointmentLocationInputPayload for an appointment location
- AppointmentSettingAppointment Setting options that a provider can customize
- AppointmentSummaryDataThe data for the appointment summary
- AppointmentTypeAn object containing information about the type of appointment
- AppointmentTypeAppointmentSettingInputPayload for an appointment setting
- AppointmentTypeFormConnectionInputPayload for connecting an appointment type to a custom module form
- AttendedClientsInputPayload for an AttendedClient
- AutoTaskGeneratorThe auto task generators belonging to a specific user
- AvailabilityAn object containing availability ranges for a provider
- AvailabilityInputPayload for an availability
- BenefitBenefit associated with policy
- BenefitInputPayload for a benefit
- BillingItemBilling
- BrandBrand options that a client can customize
- BrandInfoInfo for authentication pages for either a dietitian or partner
- bulkApplyCarePlanTemplateInputAutogenerated input type of bulkApplyCarePlanTemplate
- BulkEntryInputPayload for a new entry
- bulkUpdateCardIssuesInputAutogenerated input type of bulkUpdateCardIssues
- bulkUpdateCarePlanUsersInputAutogenerated input type of bulkUpdateCarePlanUsers
- bulkUpdateClientsInputAutogenerated input type of bulkUpdateClients
- bulkUpdateNotificationRecordsInputAutogenerated input type of bulkUpdateNotificationRecords
- bulkUpdateNotificationsInputAutogenerated input type of bulkUpdateNotifications
- bulkUpdateTasksInputAutogenerated input type of bulkUpdateTasks
- CalendarColorSchemeInputPayload for a calendar color scheme
- CalendarViewSettingView settings for provider calendar
- CampaignMarketing campaign (email/sms) sent to clients by provider
- CandidHealthConnectionInfo on connection to Candid Health
- CarePlanA Care Plan
- ChangeClaimSubmitterInfo on connection to Change Health
- ChangeDevicesAvailabilityInputAutogenerated input type of ChangeDevicesAvailability
- ChartingItemTypeCharting Item
- ChatSettingChat settings for a user
- ClientLocationInputPayload for a deletable location
- ClientPolicyInputPayload for a client policy
- ClientPortalSettingA client portal settings
- ClientPortalSettingInputPayload for a client portal setting
- Cms1500A CMS1500 claim
- Cms1500PolicyInputPayload for associating a policy with a CMS 1500
- ColorCodeInputPayload for a ColorCode
- CommentA comment of an entry
- completeCheckoutInputAutogenerated input type of completeCheckout
- completeCheckoutPayloadAutogenerated return type of completeCheckout.
- CompletedOnboardingItemAn object with information about how an onboarding item was completed
- ContactTypeA object containing information about whether a specific contact type can be booked
- ContactTypeOverridePayload for overriding a contact type
- ContactTypeOverrideInputPayload for overriding a contact type
- ConversationAn association between conversation holders
- ConversationMembershipConversationMembership entry, returns basic info related to conversation participant
- CourseA Course
- CourseGroupRelationship between a user group and a course
- CourseItemA Course Item
- CptCodeThe CPT code
- CptCodesCms1500cpt codes cms 1500s join table
- CptCodesCms1500InputPayload for a CPT code on a CMS 1500 form
- CptCodesPolicyInputProperties assigning a policy to a CPT code
- CptCodesSuperBillInputPayload for a CPT code super bill
- createAllergySensitivityInputAutogenerated input type of createAllergySensitivity
- createAnnouncementInputAutogenerated input type of createAnnouncement
- createAppleHealthInputAutogenerated input type of createAppleHealth
- createAppointmentInputAutogenerated input type of createAppointment
- createAppointmentSettingInputAutogenerated input type of createAppointmentSetting
- createAppointmentTypeInputAutogenerated input type of createAppointmentType
- createAutoTaskGeneratorInputAutogenerated input type of createAutoTaskGenerator
- createAvailabilityInputAutogenerated input type of createAvailability
- createBillingItemInputAutogenerated input type of createBillingItem
- createCampaignInputAutogenerated input type of createCampaign
- createCarePlanInputAutogenerated input type of createCarePlan
- createChatSettingInputAutogenerated input type of createChatSetting
- createClientInputAutogenerated input type of createClient
- CreateClientViaFormInputAutogenerated input type of CreateClientViaForm
- createCms1500InputAutogenerated input type of createCms1500
- createCommentInputAutogenerated input type of createComment
- createCompletedOnboardingItemInputAutogenerated input type of createCompletedOnboardingItem
- createCourseInputAutogenerated input type of createCourse
- createCourseItemInputAutogenerated input type of createCourseItem
- createCustomModuleFormInputAutogenerated input type of createCustomModuleForm
- createCustomModuleInputAutogenerated input type of createCustomModule
- createDocumentInputAutogenerated input type of createDocument
- createDosespotClinicianInputAutogenerated input type of createDosespotClinician
- createEntryInputAutogenerated input type of createEntry
- createExternalCalendarInputAutogenerated input type of createExternalCalendar
- createFaxAcctInfoInputAutogenerated input type of createFaxAcctInfo
- createFeatureToggleInputAutogenerated input type of createFeatureToggle
- createFolderInputAutogenerated input type of createFolder
- createFormAnswerGroupInputAutogenerated input type of createFormAnswerGroup
- createGoalHistoryInputAutogenerated input type of createGoalHistory
- createGoalInputAutogenerated input type of createGoal
- createGoogleFitInputAutogenerated input type of createGoogleFit
- createInsurancePlanInputAutogenerated input type of createInsurancePlan
- createMedicationInputAutogenerated input type of createMedication
- createNoteInputAutogenerated input type of createNote
- createNotificationContactInputAutogenerated input type of createNotificationContact
- createOfferingInputAutogenerated input type of createOffering
- createOnboardingItemInputAutogenerated input type of createOnboardingItem
- createOrganizationInputAutogenerated input type of createOrganization
- createOrganizationMembershipInputAutogenerated input type of createOrganizationMembership
- createPermissionTemplateInputAutogenerated input type of createPermissionTemplate
- createPersonalizationQuestionnairePayloadAutogenerated return type of createPersonalizationQuestionnaire.
- createProductInputAutogenerated input type of createProduct
- createReferringPhysicianInputAutogenerated input type of createReferringPhysician
- createRequestedFormInputAutogenerated input type of createRequestedForm
- createRequestedPaymentInputAutogenerated input type of createRequestedPayment
- createSentFaxInputAutogenerated input type of createSentFax
- createStripeCustomerDetailInputAutogenerated input type of createStripeCustomerDetail
- createTaskInputAutogenerated input type of createTask
- createWebhookInputAutogenerated input type of createWebhook
- CustomMetricA custom metric for a user
- CustomMetricInputPayload for a custom metric
- CustomMetricOverrideA custom metric for a user
- CustomMetricOverridesInputPayload for overriding a custom metric
- CustomModuleA question in a template
- CustomModuleConditionInputPayload for a CustomModuleCondition
- CustomModuleFormA template for a form, that can then be filled out
- CustomSidebarOverrideA custom sidebar override
- deleteAppointmentInputAutogenerated input type of deleteAppointment
- deleteNoteInputAutogenerated input type of deleteNote
- DiagnosesInputPayload for a diagnosis
- DiagnosisA diagnosis
- DocumentA document file that contains an attachment and information about the attachment
- DoseSpotOnly available to Internal Healthie Users -- Roles assigned to a given User
- editAvailabilityInputAutogenerated input type of editAvailability
- EntryA post about a client, with different category options
- ExternalCalendarAn object containing info about the provider's exrernal calendar
- FeatureToggleAn object containing details about what the client can and can't do
- FitbitA Fitbit Sync
- FolderA folder that contains documents and other folders
- FoodA food object
- FoodNutrientA food nutrient item object
- FormAnswerGroupA completed form, with metadata about the completion, and the saved answers
- FormTypesToRequesttypes of forms that can be requested
- generateChartingPdfInputAutogenerated input type of generateChartingPdf
- Goala goal
- GoalHistorya goal history
- GoalInstancea goal instance. gives a snapshot of a goal over a specific interval(start_range and end_range )
- GoalTemplatea goal template
- GroupCarePlanUserConnectionA connection between a user and a care plan
- HealthAssessmentHealth Assessment contains in-depth help info and goals for a client
- IcdCodeicd code
- IcdCodesCms1500icd codes cms 1500s join table
- IcdCodesCms1500InputPayload for ICD code on CMS 1500 form
- IcdCodesPolicyInputPayload for assigning a policy to an ICD code
- IcdCodesSuperBillInputPayload for an ICD code super bill
- IndividualClientTypeAn object containing an individual note for certain patient associated with group charting note
- InsurancePlanAn Insurance Plan
- IntakeFlowItemThe intake flow item
- IntegrationOptionTypeThe option of an integration
- LabOrderLab Order Object
- MealPlanA meal plan
- MedicationTypeMedication belonging to client
- MetricGraphDataTypeMetric Graph data
- MultiLineMetricGraphDataTypeMulti line metric graph data type
- NoteChat message object
- NotificationA notification
- NotificationContactA notification contact
- NotificationContactInputPayload for a notification contact
- NotificationSettingAn object containing the users preferences on notification
- OfferingOffering (or Package)
- OfferingIncludeOffering Include
- OfferingIncludesFieldsPayload for an include to an offering
- OfferingProductOffering product type
- OfferingProductInputPayload for an offering product
- OfficeallySftpAccountInfo on SFTP connection to OfficeAlly
- OnboardingFlowAn onboarding flow that is comprised of onboarding items
- OnboardingItemAn onboarding item that has something for the client to complete
- OrganizationAn organization, that is an umbrella group for multiple providers
- OrganizationInfoSpecific information for an organization
- OrganizationMembershipAn organization membership
- PairAccountsInputAutogenerated input type of PairAccounts
- PermissionTemplateTypeAn permission templateType
- PhysicianReferralInputPayload for a referral
- PolicyA policy
- PolicyInputPayload for a policy
- PotentialAppointmentSlotA potential appointment slot
- PrescriptionPrescription created in Dosespot
- PrimaryOrganizationInfoInputPayload for a primary organization
- ProductThe product
- ProviderAppointmentLocationsInputPayload to bind an appointment location to a provider
- QueryThe query root of this schema. See available queries.
- ReceivedFaxA Received Fax
- RecurringAppointmentA Recurring Appointment
- RecurringAppointmentInputPayload for a recurring appointment
- RecurringFormA Recurring Form
- RecurringPaymentRecurring Payment
- ReferralInputPayload for a referral
- ReferringPhysiciana referring physician
- ReferringPhysicianInputPayload for a referring physician
- ReminderA reminder object
- ReminderInputPayload for a reminder
- RemoveCardOnFileInputAutogenerated input type of RemoveCardOnFile
- RequestedPaymentA request, from a provider to a client, to make a payment
- RequestedPaymentTemplateRequested payment template
- RequestedPaymentTemplateInputPayload for a requested payment template
- RoomA room at a location
- RoomInputPayload for a Room
- SentFaxA Sent Fax
- ServingSizeA serving size object
- shareAnswersAsDocumentInputAutogenerated input type of shareAnswersAsDocument
- signInInputAutogenerated input type of signIn
- signInPayloadAutogenerated return type of signIn.
- StateLicensesInputPayload for a state license
- StripeBankAccountTypeA Stripe bank account
- StripeCompanyTypeA Stripe company
- StripeCustomerDetailDetails of the client's credit card
- SubgoalInputPayload for a sub-goal
- SubOrganizationInfoInputPayload for a sub-organization
- SubscriptionInstancea subscription object
- SupportDashboardOrganizationMembershipINTERNAL -- Data on the Organization Membership Object
- SupportDashboardUserINTERNAL -- Data on the User Object
- TagA custom tag that can be applied on a user
- TaskTasks for providers to create, complete, and optionally assign to client profiles
- TaskReminderInputPayload for a task reminder
- toggleCarePlanStatusForSpecificUserInputAutogenerated input type of toggleCarePlanStatusForSpecificUser
- unsubscribeFromNotificationPayloadAutogenerated return type of unsubscribeFromNotification.
- updateAllergySensitivityInputAutogenerated input type of updateAllergySensitivity
- updateAnnouncementInputAutogenerated input type of updateAnnouncement
- updateAppleHealthInputAutogenerated input type of updateAppleHealth
- updateAppointmentInclusionInputAutogenerated input type of updateAppointmentInclusion
- updateAppointmentInputAutogenerated input type of updateAppointment
- updateAppointmentSettingInputAutogenerated input type of updateAppointmentSetting
- updateAppointmentTypeInputAutogenerated input type of updateAppointmentType
- updateAutoTaskGeneratorInputAutogenerated input type of updateAutoTaskGenerator
- updateBillingItemInputAutogenerated input type of updateBillingItem
- updateBrandInputAutogenerated input type of updateBrand
- updateCalendarViewSettingInputAutogenerated input type of updateCalendarViewSetting
- updateCampaignInputAutogenerated input type of updateCampaign
- updateCarePlanInputAutogenerated input type of updateCarePlan
- updateChargeBackInputAutogenerated input type of updateChargeBack
- updateChatSettingInputAutogenerated input type of updateChatSetting
- updateClientInputAutogenerated input type of updateClient
- updateCms1500InputAutogenerated input type of updateCms1500
- updateConversationInputAutogenerated input type of updateConversation
- updateConversationMembershipInputAutogenerated input type of updateConversationMembership
- updateCourseInputAutogenerated input type of updateCourse
- updateCourseItemInputAutogenerated input type of updateCourseItem
- updateCourseMembershipInputAutogenerated input type of updateCourseMembership
- updateCustomModuleFormInputAutogenerated input type of updateCustomModuleForm
- updateCustomModuleInputAutogenerated input type of updateCustomModule
- updateDocumentInputAutogenerated input type of updateDocument
- updateEntryInputAutogenerated input type of updateEntry
- updateExternalCalendarInputAutogenerated input type of updateExternalCalendar
- updateFeatureToggleInputAutogenerated input type of updateFeatureToggle
- updateFolderInputAutogenerated input type of updateFolder
- updateFormAnswerGroupInputAutogenerated input type of updateFormAnswerGroup
- updateGoalInputAutogenerated input type of updateGoal
- updateGoogleFitInputAutogenerated input type of updateGoogleFit
- updateGroupCarePlanInputAutogenerated input type of updateGroupCarePlan
- updateInsurancePlanInputAutogenerated input type of updateInsurancePlan
- updateLabOrderInputAutogenerated input type of updateLabOrder
- updateMedicationInputAutogenerated input type of updateMedication
- updateNotificationContactInputAutogenerated input type of updateNotificationContact
- updateNotificationInputAutogenerated input type of updateNotification
- updateNotificationSettingInputAutogenerated input type of updateNotificationSetting
- updateOfferingInputAutogenerated input type of updateOffering
- updateOfficeallySftpAccountInputAutogenerated input type of updateOfficeallySftpAccount
- updateOnboardingItemInputAutogenerated input type of updateOnboardingItem
- updateOrganizationMembershipInputAutogenerated input type of updateOrganizationMembership
- updatePermissionTemplateInputAutogenerated input type of updatePermissionTemplate
- updatePolicyMutationInputAutogenerated input type of updatePolicyMutation
- updateProductInputAutogenerated input type of updateProduct
- updateReceivedFaxInputAutogenerated input type of updateReceivedFax
- updateRecurringFormInputAutogenerated input type of updateRecurringForm
- updateReferringPhysicianInputAutogenerated input type of updateReferringPhysician
- updateRequestedPaymentInputAutogenerated input type of updateRequestedPayment
- updateStateInputAutogenerated input type of updateState
- updateStripeCustomerDetailInputAutogenerated input type of updateStripeCustomerDetail
- updateStripeVerificationDetailsInputAutogenerated input type of updateStripeVerificationDetails
- updateSubscriptionInputAutogenerated input type of updateSubscription
- updateSuperBillInputAutogenerated input type of updateSuperBill
- updateTaskInputAutogenerated input type of updateTask
- updateUserInputAutogenerated input type of updateUser
- updateWebhookInputAutogenerated input type of updateWebhook
- UserAn user entry, returns basic user information
- UserGroupA user group, returns basic info about the user group
- UserPolicyInputPayload for a user policy
- ValidateOfferingCouponInformation based on if an offering coupon is valid
- VideoChatVideo chat info for subscriptions
- WebhookA configured webhook
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.