# Healthie GraphQL API — schema (SDL) # Retrieved by anonymous introspection of the Healthie sandbox endpoint. # Source: https://staging-api.gethealthie.com/graphql # Production endpoint (same schema, isolated data): https://api.gethealthie.com/graphql # Docs: https://docs.gethealthie.com/ schema { query: Query mutation: Mutation subscription: Subscription } "The action recorded by an audit event on a form answer group, such as locking, unlocking, or signing." enum Action { LOCKED UNLOCKED SIGNED ADDENDUM_CREATED REMOVE_SIGNATURE APPOINTMENT_LINKED APPOINTMENT_UNLINKED APPOINTMENT_RELINKED } "Ordering options for active care team members" enum ActiveCareTeamMemberOrderKeys { LAST_NAME_ASC } "The type of adjustment group" enum AdjustmentGroup { "Adjustment group for CO" CO "Adjustment group for OA" OA "Adjustment group for PR" PR "Adjustment group for PI" PI } "API Key sorting enum" enum ApiKeyOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NAME_ASC NAME_DESC } "AppliedTag sorting enum" enum AppliedTagOrderKeys { "Sort by created at in ascending order" CREATED_AT_ASC "Sort by created at in descending order" CREATED_AT_DESC "Sort by updated at in ascending order" UPDATED_AT_ASC "Sort by updated at in descending order" UPDATED_AT_DESC "Do not sort records" UNSORTED } "Appointment sorting enum" enum AppointmentOrderKeys { DATE_ASC DATE_DESC CREATED_AT_DESC CREATED_AT_ASC UPDATED_AT_DESC UPDATED_AT_ASC UNSORTED } "Available pricing methods for appointments" enum AppointmentPricingMethod { "Copay pricing method" COPAY "Coinsurance pricing method" COINSURANCE "Deductible pricing method" DEDUCTIBLE "Appointment type client pricing method" APPOINTMENT_TYPE_CLIENT "Appointment type provider pricing method" APPOINTMENT_TYPE_PROVIDER "Appointment type default pricing method" APPOINTMENT_TYPE_DEFAULT } "Appointment Request sorting enum" enum AppointmentRequestOrderKeys { date_asc date_desc appt_type client_name req_provider new_clients active_clients "Sort by requested date, earliest first. A request with several slots is positioned by its earliest slot, regardless of any range_start/range_end filter. Requests with no slots sort last." requested_date_asc "Sort by requested date, latest first. A request with several slots is positioned by its earliest slot, regardless of any range_start/range_end filter. Requests with no slots sort last." requested_date_desc } "The status of an appointment request" enum AppointmentRequestStatus { "Request is active and available for booking appointments" OPEN "Request has been closed and is no longer active" CLOSED } "Appointment Type sorting enum" enum AppointmentTypeOrderKeys { "Sort ascending by the manual order set for Appointment Types on the list" POSITION_ASC "Sort descending by the manual order set for Appointment Types on the list" POSITION_DESC CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "Chart note statuses" enum AppointmentWorkflowChartNoteStatus { CREATED SIGNED LOCKED SIGNED_AND_LOCKED } "AuditEvent sorting enum" enum AuditEventOrderKeys { OCCURRED_AT_ASC OCCURRED_AT_DESC } "The types of resources that audit events can be associated with." enum AuditEventResourceName { API_KEY APPOINTMENT APPOINTMENT_INCLUSION APPOINTMENT_LOCATION APPOINTMENT_SETTING AVAILABILITY BILLING_ITEM CARE_ALERT CARE_PLAN CMS1500 CMS1500_POLICY CPT_CODES_CMS1500 DIAGNOSIS DOCUMENT_DRAFT FEATURE_TOGGLE FORM_ANSWER_GROUP FORM_ANSWER GOAL LOCATION ORGANIZATION ORGANIZATION_INFO ORGANIZATION_MEMBERSHIP POLICY TASK USER } "The different kinds of AuditEvents" enum AuditEventType { CREATE UPDATE DESTROY } "GraphQL mutations that can be executed by automation actions" enum AutomationActionKind { "Create an appointment" CREATE_APPOINTMENT "Create a billing item" CREATE_BILLING_ITEM "Create a care plan" CREATE_CARE_PLAN "Create a CMS1500" CREATE_CMS1500 "Create a conversation" CREATE_CONVERSATION "Create a document" CREATE_DOCUMENT "Create an entry" CREATE_ENTRY "Create a form answer group" CREATE_FORM_ANSWER_GROUP "Create a goal" CREATE_GOAL "Create a medication" CREATE_MEDICATION "Create a note" CREATE_NOTE "Create a requested form completion" CREATE_REQUESTED_FORM_COMPLETION "Create a requested payment" CREATE_REQUESTED_PAYMENT "Create a superbill" CREATE_SUPER_BILL "Create a tag" CREATE_TAG "Create a task" CREATE_TASK "Update an appointment" UPDATE_APPOINTMENT "Update a billing item" UPDATE_BILLING_ITEM "Update a care plan" UPDATE_CARE_PLAN "Update a client" UPDATE_CLIENT "Update a CMS1500" UPDATE_CMS1500 "Update a document" UPDATE_DOCUMENT "Update an entry" UPDATE_ENTRY "Update a form answer group" UPDATE_FORM_ANSWER_GROUP "Update a goal" UPDATE_GOAL "Update a medication" UPDATE_MEDICATION "Update a note" UPDATE_NOTE "Update a requested payment" UPDATE_REQUESTED_PAYMENT "Update a superbill" UPDATE_SUPER_BILL "Update a tag" UPDATE_TAG "Update a task" UPDATE_TASK "Update a user" UPDATE_USER } "Logic operators for combining multiple conditions" enum AutomationConditionLogic { "All conditions must match" ALL_MATCH "Any condition must match" ANY_MATCH } "Comparison operators for automation conditions" enum AutomationConditionOperator { "Field equals value" EQUALS "Field does not equal value" NOT_EQUALS "Field contains value" CONTAINS "Field does not contain value" DOES_NOT_CONTAIN "Field is greater than value" GREATER_THAN "Field is greater than or equal to value" GREATER_THAN_OR_EQUAL_TO "Field is less than value" LESS_THAN "Field is less than or equal to value" LESS_THAN_OR_EQUAL_TO "Field is empty or null" IS_EMPTY "Field is not empty" IS_NOT_EMPTY } "Unit for a delay step duration" enum AutomationDelayUnit { "Wait a number of minutes" MINUTES "Wait a number of hours" HOURS "Wait a number of days" DAYS "Wait a number of weeks" WEEKS } "Status of an automation run" enum AutomationRunStatus { "Run is queued but not started" PENDING "Run is currently executing" RUNNING "Run is paused on a delay step until its resume time" WAITING "Run finished successfully" COMPLETED "Run failed with an error" FAILED } "Status of an automation run step" enum AutomationRunStepStatus { "Step is queued but not started" PENDING "Step is currently executing" RUNNING "Delay step paused until its resume time" WAITING "Step finished successfully" COMPLETED "Step failed with an error" FAILED "Step was skipped due to condition" SKIPPED } "Types of automation steps" enum AutomationStepType { "A conditional step that evaluates rules" CONDITION "An action step that performs an operation" ACTION "A query step that fetches data" QUERY "A delay step that pauses the run for a relative duration" DELAY } "Types of automation triggers" enum AutomationTriggerKind { "Triggered by a webhook event" WEBHOOK } "The base minute interval for availability operations" enum BaseCalendarInterval { FIVE_MINUTES TEN_MINUTES FIFTEEN_MINUTES } "BillingItem sorting enum" enum BillingItemOrderKeys { CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC AMOUNT_PAID_DESC AMOUNT_PAID_ASC PATIENT_FIRST_NAME_ASC PATIENT_FIRST_NAME_DESC PROVIDER_FIRST_NAME_ASC PROVIDER_FIRST_NAME_DESC "Sort by the payment medium ascending" METHOD_ASC "Sort by the payment medium descending" METHOD_DESC STATE_ASC STATE_DESC } "External calendar status filters" enum CalendarStatus { "Calendars with sync errors" errored } "External calendar provider types" enum CalendarType { "Google Calendar" google "Outlook Calendar" outlook } "Type of cancellation reason based on who initiated the cancellation" enum CancellationReasonTypeEnum { "Returns all cancellation reasons regardless of type" all "Cancellation initiated by the client" client "Cancellation initiated by the provider" provider "Cancellation initiated by the organization" organization } "Priority level for a Care Alert" enum CareAlertPriorityEnum { "Normal" NORMAL "High" HIGH } "CarePlan sorting enum" enum CarePlanOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NAME_ASC NAME_DESC STATUS_ASC STATUS_DESC CLIENT_FIRST_NAME_DESC CLIENT_FIRST_NAME_ASC DEACTIVATED_DESC DEACTIVATED_ASC } "Charge back sorting enum" enum ChargeBackOrderKeys { CREATED_AT_DESC CREATED_AT_ASC UPDATED_AT_DESC UPDATED_AT_ASC } "Charge dispute statuses" enum ChargeDisputeStatus { LOST NEEDS_RESPONSE UNDER_REVIEW WARNING_CLOSED WARNING_NEEDS_RESPONSE WARNING_UNDER_REVIEW WON } "Chart note statuses" enum ChartNoteStatus { CREATED SIGNED CO_SIGNED LOCKED CO_SIGNED_AND_LOCKED SIGNED_AND_LOCKED } "Options for the service to submit a claim to" enum ClaimDestinationIntegration { candid claim_md change_health @deprecated(reason: "ChangeHealth claims integration has been discontinued.") office_ally } "The reason why a ClaimMd rejection messages field is empty" enum ClaimMdRejectionMessagesInfo { CLAIM_MD_REJECTION_MESSAGES_NOT_AVAILABLE @deprecated(reason: "This value is no longer returned. The cms1500s-rejection-reason feature flag has been permanently enabled.") NO_RECENT_CLAIM_SUBMISSION NOT_A_CLAIM_MD_CLAIM NO_REJECTION_MESSAGES } "Insurance policy priority level" enum ClaimPolicyPriority { "Primary insurance" PRIMARY "Secondary insurance" SECONDARY "Inactive policy" INACTIVE "Carve-out insurance" CARVE_OUT } "Cms1500 sorting enum" enum Cms1500OrderKeys { CREATED_AT_ASC CREATED_AT_DESC STATUS_ASC STATUS_DESC PRIMARY_PLAN_NAME_ASC PRIMARY_PLAN_NAME_DESC PATIENT_LAST_NAME_ASC PATIENT_LAST_NAME_DESC SERVICE_DATE_ASC SERVICE_DATE_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "Status options for a CMS1500 form" enum Cms1500Status { "Scheduled" SCHEDULED "Sent" SENT "Not Sent" NOT_SENT "Partially Paid" PARTIALLY_PAID "Batched" BATCHED "Closed" CLOSED "Fully Paid" FULLY_PAID "Client's Deductible Applies" CLIENTS_DEDUCTIBLE_APPLIES "Rejected by Clearinghouse" REJECTED "Denied by Insurance" DENIED } "Conversation Membership sorting enum" enum ConversationMembershipOrderKeys { CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC CONVERSATION_CREATED_AT_ASC CONVERSATION_CREATED_AT_DESC CONVERSATION_UPDATED_AT_ASC CONVERSATION_UPDATED_AT_DESC } "CustomModuleForm sorting enum" enum CustomModuleFormOrderKeys { NAME_ASC NAME_DESC UPDATED_AT_ASC UPDATED_AT_DESC "Sort by owner last name descending" USER_LAST_NAME_DESC "Sort by owner last name ascending" USER_LAST_NAME_ASC TYPE_ASC TYPE_DESC CREATED_AT_ASC CREATED_AT_DESC } "The default billing type for a patient" enum DefaultBillingType { "Patient pays out of pocket" SELF_PAY "Patient pays via insurance" INSURANCE_PAY } "Whether a diagnosis is currently active or inactive" enum DiagnosisStatusEnum { "The diagnosis is currently active" active "The diagnosis is no longer active" inactive } "Document draft status enum" enum DocumentDraftStatusTypeEnum { "Draft status" DRAFT "Published status" PUBLISHED } "Document sorting enum" enum DocumentOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NAME_DESC NAME_ASC } "Role assigned to a user in DoseSpot" enum DosespotRoleEnum { "Prescribing provider" PRESCRIBING_PROVIDER "Reporting" REPORTING "EPCS coordinator" EPCS_COORDINATOR "Clinician admin" CLINICIAN_ADMIN "Prescribing agent" PRESCRIBING_AGENT "Proxy" PROXY } "DrugAllergen class enum" enum DrugAllergenTypeEnum { "A screenable ingredient" INGREDIENT "A class of allergens" CLASS "A routed dose form drug" ROUTED_DOSE_FORM_DRUG "A food or environmental allergen" FOOD_AND_ENVIRONMENT_ALLERGEN } "Options for the service to run the eligibiliy check with" enum EligibilityCheckService { change_health @deprecated(reason: "ChangeHealth integration has been discontinued. Use claim_md instead.") claim_md } "Paperclip style variants available for an entry image" enum EntryImageStyleEnum { "Thumbnail variant (100x100)." THUMB "Medium variant (300x300)." MEDIUM "Large variant (500x500)." LARGE } "Entry sorting enum" enum EntryOrderKeys { CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC METRIC_STAT_ASC METRIC_STAT_DESC THIRD_PARTY_SOURCE_ASC THIRD_PARTY_SOURCE_DESC UNSORTED } "ERx clinic sorting enum" enum ErxClinicOrderKeys { "name ascending" NAME_ASC "name descending" NAME_DESC } "Available feature flag names for querying flag values in camelCase" enum FeatureFlagNameEnum { "Feature flag: mobile_health_data_sync_v2" mobileHealthDataSyncV2 "Feature flag: partner_portal" partnerPortal "Feature flag: dob_scoped_email_uniqueness" dobScopedEmailUniqueness "Feature flag: care_alerts" careAlerts "Feature flag: pass_relevant_oauth_connection_to_calendar_service" passRelevantOauthConnectionToCalendarService "Feature flag: get_flag_values_for_unauth_context" getFlagValuesForUnauthContext "Feature flag: cache_user_type_appointment_types" cacheUserTypeAppointmentTypes "Feature flag: perf_cache_persistence" perfCachePersistence "Feature flag: perf_medications_lazy_expand" perfMedicationsLazyExpand "Feature flag: chart_note_signing_behavior_phase_2" chartNoteSigningBehaviorPhase2 "Feature flag: organization_id_in_webhooks" organizationIdInWebhooks "Feature flag: metrics_quickprofile" metricsQuickprofile "Feature flag: perf_progressive_loading" perfProgressiveLoading "Feature flag: patient_statements_checkout" patientStatementsCheckout "Feature flag: payment_report" paymentReport "Feature flag: phased_available_slots" phasedAvailableSlots "Feature flag: prevent_inactive_access_setting" preventInactiveAccessSetting "Feature flag: provider_bios" providerBios "Feature flag: perf_progressive_loading_v2" perfProgressiveLoadingV2 "Feature flag: perf_progressive_loading_v3" perfProgressiveLoadingV3 "Feature flag: org_recent_payments_for_org_owner" orgRecentPaymentsForOrgOwner "Feature flag: qp_beautification" qpBeautification "Feature flag: qp_v2_duplication" qpV2Duplication "Feature flag: provider_taxonomy_selector" providerTaxonomySelector "Feature flag: provider_cancel_reason" providerCancelReason "Feature flag: prevent_client_name_editing" preventClientNameEditing "Feature flag: restructure_conversation_types" restructureConversationTypes "Feature flag: audit_log_ui" auditLogUi "Feature flag: provider_updater_job_scheduling" providerUpdaterJobScheduling "Feature flag: provider_utilization_report" providerUtilizationReport "Feature flag: send_plan_type_to_candid" sendPlanTypeToCandid "Feature flag: save_audit_events" saveAuditEvents "Feature flag: secondary_claims_workflow" secondaryClaimsWorkflow "Feature flag: reconnect_google_calendar_button" reconnectGoogleCalendarButton "Feature flag: group_level_actions_permission_improvements" groupLevelActionsPermissionImprovements "Feature flag: sent_webhook_id" sentWebhookId "Feature flag: send_sex_on_file_to_integrations" sendSexOnFileToIntegrations "Feature flag: scribe_usage_report" scribeUsageReport "Feature flag: query_available_slots" queryAvailableSlots "Feature flag: send_email_to_dosespot" sendEmailToDosespot "Feature flag: show_invoice_total_with_adjustments" showInvoiceTotalWithAdjustments "Feature flag: require_individual_client_notes" requireIndividualClientNotes "Feature flag: serve_db_backed_slots_in_experiment" serveDbBackedSlotsInExperiment "Feature flag: query_optimization_organization" queryOptimizationOrganization "Feature flag: optimize_external_calendar_unsync" optimizeExternalCalendarUnsync "Feature flag: self_scheduling" selfScheduling "Feature flag: tasks_ui_update" tasksUiUpdate "Feature flag: skip_duplicates_when_syncing_cms1500_diagnoses" skipDuplicatesWhenSyncingCms1500Diagnoses "Feature flag: skip_non_primary_era_claim_details" skipNonPrimaryEraClaimDetails "Feature flag: split_check_inbound_faxes_job" splitCheckInboundFaxesJob "Feature flag: secondary_claims_api" secondaryClaimsApi "Feature flag: show_cms1500_invoice_line_items" showCms1500InvoiceLineItems "Feature flag: show_invalid_icd_codes" showInvalidIcdCodes "Feature flag: transfer_dosespot_credential" transferDosespotCredential "Feature flag: claim_submission_tracking" claimSubmissionTracking "Feature flag: automations" automations "Feature flag: state_license_as_joins" stateLicenseAsJoins "Feature flag: split_evexia_sync_job" splitEvexiaSyncJob "Feature flag: short_circuit_dosespot_dosage_id" shortCircuitDosespotDosageId "Feature flag: use_human_appointment_blockers" useHumanAppointmentBlockers "Feature flag: use_manual_overlap_query" useManualOverlapQuery "Feature flag: document_editor" documentEditor "Feature flag: updated_dst_shifting_logic" updatedDstShiftingLogic "Feature flag: updated_form_answers" updatedFormAnswers "Feature flag: split_recurring_appointments" splitRecurringAppointments "Feature flag: line_payment_tracking_for_new_claims" linePaymentTrackingForNewClaims "Feature flag: task_updates" taskUpdates "Feature flag: white_label_use_theme" whiteLabelUseTheme "Feature flag: use_organization_requires_sms_mfa" useOrganizationRequiresSmsMfa "Feature flag: tasks_commenting" tasksCommenting "Feature flag: temp_hold_slots_on_book" tempHoldSlotsOnBook "Feature flag: validate_auth_app" validateAuthApp "Feature flag: use_candid_v4_api" useCandidV4Api "Feature flag: use_google_sync_tokens" useGoogleSyncTokens "Feature flag: whitelabel_automation" whitelabelAutomation "Feature flag: workflows_charting_by_care_team" workflowsChartingByCareTeam "Feature flag: use_stripe_checkout" useStripeCheckout "Feature flag: treat_yourself_fix" treatYourselfFix "Feature flag: view_era_pdf" viewEraPdf "Feature flag: webhook_send_lock" webhookSendLock "Feature flag: workflows_page" workflowsPage "Feature flag: iba_auto_create_cms1500s" ibaAutoCreateCms1500s "Feature flag: use_unified_metrics" useUnifiedMetrics "Feature flag: shareable_org_members_optimized_query" shareableOrgMembersOptimizedQuery "Feature flag: unlink_permission" unlinkPermission "Feature flag: embedded_zoom" embeddedZoom "Feature flag: appointment_status_dashboard" appointmentStatusDashboard "Feature flag: chart_note_linking" chartNoteLinking "Feature flag: zoom_alternate_hosts" zoomAlternateHosts "Feature flag: goal_views_improvement_and_audit_trail" goalViewsImprovementAndAuditTrail "Feature flag: invoice_for_automated_charges" invoiceForAutomatedCharges "Feature flag: batch_gcal_sync_invalidation" batchGcalSyncInvalidation "Feature flag: critical_chat_performance_improvements_mint_phase_1" criticalChatPerformanceImprovementsMintPhase1 "Feature flag: question_groups" questionGroups "Feature flag: s3_images_in_form_templates" s3ImagesInFormTemplates "Feature flag: multi_contact_type_availability" multiContactTypeAvailability "Feature flag: conversation_member_limit" conversationMemberLimit "Feature flag: defer_external_sync_for_recurring_updates" deferExternalSyncForRecurringUpdates "Feature flag: add_clients_to_group_appt_async" addClientsToGroupApptAsync "Feature flag: use_google_api_wrapper_for_google_calendar" useGoogleApiWrapperForGoogleCalendar "Feature flag: org_member_filter_intersection" orgMemberFilterIntersection "Feature flag: clear_external_calendar_refresh_token_on_error" clearExternalCalendarRefreshTokenOnError "Feature flag: edit_status_delete_appt_permissions" editStatusDeleteApptPermissions "Feature flag: multi_appointment_type_availability" multiAppointmentTypeAvailability "Feature flag: restricted_clients" restrictedClients "Feature flag: payout_accounts" payoutAccounts "Feature flag: restrict_editing_org_owner_info" restrictEditingOrgOwnerInfo "Feature flag: split_long_sms_messages" splitLongSmsMessages "Feature flag: record_form_answer_data" recordFormAnswerData "Feature flag: bypass_api_key_warning_for_api" bypassApiKeyWarningForApi "Feature flag: self_pay_exemption" selfPayExemption "Feature flag: link_custom_metrics_to_form_templates" linkCustomMetricsToFormTemplates "Feature flag: organization_active_toggle" organizationActiveToggle "Feature flag: healthie_logo_updates" healthieLogoUpdates "Feature flag: educational_resource_pdf_enabled" educationalResourcePdfEnabled "Feature flag: client_actions_currentuser_query" clientActionsCurrentuserQuery "Feature flag: graphql_api_version_deprecation_warnings" graphqlApiVersionDeprecationWarnings "Feature flag: form_answer_group_bulk_insert" formAnswerGroupBulkInsert "Feature flag: program_pausing" programPausing "Feature flag: auth_service_enabled" authServiceEnabled "Feature flag: erx_clinic_selection" erxClinicSelection "Feature flag: organization_appointments_optimization" organizationAppointmentsOptimization "Feature flag: use_parent_org_patient_query" useParentOrgPatientQuery "Feature flag: custom_pdf_headers_shared_notes" customPdfHeadersSharedNotes "Feature flag: hide_inactive_medications" hideInactiveMedications "Feature flag: prevent_appointment_type_connection_delete" preventAppointmentTypeConnectionDelete "Feature flag: late_cancellation_appointment_status" lateCancellationAppointmentStatus "Feature flag: show_encounters" showEncounters "Feature flag: link_lab_orders_to_chart_notes" linkLabOrdersToChartNotes "Feature flag: dosespot_v2_api" dosespotV2Api "Feature flag: zoom_cloud_recordings" zoomCloudRecordings "Feature flag: api_key_projection_routing_enabled" apiKeyProjectionRoutingEnabled "Feature flag: utilize_goal_policy" utilizeGoalPolicy "Feature flag: account_for_credits_in_appt_auto_charge" accountForCreditsInApptAutoCharge "Feature flag: add_appt_permissions" addApptPermissions "Feature flag: add_multiple_members_to_new_sub_orgs" addMultipleMembersToNewSubOrgs "Feature flag: ai_scribe_extended_bedrock_timeout" aiScribeExtendedBedrockTimeout "Feature flag: ai_scribe_form_custom_instructions" aiScribeFormCustomInstructions "Feature flag: ai_scribe_new_model" aiScribeNewModel "Feature flag: algolia_sync" algoliaSync "Feature flag: allow_cache_skippping_in_availabilities_for_day" allowCacheSkipppingInAvailabilitiesForDay "Feature flag: allow_excluding_provider_ids_in_available_slots_queries" allowExcludingProviderIdsInAvailableSlotsQueries "Feature flag: always_show_enable_insurance_billing_checkbox_when_insurance_parent_setting_is_on" alwaysShowEnableInsuranceBillingCheckboxWhenInsuranceParentSettingIsOn "Feature flag: auth_provider_user_sync" authProviderUserSync "Feature flag: query_optimization_calendardata" queryOptimizationCalendardata "Feature flag: appt_req_status" apptReqStatus "Feature flag: ar_aging_report" arAgingReport "Feature flag: audit_log_query" auditLogQuery "Feature flag: auth_service_mfa_enabled" authServiceMfaEnabled "Feature flag: auth_service_mobile_sdk" authServiceMobileSdk "Feature flag: auto_adjust_subscription_plans_and_seats" autoAdjustSubscriptionPlansAndSeats "Feature flag: automated_eligibility_checks" automatedEligibilityChecks "Feature flag: avail_block_permissions" availBlockPermissions "Feature flag: availability_filters" availabilityFilters "Feature flag: availability_improvements" availabilityImprovements "Feature flag: availability_summary_report" availabilitySummaryReport "Feature flag: bill_from_encounters" billFromEncounters "Feature flag: block_empty_community_conversations" blockEmptyCommunityConversations "Feature flag: can_resync_integration_data" canResyncIntegrationData "Feature flag: candid_service_line_dates" candidServiceLineDates "Feature flag: cap_offset_in_users_query" capOffsetInUsersQuery "Feature flag: ambient_ai_scribe" ambientAiScribe "Feature flag: chart_notes_workflows_more_filters" chartNotesWorkflowsMoreFilters "Feature flag: charting_workflows_page" chartingWorkflowsPage "Feature flag: claimmd_era_cursor_sync" claimmdEraCursorSync "Feature flag: cms1500_claim_lock" cms1500ClaimLock "Feature flag: claim_md_box_19_clinical_trial_number" claimMdBox19ClinicalTrialNumber "Feature flag: cms1500_generation_respects_client_billing_type" cms1500GenerationRespectsClientBillingType "Feature flag: conversation_count_batching" conversationCountBatching "Feature flag: optimized_patients_query" optimizedPatientsQuery "Feature flag: custom_pdf_headers" customPdfHeaders "Feature flag: custom_emails_for_form_completions" customEmailsForFormCompletions "Feature flag: delay_provider_updater_job_for_provider" delayProviderUpdaterJobForProvider "Feature flag: auto_charge_copay_etc" autoChargeCopayEtc "Feature flag: disable_patient_profile_photo" disablePatientProfilePhoto "Feature flag: disable_rupa_ordering" disableRupaOrdering "Feature flag: create_note_saves_appointment_form" createNoteSavesAppointmentForm "Feature flag: elabs_guarantor_auth_rep" elabsGuarantorAuthRep "Feature flag: document_sharing_refactor_v3" documentSharingRefactorV3 "Feature flag: eligibility_auto_populate_271" eligibilityAutoPopulate271 "Feature flag: dose_spot_multi_clinic_uploads" doseSpotMultiClinicUploads "Feature flag: eligibility_issues_worklist" eligibilityIssuesWorklist "Feature flag: eligibility_271_display" eligibility271Display "Feature flag: enable_merge_availabilities" enableMergeAvailabilities "Feature flag: enable_appt_req_dashboard" enableApptReqDashboard "Feature flag: ai_scribe_field_exclusion" aiScribeFieldExclusion "Feature flag: enable_appointment_type_buffer" enableAppointmentTypeBuffer "Feature flag: enhanced_rate_limiting" enhancedRateLimiting "Feature flag: faster_availability_sequences" fasterAvailabilitySequences "Feature flag: enable_visualize_dashboard" enableVisualizeDashboard "Feature flag: enable_visualize_plus" enableVisualizePlus "Feature flag: diagnosis_list_module" diagnosisListModule "Feature flag: faster_charting_autosave" fasterChartingAutosave "Feature flag: fax_magick" faxMagick "Feature flag: filter_scheduled_forms_using_form_history" filterScheduledFormsUsingFormHistory "Feature flag: async_fax_generation" asyncFaxGeneration "Feature flag: form_scheduling_follow_up_disabled" formSchedulingFollowUpDisabled "Feature flag: document_folder_rel_consistency" documentFolderRelConsistency "Feature flag: folder_sharing_refactor" folderSharingRefactor "Feature flag: form_answer_s3_images" formAnswerS3Images "Feature flag: google_calendar_consent_prompt" googleCalendarConsentPrompt "Feature flag: extend_appt_lookup" extendApptLookup "Feature flag: found_overlaps_any_query" foundOverlapsAnyQuery "Feature flag: form_answer_validations" formAnswerValidations "Feature flag: fullscript_lab_results" fullscriptLabResults "Feature flag: formbuilder_phase_3" formbuilderPhase3 "Feature flag: frontegg_cdn" fronteggCdn "Feature flag: icd_code_enhanced_search" icdCodeEnhancedSearch "Feature flag: legacy_auth_allowed" legacyAuthAllowed "Feature flag: mobile_chart_note_appointment_linking" mobileChartNoteAppointmentLinking "Feature flag: mobile_chart_note_create_edit" mobileChartNoteCreateEdit "Feature flag: integration_requests" integrationRequests "Feature flag: healthwise_enabled" healthwiseEnabled "Feature flag: launch_darkly_iba_iteration_flag" launchDarklyIbaIterationFlag "Feature flag: first_touch_partner_integration" firstTouchPartnerIntegration "Feature flag: keep_available_slots_up_to_date" keepAvailableSlotsUpToDate "Feature flag: mobile_diagnosis_list_module" mobileDiagnosisListModule "Feature flag: mobile_form_view_redesign_v1" mobileFormViewRedesignV1 "Feature flag: hide_requested_prescriptions" hideRequestedPrescriptions "Feature flag: mobile_ota_updates_enabled" mobileOtaUpdatesEnabled "Feature flag: multiple_forms_to_appointment" multipleFormsToAppointment "Feature flag: new_org_member_to_multiple_orgs" newOrgMemberToMultipleOrgs "Feature flag: new_quickprofile_components" newQuickprofileComponents "Feature flag: offering_purchase_cap" offeringPurchaseCap "Feature flag: onboarding_app" onboardingApp "Feature flag: bypass_available_slots_experiment" bypassAvailableSlotsExperiment "Feature flag: mobile_chart_note_delete" mobileChartNoteDelete "Feature flag: iframe_client_overview" iframeClientOverview "Feature flag: load_appointments_via_inclusions" loadAppointmentsViaInclusions "Feature flag: mixpanel_session_replay" mixpanelSessionReplay "Feature flag: intelligence_encounter_summaries" intelligenceEncounterSummaries "Feature flag: fix_bad_method_calls" fixBadMethodCalls "Feature flag: intelligence_task_suggestions" intelligenceTaskSuggestions "Feature flag: mobile_chart_note_locking" mobileChartNoteLocking "Feature flag: mobile_chart_note_signing" mobileChartNoteSigning "Feature flag: mobile_charting_notes_v1" mobileChartingNotesV1 "Feature flag: mobile_chat_video_uploads" mobileChatVideoUploads "Feature flag: is_at_free_slot_read_replica" isAtFreeSlotReadReplica "Deprecated feature flag: auto_charge_late_cancellation_no_shows" autoChargeLateCancellationNoShows @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: automatic_package_renewal_notice" automaticPackageRenewalNotice @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: claim_payment_details" claimPaymentDetails @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: client_billing_type" clientBillingType @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: client_profile_cms1500s_tab_migration" clientProfileCms1500sTabMigration @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: cms1500s_read_only_view" cms1500sReadOnlyView @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: cms_access" cmsAccess @deprecated(reason: "Permanently disabled; no longer needs to be requested.") "Deprecated feature flag: defer_stripe_address_to_checkout" deferStripeAddressToCheckout @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: document_sharing_refactor_v2" documentSharingRefactorV2 @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: insurance_parent_setting" insuranceParentSetting @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: insurance_payments" insurancePayments @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: living_plate_api_bugfix" livingPlateApiBugfix @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: outside_payment_type_for_write_offs" outsidePaymentTypeForWriteOffs @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: question_bank_search" questionBankSearch @deprecated(reason: "Permanently enabled; no longer needs to be requested.") "Deprecated feature flag: update_cms1500_status_on_claimmd_rejection_messages" updateCms1500StatusOnClaimmdRejectionMessages @deprecated(reason: "Permanently enabled; no longer needs to be requested.") } "Folder sorting enum" enum FolderOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NAME_DESC NAME_ASC } "FormAnswerGroup sorting enum" enum FormAnswerGroupOrderKeys { RECORD_CREATED_AT_ASC RECORD_CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC CREATED_AT_ASC CREATED_AT_DESC UNSORTED } "Form History action enum" enum FormHistoryAction { created edited opened completed skipped } "Form History sourceable_type enum" enum FormHistorySourceable { RequestedFormCompletion OnboardingItem } "Forms status filter enum" enum FormStatus { incomplete completed not_started } "Forms form type filter enum" enum FormType { requested_forms recurring_forms intake_forms } "Fullscript dynamic link entrypoint page" enum FullscriptEntrypoint { "Opens the product catalog page" CATALOG "Opens the labs page" LABS } "Accepted values for a `gender` form answer" enum Gender { MALE FEMALE FEMALE_TO_MALE MALE_TO_FEMALE GENDERQUEER CHOOSE_NOT_TO_DISCLOSE OTHER } "The reason for rejecting an AI-generated form answer group" enum GeneratedFormAnswerGroupRejectionReasonEnum { "The proposed note contains factual errors or incorrect details from the encounter" INACCURATE_INFORMATION "The proposed note is missing significant details that were discussed during the encounter" MISSING_DETAILS "The proposed note did not follow the formatting or content instructions provided" DIDNT_FOLLOW_INSTRUCTIONS "The provider already created their own note for this encounter" DUPLICATE_OR_OWN_NOTE } "The type of action that created this goal history record" enum GoalHistoryActionTypeEnum { "Goal history was created" CREATED "Goal was marked as completed" COMPLETED "Goal was marked as incomplete" MARKED_INCOMPLETE "Goal was activated" ACTIVE "Goal was deactivated" INACTIVE "Goal was updated" UPDATED } "Goal sorting enum" enum GoalOrderKeys { START_DATE_ASC START_DATE_DESC FREQUENCY_ASC FREQUENCY_DESC NAME_ASC NAME_DESC CREATED_BY_ASC CREATED_BY_DESC STATUS_ASC STATUS_DESC DUE_DATE_ASC DUE_DATE_DESC "Order by due date and start date descending" DUE_DATE_START_DATE_DESC } "Relationship of the insurance subscriber to the patient" enum HolderRelationship { "Patient is the subscriber" SELF "Patient is the child of the subscriber" CHILD "Patient is the spouse of the subscriber" SPOUSE "No relationship specified" NONE "Other relationship" OTHER } "ICD Code sorting enum" enum IcdCodeOrderKeys { CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC CODE_ASC CODE_DESC FAVORITES_ASC FAVORITES_DESC } "Individual client note sorting enum" enum IndividualClientNoteOrderKeys { ATTENDED_DESC CREATED_AT_DESC } "Individual client note sorting enum" enum IndividualClientNoteSorting { ATTENDED_DESC @deprecated(reason: "Use `IndividualClientNoteOrderKeys` and `order_by` instead") CREATED_AT_DESC @deprecated(reason: "Use `IndividualClientNoteOrderKeys` and `order_by` instead") } "Insurance Payment deposit statuses enum" enum InsurancePaymentsDepositStatusEnum { PENDING DEPOSITED } "InsurancePlan sorting enum" enum InsurancePlanOrderKeys { ACCEPTED PAYER_NAME_ASC } "IntakeFlow sorting enum" enum IntakeFlowOrderKeys { DATE_ASC DATE_DESC NAME_ASC NAME_DESC STATUS_ASC STATUS_DESC TYPE_ASC TYPE_DESC REQUEST_DATE_ASC REQUEST_DATE_DESC COMPLETE_DATE_ASC COMPLETE_DATE_DESC } "The plan tiers that an integration is available for" enum IntegrationPlanTiersType { ENTERPRISE GROUP PLUS ESSENTIALS CORE STARTER } "Enum representing the commentable types that can be linked to an InternalComment" enum InternalCommentable { Task } "InternalComment sorting enum" enum InternalCommentsOrderKeys { CREATED_AT_ASC CREATED_AT_DESC } "The type of intervention for a DSI comment" enum InterventionType { GENDER_MISMATCHED_DIAGNOSIS INCOMPATIBLE_DIABETES_DIAGNOSIS UDI_NOT_UNIQUE BREAST_CANCER_PROCEDURE_RECOMMENDATION ALLERGY_DRUG_INTERACTIONS LAB_BASED_ASSESSMENTS DRUG_DRUG_INTERACTIONS VITALS_OUTSIDE_OF_RANGE } "The entity that will be billed for the lab order" enum LabOrderBilling { "Bill to patient insurance" INSURANCE "Bill to organization" PROVIDER "Bill to patient" PATIENT } "Interpretations for Lab Orders and related objects" enum LabOrderInterpretation { "Unknown interpretation" UNKNOWN "Normal" NORMAL "Abnormal" ABNORMAL "Critical" CRITICAL } "Lab vendors that can used to order labs from" enum LabOrderLabVendor { "BioReference" BIOREFERENCE "Labcorp" LABCORP "Quest" QUEST } "LabOrder sorting enum" enum LabOrderOrderKeys { NAME_ASC NAME_DESC LAB_ASC LAB_DESC APPT_ASC APPT_DESC CLIENT_LAST_NAME_ASC CLIENT_LAST_NAME_DESC PROVIDER_LAST_NAME_ASC PROVIDER_LAST_NAME_DESC REVIEWING_PROVIDER_LAST_NAME_ASC REVIEWING_PROVIDER_LAST_NAME_DESC NORMALIZED_STATUS_ASC NORMALIZED_STATUS_DESC INTERPRETATION_ASC INTERPRETATION_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "CARC adjustment group on a line payment (CAS segment)" enum LinePaymentAdjustmentGroup { "Adjustment group CO" CO "Adjustment group PR" PR "Adjustment group OA" OA "Adjustment group PI" PI "Adjustment group unknown" UNKNOWN } "How a line payment or write-off was recorded (ERA import or manual entry)" enum LinePaymentSource { ERA MANUAL } "Reason a payer-balance line write-off was recorded" enum LineWriteOffReason { TIMELY_FILING CONTRACTUAL_UNCATEGORIZED PAYER_RECOUPMENT BILLING_ERROR OTHER } "Type of multi-factor authentication used" enum MfaType { SMS EMAIL } "Mobile health data integration type enum" enum MobileHealthDataIntegrationType { "Google health connect" GOOGLE_HEALTH_CONNECT } "Mobile health data snapshot integration type enum" enum MobileHealthDataSnapshotIntegrationType { "Apple health" APPLE_HEALTH "Google health connect" GOOGLE_HEALTH_CONNECT } "Mobile health data snapshot status enum" enum MobileHealthDataSnapshotStatus { "Initialized" INITIALIZED "Processing" PROCESSING "Partially processed" PARTIALLY_PROCESSED "Processed" PROCESSED "Failed" FAILED } "The format of a monograph" enum MonographFormat { "The monograph is in HTML format" HTML "The monograph is in XML format" XML } "Note sorting enum" enum NoteOrderKeys { CREATED_AT_ASC CREATED_AT_DESC } "Notification sorting enum" enum NotificationOrderKeys { CREATED_AT_ASC CREATED_AT_DESC } "OfferingCoupon sorting enum" enum OfferingCouponOrderKeys { CODE_ASC CODE_DESC TYPE_ASC TYPE_DESC APPLIES_TO_ASC APPLIES_TO_DESC AMOUNT_ASC AMOUNT_DESC EXPIRES_AT_ASC EXPIRES_AT_DESC TOTAL_USAGE_ASC TOTAL_USAGE_DESC } "Offering sorting enum" enum OfferingOrderKeys { SET_ORDER PRICE_ASC PRICE_DESC NAME_ASC NAME_DESC "Sort by billing items count descending" BEST_SELLER } "OnboardingFlow sorting enum" enum OnboardingFlowOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NAME_ASC NAME_DESC FORMS_COUNT_ASC FORMS_COUNT_DESC } "OrganizationMembership sorting enum" enum OrganizationMembershipOrderKeys { LAST_NAME_ASC LAST_NAME_DESC FIRST_NAME_ASC FIRST_NAME_DESC STATUS_ASC STATUS_DESC TYPE_ASC TYPE_DESC POSITION_ASC } "Roles that a user can have in an organization" enum OrganizationMembershipRole { "The user is a standard member of the organization (includes providers)" STANDARD "The user is a support member of the organization" SUPPORT } "Describes who built the product and/or the API integration connecting it to Healthie" enum PartnerType { "The partner company built both the product and the API integration that connects it to Healthie" HARBOR_PARTNER "Healthie built both the product itself and the API integration that connects it to Healthie" HEALTHIE_APP "Healthie built the API integration that connects a third-party product to Healthie, but did not build the product itself" HEALTHIE_INTEGRATION "The partner built the product; Keragon handles the API communication between it and Healthie" KERAGON } "Whether a claim is primary or secondary" enum PayerOrder { "Primary claim" PRIMARY "Secondary claim" SECONDARY } "Coordination-of-benefits position for a line payment" enum PayerResponsibility { PRIMARY SECONDARY TERTIARY } "The source used to populate the address shown on the letterhead." enum PdfLetterheadTemplateAddressSource { ORGANIZATION CURRENT_USER PRIMARY_PROVIDER OTHER } "The source used to populate the brand logo shown on the letterhead." enum PdfLetterheadTemplateBrandLogoSource { ORGANIZATION CURRENT_USER PRIMARY_PROVIDER } "The source used to populate the email address shown on the letterhead." enum PdfLetterheadTemplateEmailSource { ORGANIZATION CURRENT_USER PRIMARY_PROVIDER OTHER } "The source used to populate the phone number shown on the letterhead." enum PdfLetterheadTemplatePhoneNumberSource { ORGANIZATION CURRENT_USER PRIMARY_PROVIDER OTHER } "The source used to populate the team member name shown on the letterhead." enum PdfLetterheadTemplateTeamMemberNameSource { CURRENT_USER PRIMARY_PROVIDER } "The different types of phases that can be passed into the phased_available_slots_for_range query" enum PhasedAppointmentType { BACK_TO_BACK CONCURRENT_START } "Enum for sorting prescription medications" enum PrescriptionMedicationOrderBy { "Sort by name in ascending order" NAME_ASC "Sort by name in descending order" NAME_DESC "Sort by start date in ascending order" START_DATE_ASC "Sort by start date in descending order" START_DATE_DESC "Sort by status in ascending order" STATUS_ASC "Sort by status in descending order" STATUS_DESC "Sort by active status first" ACTIVE_FIRST "Sort by inactive status first" INACTIVE_FIRST "Sort by error status first" ERROR_FIRST "Sort by pending status first" PENDING_FIRST } "Prescription medication status type filter enum" enum PrescriptionMedicationStatus { "(prescriptions and medications)" ACTIVE "(prescriptions and medications)" ERROR "(prescriptions and medications) has a future start date" FUTURE "(prescriptions and medications)" HIDDEN "(prescriptions and medications) Marked inactive by the user or past its end date" INACTIVE "(prescriptions only)" PENDING "(prescriptions only)" REORDERED } "Enum for the type of medication" enum PrescriptionMedicationTypeEnum { "A prescription medication" PRESCRIPTION "A general medication" MEDICATION } "Product sorting enum" enum ProductOrderKeys { NAME_ASC NAME_DESC QUANTITY_ASC QUANTITY_DESC PRICE_ASC PRICE_DESC CREATED_AT_ASC CREATED_AT_DESC } "ReceivedDirectMessage sorting enum" enum ReceivedDirectMessageOrderKeys { CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "ReceivedFax sorting enum" enum ReceivedFaxOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NUMBER_ASC NUMBER_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "ReferringPhysician sorting enum" enum ReferringPhysicianOrderKeys { NAME_ASC NAME_DESC BUSINESS_NAME_ASC BUSINESS_NAME_DESC SPECIALITY_ASC SPECIALITY_DESC CITY_ASC CITY_DESC CLIENTS_REFERRED_ASC CLIENTS_REFERRED_DESC } "How reimbursement is tracked for a claim" enum ReimbursementTracking { LEGACY LINE_PAYMENT } "RequestedPayment sorting enum" enum RequestedPaymentOrderKeys { "Sort by client last name and first name ascending" CLIENT_NAME_ASC "Sort by client last name and first name descending" CLIENT_NAME_DESC "Sort by provider last name and first name ascending" PROVIDER_NAME_ASC "Sort by provider last name and first name descending" PROVIDER_NAME_DESC PRICE_ASC PRICE_DESC CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC STATUS_ASC STATUS_DESC TYPE_ASC TYPE_DESC INVOICE_ID_ASC INVOICE_ID_DESC WRITE_OFF_AMOUNT_ASC WRITE_OFF_AMOUNT_DESC BALANCE_DUE_ASC BALANCE_DUE_DESC SERVICE_DATE_ASC SERVICE_DATE_DESC } "Requested Payment statuses" enum RequestedPaymentStatus { "Paid" PAID "Not_Yet_Paid" NOT_YET_PAID "Partial" PARTIAL } "SentDirectMessage sorting enum" enum SentDirectMessageOrderKeys { CREATED_AT_ASC CREATED_AT_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "Options of what patient XML formats to include in the message" enum SentDirectMessageXml { cda referral_note } "SentFax sorting enum" enum SentFaxOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NUMBER_ASC NUMBER_DESC STATUS STATUS_ASC STATUS_DESC CLIENT_LAST_NAME_ASC CLIENT_LAST_NAME_DESC SENDER_LAST_NAME_ASC SENDER_LAST_NAME_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "SentWebhook sorting enum" enum SentWebhookOrderKeys { CREATED_AT_ASC CREATED_AT_DESC EVENT_TYPE_ASC EVENT_TYPE_DESC URL_ASC URL_DESC } "Types of resources that can trigger webhooks" enum SentWebhookResourceType { "AcceptedInsurancePlan" ACCEPTED_INSURANCE_PLAN "AllergySensitivity" ALLERGY_SENSITIVITY "AppliedTag" APPLIED_TAG "Appointment" APPOINTMENT "AppointmentFormAnswerGroupConnection" APPOINTMENT_FORM_ANSWER_GROUP_CONNECTION "Availability" AVAILABILITY "BillingItem" BILLING_ITEM "CarePlan" CARE_PLAN "ChargeBack" CHARGE_BACK "ChartingNoteAddendum" CHARTING_NOTE_ADDENDUM "ClaimSubmission" CLAIM_SUBMISSION "Cms1500" CMS1500 "Comment" COMMENT "CompletedOnboardingItem" COMPLETED_ONBOARDING_ITEM "Conversation" CONVERSATION "ConversationMembership" CONVERSATION_MEMBERSHIP "CourseMembership" COURSE_MEMBERSHIP "CustomModule" CUSTOM_MODULE "CustomModuleForm" CUSTOM_MODULE_FORM "Diagnosis" DIAGNOSIS "Document" DOCUMENT "DocumentSharing" DOCUMENT_SHARING "Entry" ENTRY "ExternalCalendar" EXTERNAL_CALENDAR "FamilyHistoryCondition" FAMILY_HISTORY_CONDITION "FeatureToggle" FEATURE_TOGGLE "FolderSharing" FOLDER_SHARING "FormAnswerGroup" FORM_ANSWER_GROUP "GeneratedFormAnswerGroup" GENERATED_FORM_ANSWER_GROUP "Goal" GOAL "GoalHistory" GOAL_HISTORY "GoalTemplate" GOAL_TEMPLATE "GroupCarePlanUserConnection" GROUP_CARE_PLAN_USER_CONNECTION "InsuranceAuthorization" INSURANCE_AUTHORIZATION "LabOrder" LAB_ORDER "LabResult" LAB_RESULT "Location" LOCATION "Medication" MEDICATION "Note" NOTE "NoteScheduler" NOTE_SCHEDULER "NotificationContact" NOTIFICATION_CONTACT "NotificationSetting" NOTIFICATION_SETTING "OrganizationInfo" ORGANIZATION_INFO "OrganizationMember" ORGANIZATION_MEMBER "OrganizationMembership" ORGANIZATION_MEMBERSHIP "OtherIdNumber" OTHER_ID_NUMBER "PatientEducationalResource" PATIENT_EDUCATIONAL_RESOURCE "Policy" POLICY "Prescription" PRESCRIPTION "ReceivedDirectMessage" RECEIVED_DIRECT_MESSAGE "ReceivedFax" RECEIVED_FAX "RecurringPayment" RECURRING_PAYMENT "Referral" REFERRAL "ReferringPhysician" REFERRING_PHYSICIAN "RequestedFormCompletion" REQUESTED_FORM_COMPLETION "RequestedPayment" REQUESTED_PAYMENT "SentFax" SENT_FAX "SentNotificationRecord" SENT_NOTIFICATION_RECORD "StripeCustomerDetail" STRIPE_CUSTOMER_DETAIL "SuperBill" SUPER_BILL "Task" TASK "User" USER } "Accepted values for a `sex` form answer" enum Sex { MALE FEMALE } "The shareable record type enum" enum ShareableType { DOCUMENT FOLDER } "The type of offered signed stream names" enum SignedStreamName { "For new/updated notes in a conversation" NOTES "For a user's conversation membership updates" CONVERSATION_MEMBERSHIPS "For a user's notification count updates" USER_NOTIFICATIONS_COUNT "For per-appointment device-availability updates" APPOINTMENT_USER_DEVICES "For completion of adding clients to a group appointment, in both the create and update flows" GROUP_APPOINTMENT_CLIENTS_ADDED } "Smart Phrase Order enum" enum SmartPhraseOrderKeys { CREATED_AT_ASC CREATED_AT_DESC NAME_ASC NAME_DESC UPDATED_AT_ASC UPDATED_AT_DESC } "What generated a smart task (the AI scribe, or a workflow)" enum SmartSource { WORKFLOW SCRIBE } "StripeCustomerDetails sorting enum" enum StripeCustomerDetailOrderKeys { EXPIRATION_DATE_DESC EXPIRATION_DATE_ASC PATIENT_FIRST_NAME_ASC PATIENT_FIRST_NAME_DESC CREATED_AT_ASC CREATED_AT_DESC } "The status of a subscription" enum SubscriptionStatus { "Subscription is active and in good standing" ACTIVE "Subscription is in trial period" TRIALING "Subscription access is blocked" LOCKED_OUT "Subscription has been canceled" CANCELED "Subscription status cannot be determined" UNKNOWN } "SuperBill sorting enum" enum SuperBillOrderKeys { NAME_ASC NAME_DESC SERVICE_DATE_ASC SERVICE_DATE_DESC AMOUNT_PAID_ASC AMOUNT_PAID_DESC AMOUNT_BILLED_ASC AMOUNT_BILLED_DESC STATUS CREATED_AT_ASC CREATED_AT_DESC } "Tag sorting enum" enum TagOrderKeys { NAME_ASC NAME_DESC "Sort by amount of patients applied to this Tag descending" ACTIVE_USERS_DESC "Sort by amount of patients applied to this Tag ascending" ACTIVE_USERS_ASC "Sort by the first name of the user who added the Tag descending" ADDED_BY_DESC "Sort by the first name of the user who added the Tag ascending" ADDED_BY_ASC "Sort by amount of organization members applied to this Tag ascending" ORG_MEMBERS_ASC "Sort by amount of organization members applied to this Tag descending" ORG_MEMBERS_DESC } "Task sorting enum" enum TaskOrderKeys { TASK_ASC TASK_DESC CREATOR_ASC CREATOR_DESC ASSIGNEE_ASC ASSIGNEE_DESC CREATED_ASC CREATED_DESC PRIORITY_ASC PRIORITY_DESC DUE_DATE_ASC DUE_DATE_DESC "Order by client first name and last name descending" CLIENT_NAME_DESC "Order by client first name and last name ascending" CLIENT_NAME_ASC "Order by completion date ascending (earlier completed tasks first)" COMPLETED_AT_ASC "Order by completion date descending (recently completed tasks first)" COMPLETED_AT_DESC COMPLETED_AT_DESC_INCOMPLETE_FIRST UPDATED_AT_ASC UPDATED_AT_DESC } "Status of transcript processing" enum TranscriptStatusEnum { "Transcript is currently being processed" processing "Transcript processing has completed successfully" completed "Transcript processing has failed" failed "Transcript processing was interrupted but partial content is available" incomplete } "Types of transcripts" enum TranscriptTypeEnum { "Transcript captured in real-time during the meeting" realtime_capture "Transcript generated from processed recording" processed_recording } "Transfer sorting enum" enum TransferOrderKeys { CREATED_AT_ASC CREATED_AT_DESC AMOUNT_DESC AMOUNT_ASC STATUS_DESC STATUS_ASC EXPECTED_TO_HAPPEN_ASC EXPECTED_TO_HAPPEN_DESC TRANSACTIONS_COUNT_ASC TRANSACTIONS_COUNT_DESC } "UserGroup sorting enum" enum UserGroupOrderKeys { INVITE_CODE_ASC INVITE_CODE_DESC CREATED_AT_ASC CREATED_AT_DESC NAME_ASC NAME_DESC USERS_COUNT_ASC USERS_COUNT_DESC } "User sorting enum" enum UserOrderKeys { EMAIL_ASC EMAIL_DESC FIRST_NAME_ASC FIRST_NAME_DESC LAST_NAME_DESC LAST_NAME_ASC CREATED_AT_DESC CREATED_AT_ASC UPDATED_AT_DESC UPDATED_AT_ASC GROUP_NAME_ASC GROUP_NAME_DESC PROVIDER_NAME_ASC PROVIDER_NAME_DESC NEXT_APPT_DATE_ASC NEXT_APPT_DATE_DESC } "Types of webhook events that can be triggered" enum WebhookEventType { "accepted_insurance_plan.created" ACCEPTED_INSURANCE_PLAN_CREATED "accepted_insurance_plan.deleted" ACCEPTED_INSURANCE_PLAN_DELETED "allergy_sensitivity.created" ALLERGY_SENSITIVITY_CREATED "allergy_sensitivity.deleted" ALLERGY_SENSITIVITY_DELETED "allergy_sensitivity.updated" ALLERGY_SENSITIVITY_UPDATED "applied_tag.created" APPLIED_TAG_CREATED "applied_tag.deleted" APPLIED_TAG_DELETED "appointment.created" APPOINTMENT_CREATED "appointment.deleted" APPOINTMENT_DELETED "appointment.participant_joined" APPOINTMENT_PARTICIPANT_JOINED "appointment.participant_joined_waiting_room" APPOINTMENT_PARTICIPANT_JOINED_WAITING_ROOM "appointment.participant_left" APPOINTMENT_PARTICIPANT_LEFT "appointment.participant_left_waiting_room" APPOINTMENT_PARTICIPANT_LEFT_WAITING_ROOM "appointment.patient_added" APPOINTMENT_PATIENT_ADDED "appointment.patient_removed" APPOINTMENT_PATIENT_REMOVED "appointment.recording_completed" APPOINTMENT_RECORDING_COMPLETED "appointment.recording_started" APPOINTMENT_RECORDING_STARTED "appointment.recording_stopped" APPOINTMENT_RECORDING_STOPPED "appointment.transcript_available" APPOINTMENT_TRANSCRIPT_AVAILABLE "appointment.transcript_failed" APPOINTMENT_TRANSCRIPT_FAILED "appointment.transcript_started" APPOINTMENT_TRANSCRIPT_STARTED "appointment.updated" APPOINTMENT_UPDATED "appointment_form_answer_group_connection.created" APPOINTMENT_FORM_ANSWER_GROUP_CONNECTION_CREATED "appointment_form_answer_group_connection.deleted" APPOINTMENT_FORM_ANSWER_GROUP_CONNECTION_DELETED "appointment_form_answer_group_connection.updated" APPOINTMENT_FORM_ANSWER_GROUP_CONNECTION_UPDATED "availability.created" AVAILABILITY_CREATED "availability.deleted" AVAILABILITY_DELETED "availability.updated" AVAILABILITY_UPDATED "billing_item.created" BILLING_ITEM_CREATED "billing_item.deleted" BILLING_ITEM_DELETED "billing_item.updated" BILLING_ITEM_UPDATED "care_plan.activated" CARE_PLAN_ACTIVATED "care_plan.created" CARE_PLAN_CREATED "care_plan.deactivated" CARE_PLAN_DEACTIVATED "care_plan.deleted" CARE_PLAN_DELETED "care_plan.updated" CARE_PLAN_UPDATED "charge_back.created" CHARGE_BACK_CREATED "charge_back.deleted" CHARGE_BACK_DELETED "charge_back.updated" CHARGE_BACK_UPDATED "charting_note_addendum.created" CHARTING_NOTE_ADDENDUM_CREATED "charting_note_addendum.deleted" CHARTING_NOTE_ADDENDUM_DELETED "charting_note_addendum.updated" CHARTING_NOTE_ADDENDUM_UPDATED "claim_submission.created" CLAIM_SUBMISSION_CREATED "claim_submission.deleted" CLAIM_SUBMISSION_DELETED "claim_submission.updated" CLAIM_SUBMISSION_UPDATED "cms1500.created" CMS1500_CREATED "cms1500.deleted" CMS1500_DELETED "cms1500.reimbursement_updated" CMS1500_REIMBURSEMENT_UPDATED "cms1500.updated" CMS1500_UPDATED "comment.created" COMMENT_CREATED "comment.deleted" COMMENT_DELETED "comment.updated" COMMENT_UPDATED "completed_onboarding_item.created" COMPLETED_ONBOARDING_ITEM_CREATED "completed_onboarding_item.deleted" COMPLETED_ONBOARDING_ITEM_DELETED "completed_onboarding_item.updated" COMPLETED_ONBOARDING_ITEM_UPDATED "conversation.created" CONVERSATION_CREATED "conversation.updated" CONVERSATION_UPDATED "conversation_membership.created" CONVERSATION_MEMBERSHIP_CREATED "conversation_membership.deleted" CONVERSATION_MEMBERSHIP_DELETED "conversation_membership.viewed" CONVERSATION_MEMBERSHIP_VIEWED "course_membership.created" COURSE_MEMBERSHIP_CREATED "course_membership.deleted" COURSE_MEMBERSHIP_DELETED "course_membership.updated" COURSE_MEMBERSHIP_UPDATED "custom_module.created" CUSTOM_MODULE_CREATED "custom_module.deleted" CUSTOM_MODULE_DELETED "custom_module.updated" CUSTOM_MODULE_UPDATED "custom_module_form.created" CUSTOM_MODULE_FORM_CREATED "custom_module_form.deleted" CUSTOM_MODULE_FORM_DELETED "custom_module_form.updated" CUSTOM_MODULE_FORM_UPDATED "diagnosis.created" DIAGNOSIS_CREATED "diagnosis.deleted" DIAGNOSIS_DELETED "diagnosis.updated" DIAGNOSIS_UPDATED "document.created" DOCUMENT_CREATED "document.deleted" DOCUMENT_DELETED "document.updated" DOCUMENT_UPDATED "document_sharing.created" DOCUMENT_SHARING_CREATED "document_sharing.deleted" DOCUMENT_SHARING_DELETED "document_sharing.updated" DOCUMENT_SHARING_UPDATED "dosespot_notification.created" DOSESPOT_NOTIFICATION_CREATED "entry.created" ENTRY_CREATED "entry.deleted" ENTRY_DELETED "entry.updated" ENTRY_UPDATED "external_calendar.authorization_error" EXTERNAL_CALENDAR_AUTHORIZATION_ERROR "family_history_condition.created" FAMILY_HISTORY_CONDITION_CREATED "family_history_condition.deleted" FAMILY_HISTORY_CONDITION_DELETED "family_history_condition.updated" FAMILY_HISTORY_CONDITION_UPDATED "feature_toggle.created" FEATURE_TOGGLE_CREATED "feature_toggle.deleted" FEATURE_TOGGLE_DELETED "feature_toggle.updated" FEATURE_TOGGLE_UPDATED "folder_sharing.created" FOLDER_SHARING_CREATED "folder_sharing.deleted" FOLDER_SHARING_DELETED "form_answer_group.created" FORM_ANSWER_GROUP_CREATED "form_answer_group.deleted" FORM_ANSWER_GROUP_DELETED "form_answer_group.locked" FORM_ANSWER_GROUP_LOCKED "form_answer_group.signed" FORM_ANSWER_GROUP_SIGNED "form_answer_group.unlocked" FORM_ANSWER_GROUP_UNLOCKED "generated_form_answer_group.converted" GENERATED_FORM_ANSWER_GROUP_CONVERTED "generated_form_answer_group.created" GENERATED_FORM_ANSWER_GROUP_CREATED "generated_form_answer_group.deleted" GENERATED_FORM_ANSWER_GROUP_DELETED "generated_form_answer_group.rejected" GENERATED_FORM_ANSWER_GROUP_REJECTED "generated_form_answer_group.updated" GENERATED_FORM_ANSWER_GROUP_UPDATED "goal.created" GOAL_CREATED "goal.deleted" GOAL_DELETED "goal.updated" GOAL_UPDATED "goal_history.created" GOAL_HISTORY_CREATED "goal_history.deleted" GOAL_HISTORY_DELETED "goal_template.created" GOAL_TEMPLATE_CREATED "goal_template.deleted" GOAL_TEMPLATE_DELETED "goal_template.updated" GOAL_TEMPLATE_UPDATED "insurance_authorization.created" INSURANCE_AUTHORIZATION_CREATED "insurance_authorization.deleted" INSURANCE_AUTHORIZATION_DELETED "insurance_authorization.updated" INSURANCE_AUTHORIZATION_UPDATED "lab_order.created" LAB_ORDER_CREATED "lab_order.updated" LAB_ORDER_UPDATED "lab_result.created" LAB_RESULT_CREATED "lab_result.updated" LAB_RESULT_UPDATED "location.created" LOCATION_CREATED "location.deleted" LOCATION_DELETED "location.updated" LOCATION_UPDATED "medication.created" MEDICATION_CREATED "medication.deleted" MEDICATION_DELETED "medication.updated" MEDICATION_UPDATED "message.created" MESSAGE_CREATED "message.deleted" MESSAGE_DELETED "metric_entry.created" METRIC_ENTRY_CREATED "metric_entry.deleted" METRIC_ENTRY_DELETED "metric_entry.updated" METRIC_ENTRY_UPDATED "notification_contact.created" NOTIFICATION_CONTACT_CREATED "notification_contact.deleted" NOTIFICATION_CONTACT_DELETED "notification_contact.updated" NOTIFICATION_CONTACT_UPDATED "notification_setting.created" NOTIFICATION_SETTING_CREATED "notification_setting.deleted" NOTIFICATION_SETTING_DELETED "notification_setting.updated" NOTIFICATION_SETTING_UPDATED "organization_info.created" ORGANIZATION_INFO_CREATED "organization_info.deleted" ORGANIZATION_INFO_DELETED "organization_info.updated" ORGANIZATION_INFO_UPDATED "organization_member.updated" ORGANIZATION_MEMBER_UPDATED "organization_membership.created" ORGANIZATION_MEMBERSHIP_CREATED "organization_membership.updated" ORGANIZATION_MEMBERSHIP_UPDATED "other_id_number.created" OTHER_ID_NUMBER_CREATED "other_id_number.deleted" OTHER_ID_NUMBER_DELETED "other_id_number.updated" OTHER_ID_NUMBER_UPDATED "patient.created" PATIENT_CREATED "patient.merged" PATIENT_MERGED "patient.updated" PATIENT_UPDATED "patient_educational_resource.created" PATIENT_EDUCATIONAL_RESOURCE_CREATED "patient_educational_resource.deleted" PATIENT_EDUCATIONAL_RESOURCE_DELETED "patient_educational_resource.updated" PATIENT_EDUCATIONAL_RESOURCE_UPDATED "policy.created" POLICY_CREATED "policy.deleted" POLICY_DELETED "policy.updated" POLICY_UPDATED "prescription.medication_status_updated" PRESCRIPTION_MEDICATION_STATUS_UPDATED "prescription.updated" PRESCRIPTION_UPDATED "received_direct_message.created" RECEIVED_DIRECT_MESSAGE_CREATED "received_fax.created" RECEIVED_FAX_CREATED "recurring_payment.created" RECURRING_PAYMENT_CREATED "recurring_payment.updated" RECURRING_PAYMENT_UPDATED "referral.created" REFERRAL_CREATED "referral.deleted" REFERRAL_DELETED "referral.updated" REFERRAL_UPDATED "referring_physician.created" REFERRING_PHYSICIAN_CREATED "referring_physician.deleted" REFERRING_PHYSICIAN_DELETED "referring_physician.updated" REFERRING_PHYSICIAN_UPDATED "requested_form_completion.created" REQUESTED_FORM_COMPLETION_CREATED "requested_form_completion.deleted" REQUESTED_FORM_COMPLETION_DELETED "requested_form_completion.updated" REQUESTED_FORM_COMPLETION_UPDATED "requested_payment.created" REQUESTED_PAYMENT_CREATED "requested_payment.deleted" REQUESTED_PAYMENT_DELETED "requested_payment.updated" REQUESTED_PAYMENT_UPDATED "scheduled_message.sent" SCHEDULED_MESSAGE_SENT "sent_fax.created" SENT_FAX_CREATED "sent_fax.status_changed" SENT_FAX_STATUS_CHANGED "sent_fax.updated" SENT_FAX_UPDATED "sent_notification_record.created" SENT_NOTIFICATION_RECORD_CREATED "sent_notification_record.updated" SENT_NOTIFICATION_RECORD_UPDATED "stripe_customer_detail.created" STRIPE_CUSTOMER_DETAIL_CREATED "stripe_customer_detail.deleted" STRIPE_CUSTOMER_DETAIL_DELETED "stripe_customer_detail.updated" STRIPE_CUSTOMER_DETAIL_UPDATED "super_bill.created" SUPER_BILL_CREATED "super_bill.deleted" SUPER_BILL_DELETED "super_bill.updated" SUPER_BILL_UPDATED "task.created" TASK_CREATED "task.deleted" TASK_DELETED "task.updated" TASK_UPDATED "test.created" TEST_CREATED } "Webhook sorting enum" enum WebhookOrderKeys { CREATED_AT_ASC CREATED_AT_DESC EVENT_TYPE_ASC EVENT_TYPE_DESC URL_ASC URL_DESC } "Write-off type enum" enum WriteOffType { DISCOUNT UNCOLLECTABLE FINANCIAL_HARDSHIP BILLING_ERROR OTHER } "Types of Zoom recording files" enum ZoomRecordingFileTypeEnum { "Video recording file" MP4 "Audio-only recording file" M4A "Audio transcript file" TRANSCRIPT "Recording chat text file" CHAT "Closed caption file" CC "Timeline file for the recording" TIMELINE "Thumbnail image of the recording" THUMBNAIL } "Status of Zoom recording files" enum ZoomRecordingStatusEnum { "The recording is still being processed" processing "The recording is ready to be viewed" completed "The recording failed to process" failed } "Types of Zoom recordings" enum ZoomRecordingTypeEnum { "Recording with shared screen and speaker view" shared_screen_with_speaker_view "Recording with shared screen and gallery view" shared_screen_with_gallery_view "Recording with only speaker view" speaker_view "Recording with only gallery view" gallery_view "Recording with only shared screen" shared_screen "Audio-only recording" audio_only "Recording focused on the active speaker" active_speaker "a transcript-only recording" audio_transcript "a timeline with timestamps of the recording" timeline "Recording with shared screen and speaker view (CC)" shared_screen_with_speaker_view_cc } "Input for an automation action" input ActionInput { "User-defined action identifier within the step" action_identifier: String! "The GraphQL mutation to execute" action_type: AutomationActionKind! """ Mutation arguments with optional template variables. Example: {"arguments": {"content": "Complete onboarding for {{query-patient.first_name}}", "user_id": "{{query-patient.dietitian_id}}"}} """ config: JSON = {} } "Payload for added user as a label-value pair" input AddedUsersInput { "The label for the user" label: String! "The labeled value" value: ID! } "Payload for an advance appointment price" input AdvanceAppointmentPriceInput { "The ID of the appointment type" appointment_type_id: ID "The ID of the price" id: ID "The price of the appointment type" price: String } "Payload for overriding an advance appointment price" input AdvanceAppointmentPricesInput { "The ID of the appointment type" appointment_type_id: ID "The ID of the price" id: ID "The price of the appointment type" price: String "The ID of the user" user_id: ID } "Announcement image upload" input AnnouncementImageUpload { "The announcement image" image: Upload } "Attributes for an appointment autocomplete form" input AppointmentAutocompleteFormCreateInput { "The custom module form used for AI scribe" custom_module_form_id: ID! } "Attributes for an appointment autocomplete form" input AppointmentAutocompleteFormUpdateInput { "The ID of the appointment autocomplete form" id: ID "If true, will destroy the autocomplete form association" _destroy: Boolean "The custom module form used for AI scribe" custom_module_form_id: ID } "Payload for an appointment location" input AppointmentLocationInput { "If true, the location will be deleted" _destroy: Boolean "If true, clients can book appointments at this location" clients_can_book: Boolean "If true, this location has rooms" has_rooms: Boolean "The ID of the location" id: ID "The graphql_name of the location" location: String "The rooms at this location" rooms: [RoomInput] } "Payload for a time slot for an appointment request" input AppointmentRequestSlotInput { "The unique identifier of the appointment request slot" id: ID "The start time of the requested appointment availability" slot_start: ISO8601DateTime! "The end time of the requested appointment availability" slot_end: ISO8601DateTime! } "Payload for an appointment setting" input AppointmentTypeAppointmentSettingInput { "If true, the appointment setting will be deleted" _destroy: Boolean "Whether the appointment setting allows appointment type pricing" allow_appointment_type_pricing: Boolean "Whether the appointment setting allows clients to cancel appointments" allow_clients_to_cancel_appt: Boolean "Whether the appointment setting allows clients to reschedule appointments" allow_clients_to_reschedule_appt: Boolean "Whether the appointment setting allows past appointment rescheduling" allow_past_appointment_rescheduling: Boolean "Whether the appointment setting allows specific client pricing" allow_specific_client_pricing: Boolean "Whether the appointment setting allows specific provider pricing" allow_specific_provider_pricing: Boolean "Whether the appointment setting overrides the appointment type reminder" appointment_type_reminder_override: Boolean "The booking interval restriction for the appointment setting" booking_interval_restriction: Int "The buffer time for the appointment setting" buffer: String "Whether the appointment setting charges for occurred appointments" charge_for_occurred_appts: Boolean "The disallowed reschedulable statuses for the appointment setting" disallowed_reschedulable_statuses: [String] "The ID of the appointment setting" id: ID "Whether the appointment setting invoices clients without a payment method" invoice_clients_without_payment_method: Boolean "The maximum number of days in the future when appointments can be scheduled" max_days_in_future: String "Prevents the patient from canceling too close the appointment time. In minutes" minimum_advance_cancel_time: Int "Prevents the patient from rescheduling too close the appointment time. In minutes" minimum_advance_reschedule_time: Int "Prevents the patient from scheduling too close to the desired appointment time. In minutes" minimum_advance_schedule_time: Int "The maximum number of times a patient can reschedule an appointment" patient_reschedule_count_cap: String "Whether the appointment setting prevents booking without credit" prevent_no_credit_booking: Boolean "Whether the appointment setting allows appointment requests" enable_appointment_requests: Boolean "The pricing for the appointment setting" pricing: String "Whether the appointment setting allows same day appointments" same_day_appointments: Boolean "Whether the appointment setting sends a booking notice" send_booking_notice: Boolean "Whether the appointment setting sends a reminder four days before the appointment" send_reminder_four_days_before: Boolean "Whether the appointment setting sends a reminder one day before the appointment" send_reminder_one_day_before: Boolean "Whether the appointment setting sends a reminder one hour before the appointment" send_reminder_one_hour_before: Boolean "Whether the appointment setting sends a reminder three days before the appointment" send_reminder_three_days_before: Boolean "Whether the appointment setting sends a reminder two days before the appointment" send_reminder_two_days_before: Boolean "Whether the appointment setting sends a reminder two hours before the appointment" send_reminder_two_hours_before: Boolean "Whether the appointment setting sends a text reminder four days before the appointment" send_text_reminder_four_days_before: Boolean "Whether the appointment setting sends a text reminder one day before the appointment" send_text_reminder_one_day_before: Boolean "Whether the appointment setting sends a text reminder one hour before the appointment" send_text_reminder_one_hour_before: Boolean "Whether the appointment setting sends a text reminder three days before the appointment" send_text_reminder_three_days_before: Boolean "Whether the appointment setting sends a text reminder two days before the appointment" send_text_reminder_two_days_before: Boolean "Whether the appointment setting sends a text reminder two hours before the appointment" send_text_reminder_two_hours_before: Boolean "Whether the appointment setting uses the client credit system" use_client_credit_system: Boolean "Whether the appointment setting sends an email when the appointment is cancelled" send_appointment_cancellation_email: Boolean "Whether the appointment setting sends an email when the appointment is updated" send_appointment_update_email: Boolean "Whether the appointment setting sends a confirmation email to the client when the client initially books an appointment" send_embeddable_appt_creator_email: Boolean } "Payload for a CPT code associated with an appointment type" input AppointmentTypeCptCode { "The ID of the CPT code" cpt_code_id: String "Fee (in cents) per unit" fee_per_unit: Int "The number of units for the CPT code" units: String } "Payload for appointment type credit" input AppointmentTypeCreditInput { "The appointment type ID of the credit" appointment_type_id: String "The ID of the credit" id: ID "The quantity of the credit" quantity: String } "Payload for connecting an appointment type to a custom module form" input AppointmentTypeFormConnectionInput { "If true, the appointment type form connection will be destroyed" _destroy: Boolean "The ID of the custom module form" custom_module_form_id: ID "The ID of the appointment type form connection" id: ID "Form requests will be sent before or after given interval, depends on `send_trigger`" interval: ISO8601Duration } "Which appointment types an availability covers. Provide exactly one option." input AppointmentTypeSelectionInput { "Specific non-group appointment types this availability covers." ids: [ID!] "When true, covers every non-group appointment type the provider owns, including ones added later." all_non_group: Boolean } "Payload for an AttendedClient" input AttendedClientsInput { "If the client attended the event" attended: Boolean "If the client cancelled the event" cancelled: Boolean "Reason for cancellation" cancellation_reason: String "Other reason for cancellation" other_cancellation_reason: String "If the client confirmed the event" confirmed: Boolean "The unique identifier of the object" id: ID "The ID of the user" user_id: ID } "Payload for an availability" input AvailabilityInput { "The ID of the appointment location" appointment_location_id: String "The ID of the appointment type" appointment_type_id: String "The ID of the contact type" contact_type_id: String "The day of the week for the availability" day_of_week: Int "The end time for the availability" end_time: String "Whether the availability is repeating" is_repeating: Boolean "The end of the availability range" range_end: String "The start of the availability range" range_start: String "The time for the availability" time: String "The timezone for the availability" timezone: String "The ID of the user" user_id: String } "Structured BMI input for a BMI form answer" input BMIAnswerInput { "Height (inches for BMI(in.), cm for BMI(cm))" height: Float "Weight (lbs for BMI(in.), kg for BMI(cm))" weight: Float "Calculated BMI value" bmi: Float } "Payload for a benefit" input BenefitInput { "If true, the benefit will be deleted" _destroy: Boolean "The category of the benefit" category: String "The coinsurance for the benefit" coinsurance: String "The copay for the benefit" copay: String "The deductible calendar year for the benefit" deductible_calendar_year: String "The deductible year to date for the benefit" deductible_year_to_date: String "The id of the benefit" id: ID "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "Whether or not the benefit covers telemedicine" telemedicine: Boolean } "Payload for a billing address to create a new Healthie subscription." input BillingAddressInput { "The city" city: String "The country code" country: String "The first line of the address" line1: String "The second line of the address" line2: String "The state" state: String "The zip code" postal_code: String } "Autogenerated input type of BulkDeleteAvailability" input BulkDeleteAvailabilityInput { "Array of availability IDs to delete (max 200)" ids: [ID!]! } "Payload for a new entry" input BulkEntryInput { "Check and either add to pre-existing average heart rate entry or create a new one" add_to_avg_heart_rate: Boolean "The category of the entry" category: String "Check for duplicates, currently only supported if third_party_source is apple_health" check_duplicates: Boolean "The time the entry was created" created_at: String "The description of the entry" description: String "ED Post Hunger" ed_posthunger: String "ED Pre Hunger" ed_prehunger: String "The comma separated list of emotions" emotions: String "If average of any type, value indicates amount of entries already included in average" entries_in_average: String "Third party external ID associated with this entry" external_id: String "Third party associated with the external ID on this entry. Option currently supported is 'AppleHealth'" external_id_type: String "The image associated with the entry" image: Upload "The base64 encoded image string" image_string: String "The statistic associated with the metric entry" metric_stat: String "If true, will trigger a notification to the provider based on the provider settings. If nil or false will trigger a notification to the provider if the poster is a patient." notify_provider: Boolean "The percieved hungriness" percieved_hungriness: String "The reflection on the entry" reflection: String "The list of subentries associated with this entry" subentries: [SubentryInput] "Options are apple_health, google_fit, or fitbit" third_party_source: String "One of MetricEntry, FoodEntry, WorkoutEntry, MirrorEntry, SleepEntry, NoteEntry, WaterIntakeEntry, PoopEntry, SymptomEntry" type: String "The ID of the user that created the entry" user_id: String } "Payload for a calendar color scheme" input CalendarColorSchemeInput { "If true, the calendar color scheme will be deleted" _destroy: Boolean "The field, by which the color code is determined. Maximum character limit of 50." color_code_by: String "The color codes of the calendar color scheme" color_codes: [ColorCodeInput] "The default color code. Maximum character limit of 8." default_color: String "The ID of the calendar color scheme" id: ID } "Payload for a CallReference" input CallReferenceInput { "The date the call was recorded" date_recorded: String "The ID of the CallReference" id: ID "Notes about the call" notes: String "The reference number for the call" reference_number: String "The time the call was recorded" time_recorded: String } "Payload for a cancellation reason option" input CancellationReasonOptionInput { "The ID of the cancellation reason option" id: ID "Who initiated the cancellation" initiated_by: CancellationReasonTypeEnum "The other cancellation reason text" other_cancellation_reason: String } "Autogenerated input type of ChangeDevicesAvailability" input ChangeDevicesAvailabilityInput { appointment_id: String devices_unavailability: Boolean } "Payload for a chargeback evidence" input ChargeBackEvidenceInput { "The billing address of the customer" billing_address: String "The cancellation policy file" cancellation_policy: Upload "The disclosure of the cancellation policy" cancellation_policy_disclosure: String "The rebuttal of the cancellation" cancellation_rebuttal: String "The communication with the customer" customer_communication: Upload "The email address of the customer" customer_email_address: String "The name of the customer" customer_name: String "The description of the product" product_description: String "The refund policy file" refund_policy: Upload "The disclosure of the refund policy" refund_policy_disclosure: String "The explanation of the refund refusal" refund_refusal_explanation: String "The uncategorized file related to the chargeback" uncategorized_file: Upload "The uncategorized reason of the chargeback" uncategorized_text: String } "Payload for a group of answers" input CheckoutFormAnswerGroupInput { "The id of the custom module form" custom_module_form_id: String "The list of answers for the form" form_answers: [CheckoutFormAnswerInput] "The id of the form answer group" id: ID } "Payload for an answer" input CheckoutFormAnswerInput { "The answer" answer: String "Some form answers can have more than one value (eg a location form_answer has a line1, line2, city, state, country, and zip). This argument is used to submit all these various values for a single form answer. When present, these values are used instead of the single `answer` value." structured_answer: StructuredAnswerInput "The ID of the custom module" conditional_custom_module_id: ID "The ID of the custom module" custom_module_id: String "The type of the filter" filter_type: String "The mod_type (e.g question type) that is being answered." mod_type: String "Unique ID for the answer" id: ID "The label for the answer" label: String "The ID of the user who created the answer" user_id: String "The value to filter on" value_to_filter: String } "Manual overrides for claim-level COB data on a secondary claim. Only provided fields are updated; omitted fields are left unchanged." input ClaimCobOverridesInput { "Date primary payer adjudicated the claim" primary_adjudication_date: ISO8601Date "Total amount paid by primary insurance" primary_paid_amount: Float } "Manual overrides for line-level COB data on a secondary claim service line. Only provided fields are updated; omitted fields are left unchanged." input ClaimLineCobOverridesInput { "Up to 6 adjustments for this service line" adjustments: [CobAdjustmentInput!] "The ID of the service line to override" cpt_codes_cms1500_id: ID! "Date primary payer adjudicated this service line" line_adjudication_date: ISO8601Date "Amount paid by primary payer for this line" line_paid_amount: Float } "Payload for an insurance plan" input ClientInsurancePlanInput { "The ID of the insurance plan" id: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The name of the payer" payer_name: String } "Payload for a deletable location" input ClientLocationInput { "If true, the location will be deleted" _destroy: Boolean "The city" city: String "The country code" country: String "The ID of the location" id: ID "The first line of the address" line1: String "The second line of the address" line2: String "The graphql_name of the location" name: String "The state" state: String "The zip code" zip: String } "Payload for a client policy" input ClientPolicyInput { "The value (in cents) if insurance billing method is copay" copay_value: Int "The value if insurance billing method is coinsurance" coinsurance_value: Int "If true, the policy will be deleted" _destroy: Boolean "The group number" group_num: String "The date of birth of the policy holder" holder_dob: String "The first name of the policy holder" holder_first: String "The gender of the policy holder" holder_gender: String "The last name of the policy holder" holder_last: String "The location of the policy holder" holder_location: ClientLocationInput "The middle initial of the policy holder" holder_mi: String "The phone number of the policy holder" holder_phone: String "The relationship of the policy holder to the client" holder_relationship: String "The ID of the policy" id: ID "The insurance billing method for this policy (no_billing_method, copay, coinsurance, unmet_deductible)" insurance_billing_method: String "The back of the insurance card" insurance_card_back: Upload "The ID of the back of the insurance card" insurance_card_back_id: String "The front of the insurance card" insurance_card_front: Upload "The ID of the front of the insurance card" insurance_card_front_id: String "The insurance plan" insurance_plan: ClientInsurancePlanInput "The ID of the insurance plan" insurance_plan_id: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The name of the policy" name: String "The policy number" num: String "The location of the payer" payer_location: ClientLocationInput "The policy-related phone number" policy_phone_number: String "The priority type of the policy" priority_type: String "Whether the policy holder has the same address as the client" same_address_as_client: Boolean "The type of the policy" type_string: String "The ID of the user" user_id: String } "Payload for a client portal setting" input ClientPortalSettingInput { "Whether the client can chat with the provider" chat_with_provider: Boolean "The id of the client portal setting" id: ID "Whether the client can schedule appointments" schedule_appointments: Boolean "Whether the client can view and complete forms" view_and_complete_forms: Boolean "Whether the client can view and create goals" view_and_create_goals: Boolean "Whether the client can view and create journal entries" view_and_create_journal_entries: Boolean "Whether the client can view and pay bills" view_and_pay_bills: Boolean "Whether the client can view and purchase packages" view_and_purchase_packages: Boolean "Whether the client can view and upload documents" view_and_upload_documents: Boolean } "Payload for a client source" input ClientSourceInput { "The ID of the client source" id: ID "The source of the client" ref_source: String "The other source of the client" ref_source_other: String "The type of client source" ref_type: String } "Payload for associating a policy with a CMS 1500" input Cms1500PolicyInput { "If true, the join table record will be deleted upon submission" _destroy: Boolean "The ID of the join table record" id: ID "The associated policy" policy: PolicyInput "The ID of the policy" policy_id: String } "Payload for referring physician" input Cms1500ReferringPhysicianInput { "The full name of the referring physician" full_name: String "The ID of the referring physician" id: ID } "A single COB adjustment override (group, reason code, amount)" input CobAdjustmentInput { "Adjustment group code" adjustment_group: AdjustmentGroup "Adjustment dollar amount" amount: Float "CARC adjustment reason code" reason_code: String } "Payload for a ColorCode" input ColorCodeInput { "If the color code should be destroyed" _destroy: Boolean "The code by item of the color code" code_by_item: String "The color of the color code" color: String "The ID of the color code" id: ID } "Autogenerated input type of CompleteCcdaReconciliation" input CompleteCcdaReconciliationInput { id: ID added_problem_ids: [ID] added_medication_ids: [ID] added_allergy_ids: [ID] } "Input for an automation condition" input ConditionInput { "User-defined condition identifier within the step" condition_identifier: String! """ Path to the field to evaluate (e.g., "data.patient.email") """ field: String! "Comparison operator" operator: AutomationConditionOperator! "Value to compare against" value: String } "Payload for overriding a contact type" input ContactTypeOverride { "Whether to show this contact type" show: Boolean! } "Payload for overriding a contact type" input ContactTypeOverrideInput { "The ID of the contact type override" id: ID "The name of the contact type. Maximum character limit of 25." name: String "The position of the contact type" position: Int "Whether or not to show the contact type" show: Boolean } "Course members input as a label-value pair" input CourseMembersInput { "Label for the value" label: String! "Value for the label" value: String! } "Payload for a CPT code on a CMS 1500 form" input CptCodesCms1500Input { "If true, this record will be marked for destruction" _destroy: Boolean "The ID of the CPT code" cpt_code_id: String "The EPSDT code" epsdt: String "The family planning service" family_planning_service: Boolean "The fee for the service" fee: String "The ID of the join record" id: ID "The first modifier" mod1: String "The second modifier" mod2: String "The third modifier" mod3: String "The fourth modifier" mod4: String "The list of pointers to the service line" pointers: [String] "The date of the service" service_date: String "The end date of service (if the line item covers a date range). Can be blank if service was delivered on one day" service_end_date: String "The units for the service" units: String } "Properties assigning a policy to a CPT code" input CptCodesPolicyInput { "If true, the CPT codes policy will be deleted" _destroy: Boolean "The ID of the CPT code" cpt_code_id: String "The ID of the join table record" id: ID "The ID of the policy" policy_id: String } "Payload for a CPT code super bill" input CptCodesSuperBillInput { "If true, the CPT code super bill will be destroyed" _destroy: Boolean "The ID of the CPT code" cpt_code_id: String "The fee" fee: String "The ID of the CPT code super bill" id: ID "The first modifier" mod1: String "The second modifier" mod2: String "The third modifier" mod3: String "The fourth modifier" mod4: String "The list of pointers" pointers: [String] "The date of the service" service_date: String "The number of units" units: String } "Autogenerated input type of CreateAlertTemplate" input CreateAlertTemplateInput { "Short description of the alert template" description: String! "Full text content of the alert template" content: String! } "Autogenerated input type of CreateAutomation" input CreateAutomationInput { "Display name for the automation" name: String! "Description of what the automation does" description: String "Whether the automation is active" is_enabled: Boolean = true "Triggers that initiate this automation" triggers: [TriggerInput!] = [] "Steps in the automation workflow" steps: [StepInput!] = [] } "Autogenerated input type of CreateAvailabilityWithAppointmentTypes" input CreateAvailabilityWithAppointmentTypesInput { "Appointment types this availability covers." appointment_type_ids: [ID!] "When true, the availability covers every non-group appointment type the provider owns. Mutually exclusive with appointment_type_ids." link_all_non_group_types: Boolean "Start of the availability window (ISO 8601 with offset)." start_datetime: ISO8601DateTime! "End of the availability window (ISO 8601 with offset). Must be after start_datetime." end_datetime: ISO8601DateTime! "ID of the provider this availability is for. Defaults to the current user when omitted." user_id: ID "IANA timezone name to persist on the availability record. Defaults to the target provider's timezone." timezone: String "Contact type (delivery mode) to scope this availability to. Required when the org has times_by_contact_type enabled and the booking flow filters slots by contact type." contact_type_id: Int "Appointment location to scope this availability to. Required when the org has times_by_location enabled and the booking flow filters slots by location." appointment_location_id: ID "When true, creates a weekly recurring availability instead of a one-time one. Requires day_of_week." is_repeating: Boolean "Day of week the recurrence falls on (0 = Sunday through 6 = Saturday). Required when is_repeating is true." day_of_week: Int "Optional last date the recurrence is active. Ignored unless is_repeating is true; when omitted the recurrence has no end." end_on: ISO8601Date } "Autogenerated input type of CreateCareAlert" input CreateCareAlertInput { "ID of the patient this alert is for" patient_id: ID! "ID of an AlertTemplate to use as content source" template_id: ID "Custom content for the alert; supersedes template content when both are provided" content: String "Priority level of the alert" priority: CareAlertPriorityEnum "Date when the alert should expire" expires_on: ISO8601Date } "Autogenerated input type of CreateChangeHealthPatient" input CreateChangeHealthPatientInput { id: ID } "Autogenerated input type of CreateClientViaForm" input CreateClientViaFormInput { custom_module_form_id: ID email: String first_name: String form_answers: [FormAnswerInput] last_name: String phone_number: String provider_id: ID "Not in use at this time." send_product_recommendation_email: Boolean } "Autogenerated input type of CreateCustomModuleFileAttachment" input CreateCustomModuleFileAttachmentInput { "The custom module ID to attach the blob to" custom_module_id: ID! "The upload ID that was returned from the createCustomModuleFileAttachmentUploadUrl mutation" upload_id: ID! } "Autogenerated input type of CreateCustomModuleFileAttachmentUploadUrl" input CreateCustomModuleFileAttachmentUploadUrlInput { "The ID of the custom module to attach the file to" custom_module_id: ID! "The name of the file to upload" filename: String! "The size of the file in bytes" byte_size: Int! "The base64 encoded MD5 checksum of the file. This is used to verify the integrity of the file on upload." checksum: String! "The MIME type of the file" content_type: String! } "Autogenerated input type of CreateDocumentDraft" input CreateDocumentDraftInput { "The ID of the original document to copy for editing" document_id: ID! } "Autogenerated input type of CreateEncounterSummary" input CreateEncounterSummaryInput { "ID of the appointment (encounter) to summarize" appointment_id: ID! } "Autogenerated input type of CreateGeneratedSummary" input CreateGeneratedSummaryInput { "ID of the appointment the summary is about" appointment_id: ID! "The summary text" summary: String! } "Autogenerated input type of CreateInternalComment" input CreateInternalCommentInput { "The text content of the comment" content: String! "The object that the comment is linked to" commentable_id: ID! "the object that the comment is linked to" commentable_type: InternalCommentable! } "Autogenerated input type of CreateLinePayment" input CreateLinePaymentInput { "The service line the payment applies to" cpt_codes_cms1500_id: ID! "COB position of the paying payer" payer_responsibility: PayerResponsibility! "Amount the payer paid on this line" paid_amount: Float! "Amount the payer allowed on this line" allowed_amount: Float "Date the payer adjudicated the line" adjudication_date: ISO8601Date! "Payer (insurance plan) identity" insurance_plan_id: ID "Free-text notes" notes: String "CARC adjustments explaining the paid/billed gap" adjustments: [LinePaymentAdjustmentInput] } "Autogenerated input type of CreateLineWriteOff" input CreateLineWriteOffInput { "The service line the write-off applies to" cpt_codes_cms1500_id: ID! "Why the payer balance is being written off" reason: LineWriteOffReason! "Amount written off" amount: Float! "Free-text notes" notes: String } "Autogenerated input type of CreateSecondaryClaim" input CreateSecondaryClaimInput { "The ID of the primary claim (must be locked with ERA)" primary_claim_id: ID! "The secondary insurance plan ID (must belong to same patient)" insurance_plan_id: ID! "Secondary insurance member/subscriber number (required if no existing policy)" member_number: String "Secondary insurance group number" group_number: String """ Relationship to insured (defaults to "Self") """ holder_relationship: String "Policyholder date of birth (required when creating new policy)" holder_dob: String "Additional claim info (Box 19) - defaults to primary claim value" additional_claim_information: String "Prior authorization number (Box 23) - defaults to primary claim value" prior_authorization_number: String } "Autogenerated input type of CreateSharings" input CreateSharingsInput { "The shareable document or folder id" id: ID! """ The shareable type ("document" or "folder") """ shareable_type: ShareableType! "List of ids of org members to share to" org_member_ids: [ID!] = [] "List of ids of patients to share to" patient_ids: [ID!] = [] "List of ids of groups to share to" user_group_ids: [ID!] = [] "Whether the document or folder should be shared to all organization members" share_with_all_org_members: Boolean = false "Whether the document or folder should be shared to all clients" share_with_all_clients: Boolean = false } "Payload for a custom metric" input CustomMetricInput { "Whether or not to destroy the custom metric" _destroy: Boolean "The id of the custom metric" id: ID "The graphql_name of the custom metric" name: String "Whether or not to show the custom metric" show: Boolean "Whether or not to show the custom metric to the client" show_client: Boolean "Whether or not to track the custom metric" track: Boolean "The ID of an autoscored custom module form" custom_module_form_id: ID } "Payload for overriding a custom metric" input CustomMetricOverridesInput { "The ID of the custom metric" custom_metric_id: ID "The ID of the custom metric override" id: ID "Whether or not to show the custom metric" show: Boolean "Whether or not to show the custom metric to the client" show_client: Boolean } "Payload for a CustomModuleCondition" input CustomModuleConditionInput { "If true, the condition will be deleted" _destroy: Boolean "The ID of the CustomModule that will be shown if the condition is met" conditional_custom_module_id: ID "The type of filter to apply to the CustomModuleCondition" filter_type: String "The ID of the CustomModuleCondition" id: ID "The value to filter by" value_to_filter: String } "The day range input" input DayRangeInputObjectType { "The days range" days: [String] "The time range for every day" time_range: String } "Input for an automation delay (wait) step" input DelayInput { "User-defined delay identifier within the step" delay_identifier: String! "How long to wait, in duration_unit (e.g. 3)" duration_value: Int! "Unit for duration_value" duration_unit: AutomationDelayUnit! } "Autogenerated input type of DeleteAlertTemplate" input DeleteAlertTemplateInput { "ID of the alert template to delete" id: ID! } "Autogenerated input type of DeleteAutomation" input DeleteAutomationInput { "The ID of the automation to delete" id: ID! } "Autogenerated input type of DeleteCareAlert" input DeleteCareAlertInput { "ID of the care alert to delete" id: ID! } "Autogenerated input type of DeleteCustomModuleFileAttachment" input DeleteCustomModuleFileAttachmentInput { "The ID of the CustomModule file attachment to delete. Must be an attachment belonging to a CustomModule record that the current user has permission to edit." file_attachment_id: ID! } "Autogenerated input type of DeleteTranscript" input DeleteTranscriptInput { """ The composite transcript ID (e.g., "realtime_capture_123" or "processed_recording_cust1_456") """ id: String! } "Autogenerated input type of DestroyInternalComment" input DestroyInternalCommentInput { "the id of the comment to delete" id: ID! } "Autogenerated input type of DestroySharings" input DestroySharingsInput { "The shareable document or folder id" id: ID! """ The shareable type ("document" or "folder") """ shareable_type: ShareableType! "List of ids of org members to share to" org_member_ids: [ID!] = [] "List of ids of patients to share to" patient_ids: [ID!] = [] "List of ids of groups to share to" user_group_ids: [ID!] = [] } "Payload for a diagnosis" input DiagnosesInput { "If true, the diagnosis will be deleted upon saving" _destroy: Boolean "Whether the diagnosis is active or not" active: Boolean "Whether the diagnosis is the primary diagnosis" primary: Boolean "The date of the end of the diagnosis" end_date: String "The date of the first symptom" first_symptom_date: String "The ID of the ICD code" icd_code_id: ID "The ID of the diagnosis" id: ID "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON } "Payload for a dietitian" input DietitianInput { "The ID of the dietitian" id: ID "The NPI of the dietitian" npi: String "The other ID of the dietitian" other_id: String "The other ID qualifier of the dietitian" other_id_qualifier: String "The qualifications of the dietitian" qualifications: String } "Autogenerated input type of EditAvailabilityWithAppointmentTypes" input EditAvailabilityWithAppointmentTypesInput { "ID of the availability to edit." id: ID! "Up to 200 appointment type IDs accessible to the user. Use link_all_non_group_types if associating all IDs." appointment_type_ids: [ID!] "When true, the availability covers every non-group appointment type the provider owns. Mutually exclusive with appointment_type_ids." link_all_non_group_types: Boolean "Updated start of the availability window (ISO 8601 with offset). When omitted the existing value is kept." start_datetime: ISO8601DateTime "Updated end of the availability window (ISO 8601 with offset). When omitted the existing value is kept. Must be after start_datetime." end_datetime: ISO8601DateTime "IANA timezone name to persist on the availability record. When omitted the existing value is kept." timezone: String "Contact type (delivery mode) to scope this availability to. When omitted the existing value is kept." contact_type_id: Int "Appointment location to scope this availability to. When omitted the existing value is kept." appointment_location_id: ID "Set true for a weekly recurring availability or false for a one-time one. When omitted the existing recurrence is kept. Switching to recurring requires day_of_week; switching to one-time clears day_of_week and end_on." is_repeating: Boolean "Day of week the recurrence falls on (0 = Sunday through 6 = Saturday). Used when the availability is recurring." day_of_week: Int "Optional last date the recurrence is active. Used when the availability is recurring." end_on: ISO8601Date } "Attributes to change a fax dietitian" input FaxDietitianInput { "The custom identifier of the fax dietitian" id: ID "The location of the fax dietitian" location: FaxLocationInput "The phone number of the fax dietitian" phone_number: String "The qualifications of the fax dietitian" qualifications: String } "Attributes to change a fax location" input FaxLocationInput { "The city of the fax location" city: String "The country of the fax location" country: String "The custom identifier of the fax location" id: ID "The first line of the fax location address" line1: String "The second line of the fax location address" line2: String "The state of the fax location" state: String "The zip code of the fax location" zip: String } "Filters for potential appointment slots" input FiltersInput { "The list of provider ids for the appointment. When omitted, all active providers in the organization are used." provider_ids: [ID] "The id of the appointment type" appt_type_id: ID! "The contact type for the appointment" contact_type: String "The id of the location for the appointment" appt_loc_id: ID "Filters the provider list to only include users who have all of the specified tags applied" tag_ids: [ID] """ Two letter state abbreviation (e.g. "CA", "NY"). Filters providers to those licensed in the given state when the appointment type requires in-state clients. """ licensed_in_state: String } "Payload for an answer" input FormAnswerInput { "The answer. As of API version 2026-07-01, embedded Base64 image data URIs are rejected." answer: String "Structured answer payload. When present, populates `answer` from the structured value." structured_answer: StructuredAnswerInput "The ID of the conditional custom module" conditional_custom_module_id: ID "The ID of the custom module" custom_module_id: String "The type of filter" filter_type: String "(CURRENTLY UNUSED) The mod_type (e.g question type) that is being answered." mod_type: String "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String "Unique ID for the answer" id: ID "The label for the answer" label: String "The ID of the user who created the answer" user_id: String "The value to filter by" value_to_filter: String } "Structured input for a `gender` form answer" input GenderAnswerInput { "The selected gender" value: Gender } "Autogenerated input type of GenerateActivationLink" input GenerateActivationLinkInput { "Email address of the user to activate" email: String "Shared secret to authorize access" secret: String } "Payload for a gift" input GiftInput { "The email of the giver" giver_email: String "The name of the giver" giver_name: String "The ID of the gift" id: ID "The message assigned to the gift" message: String } "Autogenerated input type of HealthAssessmentServiceSignup" input HealthAssessmentServiceSignupInput { device_token: String device_type: String email: String user_id: ID } "Payload for ICD code on CMS 1500 form" input IcdCodesCms1500Input { "If true, the ICD code will be deleted from the join table" _destroy: Boolean "Whether the ICD code is active" active: Boolean "The end date of the ICD code" end_date: String "The first symptom date of the ICD code" first_symptom_date: String "The ID of the ICD code" icd_code_id: String "The ID of the ICD code join table" id: ID } "Payload for an ICD Code connection to an individual client note" input IcdCodesIndividualClientNoteInput { "The ID of the ICD Code connection to the individual client note" id: ID "The ID of the ICD Code" icd_code_id: ID "The position of this diagnosis, in relation to other diagnoses for this appointment inclusion." position: Int "If true, the ICD Code connection to the individual client note will be deleted" _destroy: Boolean } "Payload for assigning a policy to an ICD code" input IcdCodesPolicyInput { "If true, the join table record will be deleted" _destroy: Boolean "The ID of the ICD code" icd_code_id: String "The ID of the join table record" id: ID "The ID of the policy" policy_id: String } "Payload for an ICD code super bill" input IcdCodesSuperBillInput { "If true, the ICD code super bill will be deleted" _destroy: Boolean "The ID of the ICD code" icd_code_id: String "The ID of the ICD code super bill" id: ID } "Payload for an individual client note" input IndividualClientNoteInput { "The content of the individual client note" content: String "The ID of the individual client note" id: ID "The client's attendance status. This gets applied to the AppointmentInclusion object" attended: Boolean "Diagnoses connected to the individual client attendance" icd_codes_individual_client_notes_attributes: [IcdCodesIndividualClientNoteInput] "The datetime (ISO 8601) that the attendee joined the appointment" join_time: String "The datetime (ISO 8601) that the attendee left the appointment" leave_time: String "The ID of the user who created the individual client note" user_id: ID } "Payload for an insurance authorization" input InsuranceAuthorizationInput { "The authorization number" authorization_number: String "The end date of the authorization" end_on: String "The ID of the insurance authorization" id: ID "The start date of the authorization" start_on: String "The unit type" unit_type: String "The number of authorized units" units_authorized: String "The unit limit per visit" units_limit_per_visit: String "The number of used units" units_used: String "The number of authorized visits" visits_authorized: String "The number of used visits" visits_used: String } "Payload for an insurance plan" input InsurancePlanInput { "The ID of the insurance plan" id: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The name of the payer" payer_name: String } "Payload for a client portal setting" input LabObservationRequestInput { "The substance being measured and test code. e.g 005009^CBC With Differential/Platelet^RN" lab_analyte: String "the analyte result" lab_observation_result: LabObservationResultInput } "Payload for a client portal setting" input LabObservationResultInput { """ The units of the measurement e.g "x10E3/uL^x10E3/uL" """ units: String """ The reference range e.g "3.4-10.8" """ reference_range: String """ The qualitative result e.g "005025^WBC^L^6690-2^Leukocytes^LN" """ qualitative_result: String """ The quantitative result e.g "9.6" """ quantitative_result: String "Extra description or context on the result" notes: String "A flag on any abnormality (e.g L for low or H for high)" abnormal_flag: String } "A Claim Adjustment and Remittance Code (CARC) adjustment on a manual line payment" input LinePaymentAdjustmentInput { "Claim Adjustment Segment (CAS) group type" adjustment_group: LinePaymentAdjustmentGroup! "CARC reason code (e.g. 45; PR 1/2/3 = deductible/coinsurance/copay)" reason_code: String! "Adjusted amount for this CARC" amount: Float! } "Structured address input for a `location` form answer" input LocationAnswerInput { "Street address line 1" line1: String "Street address line 2" line2: String "State or province" state: String "City" city: String "Country" country: String "Postal / zip code" zip: String } "Payload for a CMS 1500 location" input LocationInput { "The city" city: String "The country code" country: String "The ID of the location" id: ID "The first line of the address" line1: String "The second line of the address" line2: String "The graphql_name of the location" name: String "The NPI of the location" npi: String "The other ID of the location" other_id: String "The other ID qual of the location" other_id_qual: String "The place of service ID of the location" place_of_service_id: String "The state" state: String "The ID of user who owns the location" user_id: String "The zip code" zip: String } "Payload for a location" input LocationInputs { "The city" city: String "The country code" country: String "The ID of the location" id: ID "The first line of the address" line1: String "The second line of the address" line2: String "The graphql_name of the location" name: String "The state" state: String "The zip code" zip: String } "Autogenerated input type of Lock" input LockInput { id: ID! } "Payload for a note" input NoteInput { "The document attached to the note" attached_document: Upload "The image attached to the note" attached_image: Upload "The content of the note" content: String } "Payload for a notification contact" input NotificationContactInput { "If true, the notification contact will be deleted" _destroy: Boolean "The email of the notification contact" email: String "The ID of the notification contact" id: ID } "Structured input for a numeric form answer. Writes are string-based to preserve the stored formatting; numericValue is computed on read and is not an input." input NumericAnswerInput { "The raw answer text" value: String } "Payload for a food nutrients" input NutrientsInput { "The number of added sugars in the food" added_sugars: String "The amount of calcium in the food" calcium: String "The amount of carbohydrates in the food" carbs: String "The amount of cholesterol in the food" cholesterol: String "The amount of fat in the food" fat: String "The amount of iron in the food" iron: String "The number of kilocalories in the food" kcal: String "The amount of monounsaturated fat in the food" monounsaturated_fat: String "The amount of polyunsaturated fat in the food" polyunsaturated_fat: String "The amount of potassium in the food" potassium: String "The amount of protein in the food" protein: String "The amount of saturated fat in the food" saturated_fat: String "The amount of sodium in the food" sodium: String "The amount of total fiber in the food" total_fiber: String "The amount of total sugars in the food" total_sugars: String "The amount of trans fat in the food" trans_fat: String "The amount of vitamin A in the food" vitamin_a: String "The amount of vitamin C in the food" vitamin_c: String "The amount of vitamin D in the food" vitamin_d: String } "Offering image upload" input OfferingImageUpload { "The image for upload" image: Upload } "Payload for an include to an offering" input OfferingIncludesFields { "The unique identifier of the appointment type" appointment_type_id: ID "The unique identifier of the object" id: ID "Whether the offering is repeating" is_repeating: Boolean "The quantity of the offering" quantity: String "Whether the appointment type is required" required_appointment_type: Boolean } "Payload for an offering product" input OfferingProductInput { "If true, the offering product will be deleted" _destroy: Boolean "If true, the main quantity will be deducted" deduct_main_quantity: Boolean "The ID of the offering product" id: ID "The price of the offering product" price: String "The offering product" product: ProductInput "The quantity of the offering product" quantity: String "If true, the offering product is taxable" taxable: Boolean } "Payload for a location of an organization" input OrgLocationInput { "The city" city: String "The country code" country: String "The ID of the location" id: ID "The first line of the address" line1: String "The second line of the address" line2: String "The graphql_name of the location" name: String "The NPI of the location" npi: String "The other ID of the location" other_id: String "The other ID qual of the location" other_id_qual: String "The place of service ID of the location" place_of_service_id: String "The state" state: String "The ID of user who owns the location" user_id: String "The zip code" zip: String } "Payload for Insurance Fees Inputs for Org Cpt Code" input OrganizationCptCodeInsuranceFeesInput { "If true, this object will be deleted" _destroy: Boolean "Fee (in cents) per unit" fee_per_unit: Int "The insurance plan associated with the cpt code object" insurance_plan_id: ID "The ID associated with organization cpt code object" organization_cpt_code_id: ID } "Payload for adding an organization info" input OrganizationInfoInput { "The ID of the organization" id: ID "The location of the organization" location: LocationInput "The graphql_name of the organization" name: String "The NPI of the organization" npi: String "The ID of the organization" organization_id: ID "The other ID of the organization" other_id: String "The other ID qual of the organization" other_id_qual: String "The phone number of the organization" phone_number: String "The tax ID of the organization" tax_id: String "The tax ID type of the organization" tax_id_type: String } "Configuration options for an organization" input OrganizationSettingsInput { "Enables conditional logic in the form builder" conditional_form_questions: Boolean = false "Enables restricting booking based on provider state licensure" booking_state_license_restrictions: Boolean = false "Enables configuring appointment settings for specific appointment types" appointment_type_specific_appointment_settings: Boolean = false "Enables pushing Healthie events to the primary Google Calendar of the synced user (vs a sub-calendar)" sync_calendar_events_with_main_cal: Boolean = false "Enables configuring priority levels for individual providers (used by our availability algorithm)" scheduling_priority_levels: Boolean = false } "Payload for another id number" input OtherIdNumberInput { "The ID of the other id number" id: ID "The other id number" other_id: String "The qualifier of the other id number" other_id_qualifier: String "The user ID of the other id number" user_id: String } "Payload for a patient" input PatientInput { "The date of birth of the patient" dob: String "The ID of the patient" id: ID "The location of the patient" location: LocationInput "The list of policies of the patient" policies: [PolicyInput] "The list of referring physicians of the patient" referring_physicians: [Cms1500ReferringPhysicianInput] "The sex of the patient" sex: String "The social security number of the patient" ssn: String "The full legal name and preferred name of the patient" full_legal_name_with_preferred: String } "A location of a patient" input PatientLocationInputs { "The city" city: String "The country code" country: String "The ID of the location" id: ID "The first line of the address" line1: String "The second line of the address" line2: String "The graphql_name of the location" name: String "The state" state: String "The zip code" zip: String } "Autogenerated input type of PauseCourseGroup" input PauseCourseGroupInput { "The ID of the course group to pause" id: ID! } "Autogenerated input type of PauseCourseMembership" input PauseCourseMembershipInput { "ID of the course membership to pause" id: ID! } "Payload for a location of a physician" input PhysicianLocationInput { "The city" city: String "The country code" country: String "The ID of the location" id: ID "The first line of the address" line1: String "The second line of the address" line2: String "The graphql_name of the location" name: String "The NPI of the location" npi: String "The other ID of the location" other_id: String "The other ID qual of the location" other_id_qual: String "The place of service ID of the location" place_of_service_id: String "The state" state: String "The ID of user who owns the location" user_id: String "The zip code" zip: String } "Payload for a referral" input PhysicianReferralInput { "If the referral should be destroyed" _destroy: Boolean "The ID of the referral" id: ID "The reason for the referral" referral_reason: String "The ID of the user" user_id: ID } "Default structured input for a form answer whose value is an undelimited string: text, textarea, read_only, video, document, iframe, label; the single_select mod_types (radio, horizontal_radio, dropdown, sex, gender, gender_identity, pronouns); and metrics/custom metrics. Unrecognized mod_types default to this type." input PlainTextAnswerInput { "The raw answer text" value: String } "Payload for a policy" input PolicyInput { "The group number" group_num: String "The date of birth of the holder" holder_dob: String "The first name of the holder" holder_first: String "The gender of the holder" holder_gender: String "The last name of the holder" holder_last: String "The location of the holder" holder_location: LocationInput "The middle initial of the holder" holder_mi: String "The phone number of the holder" holder_phone: String "The relationship of the holder to the client" holder_relationship: String "The ID of the policy" id: ID "The ID of the insurance card back" insurance_card_back_id: String "The ID of the insurance card front" insurance_card_front_id: String "The insurance plan associated with the policy" insurance_plan: InsurancePlanInput "The ID of the insurance plan" insurance_plan_id: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The name of the policy" name: String "The policy number" num: String "The location of the payer" payer_location: LocationInput "The phone number of the policy" policy_phone_number: String "The priority type of the policy" priority_type: String "Whether the holder has the same address as the client" same_address_as_client: Boolean "The type of policy" type_string: String "The ID of the user associated with the policy" user_id: String } "Input type for filtering prescription medications" input PrescriptionMedicationQueryFiltersInput { "The start of the end date filter" end_date_from: ISO8601Date "The end of the end date filter" end_date_to: ISO8601Date "The start of the start date filter" start_date_from: ISO8601Date "The end of the start date filter" start_date_to: ISO8601Date "The normalized status of the medication (e.g., active, inactive, pending)" normalized_status: [PrescriptionMedicationStatus] "The types of medications (e.g., prescription, medication)" type: [PrescriptionMedicationTypeEnum] } "Payload for a primary organization" input PrimaryOrganizationInfoInput { "If true, the organization will be deleted" _destroy: Boolean "The external ID of the organization" external_id: String "The ID of the organization" id: ID "The ID number type of the organization" id_number_type: String "The location of the organization" location: OrgLocationInput "The graphql_name of the organization" name: String "The NPI of the organization" npi: String "The other ID of the organization" other_id: String "The other ID qual of the organization" other_id_qual: String "The phone number of the organization" phone_number: String "Whether the organization is primary" primary: Boolean "The tax ID of the organization" tax_id: String "The tax ID type of the organization" tax_id_type: String } "Product input" input ProductInput { "The product id" id: String "The product name" name: String } "Payload for a profession" input ProfessionsInput { "The graphql_name of the profession" profession: String "The category of the profession" profession_category: String } "Payload to bind an appointment location to a provider" input ProviderAppointmentLocationsInput { "If true, the join table record will be deleted" _destroy: Boolean "The ID of the appointment location" appointment_location_id: ID "The ID of the join table record" id: ID } "Payload for a provider bio" input ProviderBioInput { "The ID of the provider bio (only required for updates, omit when creating)" id: ID "The biography text for the provider" bio: String! } "Properties for creating or updating a ProviderCptCode" input ProviderCptCodeInput { "The CPT code ID" cpt_code_id: ID "The unique identifier of the code" id: ID "The price per unit of the code" price_per_unit: String "The unique identifier of the provider" provider_id: ID } "Autogenerated input type of PublishDocumentDraft" input PublishDocumentDraftInput { "File with applied annotations to attach to document for publishing" file: Upload "The ID of the document draft to publish" id: ID! "The lock version for optimistic locking" lock_version: Int! } "Input for an automation query" input QueryInput { "User-defined query identifier within the step" query_identifier: String! "Name of the query to execute" query_name: String! """ Query arguments with optional template variables. Example: {"arguments": {"id": "{{trigger.resource_id}}"}} """ config: JSON = {} } "Payload for a receipt line item" input ReceiptLineItemInput { "The time the receipt line item was created" created_at: String "The description of the receipt line item" description: String "The ID of the receipt line item" id: ID "The previous price of the receipt line item" previous_price: String "The current price of the receipt line item" price: String } "Payload for a recurring appointment" input RecurringAppointmentInput { "The unique identifier of the recurring appointment" id: ID "If true, all appointments will be joined into one appointment" join_all: Boolean = false """ Options are ["Weekly", "Biweekly", "Monthly", or "Every 4 Weeks"] """ repeat_interval: String """ Must be a positive number. For example, the following values are valid: "2", "10", "25", "52" """ repeat_times: String } "The recurring days input" input RecurringDaysInputObjectType { "The list of day ranges" day_ranges: [DayRangeInputObjectType] "The id of the recurring day" id: ID } "Payload for a referral info" input ReferralInfoInput { "The state of the auto accident" auto_accident_state: String "The date of the case" case_date: String "The qualifier of the case" case_qualifier: String "The condition relationships" condition_related_to: [String] "The end date of the hospitalization" hospitalization_end: String "The start date of the hospitalization" hospitalization_start: String "The id of the referral info" id: ID "The other associated date" other_associated_date: String "The other qualifier" other_associated_qualifier: String "The prior auth number" prior_auth_number: String "The first name of the referring provider" ref_provider_first: String "The last name of the referring provider" ref_provider_last: String "The middle name of the referring provider" ref_provider_middle: String "The NPI of the referring provider" ref_provider_npi: String "The other id of the referring provider" ref_provider_other_id: String "The other id qualifier of the referring provider" ref_provider_other_id_qual: String "The qualifier of the referring provider" ref_provider_qual: String "The id of the referring physician" referring_physician_id: ID "The end date of the unable to work" unable_to_work_end: String "The start date of the unable to work" unable_to_work_start: String } "Payload for a referral" input ReferralInput { "If true, the referral will be deleted" _destroy: Boolean "The ID of the referral" id: ID "The referring physician object" referring_physician: ReferringPhysicianInput "The ID of the referring physician" referring_physician_id: ID } "Payload for a referring physician" input ReferringPhysicianInput { "If true, the referring physician will be deleted" _destroy: Boolean "The email of the referring physician" email: String "The fax number of the referring physician" fax_number: String "The first name of the referring physician" first_name: String "The ID of the referring physician" id: ID "The last name of the referring physician" last_name: String "The legal name of the referring physician" legalname: String "The location of the referring physician" location: ClientLocationInput "The NPI of the referring physician" npi: String "The phone number of the referring physician" phone_number: String } "Autogenerated input type of RefetchChangeHealthLabOrder" input RefetchChangeHealthLabOrderInput { id: ID } "Payload for a reminder" input ReminderInput { "The ID of the reminder. If no id is given, a reminder will be created" id: ID "The type of the reminder interval. Options are daily, weekly, once" interval_type: String "For daily interval -> don't send anything. For weekly interval, send in comma separated all lower-case day of week (e.g wednesday, friday). For once, send in the date (e.g 2020-11-28)" interval_value: String "If not set to true, the reminder will not be sent" is_enabled: Boolean "Send in true to delete the reminder" remove_reminder: Boolean } "Autogenerated input type of RequestIntegration" input RequestIntegrationInput { "Support article URL (name needs to be changed)" enable_button_url: String "Name of the integration" integration_name: String "ID of the IntegrationOption being requested" integration_option_id: ID } "Payload for a requested payer" input RequestedPayerInput { "The address of the requested payer" address: String "The email of the requested payer" email: String "The ID of the requested payer" id: ID "The graphql_name of the requested payer" name: String } "Payload for a requested payment template" input RequestedPaymentTemplateInput { "Whether or not the requested payment template is active" active_template: Boolean "The ID of the requested payment template" id: ID "The graphql_name of the requested payment template" name: String } "Autogenerated input type of ResetMfa" input ResetMfaInput { "The ID of the user whose MFA should be reset." id: ID! } "Autogenerated input type of ResumeCourseGroup" input ResumeCourseGroupInput { "The ID of the course group to resume" id: ID! } "Autogenerated input type of ResumeCourseMembership" input ResumeCourseMembershipInput { "ID of the course membership to resume" id: ID! } "Payload for a Room" input RoomInput { "If true, the room will be deleted" _destroy: Boolean "The ID of the room" id: ID "If true, only one user can be in the room at a time" limit_to_one: Boolean "The graphql_name of the room" name: String } "Autogenerated input type of SendSpeakToTrainerNotification" input SendSpeakToTrainerNotificationInput { email: String user_id: ID } "The serving size of a food" input ServingSizeInput { "The amount of the serving size" amount: String "The id of the serving size" id: ID "The unit of the serving size" unit: String } "Autogenerated input type of SetCustomModuleFormScribeInstructions" input SetCustomModuleFormScribeInstructionsInput { "The CustomModuleForm whose Scribe instructions should be updated." custom_module_form_id: ID! "Form-level Scribe instructions. Pass null or empty string to clear; omit to leave unchanged." custom_instructions: String } "Structured input for a `sex` form answer" input SexAnswerInput { "The selected sex" value: Sex } "Autogenerated input type of Sign" input SignInput { id: ID! } "Structured input for a single-select (radio, horizontal_radio, dropdown) form answer" input SingleSelectAnswerInput { "The selected option label; expected to match one of the question's configured options" value: String } "The properties of the specialty" input SpecialtiesInput { "The graphql_name of the specialty" specialty: String "The category of the specialty" specialty_category: String } "Payload for a state license" input StateLicensesInput { "If true, the state license will be destroyed" _destroy: Boolean "The ID of the state license" id: ID "The code of the state" state: String } "Input for an automation step" input StepInput { "User-defined step identifier within the automation" step_identifier: String! "Display name for the step" name: String! "Type of step" step_type: AutomationStepType! "Logic for combining conditions (AND/OR)" condition_logic: AutomationConditionLogic "Configuration for next steps based on outcome" next_steps_config: JSON = {} "Conditions to evaluate" conditions: [ConditionInput!] = [] "Action to execute if this is an action step" action: ActionInput "Query to execute if this is a query step" query: QueryInput "Delay configuration if this is a delay step" delay: DelayInput } """ The input type for submitting a form answer. Different types of answers (ie different mod_types) have different input types. For example a form answer with mod_type "location" should use the location field (of type LocationAnswerInput). StructuredAnswerInput only allows for one of its input types to be provided. """ input StructuredAnswerInput { "Structured address input for a `location` form answer" location: LocationAnswerInput "Structured BMI input for a BMI form answer" bmi: BMIAnswerInput "Structured input for a plain-text form answer" plain_text: PlainTextAnswerInput "Structured input for a single-select (radio, horizontal_radio, dropdown) form answer" single_select: SingleSelectAnswerInput "Structured input for a `sex` form answer" sex: SexAnswerInput "Structured input for a `gender` form answer" gender: GenderAnswerInput "Structured input for a numeric form answer (number, height, Weight, custom metrics, ...)" numeric: NumericAnswerInput } "Payload for a sub-organization" input SubOrganizationInfoInput { "Whether to copy the appointment settings from the parent organization" copy_appointment_settings: Boolean = true "Whether to copy the onboarding flows from the parent organization" copy_onboarding_flows: Boolean = false "Whether to copy the packages from the parent organization" copy_packages: Boolean = false "Whether to copy the programs from the parent organization" copy_programs: Boolean = false "The ID of the suborganization" id: ID "Whether to inherit appointment types from the parent organization" inherit_appointment_types: Boolean = true "Whether to inherit custom module forms from the parent organization" inherit_custom_module_forms: Boolean = true "Whether to inherit the stripe account from the parent organization" inherit_stripe_account: Boolean = true "Configuration options for the suborganization" organization_settings: OrganizationSettingsInput } "Payload for a sub-entry" input SubentryInput { "The category of the sub-entry" category: String "The description of the sub-entry" description: String "The ID of the sub-entry" id: ID "The statistic of the sub-entry" metric_stat: String "The type of the sub-entry" type: String } "Payload for a sub-goal" input SubgoalInput { "Whether or not this sub-goal should be deleted" _destroy: Boolean "The ID of the user who created it" created_user_id: String "The description of the sub-goal" description: String "The date the sub-goal should end - format should be: yyyy-mm-dd" due_date: String "The ID of the sub-goal. If no id is given, a sub-goal will be created" id: ID "The graphql_name of the sub-goal" name: String "The ID of the parent goal" parent_id: String "The frequency of this goal. Possible values are: 'Daily','Weekly', 'Once'" repeat: String "The ID of the sub-goal's template used to create this sub-goal" source_template_id: String "The sub-goal title hyperlink. Opens when the sub-goal graphql_name is clicked on." title_link: String "The ID of the user who created this sub-goal. If no user_id is given, the current user will be used" user_id: String } "If included, Healthie will attempt to submit an order. This must be enabled for your organization." input SubmissionInput { "List of Lab Option IDs for tests being ordered" lab_option_ids: [ID] "An optional future date to process the order" activate_by: ISO8601DateTime "Healthie ID of the physician who will review this order. If left empty default provider network will be used." physician_id: ID "The billing type for this order. If missing, the provider will be billed." billing_type: LabOrderBilling = PROVIDER "List of ICD-10 code ids for this order" icd_code_ids: [ID] "Chart note ID associated with this lab order, group charting notes are not accepted, chart note should not be signed or locked Make sure the `OrganizationType.can_link_labs_to_chart_notes` setting is enabled for your organization before using this arg." form_answer_group_id: ID } "Autogenerated input type of SubmitSecondaryClaim" input SubmitSecondaryClaimInput { "Secondary claim IDs to submit" claim_ids: [ID!]! } "Payload for a task reminder" input TaskReminderInput { "Id of the reminder. If no id is given, a reminder will be created" id: ID "The type of interval. Options are daily, weekly, once" interval_type: String "For a daily interval send nothing. For a weekly interval, send a comma separated day of week in the lower case (e.g wednesday, friday). To remind once, send the date (e.g 2020-11-28)" interval_value: String "If not set to true, the reminder will not be sent" is_enabled: Boolean "Time for reminder" reminder_time: Int "Send in true to delete the reminder" remove_reminder: Boolean } "DEPRECATED. A test that can be ordered" input TestInput { "Human readable description of the test" name: String "The unique identifier for the test" provider_identifier: ID! } "Input for an automation trigger" input TriggerInput { "Type of trigger" trigger_type: AutomationTriggerKind! = WEBHOOK "Type of webhook event that triggers this automation" webhook_type: WebhookEventType } "Autogenerated input type of Unlock" input UnlockInput { id: ID! description: String! } "Autogenerated input type of UpdateAlertTemplate" input UpdateAlertTemplateInput { "ID of the alert template to update" id: ID! "Short description of the alert template" description: String "Full text content of the alert template" content: String } "Autogenerated input type of UpdateAppointmentFormAnswerGroupConnection" input UpdateAppointmentFormAnswerGroupConnectionInput { "ID of the form answer group whose linked appointment will be updated. Must already be connected to an appointment." form_answer_group_id: ID! "ID of the appointment to link to the form answer group. Replaces any appointment the form answer group was previously connected to." appointment_id: ID! } "Autogenerated input type of UpdateAutomation" input UpdateAutomationInput { "The ID of the automation to update" id: ID! "Display name for the automation" name: String "Description of what the automation does" description: String "Whether the automation is active" is_enabled: Boolean "Full JSON configuration for the automation" config: JSON } "Autogenerated input type of UpdateCalorieLevel" input UpdateCalorieLevelInput { device_token: String device_type: String email: String high_end_caloric_intake: String run_id: ID user_id: ID } "Autogenerated input type of UpdateCareAlert" input UpdateCareAlertInput { "ID of the care alert to update" id: ID! "Updated content for the alert" content: String "Updated priority level" priority: CareAlertPriorityEnum "Updated expiration date" expires_on: ISO8601Date } "Autogenerated input type of UpdateDocumentDraft" input UpdateDocumentDraftInput { "JSON-format annotations for document edits" annotations: JSON "The ID of the document draft to update" id: ID! "The lock version for optimistic locking" lock_version: Int! } "Autogenerated input type of UpdateGeneratedSummary" input UpdateGeneratedSummaryInput { "ID of the generated summary" id: ID! "The edited summary text. Cannot be blank and cannot contain base64-encoded images." summary: String! } "Autogenerated input type of UpdateInternalComment" input UpdateInternalCommentInput { "The id of the comment to update" id: ID! "The text content of the comment" content: String! } "Autogenerated input type of UpdateMacronutrientSplit" input UpdateMacronutrientSplitInput { carbs_percentage: String device_token: String device_type: String email: String fat_percentage: String protein_percentage: String run_id: ID user_id: ID } "Autogenerated input type of UpdateOrganizationConfiguration" input UpdateOrganizationConfigurationInput { internal_care_alerts_enabled: Boolean internal_care_alerts_require_acknowledgement: Boolean "When true, clients cannot edit their own name in the client profile" prevent_client_name_edit: Boolean } "Autogenerated input type of UpdateSecondaryClaim" input UpdateSecondaryClaimInput { "Claim-level COB override data (payment totals)" claim_cob_overrides: ClaimCobOverridesInput "Line-level COB override data for each service line" claim_line_cob_overrides: [ClaimLineCobOverridesInput!] "The ID of the secondary CMS1500 to update" id: ID! } "Autogenerated input type of UpdateUiConfiguration" input UpdateUiConfigurationInput { role: OrganizationMembershipRole! ui_configuration: JSON! } "Payload for a user policy" input UserPolicyInput { "The value (in cents) if insurance billing method is copay" copay_value: Int "The value if insurance billing method is coinsurance" coinsurance_value: Int "If true, the policy will be deleted" _destroy: Boolean "The group number" group_num: String "The date of birth of the policy holder" holder_dob: String "The first name of the policy holder" holder_first: String "The gender of the policy holder" holder_gender: String "The last name of the policy holder" holder_last: String "The location of the policy holder" holder_location: ClientLocationInput "The middle initial of the policy holder" holder_mi: String "The phone number of the policy holder" holder_phone: String "The relationship of the policy holder to the client" holder_relationship: String "The ID of the policy" id: ID "The insurance billing method for this policy (no_billing_method, copay, coinsurance, unmet_deductible)" insurance_billing_method: String "The back of the insurance card" insurance_card_back: Upload "The ID of the back of the insurance card" insurance_card_back_id: String "The front of the insurance card" insurance_card_front: Upload "The ID of the front of the insurance card" insurance_card_front_id: String "The insurance plan" insurance_plan: ClientInsurancePlanInput "The ID of the insurance plan" insurance_plan_id: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The name of the policy" name: String "The policy number" num: String "The location of the payer" payer_location: ClientLocationInput "The policy-related phone number" policy_phone_number: String "The priority type of the policy" priority_type: String "Whether the policy holder has the same address as the client" same_address_as_client: Boolean "The type of the policy" type_string: String "The ID of the user" user_id: String "Either ID of related intake flow item which this policy was created for. Usually it is Insurance Form. Email notification will be triggered if this field is passed" onboarding_item_id: ID } "Payload for a new VideoUrlDefault" input VideoUrlDefaultInput { "The default url for the video url default" default_url: String "The ID of the video url default" id: ID "The ID of the user who owns the video url default" user_id: ID "The video url options" video_url_options: [VideoUrlOptionInput] } "Payload for a video url" input VideoUrlOptionInput { "The ID of the video url" id: ID "The url of the video" url: String "The url of the video by item id" url_by_item_id: String } "Autogenerated input type of VoidLinePayment" input VoidLinePaymentInput { "The line payment to void" id: ID! } "Autogenerated input type of VoidLineWriteOff" input VoidLineWriteOffInput { "The write-off to void" id: ID! } "Payload for a webhook event" input WebhookEventInput { "The ID of the webhook event" id: ID "The type of webhook event" event_type: String! } "Payload for a writeoff" input WriteOffInput { "The ID of the write-off" id: ID "The WriteOff amount" amount: Float! "The type of write-off" write_off_type: WriteOffType! "The other reason for the write-off" other_reason: String "When true, current write-off is deleted" _destroy: Boolean } "Autogenerated input type of addPharmacy" input addPharmacyInput { "ID from pharmacy search results" pharmacy_id: ID! "Healthie patient/client ID" patient_id: ID! primary: Boolean = false } "Autogenerated input type of asyncBulkCreateOrganizationMemberships" input asyncBulkCreateOrganizationMembershipsInput { """ Options are ["Standard", "Support"] """ org_role: String "Selected permission template" permission_template_id: ID "The ID of the organization" organization_id: ID! "The ID of the users to add to the organization" user_ids: [ID]! } "Autogenerated input type of bulkApplyCarePlanTemplate" input bulkApplyCarePlanTemplateInput { force_activation: Boolean = false id: ID user_group_ids: [ID] user_ids: [ID] } "Autogenerated input type of bulkApply" input bulkApplyInput { ids: [ID] "The ID of the user to apply a tag on" taggable_user_id: ID } "Autogenerated input type of bulkCreateAvailability" input bulkCreateAvailabilityInput { appointment_location_id: String appointment_type_id: String availabilities: [AvailabilityInput] contact_type_id: String end_on: String user_id: String } "Autogenerated input type of bulkCreateEntries" input bulkCreateEntriesInput { entries: [BulkEntryInput] } "Autogenerated input type of bulkCreateOrganizationMemberships" input bulkCreateOrganizationMembershipsInput { """ Options are ["Standard", "Support"] """ org_role: String "Selected permission template" permission_template_id: ID email: String first_name: String last_name: String "Can optionally be passed in along with last_name, first_name, and email. When passed in, the newly created user will have this password" password: String professions: [ProfessionsInput] "When true, an invite email will be sent to the newly created organization member" send_invite_email: Boolean = true specialties: [SpecialtiesInput] "Organization’s member timezone" timezone: String "Lets you add extra metadata about the organization membership. Not used in Healthie UI" title: String "The IDs of the organizations" organization_ids: [ID]! } "Autogenerated input type of bulkDeleteTasks" input bulkDeleteTasksInput { ids: [ID] } "Autogenerated input type of bulkUpdateCardIssues" input bulkUpdateCardIssuesInput { mark_all_as_seen: Boolean } "Autogenerated input type of bulkUpdateCarePlanUsers" input bulkUpdateCarePlanUsersInput { activate: Boolean = false ids: [ID] = [] notify: Boolean = false } "Autogenerated input type of bulkUpdateClients" input bulkUpdateClientsInput { active_status: Boolean ids: [ID] other_provider_ids: String "List of provider IDs to remove from the patients' care team" provider_ids_to_remove: [ID] select_all_excluded_ids: [ID] select_all_status: String "Suppress sending patient.updated webhooks for changes made in this mutation" suppress_patient_updated_webhooks: Boolean = false user_group_id: ID } "Autogenerated input type of bulkUpdateNotificationRecords" input bulkUpdateNotificationRecordsInput { user_id: ID viewed_bounced_records: Boolean } "Autogenerated input type of bulkUpdateNotifications" input bulkUpdateNotificationsInput { "If this is left out, updateAllNotifications must be sent as true" notification_ids: [String] seen: Boolean "When true, recent (last 500) notifications will be updated" updateAllNotifications: Boolean } "Autogenerated input type of bulkUpdateTasks" input bulkUpdateTasksInput { "If true, tasks will be marked as completed; if false, they will be marked as incomplete." complete: Boolean = null "If true, tasks will be marked as seen; if false, they will be marked as unseen." seen: Boolean = null "IDs of tasks to update. Ignored if `update_all_tasks` is true." task_ids: [ID] "If true, all tasks assigned to the current user will be updated." update_all_tasks: Boolean = false } "Autogenerated input type of cancelRecurringPayment" input cancelRecurringPaymentInput { "The ID of the billing item" billing_item_id: ID! } "Autogenerated input type of clearUnreconciledObjects" input clearUnreconciledObjectsInput { user_id: ID } "Autogenerated input type of completeCheckout" input completeCheckoutInput { appointment_id: String "An array of group appointment IDs. When passed in, the user will be registered for all at the same time." appointment_ids: [ID] appointment_location_id: String appointment_type_id: String contact_type: String coupon_code: String date: String email: String first_name: String form_answer_group: CheckoutFormAnswerGroupInput gift: GiftInput intake_flow_uuid: String "Whether the user is adding a credit card (but not charging) as part of booking process" is_adding_credit_card: Boolean = false is_gift: Boolean is_joining_waitlist: Boolean last_name: String "Optional: The user's legal first name" legal_name: String location: String offering_id: String "Currently just used for Klarna. The ID of the completed payment intent that should be used to completed the checkout." payment_intent_id: ID phone_number: String price: String provider_id: String reason: String requested_payment_id: String stripe_idempotency_key: String timezone: String "Token for credit card, created by Stripe.JS" token: String "UUID for outside party invoice payment (non-authenticated users). If provided, invoice_id is also required." outside_party_payer_id: ID "Invoice ID for outside party invoice payment. If provided, outside_party_payer_id is also required." invoice_id: ID } "Autogenerated input type of completeCourseDocument" input completeCourseDocumentInput { "The ID of related course_item" course_item_id: ID! "The ID of user" user_id: ID! } "Autogenerated input type of convertGeneratedFormAnswerGroup" input convertGeneratedFormAnswerGroupInput { id: ID! } "Autogenerated input type of copyCourse" input copyCourseInput { id: String } "Autogenerated input type of copyCustomModuleForm" input copyCustomModuleFormInput { id: ID id_list: String user_id: String } "Autogenerated input type of copyCustomModule" input copyCustomModuleInput { id: ID } "Autogenerated input type of copyOffering" input copyOfferingInput { id: ID } "Autogenerated input type of createAcceptedInsurancePlan" input createAcceptedInsurancePlanInput { insurance_plan_ids: [ID] } "Autogenerated input type of createAddendum" input createAddendumInput { content: String form_answer_group_id: ID } "Autogenerated input type of createAllergySensitivity" input createAllergySensitivityInput { category: String category_type: String custom_name: String custom_reaction: String id: ID name: String "The date of onset" onset_date: String reaction: String "The type of reaction. Options are [allergy, adverse_reaction]" reaction_type: String severity: String "Options are [active, inactive, resolved]. Defaults to active" status: String user_id: String "The drug allergen id to associate with the allergy sensitivity" drug_allergen_id: ID "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON } "Autogenerated input type of createAnnouncement" input createAnnouncementInput { active: Boolean announcement_image: AnnouncementImageUpload description: String name: String title: String user_group_ids: String } "Autogenerated input type of createApiKey" input createApiKeyInput { "A used-defined name for the API key. Optional" name: String "The ID of the user to create an API key for. Required" user_id: ID } "Autogenerated input type of createAppleHealth" input createAppleHealthInput { is_enabled: Boolean last_sync_date: String } "Autogenerated input type of createAppointmentFormAnswerGroupConnection" input createAppointmentFormAnswerGroupConnectionInput { appointment_id: ID form_answer_group_id: ID } "Autogenerated input type of createAppointment" input createAppointmentInput { appointment_location_id: String appointment_type_id: String "Optional ID of appointment request this appointment fulfills" appointment_request_id: ID attendee_ids: String "The type of appointment (video, in person, phone call, etc.). Required if not a blocker." contact_type: String "Cpt code associated with this appointment" cpt_code_id: ID date: String "Timestamp in YYYY-MM-DD HH:MM:SS or ISO8601 format, supercedes date, time params." datetime: String end_date: String end_time: String exclude_no_credits: Boolean "When passed in, this video chat URL will be used instead of built-in Video Chat or Zoom" external_videochat_url: String insurance_billing_enabled: Boolean is_blocker: Boolean is_zoom_chat: Boolean location: String max_attendees: String "a serialized JSON string of metadata" metadata: JSON notes: String other_party_id: String "The price associated with this appointment" price: String providers: String recurring_appointment: RecurringAppointmentInput room_id: String start_immediately: Boolean time: String "Timezone to use for date and time fields. Overrides the timezone of the current user" timezone: String "Units to use as a multiplier for appointment price" units: String user_id: String "When true, checks if appointment time slot is available before creating. Does not work with recurring appointments or blockers." enforce_availability: Boolean = false """ When true, suppresses "appointment.created" webhook notifications from this API call. Does not work with recurring appointments. """ suppress_webhook_notifications: Boolean = false } "Autogenerated input type of createAppointmentRequest" input createAppointmentRequestInput { "The ID of the organization the potential client is requesting the appointment from." organization_id: ID "First name of the potential client requesting the appointment." first_name: String "Last name of the potential client requesting the appointment." last_name: String "Phone number of the potential client requesting the appointment." phone: String "Email of the potential client requesting the appointment." email: String "Timezone of the potential client requesting the appointment." timezone: String! "Reason for the appointment request." reason: String! "The ID of the provider the potential client is requesting the appointment from." provider_id: ID "The ID of the patient the potential client is requesting the appointment for." patient_id: ID "The ID of the appointment type the potential client is requesting." appointment_type_id: ID "The ID of the appointment location the potential client is requesting the appointment from." appointment_location_id: ID "The contact type selected for the appointment request. Maximum character limit of 25." selected_contact_type: String "The state selected for the appointment request. Maximum character limit of 2 characters." selected_state: String "The slots the potential client is requesting the appointment for." slots: [AppointmentRequestSlotInput] "Additional booking parameters for the appointment request." booking_params: JSON "If true, use the specified provider_id as context for the appointment request but do not assign as requested provider." should_assign_provider: Boolean = true } "Autogenerated input type of createAppointmentSetting" input createAppointmentSettingInput { allow_appointment_type_pricing: Boolean allow_clients_to_cancel_appt: Boolean allow_external_videochat_urls: Boolean always_send_confirm_notification: Boolean appointment_locations: [AppointmentLocationInput] appt_type_confirmed_email: Boolean appt_type_reminder_email: Boolean appt_type_website_booking_email: Boolean ask_clients_to_confirm: Boolean ask_to_confirm_via_text: Boolean auto_create_cms1500: Boolean auto_schedule_charges_for_late_cancellation_no_show: Boolean auto_submit_cms1500: Boolean auto_invoicing: Boolean base_calendar_interval: BaseCalendarInterval = FIFTEEN_MINUTES booking_interval_restriction: Int buffer: String calendar_color_schemes: [CalendarColorSchemeInput] charge_for_occurred_appts: Boolean "When true, clients must provide a cancellation reason when cancelling" client_cancel_reason_required: Boolean client_should_call_provider: Boolean clients_have_billing: Boolean confirm_by_default: Boolean contact_type_overrides: [ContactTypeOverrideInput] default_appt_form_to_group: Boolean default_charting_template_id: String default_group_charting_template_id: ID default_to_zoom: Boolean default_video_service: String disable_requested_form_notifications: Boolean """ Enable the additional "Checked-In" status for appointments. """ enable_checked_in_status: Boolean """ Enable the additional "Late Cancellation" status for appointments. """ enable_late_cancellation_status: Boolean end_time: String hide_link: Boolean insurance_eligibility_integration: Boolean invoice_clients_without_payment_method: Boolean "Indicates if specific CPT code pricing is used for insurance." insurance_specific_cpt_code_pricing: Boolean "The late cancellation fee in cents" late_cancellation_fee: Int max_days_in_future: String "Prevents the patient from canceling too close the appointment time. In minutes" minimum_advance_cancel_time: Int "Prevents the patient from rescheduling too close the appointment time. In minutes" minimum_advance_reschedule_time: Int "Prevents the patient from scheduling too close to the desired appointment time. In minutes" minimum_advance_schedule_time: Int "The no show fee in cents" no_show_fee: Int prevent_client_booking: Boolean prevent_no_credit_booking: Boolean "When true, providers must provide a cancellation reason when cancelling" provider_cancel_reason_required: Boolean enable_appointment_requests: Boolean reply_to_provider: Boolean restore_credit_on_cancel: Boolean same_day_appointments: Boolean send_appointment_cancellation_email: Boolean send_appointment_update_email: Boolean send_booking_notice: Boolean send_embeddable_appt_creator_email: Boolean send_email_before_appointment: Boolean send_intake_forms_reminder: Boolean send_push_before_appointment: Boolean send_reminder_four_days_before: Boolean send_reminder_one_day_before: Boolean send_reminder_one_hour_before: Boolean send_reminder_three_days_before: Boolean send_reminder_two_days_before: Boolean send_reminder_two_hours_before: Boolean send_text_reminder_four_days_before: Boolean send_text_reminder_one_day_before: Boolean send_text_reminder_one_hour_before: Boolean send_text_reminder_three_days_before: Boolean send_text_reminder_two_days_before: Boolean send_text_reminder_two_hours_before: Boolean "NOTE: Your organization MUST have its own Twilio account configured to have this feature, and have AppointmentSetting.send_email_before_appointment enabled" send_text_reminder_five_minutes_before: Boolean set_default_videochat_url: Boolean show_care_plans: Boolean show_faxes: Boolean show_insurance_authorization: Boolean start_time: String "Allows times to be grouped by appointment type. NOTE: changing this value will clear all prior availability" times_by_appointment_type: Boolean "Allows times to be grouped by contact type. NOTE: changing this value will clear all prior availability" times_by_contact_type: Boolean "Allows times to be grouped by location. NOTE: changing this value will clear all prior availability" times_by_location: Boolean use_appointment_type_cpt_units_and_fees: Boolean use_client_credit_system: Boolean use_client_sources: Boolean use_zoom_waiting_room: Boolean user_id: String video_url_default: VideoUrlDefaultInput } "Autogenerated input type of createAppointmentTypeCptCode" input createAppointmentTypeCptCodeInput { appointment_type_id: ID cpt_code_id: ID units: String } "Autogenerated input type of createAppointmentType" input createAppointmentTypeInput { appointment_autocomplete_form: AppointmentAutocompleteFormCreateInput appointment_setting: AppointmentTypeAppointmentSettingInput appointment_type_cpt_code: AppointmentTypeCptCode bookable_by_groups: Boolean bookable_group_ids: String bookable_without_group: Boolean "When false, clients will not have the ability to self-book this appointment" clients_can_book: Boolean "Custom description shown to clients when self-scheduling" client_display_description: String "When set, will be used as the appointment type name shown to clients in the client booking widget UI." client_facing_display_name: String contact_type_overrides: [String] "If the provider's organization has this feature, setting this will customize the content of SMS reminder's Healthie sends." custom_text_reminder_body: 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 form_requests_before_appointment: [AppointmentTypeFormConnectionInput] form_requests_after_appointment: [AppointmentTypeFormConnectionInput] form_requests_after_appointment_booking: [AppointmentTypeFormConnectionInput] "Whether or not insurance billing is enabled for an appointment type" insurance_billing_enabled: Boolean "When true, indicates that this appointment type is used for group appointments" is_group: Boolean is_waitlist_enabled: Boolean "The length of the appointment type in minutes" length: Int "Metadata for an appointment type. Maximum character limit of 128,000." metadata: String "The name of the appointment type" name: String pricing: String "Available options are CUSTOM and CPT_CODE." pricing_option: String provider_ids_for_appt_type_connections: String "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 require_in_state_clients: Boolean require_specific_providers: Boolean specific_groups: Boolean user_group_id: String } "Autogenerated input type of createAutoTaskGenerator" input createAutoTaskGeneratorInput { """ The category of the auto task generator. Options: chart_note_unsigned_after_session - "Complete Charting Note", client_inactivity, metrics_in_month, days_from_client_creation, weeks_following_client_creation, odd_weeks_starting_given_weeks_after_client_creation, days_from_added_to_group, sequential_cancel """ category: String days_due_from_created_at: Int is_enabled: Boolean number_description: String "Number to check for when generating tasks, e.g. hours for chart_note_unsigned_after_session category." number_to_check: String task_description: String user_id_for_task: String } "Autogenerated input type of createAutomatedInsuranceBillingSetting" input createAutomatedInsuranceBillingSettingInput { auto_create_cms1500s: Boolean auto_submit_cms1500s: Boolean insurance_billing_enabled: Boolean } "Autogenerated input type of createAvailability" input createAvailabilityInput { appointment_location_id: String appointment_type_id: String contact_type_id: String "Appointment types this availability covers (provide exactly one option). Omit for the legacy appointment_type_id behavior." appointment_types: AppointmentTypeSelectionInput day_of_week: Int end_on: String "Required time format: `HH MM``, e.g., `07 30`` or `19 00`" end_time: String is_repeating: Boolean "Required date format: `month_name DD, YYYY``, e.g., `August 16, 2022`" range_start: String "Required time format: `HH MM``, e.g., `07 30`` or `19 00`" time: String timezone: String user_id: String end_datetime: String range_end: String start_datetime: String } "Autogenerated input type of createBillingItem" input createBillingItemInput { amount_paid: String created_at: String "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String note: String offering_coupon_id: ID offering_id: ID payment_due_date: String payment_medium: String recipient_id: ID requested_payer_id: ID "The ID of the requested payment to attach this billing item to. Note: scheduled billing items can not be attached to an existing requested payment." requested_payment_id: ID sender_id: ID should_charge: Boolean "When passed in, the patient will be charged on the given payment source. Patient will be charged on their default source if left blank. Comes from the relevant StripeCustomerDetail object." stripe_customer_detail_id: ID stripe_idempotency_key: String user_package_selection_id: ID } "Autogenerated input type of createBrand" input createBrandInput { about_description: String bg_color: String brand_email: String brand_name: String brand_phone: String contact_description: String custom_sign_in_path: String display_name: String email_background_color: String facebook: String font_color: String instagram: String logo: Upload selected_color: String slogan: String tab_accent_color: String titles: String twitter: String website: String } "Autogenerated input type of createCarePlan" input createCarePlanInput { is_hidden: Boolean = true is_managing_templates: Boolean = false name: String patient_id: ID } "Autogenerated input type of createCarePlanRecommendationCategory" input createCarePlanRecommendationCategoryInput { name: String! is_active: Boolean } "Autogenerated input type of createChatSetting" input createChatSettingInput { auto_welcome_text: String content: String end_date: String is_active: Boolean is_recurring_active: Boolean no_end_date: Boolean receive_notifications: Boolean receive_notifications_recurring: Boolean recurring_content: String recurring_days_data: RecurringDaysInputObjectType recurring_turned_on: Boolean scheduled_turned_on: Boolean send_auto_welcome: Boolean start_date: String user_id: String } "Autogenerated input type of createClient" input createClientInput { additional_record_identifier: String "The default billing type for the patient (e.g. insurance or self-pay). Only applicable to patients." default_billing_type: DefaultBillingType "Also known as the provider ID" dietitian_id: String "format: YYYY-MM-DD" dob: String "if true, welcome email is not sent" dont_send_welcome: Boolean email: String first_name: String "Ex. Male" gender: String last_name: String legal_name: String "A serialized JSON string of metadata. Maximum length is 128000" metadata: String other_provider_ids: [String] phone_number: String record_identifier: String "Restricted is only available when enabled for an organization" restricted: Boolean "When true, the client will not be placed into a set password state (where links sent to the client will first take them to set a password)" skip_set_password_state: Boolean = false skipped_email: Boolean "The social security number of the patient" ssn: String "Timezone of the client. IANA DB name format." timezone: String user_group_id: String } "Autogenerated input type of createClientRestrictionAuthorization" input createClientRestrictionAuthorizationInput { "ID of the client to which this authorization applies" client_id: ID! "The provider which is granted access to the client" provider_id: ID! "A reason justifying the authorization" reason: String! } "Autogenerated input type of createCms1500" input createCms1500Input { accept_assignment: Boolean appointment_id: ID amount_paid: String client_sig_on_file: Boolean cms1500_policies: [Cms1500PolicyInput] cpt_codes_cms1500s: [CptCodesCms1500Input] dietitian: DietitianInput dietitian_id: String form_answer_group_id: ID icd_codes_cms1500s: [IcdCodesCms1500Input] include_referrer_information: Boolean insured_sig_on_file: Boolean nineteen_reserved: String organization_info: OrganizationInfoInput organization_info_id: String orig_ref_number: String patient: PatientInput patient_account_num: String referral_info: ReferralInfoInput rendering_provider_other_id: String rendering_provider_other_id_number: OtherIdNumberInput resubmission_code: String service_location_id: String tend_reserved: String use_indiv_npi: Boolean } "Autogenerated input type of createCognitiveStatus" input createCognitiveStatusInput { cognitive_status: String start_date: String user_id: ID } "Autogenerated input type of createComment" input createCommentInput { content: String entry_id: ID is_reaction: Boolean user_id: ID } "Autogenerated input type of createCompletedCourseItem" input createCompletedCourseItemInput { completed_item_id: String completed_item_type: String course_item_id: String id: String user_id: String } "Autogenerated input type of createCompletedOnboardingItem" input createCompletedOnboardingItemInput { onboarding_item_id: ID skipped: Boolean user_id: ID } "Autogenerated input type of createContact" input createContactInput { about_me: String email: String first_name: String first_url: String last_name: String phone_number: String } "Autogenerated input type of createConversation" input createConversationInput { appointment_id: String name: String "The ID of the owner of the conversation. Defaults to current_user when not sent in" owner_id: ID added_users: [AddedUsersInput] "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON note: NoteInput "The value of the select all toggle. This overrides simple_added_users and allows you to easily add all of a category to the conversation. Requires simple_added_users to be sent in as well" select_all_status: String simple_added_users: String } "Autogenerated input type of createCourseBenefit" input createCourseBenefitInput { benefit: String course_id: String } "Autogenerated input type of createCourse" input createCourseInput { course_type: String description: String external_preview_image_url: String formatted_benefits: String late_enroll: Boolean name: String preview_image: Upload preview_video_content: String start_date: String } "Autogenerated input type of createCourseItem" input createCourseItemInput { completion_required_for_next_module: Boolean course_id: String item_id: String item_type: String name: String new_item_type_name: String scheduled_release: String user_id: String video_url: String } "Autogenerated input type of createCustomEmail" input createCustomEmailInput { email_type: String greeting: String message_body: String reactivation_wait_days: String subject: String } "Autogenerated input type of createCustomFood" input createCustomFoodInput { name: String nutrients: NutrientsInput serving_size: ServingSizeInput user_id: String } "Autogenerated input type of createCustomModuleForm" input createCustomModuleFormInput { external_id: String external_id_type: String is_video: Boolean "Maximum character limit of 10,000." metadata: String name: String on_completion_ifs_tag_id: String prefill: Boolean use_for_charting: Boolean use_for_program: Boolean } "Autogenerated input type of createCustomModule" input createCustomModuleInput { custom_module_form_id: String external_id: String external_id_type: String index: Int is_custom: Boolean label: String "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String mod_type: String options: String parent_custom_module_id: String required: Boolean sublabel: String } "Autogenerated input type of createDocument" input createDocumentInput { care_plan_id: ID clients_ids: String course_id: String "Requires additional permissions to edit" created_at: String description: String display_name: String file: Upload file_string: String folder_id: String from_date: String from_program_create: Boolean "When true, a CCDA document is created for the specified rel_user" generate_ccda_for_rel_user_id: Boolean "When true, a human-readable CCDA document is created for the specified rel_user" generate_human_readable_ccda_for_rel_user_id: Boolean include_in_charting: Boolean is_photo_id: Boolean "Metadata for an document type. Maximum character limit of 128,000." metadata: String "Optional. This is passed in when a document is uploaded via a Form Upload question module. Should be the User ID. Otherwise, nil." on_form_for_user_id: ID org_level: Boolean payout_id: ID provider_ids: [String] = [] rcf_id: ID rel_user_id: String """ If using the report_type parameter, value must be one of the following options: "Short Client List", "Long Client List", "Client Activity List", "Client Metrics", "Appointments", "Courses", "Program Forms", "Clients Credits", "Payments", "Transfers", "Transactions", "CMS1500s", "Superbills", "Referring Physicians", "Insurance Authorization", "Client Blood Sugar", "Requested Payments" """ report_type: String "A comma-separated list of doc_share_ids" share_users: String share_with_rel: Boolean to_date: String "Requires additional permissions to edit" updated_at: String } "Autogenerated input type of createDosespotClinician" input createDosespotClinicianInput { "Required" business_address: String "Required" city: String "Required" date_of_birth: String "Required when role is prescribing provider and prescribe_controlled_substances checked" dea_number: String "Required for prescribing provider" eligible_prescribe_medications: Boolean "Required" fax_number: String "Required" full_name: String "Required for prescribing provider" npi_number: String prescribe_controlled_substances: Boolean "Required. Dosespot user role (Prescribing Provider: 1, Proxy: 6)" role: Int "Required" state: String "Required" work_phone_number: String "Required" zip: String } "Autogenerated input type of createDraft" input createDraftInput { content: String conversation_membership_id: String } "Autogenerated input type of createDsiComment" input createDsiCommentInput { content: String! intervention_type: InterventionType! } "Autogenerated input type of createEbook" input createEbookInput { email: String first_name: String first_url: String } "Autogenerated input type of createEntry" input createEntryInput { """ The category of the entry (e.g., "Steps", "Average Heart Rate", etc.). """ category: String "The timestamp when the entry was created." created_at: String "A text description or note associated with the entry." description: String "A 1-10 hunger scale after eating, where 1 is ravenous and 10 is painfully full." ed_posthunger: String "A 1-10 hunger scale before eating, where 1 is ravenous and 10 is painfully full." ed_prehunger: String "A numerical value representing the user's mood towards the meal (e.g., 1: Stressed, 2: Anxious, 3: Tired, 4: Bored, 5: Confident, 6: Happy, 7: Sad, 8: Angry)." emotions: String "A comma-separated list of food items, where each item is formatted as 'Food record ID;ServingSize record ID;modifier' (e.g., '123;456;1,789;012;2'). Modifier is a numeric multiplier on the serving size. Associates the items with a Meal linked to this entry." food_items: String "An image file upload to attach to the entry. See 'File Uploads' under 'API Concepts' in our 'Guides and Recipes' for more information on how to upload files." image: Upload "A base64-encoded image string to attach to the entry, used as an alternative to the image upload field." image_string: String "A comma-separated list of meal IDs to associate with this entry." meal_ids: String "The name of a new meal to create and associate with this entry." meal_name: String "The statistic associated with the metric entry." metric_stat: String "If true, will trigger a notification to the provider based on the provider settings. If nil or false will trigger a notification to the provider if the poster is a patient." notify_provider: Boolean "Other symptom typed by the client." other_symptom: String "The user's self-reported hunger level." perceived_hungriness: String "The user's free-text reflection or notes about the meal." reflection: String "A comma-separated list of symptom IDs selected by the client for this entry." symptoms: String "The third-party source that created this entry (e.g., apple_health, google_fit, fitbit)." third_party_source: String "The type of entry to create. One of MetricEntry, FoodEntry, WorkoutEntry, MirrorEntry, SleepEntry, NoteEntry, WaterIntakeEntry, PoopEntry, SymptomEntry." type: String "The ID of the user (patient) for whom the entry is being created. Defaults to the current user if not provided." user_id: String "The list of subentries associated with this entry." subentries: [SubentryInput] } "Autogenerated input type of createEpisodeOfCare" input createEpisodeOfCareInput { "ID of the patient to create an episode of care for" patient_id: ID! "ID of the provider responsible for the patient episodes of care" provider_id: ID! "ID of the diagnosis associated with this episode of care" diagnosis_id: ID! "Start date (must be present or in the past) for this episode of care" start_date: ISO8601Date! "End date when episodes of care ended" end_date: ISO8601Date } "Autogenerated input type of createExternalCalendar" input createExternalCalendarInput { access_token: String "Optional. The resource name (sync partner assigned ID) for the sync" resource_name: String "When true, appointments will automatically be pushed to the external calendar" add_to_calendar: Boolean = true "The email of the Google or Outlook account that is being synced" email: String "The date and time the token will expire. In ISO8601 format." expiry_date: String "The type of External Calendar. Can either be Google or Outlook" external_type: String "When true, appointments will automatically be pulled from the external calendar" pull_from_calendar: Boolean = true "(Only for Google). The calendars to pull in from. Defaults to the primary calendar" pulled_in_calendars: [String] "The refresh token that can be used to generate new access tokens for the sync. This requires whitelabeled calendar sync to be enabled for your account" refresh_token: String token_type: String = "Bearer" "The ID of the user to associate the calendar with. Must be an org admin to create an external calendar for a different org user. If nil, defaults to current user" user_id: ID } "Autogenerated input type of createFamilyHistory" input createFamilyHistoryInput { relationships: [String] concept_id: String user_id: ID } "Autogenerated input type of createFaxAcctInfo" input createFaxAcctInfoInput { aes_key: String api_key: String fax_number: String notify_provider: Boolean user_id: ID username: String } "Autogenerated input type of createFaxLineRequest" input createFaxLineRequestInput { area_code: String bill: Upload city: String loa: Upload request_type: String state: String } "Autogenerated input type of createFeatureToggle" input createFeatureToggleInput { allow_apple_health_sync: Boolean allow_clearstep_sync: Boolean allow_community_chat: Boolean allow_direct_chat: Boolean allow_fitbit_sync: Boolean allow_google_fit_sync: Boolean allow_google_health_connect_sync: Boolean allow_shapa_sync: Boolean allow_withings_sync: Boolean apply_eating_disorder_default: Boolean can_schedule_appointments: Boolean can_track_poop: Boolean can_track_symptoms: Boolean can_track_water_intake: Boolean can_view_care_plan: Boolean can_view_documents: Boolean can_view_forms: Boolean can_view_goals: Boolean can_view_journal_entries: Boolean can_view_packages: Boolean can_view_payments: Boolean can_view_programs: Boolean care_plan_id: ID custom_metric_overrides: [CustomMetricOverridesInput] custom_metrics: [CustomMetricInput] default_water_intake: String do_not_auto_submit_cms1500: Boolean email_notification_frequency: String push_notification_frequency: String "When true, clients must complete their intake forms before they can access chat or join platform-hosted video calls (external video links are unaffected)" require_intake_for_communication: Boolean send_unpaid_invoice_reminder: Boolean separate_provider_metric_from_client: Boolean show_a1c_metric: Boolean show_bf_percent_metric: Boolean show_blood_pressure_metric: Boolean show_blood_sugar_metric: Boolean show_bmi_graph: Boolean show_bmi_growth_chart: Boolean show_bmr_metric: Boolean show_body_temperature_metric: Boolean show_client_a1c_metric: Boolean show_client_bf_percent_metric: Boolean show_client_blood_pressure_metric: Boolean show_client_blood_sugar_metric: Boolean show_client_bmi_graph: Boolean show_client_bmi_growth_chart: Boolean show_client_bmr_metric: Boolean show_client_body_temperature_metric: Boolean show_client_harris_benedict: Boolean "The status of whether the client can view and track their height" show_client_height_graph: Boolean show_client_height_growth_chart: Boolean show_client_ox_sat_metric: Boolean show_client_waist_circumference_metric: Boolean show_client_weight_growth_chart: Boolean show_client_weight_metric: Boolean show_ed_posthunger: Boolean show_ed_prehunger: Boolean show_food: Boolean show_food_category: Boolean show_food_emotion: Boolean show_food_reflection: Boolean show_harris_benedict: Boolean show_healthiness: Boolean "The status of whether the provider can view and track the client's height" show_height_graph: Boolean show_height_growth_chart: Boolean show_metric: Boolean show_mirror: Boolean show_normal_hunger: Boolean show_note: Boolean show_note_emotion: Boolean show_nutrients_tracking: Boolean show_ox_sat_metric: Boolean show_waist_circumference_metric: Boolean show_weight_growth_chart: Boolean show_weight_metric: Boolean show_workout: Boolean use_metric_system: Boolean user_group_id: ID user_id: ID "Enables client access to medications and prescriptions (mobile app only)" view_medications: Boolean view_not_track: Boolean } "Autogenerated input type of createFitbit" input createFitbitInput { access_token: String expires_at: String last_sync_date: String refresh_token: String user_id: ID } "Autogenerated input type of createFolder" input createFolderInput { folder_id: String name: String rel_user_id: String share_users: String share_with_rel: Boolean } "Autogenerated input type of createFormAnswerFileAttachment" input createFormAnswerFileAttachmentInput { "The form answer ID to attach the blob to" form_answer_id: ID! "The upload ID that was returned from the createFormAnswerFileAttachmentUploadUrl mutation" upload_id: ID! } "Autogenerated input type of createFormAnswerFileAttachmentUploadUrl" input createFormAnswerFileAttachmentUploadUrlInput { "The ID of the form answer to attach the file to" form_answer_id: ID! "The name of the file to upload" filename: String! "The size of the file in bytes" byte_size: Int! "The base64 encoded MD5 checksum of the file. This is used to verify the integrity of the file on upload." checksum: String! "The MIME type of the file" content_type: String! } "Autogenerated input type of createFormAnswerGroup" input createFormAnswerGroupInput { "ID of the appointment associated with this form answer group." appointment_id: ID "ID of the course associated with this form answer group." course_id: String "ID of the course item completed by submitting this form." course_item_id: ID "Sets the created_at timestamp of the form answer group." created_at: String "ID of the form template (CustomModuleForm) being completed." custom_module_form_id: String "Date portion of the service date, used with `time` to set the creation timestamp." date: String "External identifier for integration with third-party systems." external_id: String "Whether the form has been completed and submitted, as opposed to saved as a draft." finished: Boolean "Individual form answers to submit with this form." form_answers: [FormAnswerInput] "The datetime of service." formatted_date: String "Marks the form as explicitly completed, setting the marked_complete_at timestamp." marked_complete: Boolean "Locks the form from further editing after creation." marked_locked: Boolean "Name or title for this form answer group." name: String "Maximum character limit of 128,000." metadata: String "ID of the RequestedFormCompletion record this submission fulfills." requested_form_completion_id: ID = null "When true and no form answers are provided, auto-populates the form with default initial answers." set_initial_answers: Boolean "Time portion of the service date (e.g., '10 30' for 10:30 AM), used with `date` to set the creation timestamp." time: String "Sets the updated_at timestamp of the form answer group. Requires additional permissions to edit." updated_at: String "ID of the client or patient the form is associated with." user_id: String "Creation of a form_answer_group in the context of an onboarding_item_id." onboarding_item_id: ID = null } "Autogenerated input type of createFormAnswerGroupSigning" input createFormAnswerGroupSigningInput { form_answer_group_id: String user_id: String } "Autogenerated input type of createFullscriptPractitioner" input createFullscriptPractitionerInput { "Email address of the practitioner to create" email: String "First name of the practitioner to create" first_name: String "Last name of the practitioner to create" last_name: String "The ID of the Fullscript practitioner type for the practitioner to create" practitioner_type_id: String } "Autogenerated input type of createFunctionalStatus" input createFunctionalStatusInput { functional_condition: String start_date: String user_id: ID } "Autogenerated input type of createGoalHistory" input createGoalHistoryInput { "The action type that was performed on a specific goal that created this history record" action: GoalHistoryActionTypeEnum "The day the goal should be marked complete for. Should be of the form: 'yyyy-mm-dd'" completed_on: String goal_id: String "If true, will mark parent goal completed (must be a subgoal)" mark_parent_complete: Boolean user_id: String } "Autogenerated input type of createGoal" input createGoalInput { "The id of associated care plan" care_plan_id: ID description: String "The date the goal should end - format should be: yyyy-mm-dd" due_date: String name: String parent_id: String "If true, create goal for program" program_goal: Boolean reminder: ReminderInput "The frequency of this goal. Possible values are: 'Daily','Weekly', 'Once'" repeat: String "The id of goal template used to create this goal" source_template_id: String "The date the goal should start - format should be: yyyy-mm-dd" start_on: String subgoals: [SubgoalInput] "Title hyperlink. Opens when the name is clicked on." title_link: String "If true, use this goal as a template(favorite)" use_as_template: Boolean user_id: String } "Autogenerated input type of createGoogleFit" input createGoogleFitInput { access_token: String expiry_date: String is_enabled: Boolean last_sync_date: String refresh_token: String user_id: ID } "Autogenerated input type of createGroup" input createGroupInput { name: String } "Autogenerated input type of createHealthConcern" input createHealthConcernInput { code: String description: String display_name: String effective_time: String user_id: ID } "Autogenerated input type of createImmunization" input createImmunizationInput { additional_notes: String cvx_code: Int received_at: String status: String user_id: ID vaccine_name: String } "Autogenerated input type of createImplantableDeviceUser" input createImplantableDeviceUserInput { user_id: ID udi: String active: Boolean name: String } "Autogenerated input type of createImportDataRequest" input createImportDataRequestInput { clients_template: Upload display_name: String extension: String optional_comment: String request_type: String } "Autogenerated input type of createInsuranceAuthorization" input createInsuranceAuthorizationInput { authorization_number: String end_on: String policy_id: String start_on: String unit_type: String units_authorized: String units_used: String user_id: ID visits_authorized: String visits_used: String } "Autogenerated input type of createInsurancePayment" input createInsurancePaymentInput { paid_date: ISO8601Date! npi: String! ach_check_number: String paid_amount: Float! deposit_status: InsurancePaymentsDepositStatusEnum! payer_name: String! } "Autogenerated input type of createInsurancePlan" input createInsurancePlanInput { add_as_accepted_insurance_plan: Boolean payer_id: String payer_name: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON } "Autogenerated input type of createLabOrder" input createLabOrderInput { "Required. The ID of the PDF or HL7 document containing the lab results. Needs to be pre-created and have a rel_user_id matching the patient ID" document_id: ID "Required. The lab panel that was ordered" lab: String "Required. The lab company who processed the order" lab_company: String "Required. The ID of the user in Healthie who ordered the lab" orderer_id: ID "Required. The ID of the patient" patient_id: ID "A list of the discrete data points that will be collected in the lab panel" lab_observation_requests: [LabObservationRequestInput] "Optional. Additional arguments for submitting orders" submission: SubmissionInput } "Autogenerated input type of createLocation" input createLocationInput { city: String country: String line1: String line2: String name: String npi: String other_id: String other_id_qual: String place_of_service_id: String state: String user_id: String zip: String } "Autogenerated input type of createMeal" input createMealInput { food_items: String name: String user_id: String } "Autogenerated input type of createMedication" input createMedicationInput { active: Boolean = false code: String comment: String "Requires additional permissions to edit" created_at: String custom_name: String directions: String dosage: String "The dosage option id to associate with the medication" dosage_option_id: ID "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON end_date: String frequency: String name: String route: String start_date: String "Requires additional permissions to edit" updated_at: String user_id: String } "Autogenerated input type of createMessageBlast" input createMessageBlastInput { dietitian_id: String name: String note: NoteInput patient_id: String scheduled_at: String "The value of the select all toggle. This overrides simple_added_users and allows you to easily add all of a category to the conversation. Requires simple_added_users to be sent in as well" select_all_status: String simple_added_users: String } "Autogenerated input type of createNote" input createNoteInput { attached_audio: Upload attached_document: Upload attached_image: Upload attached_image_string: String content: String conversation_id: String created_at: String hide_org_chat_confirmation: Boolean "True, if a note create action called in the organization chat context" org_chat: Boolean scheduled_at: String updated_at: String user_id: String } "Autogenerated input type of createNotificationContact" input createNotificationContactInput { client_portal_access: Boolean client_portal_setting: ClientPortalSettingInput = null contact_form: String "Valid values: adult, minor" contact_type: String copy_notifications: Boolean email: String emergency: Boolean first_name: String last_name: String phone_number: String "Valid values: caregiver, child, dependent, family_member, legal_guardian, is_parent, spouse, other" relationship: String user_id: String dietitian_id: String linked_client_id: String send_invitation: Boolean user_group_id: String } "Autogenerated input type of createOfferingCoupon" input createOfferingCouponInput { amount_off: String code: String expires_at: String flat_amount_off: String offering_ids: String promo_type: String repeat_times: String usage_limit: String } "Autogenerated input type of createOffering" input createOfferingInput { billing_frequency: String can_be_gifted: Boolean charge_immediately: Boolean course_id: ID course_ids: String default_selection_image_url: String description: String first_time_payment: String lab_option_ids: String living_plate_meal_plan_id: String max_purchases: String name: String offering_image: OfferingImageUpload offering_includes: [OfferingIncludesFields] offering_products: [OfferingProductInput] override_group_on_purchase: Boolean price: String repeat_times: String require_booking_purchase: Boolean selected_image_id: ID show_free_text: Boolean show_offering: Boolean user_group_id: ID user_group_ids: String user_id: ID video_url: String visibility_status: String = "hidden" } "Autogenerated input type of createOfficeallySftpAccount" input createOfficeallySftpAccountInput { "The OfficeAlly SFTP URL" ftp_url: String "The SFTP password (maximum 25 characters)" password: String "The SFTP username (maximum 50 characters)" username: String } "Autogenerated input type of createOnboardingFlow" input createOnboardingFlowInput { groups_to_use_onboarding_flow: String name: String } "Autogenerated input type of createOnboardingItem" input createOnboardingItemInput { billing_disclaimer: String is_skippable: Boolean item_id: String item_type: String new_form_name: String onboarding_flow_id: String policy_disclaimer: String welcome_text: String } "Autogenerated input type of createOrAddToWaterIntakeEntry" input createOrAddToWaterIntakeEntryInput { created_at: String metric_stat: String type: String user_id: String } "Autogenerated input type of createOrganizationCptCode" input createOrganizationCptCodeInput { cpt_code_id: ID organization_id: ID price_per_unit: String organization_cpt_code_insurance_fees: [OrganizationCptCodeInsuranceFeesInput] } "Autogenerated input type of createOrganization" input createOrganizationInput { "When true, the new organization will be created as a sub-organization of the current users. Healthie support needs to enable this ability on your account. Must be passed along with user details" create_as_suborganization: Boolean email: String "Must be provided with create_as_suborganization, last_name, and email. When passed will create a new user that will be the owner of the suborg" first_name: String last_name: String "The email of organization" organization_email: String organization_info: PrimaryOrganizationInfoInput "Can optionally be passed in along with last_name, first_name, and email. When passed in, the newly created user will have this password" password: String "When email is passed in, this determines whether to send an invite email to the newly created organization user" send_invite_email: Boolean = true sub_org_settings: SubOrganizationInfoInput } "Autogenerated input type of createOrganizationMembership" input createOrganizationMembershipInput { """ Options are ["Standard", "Support"] """ org_role: String "Selected permission template" permission_template_id: ID email: String first_name: String last_name: String "Can optionally be passed in along with last_name, first_name, and email. When passed in, the newly created user will have this password" password: String professions: [ProfessionsInput] "When true, an invite email will be sent to the newly created organization member" send_invite_email: Boolean = true specialties: [SpecialtiesInput] "Organization’s member timezone" timezone: String "Lets you add extra metadata about the organization membership. Not used in Healthie UI" title: String "Required: The ID of the organization" organization_id: ID } "Autogenerated input type of createPartner" input createPartnerInput { about_me: String email: String first_name: String first_url: String last_name: String phone_number: String } "Autogenerated input type of createPaymentIntent" input createPaymentIntentInput { "The amount to charge in decimal format. e.g 10.99" amount_to_pay: String coupon_code: String "The currency the payment will be made in. e.g 'usd'" currency: String email: String first_name: String last_name: String "Optional. Defaults to first_name if left blank." legal_name: String offering_id: ID "An array of possible payment method Required. Options are 'klarna', 'apple_pay', and 'google_fit'" payment_method_types: [String] "Optional" phone_number: String "The ID of the provider who will receive the payment." recipient_id: ID "Optional, but recommended. Used to prevent duplicate PaymentIntents from being created." stripe_idempotency_key: String "Optional" timezone: String } "Autogenerated input type of createPdfLetterheadTemplate" input createPdfLetterheadTemplateInput { "The source the address should be taken from" address_source: PdfLetterheadTemplateAddressSource = ORGANIZATION "The source the brand logo should be taken from" brand_logo_source: PdfLetterheadTemplateBrandLogoSource = ORGANIZATION "The source the email address should be taken from" email_source: PdfLetterheadTemplateEmailSource = ORGANIZATION "Whether the brand logo should be shown in PDF" include_brand_logo: Boolean = true "Whether the address should be shown in PDF" include_address: Boolean = true "Whether the appointment details should be shown in PDF" include_appointment_details: Boolean = true "Whether the email address should be shown in PDF" include_email: Boolean = true "Whether the phone number should be shown in PDF" include_phone_number: Boolean = true "Whether the name of the team member should be shown in PDF" include_team_member_name: Boolean = true "Whether the name of the organization should be shown in PDF" include_organization_name: Boolean = true "Whether provider's NPI should be shown in PDF" include_team_member_npi: Boolean = true "Whether provider's qualifications should be shown in PDF" include_team_member_qualifications: Boolean = true "Custom email address to use in PDF" other_email: String "Custom phone number to use in PDF" other_phone_number: String "The source the phone number should be taken from" phone_number_source: PdfLetterheadTemplatePhoneNumberSource = ORGANIZATION "The source the team member's name should be taken from" team_member_name_source: PdfLetterheadTemplateTeamMemberNameSource = CURRENT_USER "The title for the PDF Letterhead Template" title: String } "Autogenerated input type of createPermissionTemplate" input createPermissionTemplateInput { allow_self_scheduling_in_care_team: Boolean auto_create_convo_for_care_team: Boolean can_access_calendar_quick_share: Boolean can_access_to_members_chat: Boolean can_add_clients: Boolean can_add_members: Boolean can_add_members_to_chat: Boolean can_assign_tasks_to_all_org_members: Boolean can_be_care_team_member: Boolean can_charge_clients: Boolean can_delete_charting_notes: Boolean can_delete_faxes: Boolean can_edit_appointment_types: Boolean can_edit_calendar: Boolean "If true, the user can manage their own availability" can_manage_own_availability: Boolean "If true, the user can manage their own blocks" can_manage_own_blocks: Boolean "If true, the user can manage other members' availability" can_manage_others_availability: Boolean "If true, the user can manage other members' blocks" can_manage_others_blocks: Boolean "If true, the user can add appointments on their own calendar" can_add_own_appointments: Boolean "If true, the user can add appointments on other providers' calendars" can_add_others_appointments: Boolean "If true, the user can edit appointments on their own calendar" can_edit_own_appointments: Boolean "If true, the user can edit appointments on other members' calendars" can_edit_others_appointments: Boolean "If true, the user can change the status of appointments on their own calendar" can_status_own_appointments: Boolean "If true, the user can change the status of appointments on other members' calendars" can_status_others_appointments: Boolean "If true, the user can delete appointments on their own calendar" can_delete_own_appointments: Boolean "If true, the user can delete appointments on other members' calendars" can_delete_others_appointments: Boolean can_edit_credit: Boolean can_edit_docs: Boolean can_edit_education: Boolean can_edit_forms: Boolean can_edit_members: Boolean can_edit_packages: Boolean can_edit_products: Boolean can_edit_settings: Boolean can_enroll_clients_to_programs: Boolean can_lock_others_charting_notes: Boolean can_lock_own_charting_notes: Boolean can_mark_assigned_tasks_to_other_org_members_as_completed: Boolean can_merge_clients: Boolean can_order_labs: Boolean can_view_labs: Boolean can_remove_client: Boolean can_create_tags: Boolean can_rename_and_delete_tags: Boolean can_restrict_clients: Boolean can_see_billing: Boolean can_see_calendar: Boolean can_see_clients: Boolean can_see_docs: Boolean can_see_faxes: Boolean can_see_fullscript_tab: Boolean can_see_sent_faxes: Boolean can_see_transfers: Boolean can_set_client_password: Boolean can_share_documents_and_folders_with_org_members: Boolean can_sign_others_charting_notes: Boolean can_sign_own_charting_notes: Boolean can_submit_cms_1500s_to_office_ally: Boolean can_unlink_chart_note_from_appointment: Boolean can_unlock_charting_notes: Boolean can_view_audit_log: Boolean can_view_all_org_members_tasks: Boolean can_view_cms1500s: Boolean can_view_goal_templates: Boolean can_view_org_dashboard: Boolean "If true, the user can delete Zoom recordings and transcripts" can_delete_recordings: Boolean "If true, the user can view Zoom recordings and transcripts" can_view_recordings: Boolean can_view_reports: Boolean can_view_super_bills: Boolean can_write_org_addendums: Boolean "If true, the user can access Zus functionality" can_access_zus: Boolean gets_failed_fax_notif: Boolean gets_fax_notif: Boolean has_own_branding: Boolean is_admin: Boolean is_provider: Boolean is_developer: Boolean name: String notify_any_client_activity: Boolean notify_on_book: Boolean notify_on_cancel: Boolean notify_on_payment_failure: Boolean org_role: String organization_id: ID request_eligibility_checks: Boolean sees_all_billing: Boolean sees_all_clients: Boolean send_email_on_intake_flow_complete: Boolean send_email_on_intake_flow_start: Boolean share_appointment_types: Boolean share_custom_metrics: Boolean share_fullscript: Boolean share_goal_templates: Boolean share_packages: Boolean share_smart_phrases: Boolean show_availability_first: Boolean show_org_tab: Boolean start_conversation_with: Boolean share_user_groups: Boolean allow_group_level_actions: Boolean can_manage_care_plan_templates: Boolean can_autogenerate_charting_notes_from_zoom_calls: Boolean "If true, the user can generate encounter summaries" can_generate_encounter_summaries: Boolean "If true, the user can view encounter summaries" can_view_encounter_summaries: Boolean create_chat_when_assigned: Boolean can_remove_org_member_signatures: Boolean "Requires the organization to have instant transcripts enabled" instant_transcribe_enabled: Boolean } "Autogenerated input type of createPersonalizationQuestionnaire" input createPersonalizationQuestionnaireInput { "Deprecated. No longer collected during onboarding" billing_address: BillingAddressInput "List of features the user considers most important for their practice. Filled out during Onboarding Questionnaire." most_important_features: [String] plans_to_add_more_users: String professions: [String] } "Autogenerated input type of createPreferredMedicalCode" input createPreferredMedicalCodeInput { code_ids: [ID] code_type: String } "Autogenerated input type of createProcedure" input createProcedureInput { code: String code_system_name: String cpt_code_id: ID display_name: String procedure_end_datetime: String procedure_start_datetime: String status: String target_site: String user_id: ID } "Autogenerated input type of createProduct" input createProductInput { name: String price: String remaining_quantity: String tax_description: String tax_rate: String unlimited_quantity: Boolean } "Autogenerated input type of createProviderAcceptedInsurancePlans" input createProviderAcceptedInsurancePlansInput { "The ID of the provider that the provider accepted insurance plan is associated with." provider_id: ID! "A list of accepted insurance plan IDs to associate with the provider." accepted_insurance_plan_ids: [ID!] } "Autogenerated input type of createProviderCptCodes" input createProviderCptCodesInput { provider_cpt_codes: [ProviderCptCodeInput] provider_id: ID } "Autogenerated input type of createRecommendation" input createRecommendationInput { care_plan_id: ID form_answer_id: ID care_plan_recommendation_category_id: ID recommendation_body: String } "Autogenerated input type of createReferral" input createReferralInput { "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String referral_reason: String referring_physician_id: ID user_id: ID } "Autogenerated input type of createReferringPhysician" input createReferringPhysicianInput { accepts_insurance: Boolean business_name: String email: String fax_number: String first_name: String last_name: String location: PhysicianLocationInput "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String notes: String npi: String other_id: String other_id_qualifier: String phone_number: String referrals: [PhysicianReferralInput] = [] speciality: String website: String } "Autogenerated input type of createRequestedForm" input createRequestedFormInput { custom_module_form_id: ID item_type: String recipient_id: ID ends_on: String "The ID of the custom form OR the name of the generic form (e.g 'billing_info')" form: String frequency: String hour: String is_recurring: Boolean "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String minute: String monthday: String period: String "A comma-separated list of user IDs and/or user group IDs. If passing user group IDs, they should take the following format: 'group-1,group-2,group-3' You can pass both user IDs and user group IDs. Example: '1,2,3,group-1,group-2' If you pass a user group ID, all users in that group will be sent the form." recipient_ids: String recurrence_ends: Boolean weekday: String "True to skip sending the notifying email to clients, default false" skip_notification_email: Boolean = false } "Autogenerated input type of createRequestedPayment" input createRequestedPaymentInput { appointment_id: ID cms1500_id: ID invoice_type: String is_preview: Boolean "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON notes: String offering_id: ID price: String recipient_id: ID requested_payer: RequestedPayerInput requested_payment_template: RequestedPaymentTemplateInput sender_id: ID service_date: String services_provided: String status: String user_package_selection_id: ID write_offs: [WriteOffInput] } "Autogenerated input type of createRupaOrder" input createRupaOrderInput { client_id: ID } "Autogenerated input type of createSavedFilter" input createSavedFilterInput { "Name of the new saved filter" name: String! "ID of the organization with access to the filter. Will be assigned to organization ID of user if not provided" organization_id: ID } "Autogenerated input type of createSentDirectMessage" input createSentDirectMessageInput { "Required" message_body: String "The recipient address (max 100 characters)" outbound_recipient: String "The subject of the direct message (max 100 characters)" subject: String patient_id: ID binary_attachment_document_id: ID include_patient_xml: SentDirectMessageXml } "Autogenerated input type of createSentFax" input createSentFaxInput { answer_ids: String date: String destination_number: String "AKA the provider. Required" dietitian: FaxDietitianInput document_id: String document_ids: String form_answer_group_ids: String include_header_on_every_page: Boolean include_hipaa_disclaimer: Boolean include_letterhead: Boolean patient_id: String pdf_letterhead_template_id: ID recipient_company: String recipient_name: String remarks: String skip_cover_page: Boolean subject: String } "Autogenerated input type of createSetupIntent" input createSetupIntentInput { email: String first_name: String last_name: String "Optional. Defaults to first_name if left blank." legal_name: String "Optional" phone_number: String "The ID of the provider who will be associated with this payment method." provider_id: ID "Optional, but recommended. Used to prevent duplicate SetupIntents from being created." stripe_idempotency_key: String "Optional" timezone: String "The ID of the organization associated with this setup intent." organization_id: ID } "Autogenerated input type of createSmartPhrase" input createSmartPhraseInput { "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON name: String phrase: String "Create the smart phrase on behalf of this user. Requires org-level access." user_id: ID } "Autogenerated input type of createSmokingStatus" input createSmokingStatusInput { smoking_status_code: String status_end_datetime: String status_start_datetime: String user_id: ID } "Autogenerated input type of createStripeCustomerDetail" input createStripeCustomerDetailInput { "Options are 'hsa', 'fsa', and 'personal'. Defaults to personal" card_type_label: String is_default: Boolean token: String user_id: ID } "Autogenerated input type of createSubscription" input createSubscriptionInput { plan_id: String "Can be passed in instead of plan_id to select which plan the subscription should be on. Normally preferable to use plan_id" plan_name: String stripe_idempotency_key: ID token: String billing_address: BillingAddressInput } "Autogenerated input type of createSuperBill" input createSuperBillInput { address: String amount_paid: String cpt_codes_super_bills: [CptCodesSuperBillInput] dietitian_id: ID icd_codes_super_bills: [IcdCodesSuperBillInput] license_num: String location: LocationInputs location_id: ID npi: String patient_dob: String patient_id: ID patient_location: PatientLocationInputs patient_name: String patient_phone: String place_of_service_id: ID prov_city: String prov_email: String prov_line1: String prov_line2: String prov_phone: String prov_state: String prov_zip: String provider_name: String receipt_line_items: [ReceiptLineItemInput] referrer_name: String referrer_npi: String service_date: String status: String tax_id: String } "Autogenerated input type of createTag" input createTagInput { name: String "The ID of the user to apply a tag on" taggable_user_id: ID } "Autogenerated input type of createTask" input createTaskInput { "IDs of the users assigned to this task" assignee_ids: [ID!] "The identifier of the client (patient) associated with this task" client_id: String complete: Boolean completed_by_id: ID content: String "The ID of the user (provider or staff member) who is listed as creating the task" created_by_id: String due_date: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON note_id: ID priority: Int reminder: TaskReminderInput seen: Boolean "Whether the task is a system-generated smart task" smart: Boolean "What generated this smart task" smart_source: SmartSource } "Autogenerated input type of createUniqueDeviceIdentifier" input createUniqueDeviceIdentifierInput { assigning_authority: String device_code: String display_name: String scoping_entity: String udi_code: String user_id: ID } "Autogenerated input type of createVisitor" input createVisitorInput { email: String first_name: String first_url: String } "Autogenerated input type of createWebhook" input createWebhookInput { event_type: String is_enabled: Boolean should_retry: Boolean = true "A valid URL per the WHATWG specification" url: String "Webhook events to create" webhook_events: [WebhookEventInput] } "Autogenerated input type of createWriteOff" input createWriteOffInput { "The ID of the write-off to update" requested_payment_id: ID! "The type of write-off" write_off_type: WriteOffType! "The amount of the write-off" amount: Float! """ Required if write_off_type is "other" """ other_reason: String } "Autogenerated input type of deleteAcceptedInsurancePlan" input deleteAcceptedInsurancePlanInput { id: ID } "Autogenerated input type of deleteAllergySensitivity" input deleteAllergySensitivityInput { id: ID } "Autogenerated input type of deleteApiKey" input deleteApiKeyInput { id: ID } "Autogenerated input type of deleteAppleHealth" input deleteAppleHealthInput { id: ID } "Autogenerated input type of deleteAppointmentFormAnswerGroupConnection" input deleteAppointmentFormAnswerGroupConnectionInput { form_answer_group_id: ID } "Autogenerated input type of deleteAppointment" input deleteAppointmentInput { appointment_inclusion_uuid: ID deleteRecurring: Boolean id: ID cancellation_reason: CancellationReasonOptionInput """ When true, suppresses "appointment.deleted" webhook notifications from this API call. Does not work with recurring appointments. """ suppress_webhook_notifications: Boolean = false } "Autogenerated input type of deleteAppointmentRequest" input deleteAppointmentRequestInput { "ID of the appointment request to delete" id: ID! } "Autogenerated input type of deleteAppointmentTypeCptCode" input deleteAppointmentTypeCptCodeInput { id: ID } "Autogenerated input type of deleteAppointmentType" input deleteAppointmentTypeInput { id: ID } "Autogenerated input type of deleteAutoTaskGenerator" input deleteAutoTaskGeneratorInput { id: ID } "Autogenerated input type of deleteAvailability" input deleteAvailabilityInput { id: ID } "Autogenerated input type of deleteBillingItem" input deleteBillingItemInput { id: ID } "Autogenerated input type of deleteCarePlanConnection" input deleteCarePlanConnectionInput { care_plan_id: ID connectable_id: ID connectable_type: String } "Autogenerated input type of deleteCarePlan" input deleteCarePlanInput { id: ID } "Autogenerated input type of deleteCarePlanRecommendationCategory" input deleteCarePlanRecommendationCategoryInput { id: ID! } "Autogenerated input type of deleteClientRestrictionAuthorization" input deleteClientRestrictionAuthorizationInput { "Required. ID of the client restriction authorization" id: ID! } "Autogenerated input type of deleteCms1500" input deleteCms1500Input { id: ID } "Autogenerated input type of deleteCognitiveStatus" input deleteCognitiveStatusInput { id: ID } "Autogenerated input type of deleteComment" input deleteCommentInput { id: ID } "Autogenerated input type of deleteConversationMembership" input deleteConversationMembershipInput { conversation_id: ID group_id: ID user_id: ID } "Autogenerated input type of deleteCourseBenefit" input deleteCourseBenefitInput { id: ID } "Autogenerated input type of deleteCourseGroup" input deleteCourseGroupInput { id: ID } "Autogenerated input type of deleteCourse" input deleteCourseInput { id: ID } "Autogenerated input type of deleteCourseItem" input deleteCourseItemInput { id: ID } "Autogenerated input type of deleteCourseMembership" input deleteCourseMembershipInput { id: ID } "Autogenerated input type of deleteCustomEmail" input deleteCustomEmailInput { id: ID } "Autogenerated input type of deleteCustomFood" input deleteCustomFoodInput { id: ID user_id: String } "Autogenerated input type of deleteCustomModuleForm" input deleteCustomModuleFormInput { id: ID } "Autogenerated input type of deleteCustomModule" input deleteCustomModuleInput { id: ID } "Autogenerated input type of deleteDexcomConnection" input deleteDexcomConnectionInput { id: ID } "Autogenerated input type of deleteDocument" input deleteDocumentInput { id: ID } "Autogenerated input type of deleteEntry" input deleteEntryInput { id: ID } "Autogenerated input type of deleteEpisodeOfCare" input deleteEpisodeOfCareInput { "ID of the episode of care to delete" id: ID! } "Autogenerated input type of deleteExternalCalendar" input deleteExternalCalendarInput { id: ID } "Autogenerated input type of deleteFamilyHistory" input deleteFamilyHistoryInput { id: ID } "Autogenerated input type of deleteFitbit" input deleteFitbitInput { id: ID } "Autogenerated input type of deleteFolder" input deleteFolderInput { id: ID } "Autogenerated input type of deleteFormAnswerFileAttachment" input deleteFormAnswerFileAttachmentInput { "The ID of the attachment" file_attachment_id: ID! } "Autogenerated input type of deleteFormAnswerGroup" input deleteFormAnswerGroupInput { id: ID "If passed, the connection between a form_answer_group and a group appointment for the given user will be removed" user_id: ID } "Autogenerated input type of deleteFormAnswerGroupSigning" input deleteFormAnswerGroupSigningInput { id: ID } "Autogenerated input type of deleteFunctionalStatus" input deleteFunctionalStatusInput { id: ID } "Autogenerated input type of deleteGoalHistory" input deleteGoalHistoryInput { completed_on: String "ID of the goal to remove a goal history for" id: ID } "Autogenerated input type of deleteGoal" input deleteGoalInput { id: ID } "Autogenerated input type of deleteGoogleFit" input deleteGoogleFitInput { id: ID } "Autogenerated input type of deleteHealthConcern" input deleteHealthConcernInput { id: ID } "Autogenerated input type of deleteImplantableDeviceUser" input deleteImplantableDeviceUserInput { id: ID } "Autogenerated input type of deleteInsuranceAuthorization" input deleteInsuranceAuthorizationInput { id: ID } "Autogenerated input type of deleteInsurancePlan" input deleteInsurancePlanInput { id: ID } "Autogenerated input type of deleteLocation" input deleteLocationInput { id: ID } "Autogenerated input type of deleteManualInsurancePayment" input deleteManualInsurancePaymentInput { "The ID of the insurance payment to delete" payment_id: ID! } "Autogenerated input type of deleteMeal" input deleteMealInput { id: ID user_id: String } "Autogenerated input type of deleteNote" input deleteNoteInput { deleted_by_user: Boolean = false id: ID } "Autogenerated input type of deleteNotificationContact" input deleteNotificationContactInput { id: ID user_id: ID } "Autogenerated input type of deleteOfferingCoupon" input deleteOfferingCouponInput { id: ID } "Autogenerated input type of deleteOffering" input deleteOfferingInput { id: ID } "Autogenerated input type of deleteOnboardingFlow" input deleteOnboardingFlowInput { flow_to_receive_groups: ID id: ID } "Autogenerated input type of deleteOnboardingItem" input deleteOnboardingItemInput { id: ID } "Autogenerated input type of deleteOrganizationCptCode" input deleteOrganizationCptCodeInput { id: ID } "Autogenerated input type of deleteOrganizationInfo" input deleteOrganizationInfoInput { id: ID } "Autogenerated input type of deleteOrganizationMembership" input deleteOrganizationMembershipInput { id: ID } "Autogenerated input type of deletePermissionTemplate" input deletePermissionTemplateInput { id: ID } "Autogenerated input type of deletePreferredMedicalCode" input deletePreferredMedicalCodeInput { code_ids: [ID] code_type: String } "Autogenerated input type of deleteProcedure" input deleteProcedureInput { id: ID } "Autogenerated input type of deleteProduct" input deleteProductInput { id: ID } "Autogenerated input type of deleteProviderAcceptedInsurancePlan" input deleteProviderAcceptedInsurancePlanInput { "ID of the provider accepted insurance plan to delete" id: ID! } "Autogenerated input type of deleteProviderCptCode" input deleteProviderCptCodeInput { id: ID } "Autogenerated input type of deleteReceivedFax" input deleteReceivedFaxInput { id: ID } "Autogenerated input type of deleteRecommendation" input deleteRecommendationInput { id: ID } "Autogenerated input type of deleteReferral" input deleteReferralInput { id: ID } "Autogenerated input type of deleteReferringPhysician" input deleteReferringPhysicianInput { id: ID } "Autogenerated input type of deleteRequestedForm" input deleteRequestedFormInput { id: ID recurringFormId: ID } "Autogenerated input type of deleteRequestedPayment" input deleteRequestedPaymentInput { id: ID! } "Autogenerated input type of deleteSavedFilter" input deleteSavedFilterInput { "ID of the saved filter to delete" id: ID! } "Autogenerated input type of deleteShapaConnection" input deleteShapaConnectionInput { id: ID } "Autogenerated input type of deleteSmartPhrase" input deleteSmartPhraseInput { id: ID } "Autogenerated input type of deleteSmokingStatus" input deleteSmokingStatusInput { id: ID } "Autogenerated input type of deleteStripeCustomerDetail" input deleteStripeCustomerDetailInput { card_id: String user_id: String } "Autogenerated input type of deleteSuperBill" input deleteSuperBillInput { id: ID } "Autogenerated input type of deleteTag" input deleteTagInput { id: ID "Set to true to delete the tag in a background job if it associated with more than 500 users" remove_async_if_needed: Boolean } "Autogenerated input type of deleteTask" input deleteTaskInput { id: ID } "Autogenerated input type of deleteUniqueDeviceIdentifier" input deleteUniqueDeviceIdentifierInput { id: ID } "Autogenerated input type of deleteUserGroup" input deleteUserGroupInput { group_to_receive_clients: ID id: ID } "Autogenerated input type of deleteWebhook" input deleteWebhookInput { id: ID } "Autogenerated input type of deleteWithingsConnection" input deleteWithingsConnectionInput { id: ID } "Autogenerated input type of deleteWriteOff" input deleteWriteOffInput { id: ID } "Autogenerated input type of deleteZoomRecordingFile" input deleteZoomRecordingFileInput { id: ID appointment_id: ID zoom_id: String } "Autogenerated input type of destroyAnnouncement" input destroyAnnouncementInput { id: ID } "Autogenerated input type of destroyFaxAcctInfo" input destroyFaxAcctInfoInput { aes_key: String api_key: String fax_number: String user_id: ID username: String } "Autogenerated input type of destroyMedication" input destroyMedicationInput { id: ID } "Autogenerated input type of destroyPdfLetterheadTemplate" input destroyPdfLetterheadTemplateInput { id: ID! } "Autogenerated input type of destroyRecurringForm" input destroyRecurringFormInput { connectable_id: ID connectable_type: String id: ID } "Autogenerated input type of dismissAllAnnouncements" input dismissAllAnnouncementsInput { patient_id: ID } "Autogenerated input type of dismissAnnouncement" input dismissAnnouncementInput { id: ID patient_id: ID } "Autogenerated input type of editAvailability" input editAvailabilityInput { appointment_location_id: String appointment_type_id: String contact_type_id: String """ Replaces the appointment types this availability covers (provide exactly one option). A recurring series with past occurrences is split; the new set applies going forward. Omit for the legacy appointment_type_id behavior. """ appointment_types: AppointmentTypeSelectionInput """ New window start (ISO 8601 with offset); omit to keep the current value. Ignored without appointment_types or contact_types. """ start_datetime: ISO8601DateTime """ New window end (ISO 8601 with offset); must be after start_datetime. Omit to keep the current value. Ignored without appointment_types or contact_types. """ end_datetime: ISO8601DateTime day_of_week: Int end_on: String end_time: String id: String is_repeating: Boolean range_end: String range_start: String time: String timezone: String user_id: String } "Autogenerated input type of expireWebhookSignature" input expireWebhookSignatureInput { "The ID of the webhook" id: ID! } "Autogenerated input type of exportClientEhi" input exportClientEhiInput { "The ID of the client to export EHI data for." client_id: ID "Whether or not we should export the client EHI data in a job." should_run_in_job: Boolean = false } "Autogenerated input type of exportToTemplate" input exportToTemplateInput { id: ID } "Autogenerated input type of generateChartingPdf" input generateChartingPdfInput { "Required. Comma separated array of FormAnswerGroup IDs to include" form_answer_group_array: String "Required. The ID of the patient" id: ID include_header_on_every_page: Boolean pdf_letterhead_template_id: ID } "Autogenerated input type of ingestMedicationsFromSurescripts" input ingestMedicationsFromSurescriptsInput { "Healthie user id of patient to retrieve medication history for." patient_id: ID! "Default: 1 year ago" start_date: ISO8601Date "Default: today" end_date: ISO8601Date } "Autogenerated input type of linkEncounterToEpisodeOfCare" input linkEncounterToEpisodeOfCareInput { "ID of the episode of care to link the patient encounter" episode_of_care_id: ID! "ID(s) of the patient encounter to link" encounter_ids: [ID]! } "Autogenerated input type of logMedicationHistoryConsent" input logMedicationHistoryConsentInput { "Healthie patient/client ID" patient_id: ID! } "Autogenerated input type of mergeClients" input mergeClientsInput { "the two user IDs to merge" ids: [ID] "Optional: the email to update the remaining user to" target_email: String "the user that will remain" target_user_id: ID } "Autogenerated input type of parseCcdaDocument" input parseCcdaDocumentInput { file: Upload } "Autogenerated input type of rejectGeneratedFormAnswerGroup" input rejectGeneratedFormAnswerGroupInput { "The ID of the generated form answer group to reject" id: ID! "Free-text feedback explaining why the proposed note was rejected" feedback: String "One or more reasons for rejecting the proposed note" rejection_reason: [GeneratedFormAnswerGroupRejectionReasonEnum!] = [] } "Autogenerated input type of removeAppliedTag" input removeAppliedTagInput { id: ID "The ID of the user to remove a tag from" taggable_user_id: ID } "Autogenerated input type of removeDraft" input removeDraftInput { id: ID } "Autogenerated input type of removeUserFromGroupCarePlan" input removeUserFromGroupCarePlanInput { care_plan_id: ID user_id: ID } "Autogenerated input type of resendSentFax" input resendSentFaxInput { sent_fax_id: String } "Autogenerated input type of resetDefaultPdfLetterheadTemplate" input resetDefaultPdfLetterheadTemplateInput { "This argument exists to satisfy some GraphQL client requirements. Will always be treated as true" reset_letterhead_template: Boolean = true } "Autogenerated input type of resetPassword" input resetPasswordInput { email: String "The authentication namespace to check reset passwords for." namespace: String = "healthie" } "Autogenerated input type of resyncRupaLabOrders" input resyncRupaLabOrdersInput { "DO NOT USE" clientMutationId: String } "Autogenerated input type of revokeToken" input revokeTokenInput { "DO NOT USE" clientMutationId: String } "Autogenerated input type of runEligibilityCheckMutation" input runEligibilityCheckMutationInput { "The ID of the policy to check" id: ID "An array of service type codes to check benefits for." service_codes: [String] = ["30"] "The service to use to run the eligibility check. Service needs to be pre-enabled" eligibility_check_service: EligibilityCheckService = change_health } "Autogenerated input type of sendCarePlanEmail" input sendCarePlanEmailInput { id: ID patient_id: ID } "Autogenerated input type of sendTestWebhook" input sendTestWebhookInput { "The ID of the webhook" id: ID! } "Autogenerated input type of setDefaultPdfLetterheadTemplate" input setDefaultPdfLetterheadTemplateInput { id: ID! } "Autogenerated input type of shareAnswersAsDocument" input shareAnswersAsDocumentInput { """ Comma separated list of FormAnswer ids (e.g. "10, 4, 2") """ answers: String "Whether or not to send email notification" email_notification: Boolean "The FromAnswerGroup that will be shared as a document" form_answer_group_id: ID "Will prepend letterhead to document if true" letterhead: Boolean = false "The custom letterhead ID to prepend to the document" pdf_letterhead_template_id: ID "Prepends the letterhead to every page of the document if true" include_header_on_every_page: Boolean = false "File name of the document that will be created" name: String "The patient/client user ID" user_id: ID } "Autogenerated input type of shareCourse" input shareCourseInput { course_share_recipient: String id: ID } "Autogenerated input type of shareCustomModuleForm" input shareCustomModuleFormInput { "Email of user to share the form with" form_share_recipient: String id: ID "(DEPRECATED) Does nothing. Permissions are always checked" validate_permissions: Boolean = false } "Autogenerated input type of signIn" input signInInput { "User email" email: String "Username" username: String "When true, an additional API key will be generated (versus replacing the old one)" allow_multiple_api_keys: Boolean = false "When true, an API key will be returned, versus a session token. This replaces an existing key." generate_api_token: Boolean = false "The authentication namespace to sign into. Whitelabels can have their own separated auth namespace." namespace: String = "healthie" "Password" password: String "Reset Token" reset_token: String "Timezone of user" timezone: String "API Token" token: String } "Autogenerated input type of signUp" input signUpInput { "The ID of the provider to create a patient for. Required if signing up as a patient and invite_code is not present" dietitian_id: String email: String exploring_healthie_reason: String first_name: String first_url: String "Required if signing up as a patient and dietitian_id is not present" invite_code: String last_name: String legal_name: String password: String phone_number: String provider_type: String "(HEALTHIE USE ONLY) GA-related information about the sign up" conversion_details: String "(HEALTHIE USE ONLY) Affiliate ID used for conversion tracking" ps_xid: String "(HEALTHIE USE ONLY) The unique identifier of the Partner in Partnerstack" ps_partner_key: String "'patient' to create a patient, 'dietitian' to create a staff member or provider" role: String "timezone from TZ database names in IANA Timezone list" timezone: String } "Autogenerated input type of toggleCarePlanStatusForSpecificUser" input toggleCarePlanStatusForSpecificUserInput { activate: Boolean! id: ID patient_id: ID } "Autogenerated input type of unlinkEncounterToEpisodeOfCare" input unlinkEncounterToEpisodeOfCareInput { "ID of the episode of care to unlink from the patient encounter" episode_of_care_id: ID! "ID(s) of the patient encounter to unlink" encounter_ids: [ID]! } "Autogenerated input type of unsubscribeFromNotification" input unsubscribeFromNotificationInput { notification_setting_uuid: String type_of_notification: String user_id: String } "Autogenerated input type of updateAddendum" input updateAddendumInput { content: String form_answer_group_id: ID id: ID } "Autogenerated input type of updateAllergySensitivity" input updateAllergySensitivityInput { category: String category_type: String custom_name: String custom_reaction: String id: String name: String "The date of onset_date" onset_date: String reaction: String "The type of reaction. Options are [allergy, adverse_reaction]" reaction_type: String severity: String "Options are [active, inactive, resolved]. Defaults to active" status: String user_id: String "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON } "Autogenerated input type of updateAnnouncement" input updateAnnouncementInput { active: Boolean announcement_image: AnnouncementImageUpload delete_image: Boolean description: String id: ID name: String title: String user_group_ids: String } "Autogenerated input type of updateAppleHealth" input updateAppleHealthInput { is_enabled: Boolean last_sync_date: String } "Autogenerated input type of updateAppointmentInclusion" input updateAppointmentInclusionInput { "Indicate whether a group appointment attendee have taken part in the appointment" attended: Boolean "Indicate if a group appointment attendee cancelled the appointment" cancelled: Boolean "Reason for cancellation" cancellation_reason: String "Indicate if a group appointment attendee has confirmed. For 1:1 appointments, use client_confirmed on Appointment object" confirmed: Boolean id: ID } "Autogenerated input type of updateAppointment" input updateAppointmentInput { actual_duration: String appointment_inclusion_uuid: ID appointment_location_id: String appointment_type_id: String attended_clients: [AttendedClientsInput] attendee_ids: String "The ID of the cancellation reason to apply to all attendees" cancellation_reason_id: ID "Who initiated the cancellation: client, provider, or organization (maps to CancellationReason.reason_type)" cancellation_initiated_by: String client_confirmed: Boolean client_updating: Boolean confirmed: Boolean contact_type: String "Cpt code associated with this appointment" cpt_code_id: ID date: String "Timestamp in YYYY-MM-DD HH:MM:SS or ISO8601 format, supercedes date, time params." datetime: String end_date: String end_time: String "When passed in, this video chat URL will be used instead of built-in Video Chat or Zoom" external_videochat_url: String id: ID insurance_billing_enabled: Boolean is_blocker: Boolean is_zoom_chat: Boolean "The late cancellation fee in cents" late_cancellation_fee: Int location: String max_attendees: String "a serialized JSON string of metadata" metadata: JSON "The no show fee in cents" no_show_fee: Int notes: String "Other reason for cancellation to apply to all attendees" other_cancellation_reason: String other_party_id: String """ The status of the appointment. Can be one of "Occurred", "No-Show", "Re-Scheduled", "Cancelled." If enabled, "Late Cancellation" and "Checked-In" are also valid. """ pm_status: String "The price associated with this appointment" price: String providers: String recurring_appointment: RecurringAppointmentInput room_id: String time: String "Timezone to use for date and time fields. Overrides the timezone of the current user" timezone: String "Units to use as a multiplier for appointment price" units: String updateRecurring: Boolean user_id: String "When true, checks if appointment time slot is available before updating. Does not work with recurring appointments or blockers." enforce_availability: Boolean = false """ When true, suppresses "appointment.updated" webhook notifications from this API call. Does not work with recurring appointments. """ suppress_webhook_notifications: Boolean = false "When true, suppresses appointment update and reschedule notification emails from this API call. Does not affect booking, confirmation, or cancellation emails." skip_notification_email: Boolean = false "When true, creates a Zoom meeting for ambient AI scribe on an in-person appointment" launch_ambient_scribe: Boolean } "Autogenerated input type of updateAppointmentRequest" input updateAppointmentRequestInput { "ID of the appointment request to update" id: ID! "Notes from provider or admin for the appointment request. Maximum character limit of 255." provider_notes: String "The ID of the patient is requesting the appointment for." patient_id: ID "Status to set for the appointment request (open/closed)" status: AppointmentRequestStatus } "Autogenerated input type of updateAppointmentSetting" input updateAppointmentSettingInput { advance_pricing_options: String allow_appointment_type_pricing: Boolean allow_clients_to_cancel_appt: Boolean allow_clients_to_reschedule_appt: Boolean allow_external_videochat_urls: Boolean always_send_confirm_notification: Boolean appointment_locations: [AppointmentLocationInput] appt_type_confirmed_email: Boolean appt_type_reminder_email: Boolean appt_type_website_booking_email: Boolean ask_clients_to_confirm: Boolean ask_to_confirm_via_text: Boolean auto_create_cms1500: Boolean auto_schedule_charges_for_late_cancellation_no_show: Boolean auto_submit_cms1500: Boolean auto_invoicing: Boolean base_calendar_interval: BaseCalendarInterval booking_interval_restriction: Int buffer: String calendar_color_schemes: [CalendarColorSchemeInput] calendar_interval: String charge_for_occurred_appts: Boolean client_should_call_provider: Boolean clients_have_billing: Boolean confirm_by_default: Boolean contact_type_overrides: [ContactTypeOverrideInput] default_appt_form_to_group: Boolean default_charting_template_id: String default_group_charting_template_id: ID default_to_zoom: Boolean default_video_service: String "How Zoom calls should open: 'embedded_zoom' (in browser) or 'zoom_app' (Zoom desktop/mobile app). Defaults to 'embedded_zoom'." zoom_open_preference: String disable_requested_form_notifications: Boolean """ Enable the additional "Checked-In" status for appointments. """ enable_checked_in_status: Boolean """ Enable the additional "Late Cancellation" status for appointments. """ enable_late_cancellation_status: Boolean end_time: String hide_insurance_getting_started_info: Boolean hide_link: Boolean id: ID insurance_eligibility_integration: Boolean "Indicates if specific CPT code pricing is used for insurance." insurance_specific_cpt_code_pricing: Boolean invoice_clients_without_payment_method: Boolean "The late cancellation fee in cents" late_cancellation_fee: Int max_days_in_future: String "Prevents the patient from canceling too close the appointment time. In minutes" minimum_advance_cancel_time: Int "Prevents the patient from rescheduling too close the appointment time. In minutes" minimum_advance_reschedule_time: Int "Prevents the patient from scheduling too close to the desired appointment time. In minutes" minimum_advance_schedule_time: Int "The no show fee in cents" no_show_fee: Int prevent_client_booking: Boolean prevent_no_credit_booking: Boolean enable_appointment_requests: Boolean reply_to_provider: Boolean restore_credit_on_cancel: Boolean "When true, clients must provide a cancellation reason when cancelling" client_cancel_reason_required: Boolean "When true, providers must provide a cancellation reason when cancelling" provider_cancel_reason_required: Boolean same_day_appointments: Boolean send_appointment_cancellation_email: Boolean send_appointment_update_email: Boolean send_booking_notice: Boolean send_embeddable_appt_creator_email: Boolean send_email_before_appointment: Boolean send_intake_forms_reminder: Boolean send_push_before_appointment: Boolean send_reminder_four_days_before: Boolean send_reminder_one_day_before: Boolean send_reminder_one_hour_before: Boolean send_reminder_three_days_before: Boolean send_reminder_two_days_before: Boolean send_reminder_two_hours_before: Boolean send_text_reminder_four_days_before: Boolean send_text_reminder_one_day_before: Boolean send_text_reminder_one_hour_before: Boolean send_text_reminder_three_days_before: Boolean send_text_reminder_two_days_before: Boolean send_text_reminder_two_hours_before: Boolean "NOTE: Your organization MUST have its own Twilio account configured to have this feature, and have AppointmentSetting.send_email_before_appointment enabled" send_text_reminder_five_minutes_before: Boolean set_default_videochat_url: Boolean show_care_plans: Boolean show_cms1500s: Boolean show_faxes: Boolean show_insurance_authorization: Boolean show_office_ally: Boolean show_superbills: Boolean start_time: String "Allows times to be grouped by appointment type." times_by_appointment_type: Boolean "Allows times to be grouped by contact type." times_by_contact_type: Boolean "Allows times to be grouped by location." times_by_location: Boolean use_appointment_type_cpt_units_and_fees: Boolean use_client_credit_system: Boolean use_client_sources: Boolean use_zoom_waiting_room: Boolean user_id: String video_url_default: VideoUrlDefaultInput } "Autogenerated input type of updateAppointmentTypeCptCode" input updateAppointmentTypeCptCodeInput { appointment_type_id: ID cpt_code_id: ID id: ID units: String } "Autogenerated input type of updateAppointmentType" input updateAppointmentTypeInput { appointment_autocomplete_form: AppointmentAutocompleteFormUpdateInput appointment_setting: AppointmentTypeAppointmentSettingInput appointment_type_cpt_code: AppointmentTypeCptCode auto_increase_charge_for_actual_duration: Boolean bookable_by_groups: Boolean bookable_group_ids: String bookable_without_group: Boolean "Custom description shown to clients when self-scheduling" client_display_description: String "When set, will be used as the appointment type name shown to clients in the client booking widget UI." client_facing_display_name: String "When false, clients will not have the ability to self-book this appointment" clients_can_book: Boolean "(IF LEFT OUT, DEFAULTS TO FALSE). Controls patients ability to schedule this appointment to be in person." contact_type_override_in_person: ContactTypeOverride "(IF LEFT OUT, DEFAULTS TO FALSE). Controls patients ability to schedule this appointment to be a phone call." contact_type_override_phone_call: ContactTypeOverride "(IF LEFT OUT, DEFAULTS TO FALSE). Controls patients ability to schedule this appointment to be a video call." contact_type_override_video_chat: ContactTypeOverride "If the provider's organization has this feature, setting this will customize the content of SMS reminder's Healthie sends." custom_text_reminder_body: 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 embed_question_form_id: String form_requests_before_appointment: [AppointmentTypeFormConnectionInput] form_requests_after_appointment: [AppointmentTypeFormConnectionInput] form_requests_after_appointment_booking: [AppointmentTypeFormConnectionInput] has_specific_appointment_settings: Boolean id: ID "Whether or not insurance billing is enabled for an appointment type" insurance_billing_enabled: Boolean "When true, indicates that this appointment type is used for group appointments" is_group: Boolean is_waitlist_enabled: Boolean "The length of the appointment type in minutes" length: Int "Metadata for an appointment type. Maximum character limit of 128,000." metadata: String "The name of the appointment type" name: String pricing: String "Available options are CUSTOM and CPT_CODE." pricing_option: String "Defaults to removing all connections if left out" provider_ids_for_appt_type_connections: String "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 require_in_state_clients: Boolean require_specific_providers: Boolean row_order: Int specific_groups: Boolean user_group_id: String } "Autogenerated input type of updateAutoTaskGenerator" input updateAutoTaskGeneratorInput { category: String days_due_from_created_at: Int id: ID is_enabled: Boolean number_description: String number_to_check: String task_description: String user_id_for_task: String } "Autogenerated input type of updateAutomatedInsuranceBillingSetting" input updateAutomatedInsuranceBillingSettingInput { auto_create_cms1500s: Boolean auto_submit_cms1500s: Boolean insurance_billing_enabled: Boolean } "Autogenerated input type of updateBillingItem" input updateBillingItemInput { amount_paid: String chosen_refund_amount: String created_at: String id: ID is_canceled: Boolean is_paused: Boolean "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String new_payment_date: String note: String payment_medium: String recipient_id: ID resend_payment: Boolean resend_receipt: Boolean sender_id: ID stripe_idempotency_key: String } "Autogenerated input type of updateBrand" input updateBrandInput { about_description: String bg_color: String brand_email: String brand_name: String brand_phone: String contact_description: String custom_sign_in_path: String display_embed_title: Boolean display_name: String display_package_image: Boolean email_background_color: String embed_primary_color: String facebook: String font_color: String id: ID instagram: String logo: Upload selected_color: String slogan: String tab_accent_color: String titles: String twitter: String website: String "Whitelabel only" theme_background_primary: HexColor "Whitelabel only" theme_background_secondary: HexColor "Whitelabel only" theme_background_hover: HexColor "Whitelabel only" theme_background_input: HexColor "Whitelabel only" theme_accent_primary: HexColor "Whitelabel only" theme_accent_primary_hover: HexColor "Whitelabel only" theme_border_primary: HexColor "Whitelabel only" theme_border_input: HexColor "Whitelabel only" theme_text_sidebar: HexColor "Whitelabel only" theme_background_sidebar: HexColor "Whitelabel only" theme_text_sidebar_active: HexColor "Whitelabel only" theme_text_sidebar_tab_bar: HexColor } "Autogenerated input type of updateByTemplate" input updateByTemplateInput { care_plan_id: ID care_plan_template_id: ID } "Autogenerated input type of updateCalendarViewSetting" input updateCalendarViewSettingInput { appointment_status_filter: String appointment_statuses_filter: [String] appointment_type_filter: ID appointment_types_filter: [ID] availability_contact_type_filter: String availability_location_filter: ID availability_provider_filter: ID availability_appt_type_filter: ID availability_appointment_types_filter: [ID] calendar_color_scheme_filter: ID "The calendar display interval in minutes. Maximum character limit of 2." calendar_interval: String calendar_view_filter: String client_confirmation_status: String document_area_sorting: String contact_types_filter: String expand_color_schemes: Boolean expand_filter_appointments: Boolean expand_filter_availabilities: Boolean expand_filter_by_providers: Boolean expand_filter_providers: Boolean expand_show_availabilities: Boolean id: ID insurance_plan_ids_filter: [ID!] location_filter: ID locations_filter: [ID] one_time_availabilities: Boolean org_calendar_view_filter: String provider_confirmation_status: String selected_availability_provider_filter: ID selected_availability_providers_filter: String selected_provider_filter: ID selected_providers_filter: String show_appointments: Boolean show_availabilities: Boolean show_synced_appointments: Boolean timezone: String weekly_availabilities: Boolean state_licenses_filter: String tag_ids_filter: String favorite_saved_filter_id: ID } "Autogenerated input type of updateCarePlan" input updateCarePlanInput { description: String doc_id: ID from_template: Boolean id: ID is_creating: Boolean is_hidden: Boolean is_managing_templates: Boolean = false is_template: Boolean is_updating: Boolean name: String new_patient_id: ID user_group_id: ID } "Autogenerated input type of updateCarePlanRecommendationCategory" input updateCarePlanRecommendationCategoryInput { id: ID! name: String is_active: Boolean } "Autogenerated input type of updateChangeHealthAccount" input updateChangeHealthAccountInput { "Update the stored password for the ChangeHealthAccount in Healthie. Note this does not affect the password of the account with Change" password: String } "Autogenerated input type of updateChargeBack" input updateChargeBackInput { charge_back_evidence: ChargeBackEvidenceInput "When true, the evidence will be submitted immediately. Evidence can only be submitted once" final_submission: Boolean = false id: ID } "Autogenerated input type of updateChatSetting" input updateChatSettingInput { auto_welcome_text: String content: String end_date: String id: ID is_active: Boolean is_recurring_active: Boolean no_end_date: Boolean receive_notifications: Boolean receive_notifications_recurring: Boolean recurring_content: String recurring_days_data: RecurringDaysInputObjectType recurring_turned_on: Boolean scheduled_turned_on: Boolean send_auto_welcome: Boolean start_date: String user_id: String } "Autogenerated input type of updateClient" input updateClientInput { "Whether the user is active." active: Boolean "The activity level of the user (used in BMR calculations)." activity_level: String "An additional phone number." additional_phone_number: String "An additional record identifier." additional_record_identifier: String "Custom appointment prices per appointment type." advance_appointment_prices: [AdvanceAppointmentPriceInput] "Booking credits for specific appointment types." appointment_type_credits_attributes: [AppointmentTypeCreditInput] "Whether automatic charging is enabled." auto_charge_enabled: Boolean "The source that referred the user." client_source: ClientSourceInput "The user's current email address, used to look up the user instead of the id field." current_email: String "The diagnoses associated with the user." diagnoses: [DiagnosesInput] "The ID of the provider assigned to this user." dietitian_id: String "The user's date of birth." dob: String "The user's email address." email: String "The user's first name." first_name: String "When true and user_group_id is nil, removes the user from their current group." for_changing_groups: Boolean "The user's gender." gender: String "The user's gender identity." gender_identity: String "Code representing the user's gender identity." gender_identity_code: String "The user's height." height: String "The default billing type for the patient (e.g. insurance or self-pay)." default_billing_type: DefaultBillingType "The default Dosespot Clinic ID to use for a patient. Commonly null, in which case the provider's default is used." default_dosespot_clinic_id: String "Assign a clinic to the patient for E-Rx." erx_clinic_id: ID "The ID of the user to update." id: ID "When true, indicates the form reminder is for an intake item." is_intake_item: Boolean "The user's last name." last_name: String "The user's legal first name." legal_name: String "The user's primary location." location: ClientLocationInput "The user's locations." locations: [ClientLocationInput] "A serialized JSON string of metadata. Maximum length is 128000." metadata: String "IDs of additional providers connected to the user (i.e. care team members)." other_provider_ids: [String] "The user's password." password: String "The user's phone number." phone_number: String "The user's insurance policies." policies: [ClientPolicyInput] "The user's preferred language code." preferred_language_code: String "The user's primary ethnicity code." primary_ethnicity_code: String "The user's primary race code." primary_race_code: String "The user's pronouns." pronouns: String "Brief notes about the user visible to the provider." quick_notes: String "A unique record identifier." record_identifier: String "The user's referrals." referrals: [ReferralInput] "When true, removes the user's saved payment card." remove_card_on_file: Boolean "The ID of a specific requested form completion to remind the user about." requested_form_completion_id: String "When true, re-sends the welcome email to the user." resend_welcome: Boolean "Restricted is only available when enabled for an organization." restricted: Boolean "The user's secondary ethnicity code." secondary_ethnicity_code: String "The user's secondary race code." secondary_race_code: String "When true, sends a reminder email for a requested form completion." send_form_request_reminder: Boolean "The user's biological sex." sex: String "The user's sexual orientation code." sexual_orientation_code: String "A custom description of the user's sexual orientation when 'other' is selected." sexual_orientation_other: String "Whether the user does not have a real email address." skipped_email: Boolean "The social security number of the patient." ssn: String "The user's timezone." timezone: String "A credit card token generated by Stripe." token: String "The ID of the user group to assign the user to." user_group_id: String } "Autogenerated input type of updateCms1500" input updateCms1500Input { accept_assignment: Boolean additional_text: String adjustment: String amount_paid: String amount_reimbursed: String client_responsibility_removed: Boolean client_sig_on_file: Boolean cms1500_policies: [Cms1500PolicyInput] copay: String copay_still_owed: String cpt_codes_cms1500s: [CptCodesCms1500Input] dietitian: DietitianInput dietitian_id: String form_answer_group_id: ID icd_codes_cms1500s: [IcdCodesCms1500Input] id: ID include_referrer_information: Boolean insured_sig_on_file: Boolean nineteen_reserved: String organization_info: OrganizationInfoInput organization_info_id: String orig_ref_number: String patient: PatientInput patient_account_num: String referral_info: ReferralInfoInput reimbursed_at: String rendering_provider_other_id: String rendering_provider_other_id_number: OtherIdNumberInput resubmission_code: String service_location_id: String status: String tend_reserved: String use_indiv_npi: Boolean } "Autogenerated input type of updateCognitiveStatus" input updateCognitiveStatusInput { cognitive_status: String id: ID start_date: String } "Autogenerated input type of updateConversation" input updateConversationInput { "The ID of a user closing the conversation." closed_by_id: ID "If TRUE, the current provider will no longer see the warning pop-up when closing a conversation." hide_close_confirmation: Boolean "The ID of the conversation to update." id: ID "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The name of the conversation." name: String """ Adds all members of a given category to the conversation. Merged with simple_added_users if both are provided. Accepted values: "Select All", "All My Active Clients", "All Active Clients in Organization", "All My Groups", "All Active Organization Members". """ select_all_status: String """ Comma-separated list of members to add to the conversation. Each entry must be prefixed with its type: "user-{ID}" for individual users or "group-{ID}" for user groups (e.g. "user-123,group-456,user-789"). Groups are expanded to their individual members. This replaces the full invitee list — members not included will be removed. """ simple_added_users: String } "Autogenerated input type of updateConversationMembership" input updateConversationMembershipInput { archived: Boolean id: ID viewed: Boolean } "Autogenerated input type of updateCourseGroup" input updateCourseGroupInput { id: ID start_at: String } "Autogenerated input type of updateCourse" input updateCourseInput { course_members: [CourseMembersInput] course_type: String description: String external_preview_image_url: String formatted_benefits: String id: String late_enroll: Boolean name: String preview_image: Upload preview_video_content: String start_at: String start_date: String start_on_group_assignment: Boolean } "Autogenerated input type of updateCourseItem" input updateCourseItemInput { completion_required_for_next_module: Boolean course_id: String id: String item_id: String item_type: String name: String position: Int scheduled_release: String user_id: String video_url: String } "Autogenerated input type of updateCourseMembership" input updateCourseMembershipInput { id: ID "Defaults to false. When passed in as true, other updates (like updating start_at) are ignored." send_nudge: Boolean start_at: String } "Autogenerated input type of updateCustomEmail" input updateCustomEmailInput { email_type: String greeting: String id: ID message_body: String reactivation_wait_days: String subject: String } "Autogenerated input type of updateCustomFood" input updateCustomFoodInput { id: ID user_id: String name: String nutrients: NutrientsInput serving_size: ServingSizeInput } "Autogenerated input type of updateCustomModuleForm" input updateCustomModuleFormInput { external_id: String external_id_type: String id: ID is_archived: Boolean is_video: Boolean "Maximum character limit of 10,000." metadata: String name: String on_completion_ifs_tag_id: String prefill: Boolean use_for_charting: Boolean use_for_program: Boolean } "Autogenerated input type of updateCustomModule" input updateCustomModuleInput { custom_module_condition: CustomModuleConditionInput external_id: String external_id_type: String id: ID index: Int is_custom: Boolean label: String "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String mod_type: String options: String options_array: [String] parent_custom_module_id: Int "Absolute ordering position within the form. Use instead of index to set the position directly." position: Float required: Boolean sublabel: String } "Autogenerated input type of updateDocument" input updateDocumentInput { care_plan_id: ID description: String display_name: String email_on_welcome: Boolean folder_id: String id: ID include_in_charting: Boolean internal_notes: String "Metadata for an document type. Maximum character limit of 128,000." metadata: String parse_ccda: Boolean rel_user_id: ID "A comma-separated list of doc_share_ids" share_users: String share_with_rel: Boolean shared_on_welcome: Boolean shared_with_dietitians: Boolean } "Autogenerated input type of updateDsiComment" input updateDsiCommentInput { content: String! intervention_type: InterventionType! } "Autogenerated input type of updateEntry" input updateEntryInput { category: String created_at: String description: String ed_posthunger: String ed_prehunger: String emotions: String food_items: String hide_from_main_feed: Boolean id: ID image: Upload image_string: String meal_ids: String meal_name: String metric_stat: String other_symptom: String perceived_hungriness: String reflection: String subentries: [SubentryInput] symptoms: String "Options are apple_health, google_fit, or fitbit" third_party_source: String user_id: String viewed: Boolean } "Autogenerated input type of updateEpisodeOfCare" input updateEpisodeOfCareInput { "ID of the episode of care to update" id: ID! "ID of the patient to create an episode of care for" patient_id: ID! "ID of the provider responsible for the patient episodes of care" provider_id: ID! "ID of the diagnosis associated with this episode of care" diagnosis_id: ID! "Start date (must be present or in the past) for this episode of care" start_date: ISO8601Date! "End date when episodes of care ended" end_date: ISO8601Date } "Autogenerated input type of updateExternalCalendar" input updateExternalCalendarInput { add_to_calendar: Boolean id: ID pull_from_calendar: Boolean pull_in_event_details: Boolean pulled_in_calendars: [String] } "Autogenerated input type of updateFamilyHistory" input updateFamilyHistoryInput { relationships: [String] concept_id: String user_id: ID id: ID } "Autogenerated input type of updateFaxAcctInfo" input updateFaxAcctInfoInput { aes_key: String api_key: String fax_number: String user_id: ID username: String } "Autogenerated input type of updateFeatureToggle" input updateFeatureToggleInput { allow_apple_health_sync: Boolean allow_clearstep_sync: Boolean allow_community_chat: Boolean allow_direct_chat: Boolean allow_fitbit_sync: Boolean allow_google_fit_sync: Boolean allow_google_health_connect_sync: Boolean allow_shapa_sync: Boolean allow_withings_sync: Boolean apply_eating_disorder_default: Boolean can_schedule_appointments: Boolean can_track_poop: Boolean can_track_symptoms: Boolean can_track_water_intake: Boolean can_view_care_plan: Boolean can_view_documents: Boolean can_view_forms: Boolean can_view_goals: Boolean can_view_journal_entries: Boolean can_view_packages: Boolean can_view_payments: Boolean can_view_programs: Boolean custom_metric_overrides: [CustomMetricOverridesInput] custom_metrics: [CustomMetricInput] date_range_preference: String default_water_intake: String do_not_auto_submit_cms1500: Boolean email_notification_frequency: String id: ID last_journal_from_date: String last_journal_to_date: String "When true, locks inactive clients from login and outbound emails" prevent_inactive_access: Boolean push_notification_frequency: String "When true, clients must complete their intake forms before they can access chat or join platform-hosted video calls (external video links are unaffected)" require_intake_for_communication: Boolean send_unpaid_invoice_reminder: Boolean separate_provider_metric_from_client: Boolean show_a1c_metric: Boolean show_bf_percent_metric: Boolean show_blood_pressure_metric: Boolean show_blood_sugar_metric: Boolean show_bmi_graph: Boolean show_bmi_growth_chart: Boolean show_bmr_metric: Boolean show_body_temperature_metric: Boolean show_client_a1c_metric: Boolean show_client_bf_percent_metric: Boolean show_client_blood_pressure_metric: Boolean show_client_blood_sugar_metric: Boolean show_client_bmi_graph: Boolean show_client_bmi_growth_chart: Boolean show_client_bmr_metric: Boolean show_client_body_temperature_metric: Boolean show_client_harris_benedict: Boolean "The status of whether the client can view and track their height" show_client_height_graph: Boolean show_client_height_growth_chart: Boolean show_client_ox_sat_metric: Boolean show_client_waist_circumference_metric: Boolean show_client_weight_growth_chart: Boolean show_client_weight_metric: Boolean show_ed_posthunger: Boolean show_ed_prehunger: Boolean show_food: Boolean show_food_category: Boolean show_food_emotion: Boolean show_food_reflection: Boolean show_harris_benedict: Boolean show_healthiness: Boolean "The status of whether the provider can view and track the client's height" show_height_graph: Boolean show_height_growth_chart: Boolean show_metric: Boolean show_mirror: Boolean show_normal_hunger: Boolean show_note: Boolean show_note_emotion: Boolean show_nutrients_tracking: Boolean show_ox_sat_metric: Boolean show_waist_circumference_metric: Boolean show_weight_growth_chart: Boolean show_weight_metric: Boolean show_workout: Boolean use_metric_system: Boolean user_id: ID "Whether the client can see medications and prescriptions (mobile app only)" view_medications: Boolean view_not_track: Boolean } "Autogenerated input type of updateFitbit" input updateFitbitInput { access_token: String expires_at: String id: ID last_sync_date: String refresh_token: String user_id: ID } "Autogenerated input type of updateFolder" input updateFolderInput { email_on_welcome: Boolean folder_id: String id: ID name: String share_users: String share_with_rel: Boolean shared_on_welcome: Boolean shared_with_dietitians: Boolean } "Autogenerated input type of updateFormAnswerGroup" input updateFormAnswerGroupInput { "ID of the course item completed by submitting this form." course_item_id: ID "Date portion of the service date, used with `time` to set the creation timestamp." date: String "External identifier for integration with third-party systems." external_id: String "Whether the form has been completed and submitted, as opposed to saved as a draft." finished: Boolean "Individual form answers to submit with this form." form_answers: [FormAnswerInput] "The datetime of service." formatted_date: String "The ID of the form answer group to update." id: ID "Individual client notes for group appointment charting." individual_client_notes: [IndividualClientNoteInput] "Marks the form as explicitly completed, setting the marked_complete_at timestamp." marked_complete: Boolean "Deprecated: use the `lockFormAnswerGroup` mutation instead. Locks the form from further editing." marked_locked: Boolean "Maximum character limit of 128,000." metadata: String "Name or title for this form answer group." name: String "Time portion of the service date (e.g., '10 30' for 10:30 AM), used with `date` to set the creation timestamp." time: String "ID of the appointment associated with this form answer group." appointment_id: ID "Used to track changes in `form_answers`." tab_uuid: UUID } "Autogenerated input type of updateFunctionalStatus" input updateFunctionalStatusInput { functional_condition: String id: ID start_date: String } "Autogenerated input type of updateGeneratedFormAnswerGroupFeedback" input updateGeneratedFormAnswerGroupFeedbackInput { "ID of the form answer group" id: ID! "Feedback to be updated" feedback: String! } "Autogenerated input type of updateGoal" input updateGoalInput { created_user_id: String description: String "The date the goal should end - format should be: yyyy-mm-dd" due_date: String "If true, goal was submitted via the update form" from_update_form: Boolean id: String name: String "If true, update goal for program" program_goal: Boolean reminder: ReminderInput repeat: String "The id of goal template used to create this goal" source_template_id: String "The date the goal should start - format should be: yyyy-mm-dd" start_on: String subgoals: [SubgoalInput] "Title hyperlink. Opens when the name is clicked on." title_link: String "If true, use this goal as a template(favorite)" use_as_template: Boolean user_id: String } "Autogenerated input type of updateGoogleFit" input updateGoogleFitInput { access_token: String expiry_date: String id: ID is_enabled: Boolean last_sync_date: String refresh_token: String } "Autogenerated input type of updateGroupCarePlan" input updateGroupCarePlanInput { id: ID is_active: Boolean } "Autogenerated input type of updateHealthConcern" input updateHealthConcernInput { code: String description: String display_name: String effective_time: String id: ID } "Autogenerated input type of updateHuman" input updateHumanInput { current_user_id: ID id: ID } "Autogenerated input type of updateImmunization" input updateImmunizationInput { additional_notes: String cvx_code: Int id: ID received_at: String status: String user_id: ID vaccine_name: String } "Autogenerated input type of updateImplantableDeviceUser" input updateImplantableDeviceUserInput { id: ID user_id: ID udi: String active: Boolean name: String } "Autogenerated input type of updateInsuranceAuthorization" input updateInsuranceAuthorizationInput { authorization_number: String end_on: String id: ID policy_id: String start_on: String unit_type: String units_authorized: String units_used: String visits_authorized: String visits_used: String } "Autogenerated input type of updateInsurancePaymentDepositStatus" input updateInsurancePaymentDepositStatusInput { "The ID of the insurance payment to update" payment_id: ID! "The deposit status of the payment" deposit_status: InsurancePaymentsDepositStatusEnum! } "Autogenerated input type of updateInsurancePlan" input updateInsurancePlanInput { add_as_accepted_insurance_plan: Boolean id: ID payer_id: String payer_name: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON } "Autogenerated input type of updateLabOrder" input updateLabOrderInput { appt_confirmation_code: String force_appointment_reload: Boolean id: ID patient_id: ID } "Autogenerated input type of updateLocation" input updateLocationInput { city: String country: String id: String line1: String line2: String name: String npi: String other_id: String other_id_qual: String place_of_service_id: String state: String zip: String } "Autogenerated input type of updateManualInsurancePayment" input updateManualInsurancePaymentInput { "The ID of the insurance payment to update" payment_id: ID! "The date the payment was received (cannot be in the future)" paid_date: ISO8601Date "The National Provider Identifier associated with the payment" npi: String "The ACH or check number for the payment" ach_check_number: String "The amount paid by the insurance company (must be greater than 0)" paid_amount: Float "The deposit status of the payment" deposit_status: InsurancePaymentsDepositStatusEnum } "Autogenerated input type of updateMeal" input updateMealInput { id: ID user_id: String food_items: String name: String } "Autogenerated input type of updateMedication" input updateMedicationInput { active: Boolean code: String comment: String custom_name: String directions: String dosage: String end_date: String frequency: String id: ID "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON name: String route: String start_date: String } "Autogenerated input type of updateNote" input updateNoteInput { attached_audio: Upload attached_document: Upload attached_image: Upload attached_image_string: String content: String conversation_id: String id: ID scheduled_at: String user_id: String } "Autogenerated input type of updateNoteScheduler" input updateNoteSchedulerInput { id: ID participant_ids: String "The value of the select all toggle. This overrides participant_ids and allows you to easily add all of a category to the conversation. Requires participant_ids to be sent in as well" select_all_status: String } "Autogenerated input type of updateNotificationContact" input updateNotificationContactInput { client_portal_access: Boolean client_portal_setting: ClientPortalSettingInput = null "Valid values: adult, minor" contact_type: String copy_notifications: Boolean email: String emergency: Boolean first_name: String id: ID last_name: String phone_number: String "Valid values: caregiver, child, dependent, family_member, legal_guardian, is_parent, spouse, other" relationship: String } "Autogenerated input type of updateNotification" input updateNotificationInput { id: ID read: Boolean seen: Boolean } "Autogenerated input type of updateNotificationSetting" input updateNotificationSettingInput { id: ID "An option of receiving updates and special offers [email/sms]" marketing_communication_preference: String "Send an email when a course module is completed" notification_on_module_completion: Boolean "Receive updates and special offers" receive_updates_and_offers: Boolean "Get an email when there is a new comment" send_comment_emails: Boolean "Get a push notification when there is a new comment" send_comment_push: Boolean "Send an email when a client completes a program" send_course_complete_email: Boolean "Send an email 5 minutes before the appointment" send_email_before_appointment: Boolean "Send an email when an appointment is booked" send_email_on_appointment_book: Boolean "Send an email when an appointment is cancelled" send_email_on_appointment_cancel: Boolean "Send an email when an appointment is rescheduled" send_email_on_appointment_reschedule: Boolean "Send an email to provider when client has been assigned" send_email_on_client_has_been_assigned_to_you: Boolean "Send an email when a fax delivery fails" send_email_on_fax_delivery_failure: Boolean "Send an email when a fax is received" send_email_on_fax_received: Boolean "Send an email when a client completes an intake flow" send_email_on_intake_flow_complete: Boolean "Send an email when a client completes an intake flow item" send_email_on_intake_flow_item_complete: Boolean "Send an email when a client starts an intake flow" send_email_on_intake_flow_start: Boolean "Send an email when a new document is uploaded" send_email_on_new_document: Boolean "Send an email when a new folder is created" send_email_on_new_folder: Boolean "Send an email when a client purchases a package" send_email_on_package_purchase: Boolean "Get an email when a scheduled payment fails" send_email_on_scheduled_payment_failed: Boolean "Send an email to primary account holder when subscription payment is made" send_email_receipt_for_subscription_payment: Boolean "Get an email when provider adds an emoji to a journal entry" send_emoji_email: Boolean "Get a push notification when provider adds an emoji to a journal entry" send_emoji_push: Boolean "Get an email when a client posts an entry" send_entry_emails: Boolean "Send an email to client when reminder to complete goal checked" send_goal_reminder_email: Boolean "Send a push notification to client when reminder to complete goal checked" send_goal_reminder_push: Boolean "Get an email notification when there is a new message in a group chat" send_group_message_emails: Boolean "Get a push notification when there is a new message in a group chat" send_group_message_push: Boolean "When true, it will send an expiration notification to the provider when their client insurance is about to expire" send_insurance_expiry_notifications: Boolean "Get an email when there is a new message" send_message_emails: Boolean "Get a push notification when there is a new message" send_message_push: Boolean "Get an email when a new client is added to the organization" send_new_clients_emails: Boolean "When true and client updated insurance via client form, the assigned provider will be notified" send_new_insurance_added_notifications: Boolean "Send an email to client when new program module is available" send_new_module_email: Boolean "Send a push notification to client when new program module is available" send_new_module_push: Boolean "Get a push notification 5 minutes before the appointment" send_push_before_appointment: Boolean "Get an email whenever client creates an appointment request for you" send_email_on_appt_request_for_you: Boolean = false "Get an email whenever client creates an appointment request for anyone in the organization" send_email_on_appt_request_for_anyone: Boolean = false "Send an email to the client 24hrs before next payment is due" recurring_payment_reminder_emails: Boolean } "Autogenerated input type of updateOffering" input updateOfferingInput { archived: Boolean billing_frequency: String can_be_gifted: Boolean charge_immediately: Boolean course_id: ID course_ids: String default_selection_image_url: String description: String embed_question_form_id: String first_time_payment: String has_first_payment: Boolean id: ID lab_option_ids: String living_plate_meal_plan_id: String max_purchases: String name: String offering_image: OfferingImageUpload offering_includes: [OfferingIncludesFields] offering_products: [OfferingProductInput] override_group_on_purchase: Boolean price: String repeat_times: String require_booking_purchase: Boolean row_order: Int selected_image_id: ID show_free_text: Boolean show_offering: Boolean user_group_id: ID user_group_ids: String user_id: ID video_url: String visibility_status: String } "Autogenerated input type of updateOfficeallySftpAccount" input updateOfficeallySftpAccountInput { "The OfficeAlly SFTP URL" ftp_url: String "The unique identifier of the OfficeAlly SFTP account" id: ID "Whether the SFTP connection is enabled" is_enabled: Boolean "The SFTP password (maximum 25 characters)" password: String "The SFTP username (maximum 50 characters)" username: String } "Autogenerated input type of updateOnboardingFlow" input updateOnboardingFlowInput { groups_to_use_onboarding_flow: String id: ID name: String } "Autogenerated input type of updateOnboardingItem" input updateOnboardingItemInput { billing_disclaimer: String id: ID is_skippable: Boolean item_id: String item_type: String onboarding_flow_id: String photo_id_disclaimer: String policy_disclaimer: String row_order: Int welcome_text: String } "Autogenerated input type of updateOrganizationCptCode" input updateOrganizationCptCodeInput { cpt_code_id: ID id: ID price_per_unit: String organization_cpt_code_insurance_fees: [OrganizationCptCodeInsuranceFeesInput] } "Autogenerated input type of updateOrganization" input updateOrganizationInput { id: ID "Whether the organization is active. Inactive orgs are blocked from adding clients or creating appointments." is_active: Boolean "The email of organization" organization_email: String organization_info: PrimaryOrganizationInfoInput } "Autogenerated input type of updateOrganizationMember" input updateOrganizationMemberInput { additional_record_identifier: String avatar: Upload "image in Base64 format" avatar_string: String email: String first_name: String id: ID last_name: String "A serialized JSON string of metadata. Maximum character limit of 10,000." metadata: String npi: String phone_number: String provider_appointment_locations: [ProviderAppointmentLocationsInput] provider_bio: ProviderBioInput qualifications: String record_identifier: String scheduling_priority: String state_licenses: [StateLicensesInput] "The provider's primary NUCC taxonomy code; pass null or blank to clear it" primary_taxonomy_code_id: ID timezone: String } "Autogenerated input type of updateOrganizationMembership" input updateOrganizationMembershipInput { action_for_appointments: String active: Boolean allow_group_level_actions: Boolean allow_self_scheduling_in_care_team: Boolean auto_create_convo_for_care_team: Boolean can_access_calendar_quick_share: Boolean can_access_to_members_chat: Boolean can_add_clients: Boolean can_add_members: Boolean can_add_members_to_chat: Boolean can_assign_tasks_to_all_org_members: Boolean can_be_care_team_member: Boolean can_charge_clients: Boolean can_delete_automations: Boolean can_delete_charting_notes: Boolean can_delete_faxes: Boolean can_edit_appointment_types: Boolean can_edit_automations: Boolean can_edit_calendar: Boolean "If true, the user can manage their own availability" can_manage_own_availability: Boolean "If true, the user can manage their own blocks" can_manage_own_blocks: Boolean "If true, the user can manage other members' availability" can_manage_others_availability: Boolean "If true, the user can manage other members' blocks" can_manage_others_blocks: Boolean "If true, the user can add appointments on their own calendar" can_add_own_appointments: Boolean "If true, the user can add appointments on other providers' calendars" can_add_others_appointments: Boolean "If true, the user can edit appointments on their own calendar" can_edit_own_appointments: Boolean "If true, the user can edit appointments on other members' calendars" can_edit_others_appointments: Boolean "If true, the user can change the status of appointments on their own calendar" can_status_own_appointments: Boolean "If true, the user can change the status of appointments on other members' calendars" can_status_others_appointments: Boolean "If true, the user can delete appointments on their own calendar" can_delete_own_appointments: Boolean "If true, the user can delete appointments on other members' calendars" can_delete_others_appointments: Boolean can_edit_credit: Boolean can_edit_docs: Boolean can_edit_education: Boolean can_edit_forms: Boolean can_edit_members: Boolean can_edit_packages: Boolean can_edit_products: Boolean can_edit_settings: Boolean can_enroll_clients_to_programs: Boolean "If true, the user can access Zus functionality" can_access_zus: Boolean can_lock_form_answer_groups: Boolean can_lock_others_charting_notes: Boolean can_lock_own_charting_notes: Boolean can_mark_assigned_tasks_to_other_org_members_as_completed: Boolean can_merge_clients: Boolean can_order_labs: Boolean can_remove_client: Boolean can_create_tags: Boolean can_rename_and_delete_tags: Boolean can_restrict_clients: Boolean can_see_billing: Boolean can_see_calendar: Boolean can_see_clients: Boolean can_see_docs: Boolean can_see_faxes: Boolean can_see_fullscript_tab: Boolean can_see_sent_faxes: Boolean can_see_option_to_use_erx_dosespot: Boolean can_see_transfers: Boolean can_set_client_password: Boolean can_share_documents_and_folders_with_org_members: Boolean can_sign_others_charting_notes: Boolean can_sign_own_charting_notes: Boolean can_submit_cms_1500s_to_change_health: Boolean can_submit_cms_1500s_to_office_ally: Boolean can_unlock_charting_notes: Boolean can_unlink_chart_note_from_appointment: Boolean can_view_audit_log: Boolean can_view_automations: Boolean can_view_all_org_members_tasks: Boolean can_view_cms1500s: Boolean can_view_goal_templates: Boolean can_view_labs: Boolean can_view_org_dashboard: Boolean "If true, the user can delete Zoom recordings and transcripts" can_delete_recordings: Boolean "If true, the user can view Zoom recordings and transcripts" can_view_recordings: Boolean can_view_reports: Boolean can_view_super_bills: Boolean can_write_org_addendums: Boolean can_autogenerate_charting_notes_from_zoom_calls: Boolean "If true, encounter summaries can be generated for the user's encounters" can_generate_encounter_summaries: Boolean "If true, the user can view encounter summaries" can_view_encounter_summaries: Boolean email: String erx_dosespot_role: String first_name: String fullscript_practitioner_id: String gets_failed_fax_notif: Boolean gets_fax_notif: Boolean has_own_branding: Boolean hide_calendar_tab: Boolean id: ID is_admin: Boolean is_developer: Boolean is_provider: Boolean last_name: String notify_any_client_activity: Boolean notify_on_book: Boolean notify_on_cancel: Boolean notify_on_payment_failure: Boolean """ Options are ["Standard", "Support"] """ org_role: String "Selected permission template" permission_template_id: ID phone_number: String position: Int professions: [ProfessionsInput] provider_to_receive_clients: ID "Updates the qualifications of the org member (optional)" qualifications: String request_eligibility_checks: Boolean scheduling_priority: String sees_all_billing: Boolean sees_all_clients: Boolean selected_licensed_in_filter: [String] selected_locations_filter: [String] selected_statuses_filter: [String] selected_tags_filter: [String] send_email_on_intake_flow_complete: Boolean send_email_on_intake_flow_start: Boolean share_appointment_types: Boolean share_custom_metrics: Boolean share_fullscript: Boolean share_goal_templates: Boolean share_packages: Boolean share_smart_phrases: Boolean share_user_groups: Boolean show_availability_first: Boolean show_org_tab: Boolean specialties: [SpecialtiesInput] start_conversation_with: Boolean "Updates the timezone of the org member (optional)" timezone: String "Lets you add extra metadata about the organization membership. Not used in Healthie UI" title: String "Indicate that the user applied a permission template on this update" permission_template_applied: Boolean can_manage_care_plan_templates: Boolean create_chat_when_assigned: Boolean can_remove_org_member_signatures: Boolean bypass_api_key_warning: Boolean = false "Requires the organization to have instant transcripts enabled" instant_transcribe_enabled: Boolean } "Autogenerated input type of updatePdfLetterheadTemplate" input updatePdfLetterheadTemplateInput { id: ID! "The source the address should be taken from" address_source: PdfLetterheadTemplateAddressSource = ORGANIZATION "The source the brand logo should be taken from" brand_logo_source: PdfLetterheadTemplateBrandLogoSource = ORGANIZATION "The source the email address should be taken from" email_source: PdfLetterheadTemplateEmailSource = ORGANIZATION "Whether the brand logo should be shown in PDF" include_brand_logo: Boolean = true "Whether the address should be shown in PDF" include_address: Boolean = true "Whether the appointment details should be shown in PDF" include_appointment_details: Boolean = true "Whether the email address should be shown in PDF" include_email: Boolean = true "Whether the phone number should be shown in PDF" include_phone_number: Boolean = true "Whether the name of the team member should be shown in PDF" include_team_member_name: Boolean = true "Whether the name of the organization should be shown in PDF" include_organization_name: Boolean = true "Whether provider's NPI should be shown in PDF" include_team_member_npi: Boolean = true "Whether provider's qualifications should be shown in PDF" include_team_member_qualifications: Boolean = true "Custom email address to use in PDF" other_email: String "Custom phone number to use in PDF" other_phone_number: String "The source the phone number should be taken from" phone_number_source: PdfLetterheadTemplatePhoneNumberSource = ORGANIZATION "The source the team member's name should be taken from" team_member_name_source: PdfLetterheadTemplateTeamMemberNameSource = CURRENT_USER "The title for the PDF Letterhead Template" title: String } "Autogenerated input type of updatePermissionTemplate" input updatePermissionTemplateInput { allow_self_scheduling_in_care_team: Boolean auto_create_convo_for_care_team: Boolean can_access_calendar_quick_share: Boolean can_access_to_members_chat: Boolean can_add_clients: Boolean can_add_members: Boolean can_add_members_to_chat: Boolean can_assign_tasks_to_all_org_members: Boolean can_be_care_team_member: Boolean can_charge_clients: Boolean can_delete_automations: Boolean can_delete_charting_notes: Boolean can_delete_faxes: Boolean can_edit_appointment_types: Boolean can_edit_automations: Boolean can_edit_calendar: Boolean "If true, the user can manage their own availability" can_manage_own_availability: Boolean "If true, the user can manage their own blocks" can_manage_own_blocks: Boolean "If true, the user can manage other members' availability" can_manage_others_availability: Boolean "If true, the user can manage other members' blocks" can_manage_others_blocks: Boolean "If true, the user can add appointments on their own calendar" can_add_own_appointments: Boolean "If true, the user can add appointments on other providers' calendars" can_add_others_appointments: Boolean "If true, the user can edit appointments on their own calendar" can_edit_own_appointments: Boolean "If true, the user can edit appointments on other members' calendars" can_edit_others_appointments: Boolean "If true, the user can change the status of appointments on their own calendar" can_status_own_appointments: Boolean "If true, the user can change the status of appointments on other members' calendars" can_status_others_appointments: Boolean "If true, the user can delete appointments on their own calendar" can_delete_own_appointments: Boolean "If true, the user can delete appointments on other members' calendars" can_delete_others_appointments: Boolean can_edit_credit: Boolean can_edit_docs: Boolean can_edit_education: Boolean can_edit_forms: Boolean can_edit_members: Boolean can_edit_packages: Boolean can_edit_products: Boolean can_edit_settings: Boolean can_enroll_clients_to_programs: Boolean can_lock_others_charting_notes: Boolean can_lock_own_charting_notes: Boolean can_mark_assigned_tasks_to_other_org_members_as_completed: Boolean can_merge_clients: Boolean can_order_labs: Boolean can_view_labs: Boolean can_remove_client: Boolean can_create_tags: Boolean can_rename_and_delete_tags: Boolean can_restrict_clients: Boolean can_see_billing: Boolean can_see_calendar: Boolean can_see_clients: Boolean can_see_docs: Boolean can_see_faxes: Boolean can_see_fullscript_tab: Boolean can_see_sent_faxes: Boolean can_see_transfers: Boolean can_set_client_password: Boolean can_share_documents_and_folders_with_org_members: Boolean can_sign_others_charting_notes: Boolean can_sign_own_charting_notes: Boolean can_submit_cms_1500s_to_change_health: Boolean can_submit_cms_1500s_to_office_ally: Boolean can_unlink_chart_note_from_appointment: Boolean can_unlock_charting_notes: Boolean can_view_audit_log: Boolean can_view_automations: Boolean can_view_all_org_members_tasks: Boolean can_view_cms1500s: Boolean can_view_goal_templates: Boolean can_view_org_dashboard: Boolean "If true, the user can delete Zoom recordings and transcripts" can_delete_recordings: Boolean "If true, the user can view Zoom recordings and transcripts" can_view_recordings: Boolean can_view_reports: Boolean can_view_super_bills: Boolean can_write_org_addendums: Boolean "If true, the user can access Zus functionality" can_access_zus: Boolean gets_failed_fax_notif: Boolean gets_fax_notif: Boolean has_own_branding: Boolean id: ID is_admin: Boolean is_provider: Boolean is_developer: Boolean name: String notify_any_client_activity: Boolean notify_on_book: Boolean notify_on_cancel: Boolean notify_on_payment_failure: Boolean org_role: String organization_id: ID request_eligibility_checks: Boolean sees_all_billing: Boolean sees_all_clients: Boolean send_email_on_intake_flow_complete: Boolean send_email_on_intake_flow_start: Boolean share_appointment_types: Boolean share_custom_metrics: Boolean share_fullscript: Boolean share_goal_templates: Boolean share_packages: Boolean share_smart_phrases: Boolean show_availability_first: Boolean show_org_tab: Boolean start_conversation_with: Boolean allow_group_level_actions: Boolean can_manage_care_plan_templates: Boolean can_autogenerate_charting_notes_from_zoom_calls: Boolean "If true, the user can generate encounter summaries" can_generate_encounter_summaries: Boolean "If true, the user can view encounter summaries" can_view_encounter_summaries: Boolean create_chat_when_assigned: Boolean can_remove_org_member_signatures: Boolean "Requires the organization to have instant transcripts enabled" instant_transcribe_enabled: Boolean } "Autogenerated input type of updatePolicyMutation" input updatePolicyMutationInput { benefits: [BenefitInput] call_reference: CallReferenceInput cpt_codes_policies: [CptCodesPolicyInput] effective_end: String effective_start: String holder_dob: String holder_first: String holder_gender: String holder_last: String holder_mi: String holder_phone: String icd_codes_policies: [IcdCodesPolicyInput] id: ID insurance_authorization: InsuranceAuthorizationInput insurance_authorization_required: Boolean insurance_card_back_id: String insurance_card_front_id: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON notes: String policy_phone_number: String priority_type: String referral_required: Boolean referring_physician_id: String same_address_as_client: Boolean type_string: String } "Autogenerated input type of updateProcedure" input updateProcedureInput { code: String code_system_name: String cpt_code_id: ID display_name: String id: ID procedure_end_datetime: String procedure_start_datetime: String status: String target_site: String } "Autogenerated input type of updateProduct" input updateProductInput { id: ID name: String price: String remaining_quantity: String tax_description: String tax_rate: String unlimited_quantity: Boolean } "Autogenerated input type of updateProviderCptCodes" input updateProviderCptCodesInput { provider_cpt_codes: [ProviderCptCodeInput] provider_id: ID } "Autogenerated input type of updateReceivedDirectMessage" input updateReceivedDirectMessageInput { id: ID patient_id: ID } "Autogenerated input type of updateReceivedFax" input updateReceivedFaxInput { archived: Boolean comments: String id: ID } "Autogenerated input type of updateRecommendation" input updateRecommendationInput { id: ID recommendation_body: String care_plan_recommendation_category_id: ID } "Autogenerated input type of updateRecurringForm" input updateRecurringFormInput { ends_on: String frequency: String hour: String id: String is_active: Boolean is_recurring: Boolean minute: String monthday: String period: String recipient_ids: String recurrence_ends: Boolean weekday: String } "Autogenerated input type of updateReferral" input updateReferralInput { id: ID "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String referral_reason: String referring_physician_id: ID user_id: ID } "Autogenerated input type of updateReferringPhysician" input updateReferringPhysicianInput { accepts_insurance: Boolean business_name: String email: String fax_number: String first_name: String id: ID last_name: String location: PhysicianLocationInput "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String notes: String npi: String other_id: String other_id_qualifier: String phone_number: String referrals: [PhysicianReferralInput] = [] speciality: String website: String } "Autogenerated input type of updateRequestedPayment" input updateRequestedPaymentInput { appointment_id: ID cms1500_id: ID id: ID! invoice_type: String is_preview: Boolean "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON notes: String offering_id: ID price: String recipient_id: ID requested_payer: RequestedPayerInput requested_payment_template: RequestedPaymentTemplateInput resend_receipt: Boolean send_request_email: Boolean sender_id: ID service_date: String services_provided: String status: String use_as_template: Boolean write_offs: [WriteOffInput] } "Autogenerated input type of updateSavedFilter" input updateSavedFilterInput { "ID of the saved filter to update" id: ID! "New name for the saved filter" name: String! } "Autogenerated input type of updateSmartPhrase" input updateSmartPhraseInput { id: ID "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON name: String phrase: String } "Autogenerated input type of updateSmokingStatus" input updateSmokingStatusInput { id: ID smoking_status_code: String status_end_datetime: String status_start_datetime: String } "Autogenerated input type of updateState" input updateStateInput { active: Boolean id: ID! } "Autogenerated input type of updateStripeCustomerDetail" input updateStripeCustomerDetailInput { card_type_label: String first_microdeposit: String id: ID is_default: Boolean second_microdeposit: String user_id: ID } "Autogenerated input type of updateStripeVerificationDetails" input updateStripeVerificationDetailsInput { account_holder_name: String account_number: String additional_verification_document: Upload appointment_type_credits_attributes: [AppointmentTypeCreditInput] "Additional documentation for bank accounts, e.g. voided checks, bank statements, etc" bank_verification_document: Upload "Description of the product sold or service provided by the business" business_description: String "The customer-facing business name" business_name: String business_tax_id: String "The business's publicly available website" business_url: String company_verification_document: Upload currency: String dob: String email: String entity_type: String first_name: String id: ID last_name: String location: ClientLocationInput new_country: String personal_address: ClientLocationInput personal_phone: String phone: String routing_number: String skip_adding_bank_info: Boolean ssn: String ssn_last_4: String verification_document: Upload } "Autogenerated input type of updateSubscription" input updateSubscriptionInput { activate_short_trial: Boolean details: String id: ID "The name of the new Stripe Plan to switch to. Currently, this just supports moving trialing members to starter." new_plan_name: String "The name or plan ID of the plan to switch to. Currently, this just supports moving canceled members to a new plan." stripe_plan: String reactivate_plan: String reason: String stripe_idempotency_key: ID "Value can either be monthly or annual. Allows users on Practice Plus or Small Practice to switch billing cycles." switch_plan: String token: String wants_to_cancel: Boolean } "Autogenerated input type of updateSuperBill" input updateSuperBillInput { address: String amount_paid: String cpt_codes_super_bills: [CptCodesSuperBillInput] dietitian_id: ID icd_codes_super_bills: [IcdCodesSuperBillInput] id: ID license_num: String location: LocationInputs location_id: ID npi: String patient_dob: String patient_id: ID patient_location: PatientLocationInputs patient_name: String patient_phone: String place_of_service_id: ID prov_city: String prov_email: String prov_line1: String prov_line2: String prov_phone: String prov_state: String prov_zip: String provider_name: String receipt_line_items: [ReceiptLineItemInput] referrer_name: String referrer_npi: String service_date: String should_email_to_client: Boolean status: String tax_id: String } "Autogenerated input type of updateTag" input updateTagInput { id: ID name: String } "Autogenerated input type of updateTask" input updateTaskInput { "IDs of the users assigned to this task" assignee_ids: [ID!] client_id: String complete: Boolean completed_by_id: ID content: String created_by_id: String due_date: String hidden: Boolean "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON id: String position: Int priority: Int reminder: TaskReminderInput seen: Boolean } "Autogenerated input type of updateUniqueDeviceIdentifier" input updateUniqueDeviceIdentifierInput { assigning_authority: String device_code: String display_name: String id: ID scoping_entity: String udi_code: String } "Autogenerated input type of updateUserAppointmentPricing" input updateUserAppointmentPricingInput { advance_appointment_prices: [AdvanceAppointmentPricesInput] user_id: ID } "Autogenerated input type of updateUserGroup" input updateUserGroupInput { id: ID name: String onboarding_flow_id: ID } "Autogenerated input type of updateUser" input updateUserInput { active_care_plan_id: ID assign_tasks_seen: Boolean avatar: Upload "image in Base64 format" avatar_string: String blast_seen: Boolean card_type_label: String consented_to_labs: Boolean current_email: String current_password: String default_onboarding_flow_id: ID dismissed_calendar_prompt: Boolean dismissed_charting_note_addendum_warning: Boolean dismissed_insurance_eligibility_warning: Boolean dismissed_fullscript: Boolean dismissed_products_tab: Boolean "The default billing type for the patient (e.g. insurance or self-pay). Only applicable to patients." default_billing_type: DefaultBillingType dob: String email: String first_name: String gender: String gender_identity: String gender_identity_code: String human_id: ID id: ID last_name: String legal_name: String locations: [ClientLocationInput] "This field does not do anything, and should not be used" name: String password: String password_confirmation: String phone_number: String policies: [UserPolicyInput] preferred_language_code: String pretend_to_be: String primary_ethnicity_code: String primary_race_code: String product_update_articles: Int pronouns: String qualifications: String resend_welcome_to_dietitian: Boolean secondary_ethnicity_code: Int secondary_race_code: String seen_onboarding_complete_page: Boolean seen_welcome: Boolean send_get_mobile_app_email: Boolean sex: String sexual_orientation_code: String sexual_orientation_other: String skipped_email: Boolean submit_labs_immediately: Boolean timezone: String "Token for credit card, created by Stripe.JS" token: String uniq_push_id: String } "Autogenerated input type of updateWebhook" input updateWebhookInput { event_type: String id: ID is_enabled: Boolean should_retry: Boolean "A valid URL per the WHATWG specification" url: String "Webhook events to update or delete" webhook_events: [WebhookEventInput] } "Autogenerated input type of updateWriteOff" input updateWriteOffInput { "The ID of the write-off to update" id: ID! "The ID of the requested payment associated with this write-off" requested_payment_id: ID "The type of write-off" write_off_type: WriteOffType "The amount of the write-off" amount: Float """ Required if write_off_type is "other" """ other_reason: String } "Autogenerated input type of uploadBatchToCandidHealth" input uploadBatchToCandidHealthInput { cms1500_ids: [ID] } "Autogenerated input type of uploadBatchToChangeHealth" input uploadBatchToChangeHealthInput { cms1500_ids: [ID] } "Autogenerated input type of uploadBatchToOfficeally" input uploadBatchToOfficeallyInput { cms1500_ids: [ID] } "Autogenerated input type of uploadToIntegrations" input uploadToIntegrationsInput { "Supercedes cms1500_ids if provided. The ID of a singular Cms1500 to submit" cms1500_id: ID "An array of IDs of CMS1500 objects to submit" cms1500_ids: [ID] "The claims integration to submit the specified claim(s) to" destination_integration: ClaimDestinationIntegration } "Autogenerated input type of validateVerificationToken" input validateVerificationTokenInput { verification_code: String } "Accepted Insurance Plan" type AcceptedInsurancePlan { "Unique identifier of the plan" id: ID! "Connected ICD Code Object" insurance_plan: InsurancePlan } "The connection type for AcceptedInsurancePlan." type AcceptedInsurancePlanConnection { "A list of edges." edges: [AcceptedInsurancePlanEdge] "A list of nodes." nodes: [AcceptedInsurancePlan] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type AcceptedInsurancePlanEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AcceptedInsurancePlan } "Specific appointment price object for provider/client" type AdvanceAppointmentPrice { "Appointment type ID this appointment price is associated with." appointment_type_id: ID "The unique identifier of the price" id: ID! "The advance price for this appointment type" price: String! "User ID this appointment price is associated with." user_id: ID! } "(DEPRECATED - NO LONGER USED) Information on the provider's affiliate abilities" type Affiliate { "The LeadDyno ID of the affiliate" affiliate_id: String "The referral URL of the affiliate" affiliate_url: String "The URL of the affiliate's dashboard" dashboard_url: String "Unique identifier of the affiliate" id: ID! } "A reusable template for creating Care Alerts" type AlertTemplate { "Full text content of the alert template" content: String "When the alert template was created" created_at: ISO8601DateTime! "Short description of the alert template" description: String "Unique identifier of the alert template" id: ID! "When the alert template was last updated" updated_at: ISO8601DateTime! } "An edge in a connection." type AlertTemplateEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AlertTemplate } "The connection type for AlertTemplate." type AlertTemplatePaginationConnection { "A list of edges." edges: [AlertTemplateEdge] "A list of nodes." nodes: [AlertTemplate] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An allergy/sensitivity/preference for a client" type AllergySensitivity { "Enum field. Options: allergy, sensitivity, preference, intolerance, ccda" category: String! "Type of allergy or like/dislike for preference. Options: food, drug, environmental, pet, latex, like, dislike" category_type: String "Date/Time created" created_at: String! "User who created this allergy" created_by: User "The unique identifier of the allergy" id: ID! "If the allergy is current." is_current: Boolean @deprecated(reason: "Use status instead") "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON "If the allergy is synchronized with an external system (e.g., an E-Rx system)" mirrored: Boolean! "The name of the allergy/sensitivity/preference" name: String "The date of onset" onset_date: String "Description of the reaction on the allergen" reaction: String "The type of the reaction. Options are [allergy, adverse_reaction]" reaction_type: String "When true, this object must be consolidated as part of a CCDA Ingest" requires_consolidation: Boolean "The severity of the allergy. Options: mild, moderate, severe, unknown" severity: String "The allergy's current status. Options are [active, inactive, resolved]" status: String "Date/Time last updated" updated_at: String } "Announcements created by providers for client consumption" type Announcement { "If true, announcement is active" active: Boolean! "file name of associated image" announcement_image_name: String "URL of image associated with announcement" announcement_image_url: String "Pagination cursor" cursor: Cursor! "Announcement content(viewable by client)" description: String "Unique identifier of the announcement" id: ID! "Date and time announcement active status was changed" last_toggled_at: String "User that updated active status of this announcement most recently" last_toggled_by: User "Name of announcement(only viewable by provider)" name: String "Title of announcement(viewable by client)" title: String "User that created this announcement" user: User "Comma separated list of user group ids associated with this announcement" user_group_ids: String "Comma separated list of user group names associated with this announcement" user_group_names: String } "A created API Key" type ApiKey { "The datetime the API Key was created" created_at: String! "Pagination cursor" cursor: Cursor! "Upon the initial creation of the key, this field displays the actual key to be used to authenticate." displayable_key: String "Unique identifier of the key" id: ID! "A user-chosen name for the API key." name: String } "An edge in a connection." type ApiKeyEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: ApiKey } "The connection type for ApiKey." type ApiKeyPaginationConnection { "A list of edges." edges: [ApiKeyEdge] "A list of nodes." nodes: [ApiKey] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An Apple Health Sync" type AppleHealth { "The unique identifier of the apple health" id: ID! "The last time the apple health was synced" last_sync_date: String } "A tag applied to a user" type AppliedTag { "The time the tag was applied" created_at: String! "The unique identifier of the applied tag" id: ID! "The tag applied" tag: Tag "The unique identifier of the tag" tag_id: String "The time the applied tag was last updated" updated_at: String! "The tagged user" user: User "The ID of the tagged user" user_id: String } "An appointment object containing information about the appointment, including the attendees, date, location, and more." type Appointment { "The actual length of the appointment (in minutes). Filled in by the provider after the appointment" actual_duration: String "Get link to add appointment to google calendar" add_to_gcal_link: String """ Category of the appointment: expected values are "Individual" and "Group" """ appointment_category: String "The number of people (both providers and attendees) who are in the appointment" appointment_inclusions_count: Int "A label for the appointment" appointment_label: String "the ID of the appointment location" appointment_location_id: String "The ID of the appointment request this appointment fulfills" appointment_request_id: ID "The type of the appointment" appointment_type: AppointmentType "The ID of the type of appointment this is" appointment_type_id: Int "List of assigned user groups to the group appointment" assigned_groups: [UserGroup!] "Client inclusions which includes all attendees even if they didnt show up for the appointment" attended_clients: [AppointmentInclusionType!] "All attendees for the appointment." attendees: [User!]! "Pending Appointment inclusions" attendees_on_waitlist: [User!] "The backgroundColor color of the appointment" backgroundColor(appointment_setting_updated_at: String): String "Returns true if the patient can reschedule the appointment" can_be_rescheduled: Boolean "True if client able to cancel an appointment" can_client_cancel: Boolean "True if client able to reschedule an appointment" can_client_reschedule: Boolean "True if the authenticated user can launch ambient AI scribe for this appointment" can_launch_ambient_scribe: Boolean! "The cancellation reason for this appointment" cancellation_reason: CancellationReason "false if the client needs to confirm the appointment, and has not" client_confirmed(known_requires_client_confirmed: Boolean): Boolean "Whether the appointment updating on client side or not" client_updating: Boolean "The status of whether the provider has confirmed the appointment or not" confirmed: Boolean "True if appointment is locked" connected_chart_note_locked: Boolean "The status of the connected chart note" connected_chart_note_string: String "How the provider and attendees will connect (i.e In-Person or through the phone)" contact_type: String "The ID of conversation related to the current appointment(only for group appts 10/2020)" conversation_id: ID "The date and time that the appointment was created" created_at: String! "True if a credit was used for this appointment" credit_was_used: Boolean "The position of the appointment in the recurring series" current_position_in_recurring_series: Int "Pagination cursor" cursor: Cursor! "The date and time of the appointment" date: String "default color of appointment based on confirmation/type" default_color: String "The time the appointment was deleted. It is blank if the appointment is not deleted." deleted_at: String "The effective pricing method for this appointment (calculated or stored)" effective_pricing_method: AppointmentPricingMethod "Whether AI encounter-summary generation would run for this appointment" encounter_summary_generation_eligible: Boolean! "The end time of the appointment" end: String "The type of connection to an external calendar" external_id_type: String "A URL to an external video chat site for the session" external_videochat_url: String "The custom answers filled out by the booker of the appointment" filled_embed_form: FormAnswerGroup "The Form answer group first associated with the appointment" form_answer_group: FormAnswerGroup "All Form answer groups associated with the appointment" form_answer_groups: [FormAnswerGroup!] "The AI Scribe generated form answer group associated with the appointment" generated_form_answer_group: GeneratedFormAnswerGroupType "The latest AI-generated encounter summary for the appointment" generated_summary: GeneratedSummary "open tok token" generated_token: String "When true, additional group charting fields are visible in the Healthie UI" has_expanded_vbc_charting_fields: Boolean "Returns true if the appointment has in progress job" has_in_progress_job: Boolean "The unique identifier of the appointment" id: ID! "ID of user that created of appointment" initiator_id: ID "When true, insurance billing will be enabled for this appointment" insurance_billing_enabled: Boolean "The status of whether this appointment is specifically meant to block availability" is_blocker: Boolean "Indicates whether it's a group appointment" is_group: Boolean "The status of whether the video chat uses Zoom or Healthie Default telehealth" is_zoom_chat: Boolean "id of last conversation between provider and client in appointment" last_client_conversation_id: ID "The ID of the provider who last updated the appointment record, if available" last_updated_by_id: ID "The Late Cancellation Fee (in cents) for this appointment" late_cancellation_fee: Int "The length of the appointment (in minutes)" length: Int "The plaintext location of the appointment (only used for in-person appointments)" location: String "Location Resource" locationResource: String "How many attendees can register for an appointment (only used for Group Appointments)" max_attendees: String "a serialized JSON string of metadata" metadata: JSON "Minimum time before the appointment when client can still cancel it" minimum_advance_cancel_time: Int "Minimum time (in minutes) before the appointment when client can still reschedule it" minimum_advance_reschedule_time: Int "The No Show Fee (in cents) for this appointment" no_show_fee: Int "Quick notes on the appointment (only visible to providers)" notes: String "The ID of the organization the appointment belongs to" organization_id: ID """ Free text reason when "Other" cancellation reason is selected """ other_cancellation_reason: String "The id of the provider" other_party_id: Int "The number of times a patient rescheduled an appointment" patient_reschedule_count: Int """ The status of the appointment. Can be one of "Occurred", "No-Show", "Re-Scheduled", "Cancelled." If enabled, "Late Cancellation" and "Checked-In" are also valid. """ pm_status(check_for_client_cancel: Boolean = false): String "The date and time the status of the appointment was last updated" pm_status_changed_at: String "The ID of the user who last changed the status of the appointment, if available" pm_status_last_changed_by_id: ID "Get the pricing info for this appointment" pricing_info: AppointmentPricingInfoType "The provider for the appointment" provider: User "Provider name" provider_name: String "All providers for the appointment." providers(empty_unless_multiple: Boolean = false): [User!]! "The clients reason for scheduling the appointment" reason: String "The related recurring appointment series" recurring_appointment: RecurringAppointment "The ID of the recurring appointment" recurring_appointment_id: String @deprecated(reason: "Use recurring_appointment instead") "The status of whether this is a repeating appointment or not" repeat: Boolean @deprecated(reason: "Use recurring_appointment instead") "How often to repeat the appointment (e.g Daily or Monthly)" repeat_interval: String @deprecated(reason: "Use recurring_appointment instead") "How many times does the appointment repeat" repeat_times: Int @deprecated(reason: "Use recurring_appointment instead") "A requested payment for this appointment" requested_payment: RequestedPayment "The ID of the user, used for the calendar" resourceId: String "the ID of the room" room_id: ID "A string containing info on how the appointment was scheduled" scheduled_by: String "The OpenTok session ID for the appointment" session_id: String "When true, a cms1500 should be created when the appointment status is set to occurred" should_create_cms1500_for_occurred_appointments: Boolean "The start time of the appointment" start: String "The font color of the appointment" textColor: String "The status of whether the time of this appointment has been separated from the other recurring appointments in the series" time_recurring_override: Boolean "Timezone abbreviation of the date of the appointment" timezone_abbr: String "The title of the appointment" title: String "Can only be returned via querying a single appointment, not a collection. Transcripts for the appointment (in VTT format)" transcripts(transcript_type: TranscriptTypeEnum, status: [TranscriptStatusEnum]): [Transcript!] "Unauthenticated link to download an ICS file for the appointment" unauthenticated_ics_link: String "The last date and time that the appointment was updated" updated_at: String "Whether the appointment should use embedded Zoom in browser" use_embedded_zoom: Boolean "Whether the appointment is through Zoom or not" use_zoom: Boolean "The client in a 1:1 appointment" user: User "The id of the client (if a 1:1 appointment). If a group appointment, will be nil" user_id: Int "True if this appointment is configured to be summarized by AI Scribe" will_be_scribed: Boolean! "Zoom meeting info. Appointment should have a valid zoom link and the user should have the permission to access the meeting. Otherwise returns nil" zoom_appointment: ZoomAppointment "Detailed information about Zoom cloud recording files for this appointment" zoom_cloud_recording_files: [ZoomCloudRecordingFile!] "URLs for Zoom cloud recordings for this appointment" zoom_cloud_recording_urls: [String] "ZAK tokens for each org member co-host on this Zoom group appointment. Returns an empty array when the feature flag is disabled, there is no Zoom meeting, or there are no other org member providers with a valid zoom_id." zoom_co_host_links: [ZoomCoHostLink!] "The dial-in info provided by zoom if appoint has zoom links.(separated by newline characters)" zoom_dial_in_info: String "The dial-in info provided by zoom if appoint has zoom links.(separated by break tags)" zoom_dial_in_info_html: String "An array of JSON objects containing the different dial in numbers for the Zoom call" zoom_dial_in_numbers_json: [String] "Freshly-minted ZAK for the host to join a Zoom session via Web SDK. Bounded TTL keeps it under Zoom's 48h recommendation." zoom_fresh_zak_token: String "The join link for other attendees of the Zoom call" zoom_join_url: String "The Meeting ID for the Zoom call" zoom_meeting_id: String "JWT for Zoom Web SDK with HOST role only. For role-based tokens (host for providers, participant for clients), use the embeddedZoomJwt query instead." zoom_sdk_jwt: String "The host link to start the Zoom call" zoom_start_url: String } "Autocomplete form for appointment type. Used for AI-generated charting notes." type AppointmentAutocompleteForm { "Custom module form for the appointment type" custom_module_form: CustomModuleForm "ID of the appointment autocomplete form" id: ID } "Warnings to show provider before they book" type AppointmentBookingWarning { "Category of warning (e.g no credits)" category: String "Array of IDs of objects causing booking issues for a given category" potential_issue_ids: [String!] "Array of potential booking issues for a given category" potential_issues: [String!] "Subtitle describing the category" subtitle: String } "An object containing appointment type credit change event" type AppointmentCreditChange { "The appointment related to credit change event" appointment: Appointment "The time when credit change event was created" created_at: String! "The event which caused credit change" credit_change_event: String! "The specific action which caused credit change" credit_change_event_type: String "The amount of credits after specific event" credit_quantity: Int! "The unique identifier of the credit change" id: ID! "The user who triggered credit change" initiator: User "The offering related to credit change event" offering: Offering } "Appointment Data" type AppointmentDataType { "Appointment Frequency" freq: AppointmentFrequencyDataType "Appointment Month" month: String } "An edge in a connection." type AppointmentEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: Appointment } "Appointment Frequency Data" type AppointmentFrequencyDataType { "Frequency of cancelled appointments" cancelled: Int "Frequency of checked-in appointments" checked_in: Int "Frequency of late cancellation appointments" late_cancellation: Int "Frequency of appointments with no status" no_status: Int "Frequency of no-show appointments" noshow: Int "Frequency of occurred appointments" occurred: Int "Frequency of rescheduled appointments" rescheduled: Int } "Provider/Client to Appointment connection" type AppointmentInclusionType { "The appointment the inclusion is connected to." appointment: Appointment "Indicate whether a group appointment attendee have taken part in the appointment" attended: Boolean "The reason for cancellation if the appointment was cancelled" cancellation_reason: String "Indicate if a group appointment attendee cancelled the appointment" cancelled: Boolean "The timestamp of when the attendee cancelled the appointment" cancelled_at: ISO8601DateTime "The user who performed the cancellation" cancelled_by: User "The ID of the user who performed the cancellation" cancelled_by_id: ID "If the client has confirmed the appointment, or don't need to (THIS IS FIELD IS CURRENTLY USED ONLY FOR GROUP APPT's)" confirmed: Boolean "The UUID of the appointment inclusion. Can be used in conjunction with appointment settings to allow unauthenticated users to modify an appointment." external_uuid: ID "The unique identifier of the appointment inclusion" id: ID! "The datetime that the attendee joined the appointment" join_time: String "The datetime that the attendee left the appointment" leave_time: String "The other reason for cancellation if the appointment was cancelled" other_cancellation_reason: String "Attendee" user: User "Attendee ID" user_id: ID @deprecated(reason: "Use `user` field") } "A location where appointments are held" type AppointmentLocation { "The ID of the associated appointment setting" appointment_setting_id: ID "Whether the client can select this location or not" clients_can_book: Boolean! "Whether the location has any rooms" has_rooms: Boolean "The unique identifier of the appointment" id: ID! "The location (in plain text)" location: String "The rooms at the location" rooms: [Room!] } "The connection type for Appointment." type AppointmentPaginationConnection { "A list of edges." edges: [AppointmentEdge] "A list of nodes." nodes: [Appointment] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "The appointment count for the specific day" type AppointmentPerDayData { "The object with the total count of appointments for each status" count: AppointmentFrequencyDataType "The day we count appointments for" date: String } "Appointments for the specific type and day" type AppointmentPerTypePerDayData { "The array containing the appointment count for each appointment status for the specific day" appointments: [AppointmentPerDayData!] "The name of the specific appointment type" name: String } "The data type for the appointment count for each appointment type per user" type AppointmentPerTypePerUserData { "The array containing the appointment count for each appointment type for each appointment status for the specific day" appointment_types: [AppointmentPerTypePerDayData!] "The name of the specific user who we count appointments for" name: String } "Appointments for each status for the specific day" type AppointmentPerUserData { "The array containing the appointment count for each appointment status for the specific day" appointments: [AppointmentPerDayData!] "The name of the provider who we count appointments for" name: String } "Appointment pricing info" type AppointmentPricingInfoType { "The CPT Code" cpt_code: CptCode "CPT Code ID" cpt_code_id: String "The insurance billing method for this appointment" insurance_billing_method: String "The price" price: String "The units of the price" units: String } "An range of time requested for an appointment request" type AppointmentRequestSlotType { "The identifier of the parent appointment request" appointment_request_id: ID! "The unique identifier of the appointment request slot" id: ID! "The end time of the appointment request slot" slot_end: ISO8601DateTime! "The start time of the appointment request slot" slot_start: ISO8601DateTime! } "Appointment Request for a provider waitlist" type AppointmentRequestType { "The appointment location requested for the appointment" appointment_location: AppointmentLocation "The appointment type requested for the appointment" appointment_type: AppointmentType "The booking parameters for the appointment request" booking_params: JSON "The date and time the appointment request was closed" closed_at: ISO8601DateTime "The user who closed the appointment request" closed_by: User "The date and time the appointment request was created" created_at: ISO8601DateTime! "The current status of the appointment request" current_status: AppointmentRequestStatus! "The email address of the patient requesting the appointment" email: String! "The first appointment scheduled from this request" first_appointment: Appointment "The first name of the patient requesting the appointment" first_name: String! "The unique identifier of the appointment request" id: ID! "The last name of the patient requesting the appointment" last_name: String! "If there is an existing patient record for the patient requesting the appointment" patient: User "The phone number of the patient requesting the appointment" phone: String! "The provider assigned to the appointment request, if provided" provider: User "The notes for the appointment request" provider_notes: String "The notes for the appointment request" reason: String! "The contact type selected for the appointment request" selected_contact_type: String "The state selected for the appointment request" selected_state: String "The slots for the appointment request" slots: [AppointmentRequestSlotType!]! "The timezone of the patient requesting the appointment" timezone: String! } "The connection type for AppointmentRequestType." type AppointmentRequestTypeConnection { "A list of edges." edges: [AppointmentRequestTypeEdge] "A list of nodes." nodes: [AppointmentRequestType] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type AppointmentRequestTypeEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AppointmentRequestType } "Appointment Setting options that a provider can customize" type AppointmentSetting { "Insurance plans that are accepted by the provider" accepted_insurance_plans: [AcceptedInsurancePlan!] "Whether or not providers will be able to set pricing per appointment type" allow_appointment_type_pricing: Boolean "If true, clients will be able to cancel an appointment" allow_clients_to_cancel_appt: Boolean "If true, clients will be able to reschedule an appointment" allow_clients_to_reschedule_appt: Boolean! "When true, providers can specify external url (e.g., Doxy, VSee) for Video Call appointments." allow_external_videochat_urls: Boolean! "When true, a client can reschedule a past appointment (on the Web/API only)" allow_past_appointment_rescheduling: Boolean! "Whether or not clients will have specific pricing for appointment types" allow_specific_client_pricing: Boolean! "Whether or not providers will have specific pricing for appointment types" allow_specific_provider_pricing: Boolean! "Always notify the provider when the client books" always_send_confirm_notification: Boolean "Appointment Locations for this Appointment Setting" appointment_locations: [AppointmentLocation!] "Have different appointment confirmation emails for each appointment type" appointment_type_confirmed_email: Boolean "Have different appointment reminder emails for each appointment type" appointment_type_reminder_email: 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" appointment_type_reminder_override: Boolean "Have different website booking emails for each appointment type" appointment_type_website_booking_email: Boolean "Separate confirmation emails for different appointment types" appt_type_confirmed_email: Boolean "Separate reminder emails for different appointment types" appt_type_reminder_email: Boolean "Separate website booking emails for different appointment types" appt_type_website_booking_email: Boolean "Ask clients to confirm their appointment" ask_clients_to_confirm: Boolean "If true, clients can confirm their appointment via text" ask_to_confirm_via_text: Boolean "True when either auto_schedule_charges_for_late_cancellation_no_show or charge_for_occurred_appts" auto_charge_enabled: Boolean "When true, after an appointment has been set as occurred, a CMS 1500 claim can be automatically created for the session" auto_create_cms1500: Boolean "Auto-generate a payment request when an appointment is scheduled" auto_invoicing: Boolean "when true, a scheduled charge will be created when an appointment is marked as late cancellation or no show" auto_schedule_charges_for_late_cancellation_no_show: Boolean "When true, it will be automatically submitted to the clearinghouse on the following Friday at 11:59 PM" auto_submit_cms1500: Boolean "The base minute interval (FIVE_MINUTES, TEN_MINUTES, FIFTEEN_MINUTES) that all availability operations are performed with" base_calendar_interval: BaseCalendarInterval! "Allow clients to book appointments at none, 20, 30, 60 intervals" booking_interval_restriction: Int "The amount of minutes to maintain between appointments (prevent back to back appointments)" buffer: String "The color schemes defined for this appointment setting" calendar_color_schemes: [CalendarColorScheme!] "DEPRECATED: Calendar interval" calendar_interval: String @deprecated(reason: "Use `calendar_view_setting` instead") "Text to display above the client's calendar within Healthie" calendar_text: String "Message to show clients when they are not allowed to cancel" cant_cancel_message: String "Message to show clients when they are not allowed to cancel" cant_reschedule_message: String "Whether or not client with valid payment method will be charged for occurred appointments" charge_for_occured_appts: Boolean @deprecated(reason: "Use `charge_for_occurred_appts` instead") "Whether or not client with valid payment method will be charged for occurred appointments" charge_for_occurred_appts: Boolean "When true, clients must provide a cancellation reason when cancelling" client_cancel_reason_required: Boolean "If true, clients will be able to call to provider" client_should_call_provider: Boolean "When false, the billing tab is hidden from clients" clients_have_billing: Boolean "Confirm all client-created appointments by default" confirm_by_default: Boolean "Contact type overrides for this appointment setting" contact_type_overrides: [ContactType!] "Show the group appointment form first" default_appt_form_to_group: Boolean "The template selected will automatically appear when a new chart note is started" default_charting_template_id: String "The template name selected" default_charting_template_name: String "The form that should be pre-selected when creating a new group charting note" default_group_charting_template: CustomModuleForm "Use Zoom for all telehealth appointments" default_to_zoom: Boolean "Video service to use for telehealth appointments ('internal', 'zoom', or 'external')" default_video_service: String "Prevent the client from rescheduling a past appointment with one of these statuses" disallowed_reschedulable_statuses: [String] "Whether or not to allow appointment requests" enable_appointment_requests: Boolean """ Enable the additional "Checked-In" status for appointments. """ enable_checked_in_status: Boolean """ Enable the additional "Late Cancellation" status for appointments. """ enable_late_cancellation_status: Boolean "The end time to show when setting weekly availability" end_time: String "Facebook pixel code that runs when the client completes the embedded scheduler/purchaser" fb_pixel: String "Assign a name to chart notes" give_notes_name: Boolean @deprecated(reason: "This now always returns true") "If true, hide insurance getting started info" hide_insurance_getting_started_info: Boolean "Hide links to Healthie from appointment reminders" hide_link: Boolean "The unique identifier of the setting" id: ID! "When true, it will show the option to run an insurance eligibility check for a client" insurance_eligibility_integration: Boolean "When true, CPT codes can be set for each insurance plan" insurance_specific_cpt_code_pricing: Boolean "Whether or not to send invoice to client without a valid payment card/method" invoice_clients_without_payment_method: Boolean "The fee (in cents) to use for appointments marked as late cancellation" late_cancellation_fee: Int "The maximum number of days in advance a client can book" max_days_in_future: String "DEPRECATED: Maximum time a client must wait before being able to reschedule a past appointment" maximum_past_reschedule_time: Int @deprecated(reason: "No longer supported") "Minimum time before the appointment when client still can cancel it (in minutes)" minimum_advance_cancel_time: Int "Minimum time before the appointment when client still can reschedule it (in minutes)" minimum_advance_reschedule_time: Int "Minimum time before the desired appointment type where client still can schedule it (in minutes)" minimum_advance_schedule_time: Int "The minimum days in advance a client has to book" minimum_days_in_advance: String "DEPRECATED: Minimum time a client must wait before being able to reschedule a past appointment" minimum_past_reschedule_time: Int @deprecated(reason: "No longer supported") "The fee (in cents) to use for appointments marked as no show" no_show_fee: Int """ Either "even" or "hour" to restrict booking to even hours or half hours. """ only_book: String @deprecated(reason: "Use booking_interval_restriction instead") "Whether or not to restrict booking to even hours or half hours." only_book_even: Boolean @deprecated(reason: "Use booking_interval_restriction instead") "Whether or not to restrict booking to even hours or half hours." only_book_hour: Boolean @deprecated(reason: "Use booking_interval_restriction instead") "Owner of this appointment_setting" owner: User "The maximum number of times a patient can self reschedule" patient_reschedule_count_cap: String "Appointment statuses that can be applied to an appointment. Includes default ones plus any custom" pm_statuses: [String] "Prevent clients from booking an appointment" prevent_client_booking: Boolean "Prevent clients from booking if they do not have the needed credit" prevent_no_credit_booking: Boolean "When true, providers must provide a cancellation reason when cancelling" provider_cancel_reason_required: Boolean "When true, replies to automatic notifications will go to the provider" reply_to_provider: Boolean "When true, providers and staff will always be asked to select an appointment location when scheduling, even if its a video chat." require_selected_location_for_all_contact_types: Boolean "DEPRECATED: The minimum number of days beyond the current appointment date that the patient can reschedule to" reschedule_max_days_before_date: String @deprecated(reason: "No longer supported") "DEPRECATED: The maximum number of days beyond the current appointment date that the patient can reschedule to" reschedule_max_days_from_date: String @deprecated(reason: "No longer supported") "Give clients their credit back when an appointment is cancelled" restore_credit_on_cancel: Boolean "When true, clients are prevented from scheduling appointments the day of" same_day_appointments: Boolean "When false, no appointment cancel emails are sent to patients." send_appointment_cancellation_email: Boolean "When false, no appointment update emails are sent to patients." send_appointment_update_email: Boolean "Send clients an email when a provider schedules an appointment" send_booking_notice: Boolean "Send an email 5 minutes before a video chat starts" send_email_before_appointment: Boolean "Sends a confirmation email to the client when the client initially books an appointment" send_embeddable_appt_creator_email: Boolean "Send email reminder to complete intake forms two days before" send_intake_forms_reminder: Boolean "Send a push notification 5 minutes before a video chat starts" send_push_before_appointment: Boolean "Send an email reminder four days before the appointment" send_reminder_four_days_before: Boolean "Send an email reminder one day before the appointment" send_reminder_one_day_before: Boolean "Send an email reminder one hour before the appointment" send_reminder_one_hour_before: Boolean "Send an email reminder three days before the appointment" send_reminder_three_days_before: Boolean "Send an email reminder two days before the appointment" send_reminder_two_days_before: Boolean "Send an email reminder two hours before the appointment" send_reminder_two_hours_before: Boolean "NOTE: Your organization MUST have its own Twilio account configured to have this feature, and have AppointmentSetting.send_email_before_appointment enabled" send_text_reminder_five_minutes_before: Boolean "Send a text reminder four days before the appointment" send_text_reminder_four_days_before: Boolean "Send a text reminder one day before the appointment" send_text_reminder_one_day_before: Boolean "Send a text reminder one hour before the appointment" send_text_reminder_one_hour_before: Boolean "Send a text reminder three days before the appointment" send_text_reminder_three_days_before: Boolean "Send a text reminder two days before the appointment" send_text_reminder_two_days_before: Boolean "Send a text reminder two hours before the appointment" send_text_reminder_two_hours_before: Boolean "When true, providers can set a default external link for video call sessions." set_default_videochat_url: Boolean "If True, provider will see Care Plans option on a Client profile page" show_care_plans: Boolean "If true, show cms1500s" show_cms1500s: Boolean "When false, the faxing tab on the left hand side is hidden from providers" show_faxes: Boolean "If true, show the insurance authorization section on the clients profile" show_insurance_authorization: Boolean "If true, show office ally" show_office_ally: Boolean "If true, show superbills" show_superbills: Boolean "Facebook pixel code that runs when the client starts the embedded scheduler/purchaser" start_fb_pixel: String "The start time to show when setting weekly availability" start_time: String "Set different availability for each appointment type" times_by_appointment_type: Boolean "Set different availability for each contact type" times_by_contact_type: Boolean "Set different availability for each appointment location" times_by_location: Boolean "The last date and time that the appointment setting was updated" updated_at: String "If true, cpt units and fees can be associated with appointment types" use_appointment_type_cpt_units_and_fees: Boolean "Whether or not to use the client credit system" use_client_credit_system: Boolean "If true, you can see where each client came from" use_client_sources: Boolean "If true, clients will be placed in a waiting room instead of joining the Zoom call directly" use_zoom_waiting_room: Boolean "The id of the user" user_id: String "Default video url settings" video_url_default: VideoUrlDefault "Preference for how Zoom calls should open ('embedded_zoom' for browser, 'zoom_app' for Zoom app)" zoom_open_preference: String } "The data for the appointment summary" type AppointmentSummaryData { "The array containing the appointment count for each appointment status for the specific day" appointment_history: [AppointmentPerDayData!] "The array containing the appointment count for each appointment status for each provider for the specific day" appointment_history_per_provider: [AppointmentPerUserData!] "The array containing the appointment count for each appointment status for each provider for each appointment type for the specific day" appointment_history_per_provider_and_type: [AppointmentPerTypePerUserData!] "The array containing the appointment count for each appointment status for each appointment type for the specific day" appointment_history_per_type: [AppointmentPerTypePerDayData!] "The count of appointments for each appointment type" appointments_per_type_count: [AppointmentTypeAppointmentCountData!] "The average amount of appointments per day" avg_per_day: Int "The difference between the current average amount of appointments and the average count of appointments in prior period" avg_per_day_percent_diff: Int "The busiest week day in selected period" busiest_days_of_week: [String] "When true, the data is in the process of being generated and stored in the cache." cache_generation_in_progress: Boolean "The difference in contrast to previous period in percents" percent_diff: Int "The total appointment count" total_count: Int } "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(appointment_location_id: String, org_level: Boolean = false, 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 "Custom description shown to clients when self-scheduling" client_display_description: String "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 raw client-facing display name without fallback to name. Used for editing." client_facing_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(appointment_location_id: String, 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 organization that the appointment type belongs to" organization_id: Int! "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(client_state_of_residence: String, org_level: Boolean = false, provider_id: String, provider_ids: [String]): Boolean } "The count of appointments for each appointment type" type AppointmentTypeAppointmentCountData { "The unique identifier of the count" appointment_count: Int "The name of the appointment type for which we count appointments for" name: String } "AppointmentTypeCptCode object" type AppointmentTypeCptCodeType { "Appointment Type ID" appointment_type_id: ID! "CPT Code ID" cpt_code_id: ID! "Fee (in cents) per unit" fee_per_unit: Int "The unique identifier of the object" id: ID! "DEPRECATED. Use appointmentType's insurance_billing_enabled instead" insurance_billing_enabled: Boolean @deprecated(reason: "Use appointmentType's insurance_billing_enabled instead") "Units" units: String } "An object containing information the clients' remaining credit for a given appointment type" type AppointmentTypeCredit { "The Appointment Type connected to the credit" appointment_type: AppointmentType "the id of the appointment type" appointment_type_id: String "An Alias of ID that makes creating the form easier" form_id: String "The unique identifier of the credit" id: ID "The quantity of the credit" quantity: String "The id of the holder of the credit" user_id: Int } "An object containing event which should be taken before or after appointment" type AppointmentTypeFormConnection { "ID of the form for the form completion request" custom_module_form: CustomModuleForm "The unique identifier of the form" id: ID! "Form requests will be sent before or after given interval, depends on `send_trigger`" interval: ISO8601Duration "Determines when action should be taken(before or after appointment)" send_trigger: String } "AppointmentWorkflowStatusType object" type AppointmentWorkflowStatus { "Appointment object" appointment: AppointmentWorkflowStatusAppointmentType "Chart notes for the appointment" chart_notes: [AppointmentWorkflowStatusChartNoteType!] "Total chart notes for the appointment" chart_notes_count: Int "The client for the appointment" client: AppointmentWorkflowStatusClientType "The CMS1500 for the appointment" cms1500: AppointmentWorkflowStatusCms1500Type "The invoice for the appointment" invoice: AppointmentWorkflowStatusInvoiceType "The provider for the appointment" provider: AppointmentWorkflowStatusProviderType } "The appointment object" type AppointmentWorkflowStatusAppointmentType { """ Category of the appointment: expected values are "Individual" and "Group" """ appointment_category: String "Date of the appointment" date: ISO8601DateTime "ID of the appointment" id: ID "Status of the appointment" status: String } "The chart note object for the appointment" type AppointmentWorkflowStatusChartNoteType { "ID of the chart note for the appointment" id: ID "Status of the chart note for the appointment" status: AppointmentWorkflowChartNoteStatus "The chart note title for the appointment" title: String } "The client object for the appointment" type AppointmentWorkflowStatusClientType { "ID of the client for the appointment" id: ID "Name of the client for the appointment" name: String } "The cms1500 object for the appointment" type AppointmentWorkflowStatusCms1500Type { "ID of the cms1500 for the appointment" id: ID "Status of the cms1500 for the appointment" status: String } "The connection type for AppointmentWorkflowStatus." type AppointmentWorkflowStatusConnection { "A list of edges." edges: [AppointmentWorkflowStatusEdge] "A list of nodes." nodes: [AppointmentWorkflowStatus] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type AppointmentWorkflowStatusEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AppointmentWorkflowStatus } "The invoice object for the appointment" type AppointmentWorkflowStatusInvoiceType { "ID of the invoice for the appointment" id: ID "Status of the invoice for the appointment" status: String } "The provider object for the appointment" type AppointmentWorkflowStatusProviderType { "ID of the provider for the appointment" id: ID "Name of the provider for the appointment" name: String } "Assumed brand information" type AssumedBrand { "The dark logo url for the brand" alt_branded_logo_url: String "The favicon url for the brand" branded_favicon_url: String "The branded logo url for the brand" branded_logo_url: String "The branded name for the brand" branded_name: String id: ID! "theme_accent_primary" theme_accent_primary: String "theme_accent_primary_hover" theme_accent_primary_hover: String "theme_background_hover" theme_background_hover: String "theme_background_input" theme_background_input: String "theme_background_primary" theme_background_primary: String "theme_background_secondary" theme_background_secondary: String "bg_color" theme_background_sidebar: String "theme_border_input" theme_border_input: String "theme_border_primary" theme_border_primary: String "font_color" theme_text_sidebar: String "selected_color" theme_text_sidebar_active: String "tab_accent_color" theme_text_sidebar_tab_bar: String } "An audit event." type AuditEvent { "The user who caused this event." acting_user: User "Pagination cursor" cursor: Cursor! "Date and time that the event happened." occurred_at: ISO8601DateTime! "The patient associated with this audit event, if any." patient: User "The set of changes associated with the event" resource_changes: [AuditEventResourceChange!] "The ID of the resource that was affected by the event." resource_id: ID! "The name of the resource that was affected by this event." resource_name: AuditEventResourceName! "The type of the event." type: AuditEventType! } "The details of a change associated with a audit event." type AuditEventResourceChange { "The field that was changed." field: String! "The value after the change." value_after_change: String "The value before the change." value_before_change: String } "Setting to initialize Authentication" type AuthenticationSetting { "Application ID for the authentication service" app_id: ID "Base URL for the authentication service" app_url: String "Whether the authentication service is enabled" auth_service_enabled: Boolean! "Client ID for the authentication service" client_id: ID "Whether the native mobile SDK login path is enabled" mobile_sdk_login_enabled: Boolean! "Tenant ID for the authentication service" tenant_id: ID } "The auto task generators belonging to a specific user" type AutoTaskGenerator { "Category of task" category: String! "The date and time that the task was created" created_at: String! "The number of days the task is due from the date it was created" days_due_from_created_at: Int "The unique identifier of the generator" id: ID! "True if task is active" is_enabled: Boolean! "Description of the number to check" number_description: String "The number to check" number_to_check: Float! "Description of the task" task_description: String! "The last date and time that the task was updated" updated_at: String! "The id of the user who creates the task" user_id: String "The id of the user" user_id_for_task: String } "Automated Insurance Billing Setting Type" type AutomatedInsuranceBillingSetting { "When true, CMS1500s will be created automatically" auto_create_cms1500s: Boolean "When true, CMS1500s will be submitted automatically" auto_submit_cms1500s: Boolean "The unique identifier of the setting" id: ID! "When true, insurance billing features are enabled for the organization" insurance_billing_enabled: Boolean "DEPRECATED. This setting no longer has any effect" use_cpt_codes_units_and_fees_with_appointment_types: Boolean } "An automation workflow definition" type Automation { "When the automation was created" created_at: ISO8601DateTime! "Description of what the automation does" description: String "Unique identifier" id: ID! "Whether the automation is active" is_enabled: Boolean! "When the automation last executed" last_run_at: ISO8601DateTime "Display name for the automation" name: String! "Total number of times the automation has run" run_count: Int! "Steps in the automation workflow" steps(after: String, before: String, first: Int, last: Int): AutomationStepPaginationConnection! "Triggers that initiate this automation" triggers: [AutomationTrigger!]! "When the automation was last updated" updated_at: ISO8601DateTime! } "An action to execute in an automation step" type AutomationAction { "User-defined action identifier within the step" action_identifier: String! "The GraphQL mutation to execute" action_type: AutomationActionKind! """ Mutation arguments with optional template variables. Example: {"arguments": {"content": "Complete onboarding for {{query-patient.first_name}}", "user_id": "{{query-patient.dietitian_id}}"}} """ config: JSON! "When the action was created" created_at: ISO8601DateTime! "Unique identifier" id: ID! "When the action was last updated" updated_at: ISO8601DateTime! } "A condition that evaluates data in an automation step" type AutomationCondition { "User-defined condition identifier within the step" condition_identifier: String! "When the condition was created" created_at: ISO8601DateTime! """ Path to the field to evaluate (e.g., "data.patient.email") """ field: String! "Unique identifier" id: ID! "Comparison operator" operator: AutomationConditionOperator! "Value to compare against" value: String } "An edge in a connection." type AutomationConditionEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AutomationCondition } "A group of conditions evaluated together with AND/OR logic" type AutomationConditionGroup { "Logic for combining conditions (AND/OR)" condition_logic: AutomationConditionLogic "Conditions to evaluate" conditions(after: String, before: String, first: Int, last: Int): AutomationConditionPaginationConnection! } "The connection type for AutomationCondition." type AutomationConditionPaginationConnection { "A list of edges." edges: [AutomationConditionEdge] "A list of nodes." nodes: [AutomationCondition] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A delay (wait) configured on an automation step" type AutomationDelay { "When the delay was created" created_at: ISO8601DateTime! "User-defined delay identifier within the step" delay_identifier: String! "Unit for duration_value" duration_unit: AutomationDelayUnit! "How long to wait, in duration_unit" duration_value: Int! "Unique identifier" id: ID! "When the delay was last updated" updated_at: ISO8601DateTime! } "An edge in a connection." type AutomationEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: Automation } "The connection type for Automation." type AutomationPaginationConnection { "A list of edges." edges: [AutomationEdge] "A list of nodes." nodes: [Automation] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A query step that fetches data in an automation" type AutomationQuery { """ Query arguments with optional template variables. Example: {"arguments": {"id": "{{trigger.resource_id}}"}} """ config: JSON! "When the query was created" created_at: ISO8601DateTime! "Unique identifier" id: ID! "User-defined query identifier within the step" query_identifier: String! "Name of the query to execute" query_name: String! "When the query was last updated" updated_at: ISO8601DateTime! } "A record of an automation execution" type AutomationRun { "Name of the automation at time of execution" automation_name: String! "When execution completed" completed_at: ISO8601DateTime "When this record was created" created_at: ISO8601DateTime! "Error description when status is FAILED" error_message: String "Unique identifier" id: ID! "When a run paused on a delay step will resume" resume_at: ISO8601DateTime "Individual step execution records" run_steps(after: String, before: String, first: Int, last: Int): AutomationRunStepPaginationConnection! "When execution started" started_at: ISO8601DateTime "Execution status of the run" status: AutomationRunStatus! "The webhook event payload that initiated this run" trigger_data: JSON "When this record was last updated" updated_at: ISO8601DateTime! } "An edge in a connection." type AutomationRunEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AutomationRun } "The connection type for AutomationRun." type AutomationRunPaginationConnection { "A list of edges." edges: [AutomationRunEdge] "A list of nodes." nodes: [AutomationRun] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A record of a step execution within an automation run" type AutomationRunStep { "When execution completed" completed_at: ISO8601DateTime "When this record was created" created_at: ISO8601DateTime! "Error description when status is FAILED" error_message: String "Unique identifier" id: ID! "Data context available to this step, including trigger data and outputs from prior steps" input_data: JSON "Data produced by this step, available as input to subsequent steps" output_data: JSON "When a delay step paused on this run-step will resume" resume_at: ISO8601DateTime "When execution started" started_at: ISO8601DateTime "Execution status of the step" status: AutomationRunStepStatus! "User-defined step identifier of the step that was executed" step_identifier: String! "Name of the step at time of execution" step_name: String! "When this record was last updated" updated_at: ISO8601DateTime! } "An edge in a connection." type AutomationRunStepEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AutomationRunStep } "The connection type for AutomationRunStep." type AutomationRunStepPaginationConnection { "A list of edges." edges: [AutomationRunStepEdge] "A list of nodes." nodes: [AutomationRunStep] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A step in an automation workflow" type AutomationStep { "When the step was created" created_at: ISO8601DateTime! "The step-type-specific detail (action, query, delay, or condition group)" detail: AutomationStepDetail "Unique identifier" id: ID! "Display name for the step" name: String! "Configuration for next steps based on outcome" next_steps_config: JSON "User-defined step identifier within the automation" step_identifier: String! "When the step was last updated" updated_at: ISO8601DateTime! } "An edge in a connection." type AutomationStepEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: AutomationStep } "The connection type for AutomationStep." type AutomationStepPaginationConnection { "A list of edges." edges: [AutomationStepEdge] "A list of nodes." nodes: [AutomationStep] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A trigger that initiates an automation" type AutomationTrigger { "When the trigger was created" created_at: ISO8601DateTime! "Unique identifier" id: ID! "Type of trigger" trigger_type: AutomationTriggerKind! "When the trigger was last updated" updated_at: ISO8601DateTime! "Type of webhook event that triggers this automation" webhook_type: WebhookEventType } "The autoscored section for a filled form" type AutoscoredSectionType { """ The autoscored section has a live autoscoring module(mod_type: "autoscored_calculator") if true. """ has_autoscored_calculator: Boolean "The key of the section" section_key: String "The title of the section" section_title: String "Is false when none of the questions for the autoscored section are answered" show: Boolean "The value of the section" value: Float } "An object containing availability ranges for a provider" type Availability { "If not nil, the specific location the availability is for" appointment_location_id: String "If not nil, the specific appointment type the availability is for" appointment_type_id: Int "Appointment types associated with this availability via the many-to-many join" appointment_types: [AppointmentType!] "If not nil, the specific contact type the availability is for" contact_type_id: Int "The time the availability was created" created_at: ISO8601DateTime "The 0-indexed day of the week the availability is on" day_of_week: Int "Duration between range start and range end in hours and minutes. Example:(4h 20min)" duration_string: String "The end date of the availability" end_on: String "When true, this availability covers every non-group appointment type the provider owns" has_all_appointment_types: Boolean! "The unique identifier of the availability (if the availability is repeating, this will be a unique identifier comprised of the date and ID of the availability)" id: ID! "The status of whether the availability repeats every week" is_repeating: Boolean "The origin start of the availability" origin_start_date: String "The end of the datetime of the availability" range_end: String "The start of the datetime of the availability" range_start: String "Availability ID if the availability is repeating" repeating_availability_id: ID "The ID of the user, used for the calendar" resourceId: String "Timezone of the availability passed in when it was created" timezone: String "Timezone abbreviation of the availability time range" timezone_abbr: String "The time the availability was last updated" updated_at: ISO8601DateTime "Provider this availability belongs to" user: User "The ID of the person who the availability is for" user_id: Int } "Structured height, weight, and bmi data for a `bmi` (bmi, bmi(in.), bmi(cm)) form answer" type BMIAnswer { "BMI" bmi: Float "Height" height: Float "Weight" weight: Float } "Benefit associated with policy" type Benefit { "Enumerated field: Medical or Preventive. Describes the type of benefit" category: String "Coinsurance percentage due" coinsurance: String "Copay amount due" copay: String "Deductible amount for the calendar year" deductible_calendar_year: String "Deductible amount for the year to date" deductible_year_to_date: String "The unique identifier of the benefit" id: ID! "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "If true, benefits include telemedicine" telemedicine: Boolean } "Billing configuration for an organization" type BillingConfiguration { "Whether Carve-out insurance options are enabled for this organization." allow_carve_out_insurance: Boolean! "Whether patient encounters are the source of truth for billing data for this organization" encounters_enabled: Boolean! } "Billing" type BillingItem { "Raw amount value (use amount_paid_string for displaying money amounts)" amount_paid: String "Formatted money amount with 2 decimal places - use this field for displaying payment amounts" amount_paid_string: String "Fee charged by stripe in cents" application_fee_amount: String "card brand used for this charge (e.g. visa, mastercard) for succeeded payments" card_brand: String "last 4 digits of the card used for this specific charge for succeeded payments" card_last4: String "card brand and last4 digits in the event of a failed charge" card_source: String "the related charge backs" charge_backs: [ChargeBack!] "coupon code" coupon_code: String "cpt codes super bills id" cpt_codes_super_bills_id: ID "created at date" created_at: String! "type of currency" currency: String "Pagination cursor" cursor: Cursor! "date payment was deleted" deleted_at: String "Error message returned when payment failed" failure_reason: String "Name of person who gifted this package(if applicable). Returns nil if not an offering or if not a gift" gifted_by: String "Name of person who received this package as a gift. Returns nil if not an offering or if not a gift" gifted_to: String "The unique identifier of the billing item" id: ID! "id of invoice" invoice_id: ID @deprecated(reason: "Use requested_payment_id instead. This will return the same data as that") "canceled indicator" is_canceled: Boolean "Whether this payment was made outside of Healthie" is_outside_payment: Boolean "Whether this payment is recurring" is_recurring: Boolean "The index number of partial payment" item_position_number: Int "A serialized JSON string of metadata" metadata: JSON "The payment, after refunds are taken out" net_payment: String "Nil unless the payment is an uncharged upcoming scheduled payment. Otherwise, is the payment amount that is scheduled to be charged" next_scheduled_payment_amount: String "payment note" note: String "offering connected to the payment" offering: Offering "offering coupon connected to the payment" offering_coupon: OfferingCoupon "id of coupon" offering_coupon_id: ID "offering id" offering_id: ID "original price" original_price: String "payment medium" payment_medium: ID "provider" provider: User "receipt last sent at date" receipt_last_sent_at: String "recipient of this payment" recipient: User "id of receiver" recipient_id: ID "recurring payment connected to the payment" recurring_payment: RecurringPayment "amount of refund" refund_amount: String "date of refund" refund_date: String "the related refundings" refund_items: [RefundItem!] "Individual responsible for payment. If user_id, user exists in Healthie, if not, individual doesn't have a Healthie account" requested_payer: RequestedPayer "the connected requested payment" requested_payment: RequestedPayment "id of requested payment (we call them invoices in our UI)" requested_payment_id: ID "sender of this payment" sender: User "id of sender" sender_id: ID "The description text to show for the payment" shown_description: String "The note text to show for the payment" shown_note: String "Enum status of billing item succeeded/failed" state: String "id of stripe charge" stripe_charge_id: ID "A JSON hash containing information on why Stripe was unable to process a charge" stripe_error: String "if a failed payment is retried successfully then this will reference that successful payment" successful_retried_payment: BillingItem "updated at date" updated_at: String "User Package Selection connected to this payment" user_package_selection: UserPackageSelection } "Body Report is a sub category of a HealthAssessment" type BodyReport { "amr of user" amr: String "bmi of user" bmi: String "body_fat_percent of user" body_fat_percent: String "body_weight of user" body_weight: String "c_bmi of user" c_bmi: String "fat_mass of user" fat_mass: String "lean_body_mass of user" lean_body_mass: String "rmr of user" rmr: String } "Brand options that a client can customize" type Brand { "Brand Owner's about description" about_description: String "Brand Owner's bg color" bg_color: String "Brand Owner's brand email" brand_email: String "Name of provider's brand" brand_name: String "Owner of this brand" brand_owner: User "Whether or not brand owner has practice plus" brand_owner_has_practice_plus: Boolean "Whether or not brand owner has whitelabel" brand_owner_has_whitelabel: Boolean "Brand Owner's brand phone" brand_phone: String "Brand Owner's contact info" contact_description: String "Custom sign in path for provider with practice plus" custom_sign_in_path: String "Whether or not we should display the header text of a package embed" display_embed_title: Boolean "Brand Owner's display name" display_name: String "Whether or not we should display the package image on embed and sharing link pages" display_package_image: Boolean "Brand Owner's email background color" email_background_color: String "The primary color that will use to customize a customer's embed process" embed_primary_color: String "URL to a hosted stylesheet that will apply to Embeddable Layout" embeddable_layout_css_url: String "Brand Owner's Facebook link" facebook: String "Brand Owner's font color of choice" font_color: String "The brand's Universal GA ID" ga_id: String "The brand's Google Tag Manager ID" gtm_id: String "The unique identifier of the brand" id: ID! "Brand Owner's Instagram link" instagram: String "Custom HTML that replaces the content on the standard intake flow completed screen" intake_completed_html: String "Brand owner's logo" logo: Upload "Brand Owner's logo" logo_file_name: String "The URL to the logo" logo_url: String "URL to a hosted stylesheet that will apply to Main Layout" main_layout_css_url: String "Brand Owner's selected color" selected_color: String "Brand Owner's slogan" slogan: String "Brand Owner's tab accent color" tab_accent_color: String "Primary accent color for highlighted and interactive elements in the brand theme" theme_accent_primary: String "Accent color applied to highlighted elements when hovered in the brand theme" theme_accent_primary_hover: String "Background color applied to elements in a hover state within the brand theme" theme_background_hover: String "Background color for input fields and form controls in the brand theme" theme_background_input: String "Primary background color for the brand theme, used as the main surface color throughout the UI" theme_background_primary: String "Secondary background color for the brand theme, used for alternate surfaces and panels" theme_background_secondary: String "Background color for the sidebar navigation" theme_background_sidebar: String "Border color for input fields and form controls in the brand theme" theme_border_input: String "Primary border color used for dividers and container outlines in the brand theme" theme_border_primary: String "Text color used in the sidebar navigation" theme_text_sidebar: String "Text color for the currently active or selected item in the sidebar" theme_text_sidebar_active: String "Text color for the sidebar tab bar items" theme_text_sidebar_tab_bar: String "Brand Owner's credentials" titles: String "Brand Owner's Twitter link" twitter: String "ID of Brand Owner" user_id: String "Brand Owner's website link" website: String } "Info for authentication pages for either a dietitian or partner" type BrandInfo { "Brand Owner's logo" image_url: String "Name of the partner" name: String "The brand associated with provider/partner" partner_brand: Brand "if false the client signup tab is not shown" show_client_tab: Boolean "if false the client signup tab is not shown" show_provider_tab: Boolean "Header for the sign up page" sign_up_header: String "Header for the sign up page" sign_up_text: String "Custom HTML to be placed at the bottom of signup" signup_footer: String "Unique code of the brand or provider" unique_code: String "Whether the partner's users can use a username to sign in (defaults to false)" uses_username: Boolean } "Autogenerated return type of BulkDeleteAvailability." type BulkDeleteAvailabilityPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "Number of availabilities deleted" deleted_count: Int "The list of errors occurred during the mutation" messages: [FieldError] "Whether the operation succeeded" success: Boolean } "A Calendar Color Scheme" type CalendarColorScheme { "Course ID of benefit" appointment_setting_id: String "The category to color code by" color_code_by: String "Color code options that make up this color scheme" color_codes: [ColorCode!] "The default color (in case the subcategory conditions are not met)" default_color: String "The unique identifier of the scheme" id: ID! "The ID of the connected user" user_id: String } "View settings for provider calendar" type CalendarViewSetting { "Filter appointments by status" appointment_status_filter: String! "Filter appointments by statuses" appointment_statuses_filter: [String] "ID of appointment type to filter appointments" appointment_type_filter: ID! "Array of IDs of appointment types to filter appointments" appointment_types_filter: [ID] "Array of IDs of appointment types to filter availabilities" availability_appointment_types_filter: [ID] "ID of appointment type to filter availabilities" availability_appt_type_filter: ID "Filter availabilities by contact type" availability_contact_type_filter: String "ID of location to filter availabilities" availability_location_filter: ID "ID of provider to filter availabilities" availability_provider_filter: ID "ID of appointment type to filter availabilities" availablilty_appt_type_filter: ID @deprecated(reason: "Use `availability_appt_type_filter` instead") "ID of selected calendar color scheme" calendar_color_scheme_filter: ID "Selected calendar interval" calendar_interval: String "Selected calendar view" calendar_view_filter: String "Filter appointments by client confirmation status" client_confirmation_status: String "Comma separated names of contact types to filter appointments" contact_types_filter: String "Selected sorting for documents(This is not a calendar setting. Related to documents area)" document_area_sorting: String "Visibility of color schemes section" expand_color_schemes: Boolean "Visibility of appointment filters section" expand_filter_appointments: Boolean "Visibility of availability filters section" expand_filter_availabilities: Boolean "Visibility of 'Filter Providers' section in organization calendar" expand_filter_by_providers: Boolean "Visibility of 'View By Provider' section in organization calendar" expand_filter_providers: Boolean "Visibility of show section" expand_show_availabilities: Boolean "ID of favorite saved filter" favorite_saved_filter_id: ID "The unique identifier of the setting" id: ID! "Filter appointments by provider accepted insurance ids" insurance_plan_ids_filter: [ID!] "ID of location to filter appointments" location_filter: ID "IDs of locations to filter appointments" locations_filter: [ID] "Visibility of one time availabilities in calendar" one_time_availabilities: Boolean "Selected organization calendar view" org_calendar_view_filter: String "A collection of providers that can be selected, given the state and tag filters. If no filters are selected, this will be empty" potential_filtered_provider_ids: [ID!] "Filter appointments by provider confirmation status" provider_confirmation_status: String "ID of selected provider to filter availabilities in organization calendar" selected_availability_provider_filter: ID "Comma separated IDs of providers to filter availabilities in organization calendar" selected_availability_providers_filter: String "ID of selected provider in organization calendar" selected_provider_filter: ID "Comma separated IDs of selected providers in organization calendar" selected_providers_filter: String "Visibility of all appointments" show_appointments: Boolean "Visibility of all availabilities" show_availabilities: Boolean "Visibility of all synced appointments" show_synced_appointments: Boolean "Filter appointments by provider state licenses" state_licenses_filter: String "Filter appointments by provider tags" tag_ids_filter: String "Selected calendar timezone" timezone: String "Visibility of weekly availabilities in calendar" weekly_availabilities: Boolean } "Call reference information associated with a policy" type CallReference { "Date call was made" date_recorded: String "The unique identifier of the reference call" id: ID! "Notes taken for this reference call" notes: String "call reference number provided by insurance company" reference_number: String "Time call was made" time_recorded: String "The ID of the patient who the call reference is for" user_id: Int } "An appointment cancellation reasons" type CancellationReason { "The unique identifier of the cancellation reason" id: ID! "The label of the cancellation reason" label: String! "The type of cancellation reason" reason_type: CancellationReasonTypeEnum! } "Info on connection to Candid Health" type CandidHealthConnection { "The unique identifier of the connection" id: ID! "True if the Candid connection is turned by user" is_enabled: Boolean! } "A care alert associated with a patient. These can notify users about important information related to this patient." type CareAlert { "Text content of the care alert" content: String! "When the care alert was created" created_at: ISO8601DateTime! "Provider who created this care alert" creator: User "When the care alert was soft-deleted" deleted_at: ISO8601DateTime "When the care alert expires" expires_at: ISO8601DateTime @deprecated(reason: "Use `expires_on` instead") "Date when the care alert expires" expires_on: ISO8601Date "Unique identifier of the care alert" id: ID! "Patient this care alert is associated with" patient: User "Priority level of the care alert" priority: CareAlertPriorityEnum! "When the care alert was last updated" updated_at: ISO8601DateTime! } "An edge in a connection." type CareAlertEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: CareAlert } "The connection type for CareAlert." type CareAlertPaginationConnection { "A list of edges." edges: [CareAlertEdge] "A list of nodes." nodes: [CareAlert] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A Care Plan" type CarePlan { "The name of a user group or a patient the care plan has been assigned to" assigned_to: String "Date of creation" created_at: String! "Provider who created care plan" creator: User "Pagination cursor" cursor: Cursor! "The care plan description" description: String "Associated documents" documents: [Document!]! "Feature Toggle of the care plan" feature_toggle: FeatureToggle "Associated goals" goals: [Goal!]! "Shows whether a group care plan(or a single one, if patient_id argument is not passed) is active for a given user. Make sure to pass patient_id argument if you need to check the status of a group care_plan for the given user" group_plan_is_active_for_given_user(patient_id: ID): Boolean "Shows whether the patient or at least one user from the related group has not skipped email. We don't want to call care_plan_mailer if all of related users have skipped_email == true" has_users_with_real_emails: Boolean "The unique identifier of the plan" id: ID! "Care plan is active for the associated patient" is_active: Boolean "Indicates whether a care plan is for a group" is_group: Boolean "Care plan status" is_hidden: Boolean! "Indicates if care plan can be used as a template and can be assigned on other users" is_template: Boolean! "The name of care plan" name: String "A user the care plan has been assigned to" patient: User "Ordered (Ascending) associated recommendations" recommendations: [Recommendation!]! "Date when record was last updated" updated_at: String! "A user group the care plan has been assigned to" user_group: UserGroup } "A connection between a care plan and a connectable item" type CarePlanConnection { "The ID of the connected care plan" care_plan_id: ID "The ID of the connected item" connectable_id: ID "The type of the connected item" connectable_type: String "The unique identifier of the connection" id: ID! } "A Care Plan Recommendation Category object" type CarePlanRecommendationCategory { created_at: ISO8601DateTime! id: ID! is_active: Boolean! is_editable: Boolean! name: String! organization: Organization! updated_at: ISO8601DateTime! } "Information on an event surrounding CDA activity" type CdaActivityEvent { "The activity that occured" activity_type: String "The type of CDA" cda_type: String "The time of the event" created_at: String "The ID of the document" document_id: String "Self descriptive" id: ID! "The outbound recipient" outbound_recipient: String "The user who opened the document" user: User "The email of the user who took the action." user_email: String } "Info on connection to Change Health" type ChangeClaimSubmitter { "The unique identifier of the connection" id: ID! "True if the Change connection is turned by user" is_enabled: Boolean } "Autogenerated return type of ChangeDevicesAvailability." type ChangeDevicesAvailabilityPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "A Chargeback object, contains info on the dispute reason, status, and evidence submitted" type ChargeBack { "The payment in Healthie that was disputed" billing_item: BillingItem "The date and time the chargeback was initiated" created_at: String! "The amount that was disputed" disputed_amount: String "Evidence to contest the chargeback" evidence: ChargeBackEvidence "Fields that should be submitted for this chargeback" evidence_fields_to_submit: [String] "The dispute fee charged by the payment processor" fee: String "A formatted version of the reason" formatted_reason: String "A formatted version of the status" formatted_status: String "The unique identifier of the chargeback" id: ID! "The reason for the chargeback. Matches Stripe's list of reasons at https://stripe.com/docs/api/disputes/object?lang=ruby" reason: String "The date and time that evidence needs to be submitted by" response_required_by: String "The status of the chargeback" status: String "The total cost of the chargeback. Includes both the disputed amount and the fee" total_amount: String "The date and time the chargeback was last updated" updated_at: String! } "A Chargeback Evidence object, contains info to contest the dispute" type ChargeBackEvidence { "The billing address provided by the customer." billing_address: String "ID of the uploaded cancellation_policy." cancellation_policy: String "An explanation of how and when the customer was shown your refund policy prior to purchase." cancellation_policy_disclosure: String "A justification for why the customer’s subscription was not canceled." cancellation_rebuttal: String "ID of the uploaded customer_communication." customer_communication: String "The email address of the customer." customer_email_address: String "The name of the customer." customer_name: String "A description of the product or services that were sold." product_description: String "ID of the uploaded refund_policy." refund_policy: String "Documentation demonstrating that the customer was shown your refund policy prior to purchase." refund_policy_disclosure: String "A justification for why the customer is not entitled to a refund." refund_refusal_explanation: String "ID of the uploaded uncategorized_file." uncategorized_file: String "Any additional evidence or statements." uncategorized_text: String } "An object containing information on a Stripe charge dispute" type ChargeDisputeType { "The amount that was disputed, in cents" amount: Int "The ID of the billing item being disputed" billing_item_id: ID! "The client associated with the billing item" client: User! "The ID for the charge dispute at Healthie" id: ID! "The ID of the invoice associated with this dispute" invoice_id: ID "The provider associated with the billing item" provider: User! "The reason for the charge dispute" reason: String "The ID of the requested payment associated with the billing item attached to this dispute" requested_payment_id: ID "The status of the charge dispute" status: ChargeDisputeStatus "The ID for the charge dispute object at Stripe" stripe_dispute_id: String! } "The connection type for ChargeDisputeType." type ChargeDisputeTypeConnection { "A list of edges." edges: [ChargeDisputeTypeEdge] "A list of nodes." nodes: [ChargeDisputeType] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type ChargeDisputeTypeEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: ChargeDisputeType } "Charting Item" type ChartingItemType { "The date of the item' creation" created_at: String! "The name of the custom module form" custom_module_form_name: String "The type of the document" document: Document "The ID of the filler" filler_id: ID "The type of the form answer group" form_answer_group: FormAnswerGroup "The ID of the form answer group" form_answer_group_id: ID "The type of the generated form answer group" generated_form_answer_group: GeneratedFormAnswerGroupType "The unique identifier of the item" id: ID! "Whether the item is a document" is_document: Boolean "Whether the item is generated" is_generated: Boolean "The name of the item" name: String "The name of the provider" provider_name: String "Whether the item is signed" signed: Boolean "Whether the item is used for a charting" use_for_charting: Boolean "Whether the item is used for a program" use_for_program: Boolean } "A charting note addendum" type ChartingNoteAddendumType { "The content of the addendum" content: String "The date the addendum was created" created_at: String! "The form answer group the addendum belongs to" form_answer_group: FormAnswerGroup "The unique identifier of the addendum" id: ID! "A provider who created the addendum" user: User } "Chat settings for a user" type ChatSetting { "The text of the auto welcome message" auto_welcome_text: String "The text of the setting" content: String "The end of scheduled autoreply period" end_date: String "Whether a user should be prompted to confirm closing a chat" hide_close_confirmation: Boolean "Whether a user should be prompted to confirm opening an org chat" hide_org_chat_confirmation: Boolean "The unique identifier of the chat setting" id: ID! "Whether the setting is active" is_active: Boolean "Whether the setting is within recurring messaging period" is_recurring_active: Boolean "Allow users to no add an end date" no_end_date: Boolean "Whether user should receive notifications from chat while is_active is true" receive_notifications: Boolean "Whether a user should receive notifications from chat while is_recurring_active is true" receive_notifications_recurring: Boolean "Whether or not the recurring messages should be all day or for a time range" recurring_all_day: Boolean "The content for recurring autoreplies" recurring_content: String "Front-end friendly version of recurring days" recurring_days_data: RecurringDaysData "The end of time range for recurring messages" recurring_end_time: String "Either nil, all_day, or a string representation of a time range" recurring_friday: String "Either nil, all_day, or a string representation of a time range" recurring_monday: String "Either nil, all_day, or a string representation of a time range" recurring_saturday: String "The start of time range for recurring messages" recurring_start_time: String "Either nil, all_day, or a string representation of a time range" recurring_sunday: String "Either nil, all_day, or a string representation of a time range" recurring_thursday: String "Either nil, all_day, or a string representation of a time range" recurring_tuesday: String "Indicates whether or not recurring messaging has been set up" recurring_turned_on: Boolean "Either nil, all_day, or a string representation of a time range" recurring_wednesday: String "Whether or not a schedule message is set up" scheduled_turned_on: Boolean "Whether to send an auto welcome message" send_auto_welcome: Boolean "The beginning of scheduled autoreply period" start_date: String "The ID of the setting owner" user_id: ID } "A claim (CMS1500) with snapshot data for submitted claims, live data for drafts, and correction tracking" type Claim { "Whether assignment is accepted" accept_assignment: Boolean "Additional claim info from Box 19" additional_claim_information: String "Amount paid by the patient" amount_paid: String "Billing provider / organization info" billing_provider: ClaimProvider "Condition codes from Box 10d" claim_codes: String "Most recent Claim MD rejection messages" claim_md_rejection_messages: [ClaimMdMessage!]! "Submission history for this claim" claim_submissions(after: String, before: String, first: Int, last: Int): ClaimSubmissionPaginationConnection! "Whether the client signature is on file" client_sig_on_file: Boolean "COB data derived from primary claim ERA and manual overrides" coordination_of_benefits: CoordinationOfBenefits "Child correction claims" correction_claims(after: String, before: String, first: Int, last: Int): ClaimPaginationConnection! "ICD-10 diagnoses" diagnoses: [ClaimDiagnosis!]! "Whether the claim has been submitted" has_been_submitted: Boolean! "Whether frozen claim submission data exists for this claim" has_claim_submission_claim_data: Boolean! id: ID! "Whether referrer information should be included" include_referrer_information: Boolean "Whether the insured signature is on file" insured_sig_on_file: Boolean "True if this claim is a correction of another claim" is_correction: Boolean! "Whether the claim is in a locked status" is_locked: Boolean! "The Organization Info in use on this claim" org_info: OrganizationInfo "The parent claim if this is a correction" original_claim: Claim "The ID of the original claim if this is a correction" original_claim_id: ID "Original reference number from Box 22" original_reference_number: String "Patient demographics" patient: ClaimPatient "Patient account number" patient_account_num: String "Whether this is a primary or secondary claim" payer_order: PayerOrder "Insurance policies on this claim" policies: [ClaimPolicy!]! "The primary claim if this is a secondary claim" primary_claim: Claim "The ID of the primary claim if this is a secondary claim" primary_claim_id: ID "Prior authorization number from Box 23" prior_authorization_number: String "Referral information" referral_info: ClaimReferralInfo "Referring provider" referring_provider: ClaimProvider "Rendering provider" rendering_provider: ClaimProvider "Frequency/resubmission code from Box 22" resubmission_code: String "CPT service lines" service_lines: [ClaimServiceLine!]! "Service location" service_location: ClaimLocation "Current claim status (live, not from snapshot)" status: String "Submission method (e.g. office_ally, change_health, manual)" submission_method: String "Timestamp when the claim was last submitted" submitted_at: ISO8601DateTime "Whether the claim uses the individual NPI" use_indiv_npi: Boolean } "Frozen CPT code data from a submitted claim snapshot" type ClaimCptCode { "CPT code" code: String "CPT code description" description: String "CPT display name" display_name: String "CPT code ID" id: ID } "Claim details and associated ERAs" type ClaimDetailsEra { "The ERAs associated with the claim" eras(after: String, before: String, first: Int, last: Int): EraConnection! } "Frozen diagnosis data from a submitted claim snapshot" type ClaimDiagnosis { "Whether the diagnosis is active" active: Boolean "Diagnosis end date" end_date: String "First symptom date" first_symptom_date: String "ICD code data" icd_code: ClaimIcdCode "Diagnosis join record ID" id: ID } "An edge in a connection." type ClaimEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: Claim } "Deprecated (use EligiblityCheck instead). A ChangeHealth eligibility check" type ClaimEligibilityCheck { "A string used to identify the eligibility check in the Change system." control_number: String! "The time the eligibility check was run" created_at: String! "The unique identifier of the check" id: ID! "The retrieved plan status" plan_status: String "The policy associated with this check" policy: Policy "The ID of the associated policy" policy_id: ID! "A JSON object containing the eligibility details" response: String } "Claim Eligibility Check Errors" type ClaimEligibilityCheckErrors { "The error code" code: String "The description of the error" description: String } "Frozen ICD code data from a submitted claim snapshot" type ClaimIcdCode { "ICD code" code: String "ICD code description" description: String "ICD display name" display_name: String "ICD code ID" id: ID } "Frozen insurance plan data from a submitted claim snapshot" type ClaimInsurancePlan { "Insurance plan ID" id: ID "Combined payer name and payer ID" name_and_id: String "Insurance payer ID" payer_id: String "Insurance payer name" payer_name: String } "Frozen location data from a submitted claim snapshot" type ClaimLocation { "City" city: String "Country" country: String "Location ID" id: ID "Street address line 1" line1: String "Street address line 2" line2: String "Location name" name: String "Location NPI" npi: String "Other ID of the location" other_id: String "Other ID qualifier of the location" other_id_qualifier: String "Place of service" place_of_service: ClaimPlaceOfService "Place of service code" place_of_service_code: String "State" state: String "ZIP code" zip: String } "A message from ClaimMD" type ClaimMdMessage { "The fields involved in the message" fields: [String!]! "The message content" message: String! "The status of the message" status: String! } "Frozen other ID number data from a submitted claim snapshot" type ClaimOtherIdNumber { "Other ID number ID" id: ID "Display label for the other ID" label: String "Other ID" other_id: String "Other ID qualifier" other_id_qualifier: String } "The connection type for Claim." type ClaimPaginationConnection { "A list of edges." edges: [ClaimEdge] "A list of nodes." nodes: [Claim] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "Frozen patient data from a submitted claim snapshot" type ClaimPatient { "Date of birth" dob: String "First name" first_name: String "Full name" full_name: String "Patient ID" id: ID "Last name" last_name: String "Patient address at time of submission" location: ClaimLocation "Biological sex (CMS-1500 Box 3)" sex: String } "Frozen place of service data from a submitted claim snapshot" type ClaimPlaceOfService { "Place of service code" code: String "Place of service ID" id: ID "Place of service name" name: String } "Frozen policy data from a submitted claim snapshot" type ClaimPolicy { "Group number" group_number: String "Insurance subscriber (policyholder)" holder: ClaimPolicyHolder "Policy ID" id: ID "Insurance plan at time of submission" insurance_plan: ClaimInsurancePlan "Member ID" member_id: String "Policy name" name: String "Insurance company address at time of submission" payer_location: ClaimLocation "Insurance company phone number" policy_phone_number: String "Policy priority" priority_type: ClaimPolicyPriority "Policy type (e.g. Commercial, Medicare)" type_string: String } "Insurance subscriber (policyholder) data from a submitted claim snapshot" type ClaimPolicyHolder { "Date of birth" date_of_birth: String "First name" first_name: String "Gender" gender: String "Last name" last_name: String "Address at time of submission" location: ClaimLocation "Middle initial" middle_initial: String "Phone number" phone: String "Relationship to patient" relationship: HolderRelationship } "Frozen provider data from a submitted claim snapshot" type ClaimProvider { "First name" first_name: String "Full legal name" full_legal_name: String "Provider ID" id: ID "Last name" last_name: String "Address at time of submission" location: ClaimLocation "Provider or organization name" name: String "National Provider Identifier" npi: String "Organization name" organization_name: String "Other ID" other_id: String "Other ID qualifier" other_id_qualifier: String "Phone number" phone_number: String "Primary contact name" primary: String "Provider qualifications" qualifications: String "Claim-specific other ID number" rendering_provider_other_id_number: ClaimOtherIdNumber "Tax ID" tax_id: String "Taxonomy code" taxonomy_code: String } "Frozen referral info data from a submitted claim snapshot" type ClaimReferralInfo { "Case date" case_date: String "Case qualifier" case_qualifier: String "Condition related to values" condition_related_to: [String!] "Hospitalization end date" hospitalization_end: String "Hospitalization start date" hospitalization_start: String "Referral info ID" id: ID "Other associated date" other_associated_date: String "Other associated date qualifier" other_associated_qualifier: String "Prior authorization number" prior_auth_number: String "Referring physician" referring_physician: ClaimReferringPhysician "Referring provider first name" referring_provider_first_name: String "Referring provider last name" referring_provider_last_name: String "Referring provider middle name" referring_provider_middle_name: String "Referring provider NPI" referring_provider_npi: String "Referring provider other ID" referring_provider_other_id: String "Referring provider other ID qualifier" referring_provider_other_id_qualifier: String "Referring provider qualifier" referring_provider_qualifier: String "Unable to work end date" unable_to_work_end: String "Unable to work start date" unable_to_work_start: String } "Frozen referring physician data from a submitted claim snapshot" type ClaimReferringPhysician { "Whether the physician accepts insurance" accepts_insurance: Boolean "Business name" business_name: String "Email" email: String "Fax number" fax_number: String "First name" first_name: String "Full name" full_name: String "Referring physician ID" id: ID "Last name" last_name: String "Location at time of submission" location: ClaimLocation "Notes" notes: String "National Provider Identifier" npi: String "Other ID" other_id: String "Other ID qualifier" other_id_qualifier: String "Phone number" phone_number: String "Speciality" speciality: String "Website" website: String } "Frozen service line data from a submitted claim snapshot" type ClaimServiceLine { "CPT procedure code" cpt_code: ClaimCptCode "EPSDT indicator" epsdt: String "Family planning indicator" family_planning_service: Boolean "Fee amount" fee: String "Service line ID" id: ID "Modifier 1" mod1: String "Modifier 2" mod2: String "Modifier 3" mod3: String "Modifier 4" mod4: String "Diagnosis pointers (0-indexed)" pointers: [Int!] "Service date" service_date: String "Service end date" service_end_date: String "Number of units" units: Int } "A claim submission event (to a clearinghouse or RCM system)" type ClaimSubmission { "a Healthie-formatted JSON representation of the CMS1500 claim at the time it was submitted" claim_data: JSON "The ID of the CMS1500 that was submitted" cms1500_id: ID "The time of the claim submission" created_at: ISO8601DateTime "The unique identifier of the Claim Submission" id: ID! "The integration that the claim was submitted to" integration: ClaimDestinationIntegration "An JSON representation of the CMS1500 claim, formatted for the specific integration" integration_formatted_claim_data: JSON "The PCN (Patient Control Number) returned by the clearinghouse" pcn: String } "An edge in a connection." type ClaimSubmissionEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: ClaimSubmission } "The connection type for ClaimSubmission." type ClaimSubmissionPaginationConnection { "A list of edges." edges: [ClaimSubmissionEdge] "A list of nodes." nodes: [ClaimSubmission] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A client portal setting" type ClientPortalSetting { "Whether the client can chat with the provider" chat_with_provider: Boolean! "The unique identifier of the setting" id: ID! "Whether the client can schedule appointments" schedule_appointments: Boolean! "Whether the client can view and complete forms" view_and_complete_forms: Boolean! "Whether the client can view and create goals" view_and_create_goals: Boolean! "Whether the client can view and create journal entries" view_and_create_journal_entries: Boolean! "Whether the client can view and pay bills" view_and_pay_bills: Boolean! "Whether the client can view and purchase packages" view_and_purchase_packages: Boolean! "Whether the client can view and upload documents" view_and_upload_documents: Boolean! } "A client restriction authorization must be created for users to access restricted patients" type ClientRestrictionAuthorization { "The client to whom the restriction authorization applies" client: User! created_at: ISO8601DateTime "The unique identifier of the authorization" id: ID! "The user who was granted access" provider: User! "Optional reason for this authorization" reason: String! } "Info about how a client was acquire" type ClientSource { "The unique identifier of the source" id: String! "Get readable source based on ref_type" readable_source: String "The source of how a client was acquire: contain ID or a Other string" ref_source: String "If ref_source eq 'Other', than it may contain custom string or NULL" ref_source_other: String "The type of the source of how a client was acquire" ref_type: String "related insurance" related_insurance: InsurancePlan "related object" related_object: RelatedObject "related object" related_object_name: String } "A CMS1500 claim" type Cms1500 { "The provider agrees to accept assignment" accept_assignment: Boolean "Notes" additional_text: String "The insurance discount" adjustment: String "The amount that the client paid towards the claim" amount_paid: String "The amount that the insurance company reimbursed" amount_reimbursed: String "The billing provider for the CMS1500" billing_provider: Organization "The ID of the Billing Provider" billing_provider_id: String "Check numbers associated with a reimbursement from the claim. Imported via ERA" check_numbers: [String] "Most recent Claim MD rejection messages for this CMS1500" claim_md_rejection_messages: [ClaimMdMessage!]! "Info explaining why claim_md_rejection_messages field is empty" claim_md_rejection_messages_info: ClaimMdRejectionMessagesInfo "(Must be admin to view) A record of submission of events for this claim to different clearinghouse/RCM integrations." claim_submissions: [ClaimSubmission!] "Amount the client owes" client_responsibility: String "True if the provider chose to remove client responsibility" client_responsibility_removed: Boolean "True if the client's signature is on file" client_sig_on_file: Boolean "Cms1500 policies in use for this claim" cms1500_policies(only_with_assigned_policies: Boolean = false): [Cms1500Policy!] "The client's copay for the claim" copay: String "The amount of copay still owed" copay_still_owed: String "The comma separated list of cpt codes names" cpt_code_names: String "CPT codes in use for this claim" cpt_codes_cms1500s: [CptCodesCms1500!] "The creation date of the claim" created_at: String! "Pagination cursor" cursor: Cursor! "The claim's date of service" date_of_service: String "The ID of the rendering provider" dietitian_id: String eras(after: String, before: String, first: Int, last: Int): EraConnection! "Estimated fee for the specific cpt code based on previous use" estimated_cpt_fees_for_user: [CptCodesCms1500!] @deprecated(reason: "Use CptCodesCms1500.last_fee_amount") "Chart Note ID, if CMS1500 was exported from a Chart Note" form_answer_group_id: ID "Are there any submissions for this claim" has_been_submitted: Boolean "ICD codes in use for this claim" icd_codes_cms1500s: [IcdCodesCms1500!] "The unique identifier of the CMS1500" id: ID "When true, includes referrer information on the claim" include_referrer_information: Boolean "True if the insured's signature is on file" insured_sig_on_file: Boolean "The value of the nineteen field" nineteen_reserved: String "The specific Organization Info in use on this claim" org_info: OrganizationInfo "The ID of the Organization Info" organization_info_id: String "The original reference number of the claim" orig_ref_number: String "The date that the claim was paid out to employees/contractors" paid_out_at: String "The patient for the CMS1500" patient: User "The patient's account number" patient_account_num: String "The ID of the patient" patient_id: String "The primary insurance plan name for the CMS1500" primary_plan_name: String "Rejected/Denied status reason" reasons: ID "The referral info for the CMS1500" referral_info: ReferralInfo "The date that the claim was reimbursed" reimbursed_at: String "How reimbursement is tracked for this claim" reimbursement_tracking: ReimbursementTracking "The provider for the CMS1500" rendering_provider: User "The Rendering Provider's other id number" rendering_provider_other_id: String "Other ID info in use for this render provider" rendering_provider_other_id_object: OtherIdNumber "The resubmission code of the claim" resubmission_code: String "The service location for the CMS1500" service_location: Location "The ID of the service location" service_location_id: String "The status of the claim" status: String "The value of the ten d field" tend_reserved: String "Total amount the claim was billed for" total_charge: String "The last date and time that the CMS1500 was updated" updated_at: ISO8601DateTime "True if the claim reimbursement info was updated via SFTP" updated_by_sftp: Boolean "When true, uses the individual npi in all npi fields" use_indiv_npi: Boolean } "A CMS1500 policy" type Cms1500Policy { "The cms1500 for the cms1500 policy" cms1500: Cms1500 "The id of the cms1500 for the cms1500 policy" cms1500_id: String "The unique identifier of the policy" id: ID "The policy for the cms1500 policy" policy: Policy "The policy id of the cms1500 for the cms1500 policy" policy_id: String } "A single COB adjustment (group, reason code, amount)" type CobAdjustment { "Adjustment group code (CO, OA, PR, PI)" adjustment_group: AdjustmentGroup "Adjustment amount" amount: Float "Adjustment reason code" reason_code: String } "COB data for a single service line on a secondary claim" type CobServiceLineAdjustment { "Adjustments applied to this service line" adjustments: [CobAdjustment!]! "CPT procedure code" cpt_code: String "Whether this line has a manual COB override" has_manual_override: Boolean! "Date the primary payer adjudicated this line" line_adjudication_date: ISO8601Date "Amount paid by the primary payer for this line" line_paid_amount: Float "Service date for this line" service_date: ISO8601Date } "CognitiveStatus object" type CognitiveStatus { "Cognitive status" cognitive_status: String "The unique identifier of the status" id: ID! "Start date" start_date: String "User id" user_id: ID! } "A Calendar Color Scheme" type ColorCode { "The ID of the calendar color scheme" calendar_color_scheme_id: String "The item to code by" code_by_item: String "The item name to code by" code_by_item_name: String "The color" color: String "The unique identifier of the color code" id: ID! } "A color code option" type ColorCodeOption { "The label of the color code option" label: String "The value of the color code option" value: String } "A set of two potential appointment slots" type CombinedPotentialAppointmentSlots { "The first potential appointment slot" potential_appointment_1_slot: PotentialAppointmentSlot "The second potential appointment slot" potential_appointment_2_slot: PotentialAppointmentSlot } "A comment of an entry" type Comment { "User who created comment" author: User "The content of this comment" content: String "The date on which the comment was posted" created_at: String! "User who created comment" creator: User "Pagination cursor" cursor: Cursor! "The id of the entry associated with the comment" entry_id: String "The unique identifier of the comment" id: ID! "Indicates when posting an emoji reaction" is_reaction: Boolean! "User who created comment" poster: User "the owner of the comment" user_id: ID! } "Autogenerated return type of CompleteCcdaReconciliation." type CompleteCcdaReconciliationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "a completed course item" type CompletedCourseItem { "The ID of the completed item" completed_item_id: ID "The type of the completed item" completed_item_type: String "The ID of course related to the completed item" course_item_id: ID "The date when the completed item was created" created_at: String! "The unique identifier of the item" id: ID! "The next item after the current item" next_item: CourseItem "The date when the completed item was updated" updated_at: String! "The ID of the user related to the completed item" user_id: ID } "An object with information about how an onboarding item was completed" type CompletedOnboardingItem { "The URL to go to to edit the attached object" attached_object_edit_url: String "The most relevant date to display" date_to_show: String "The unique identifier of the item" id: ID! "The id of the object that completed the onboarding item" item_id: String "The type of item that was completed" item_type: String "The onboarding item that was completed" onboarding_item: OnboardingItem "The ID of the onboarding item" onboarding_item_id: String "Set to true if the user skipped this" skipped: Boolean! "The completed (client)" user: User "The ID of the completer (client)" user_id: String "The URL to view" view_url: String } "A object containing information about whether a specific contact type can be booked" type ContactType { "ID of the connected appointment setting" appointment_setting_id: String "ID of the connected appointment type" appointment_type_id: String "An Alias of ID that makes creating the form easier" form_id: String "The unique identifier of the contact type" id: ID "The graphql_name of the contact type" name: String "Whether this contact type can be used" show: Boolean! "The ID of the connected user" user_id: String } "An association between conversation holders" type Conversation { "The user who closed the conversation" closed_by: User "The date the conversation was closed" closed_date: String "Indicates whether the conversation is a community chat." community_chat: Boolean "Display default name for community chat" community_chat_prefix: String "All ConversationMemberships associated with this conversation." conversation_memberships: [ConversationMembership!]! "The number of users in the conversation" conversation_memberships_count: Int "The time the Conversation was created" created_at: String! "The conversation membership for the current user" current_user_conversation_membership: ConversationMembership "ID of dietitian" dietitian_id: ID "first four invitees to the conversation" first_four_invitees: [User!] "The unique identifier of the conversation" id: ID! "Whether the conversation includes multiple clients" includes_multiple_clients: Boolean "The invitees to the conversation" invitees: [User!] "Whether the conversation is hidden for the client" is_hidden_for_client: Boolean "The content of the last note, with HTML stripped" last_message_content: String "ID of the most recent note authored by the current viewer that has been read by the patient. Returns null when no message of the viewer's has been read yet, or when the concept doesn't apply (no current user, or the conversation has 0 or more than 1 patient)." last_note_viewed_id: String "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The subject of conversation" name: String "All notes associated with this conversation." notes: [Note!]! "owner of conversation" owner: User "ID of patient (only set when conversation was automatically created due to provider assignment; Please use invitees instead to access patient(s) in a conversation)" patient_id: ID "The last time the conversation was updated" updated_at: String! "invitees to the conversation" user_groups: [UserGroup!] } "ConversationMembership entry, returns basic info related to conversation participant" type ConversationMembership { "Toggle for archive status" archived: Boolean! "Conversation id of conversation membership" conversation_id: ID "Role in conversation" conversation_role: String "Conversation linked to this membership" convo: Conversation "The time the conversation of the" convo_updated_at: User "The date the Conversation Membership was created" created_at: String! "The creator of this ConversationMembership" creator: User "Pagination cursor" cursor: Cursor! "URL to the avatar to display" display_avatar: String "Either the name of the owner or conversation subject?" display_name: String "The first name and last name initial of the owner" display_name_and_initial: String "Display the other user first name for non group convos" display_other_user_first_name: String "Display title or other user name for non group convos" display_other_user_name: String "The unique identifier of the membership" id: ID! "Get last conversation task" last_task(notes_type: String = "inbox"): Task "Datetime membership was updated" updated_at: String! "The creator of membership" user_id: ID "The list of users in conversation (to use in place of display name" user_list_as_display_name: String "Whether the conversation has been viewed" viewed: Boolean! } "Counts for all conversation membership tabs (active, scheduled, archived, closed)" type ConversationMembershipsAllCounts { "Count of active (non-archived, non-closed) conversation memberships" active_count: Int! "Count of archived conversation memberships" archived_count: Int! "Count of closed conversation memberships" closed_count: Int! "Count of scheduled conversation memberships" scheduled_count: Int! } "Coordination of Benefits data for a secondary claim, derived from primary claim ERA and manual overrides" type CoordinationOfBenefits { "Whether any claim-level or line-level manual overrides exist" has_manual_overrides: Boolean! "Primary subscriber date of birth" other_ins_dob: ISO8601Date "Primary subscriber first name" other_ins_first_name: String "Primary insurance group number" other_ins_group_num: String "Primary subscriber last name" other_ins_last_name: String "Primary subscriber member ID" other_ins_member_id: String "Patient relationship to primary subscriber" other_ins_relationship: String "Payer ID of the primary insurance" other_payer_id: String "Name of the primary insurance payer" other_payer_name: String "Date the primary payer adjudicated the claim" primary_adjudication_date: ISO8601Date "Total amount paid by the primary payer" primary_paid_amount: Float "Per-service-line COB data" service_line_adjustments: [CobServiceLineAdjustment!]! } "A Course" type Course { "Whether the course is active" active: Boolean! "Course clients" clients(course_status: String): [CourseMembership!] "Course group memberships for the course" clients_groups(course_status: String): [CourseGroup!] "The number of completed memberships in the course" completed_course_memberships_count: Int "The benefits of a course" course_benefits: [CourseBenefit!]! "Course group memberships for the course" course_groups: [CourseGroup!] "The items of a course" course_items(include_emails: Boolean = true): [CourseItem!]! "Course memberships for the course" course_memberships: [CourseMembership!] "The number of members in the course" course_memberships_count: String "type of the course" course_type: String! "date course was created" created_at: String! "Pagination cursor" cursor: Cursor! "date course was deleted" deleted_at: String "Description of course" description: String "end date of the course based on included items" end_date: String "HTML-formatted benefits of the course" formatted_benefits: String "The unique identifier of the course" id: ID! "The number of in progress memberships in the course" in_progress_course_memberships_count: Int "late enrollment for fixed type courses" late_enroll: Boolean "Name of course" name: String "The number of not started memberships in the course" not_started_course_memberships_count: Int "Offerings contains current course" offerings: [Offering!] "url for course image" preview_image_url: String "url for course video" preview_video_content: String "start date for fixed type course" start_date: String "Ungrouped Course memberships for the course" ungrouped_course_memberships: [CourseMembership!] "date course was updated" updated_at: String "Use category toggle" use_category: Boolean @deprecated(reason: "This field is no longer used") "Use video label toggle" use_video_label: Boolean "The user groups who have access to this course" user_groups: [UserGroup!]! "User id of course" user_id: ID "The users who have access to this course" users: [User!]! "The progress of users who completed the course item" users_course_items_progress: String "The users course progress" users_progress: String } "A Course Benefit" type CourseBenefit { "Benefit of a course" benefit: String "Course ID of benefit" course_id: ID "The unique identifier of the benefit" id: ID! } "Completion info for group participants enrolled to the course" type CourseCompletionInfoGroupsType { "Count of users in the group which completed the course" completed: Int "Group name" label: String "Count of users in the group" total: Int "Group participant ids" user_ids: [String!] "Group ID" value: String } "Completion info for individual participants enrolled to the course" type CourseCompletionInfoIndividualsType { "User full_name" label: String "User ID" value: String } "Information based on course groups & individuals completion status" type CourseCompletionInfoType { "Complete info for the course user_groups" groups: [CourseCompletionInfoGroupsType!] "Complete info for the course individual users" individuals: [CourseCompletionInfoIndividualsType!] } "Relationship between a user group and a course" type CourseGroup { "the course associated with this membership" course: Course "The unique identifier of the group" id: ID! "Whether the course group is currently paused" is_paused: Boolean! "When the group was paused; nil if not paused" paused_at: ISO8601DateTime "start of course" start_at: String "When true, new group members start the course at the current time, overriding start_at" start_on_group_assignment: Boolean! "the user group associated with this membership" user_group: UserGroup } "A Course Item" type CourseItem { "whether the attached object is a video form" attached_object_is_video: Boolean "Shows if the current course item is blocked by an incomplete previous required item" blocked_by_prev_item(course_membership_id: ID): Boolean "category of item" category: String @deprecated(reason: "This field is no longer used") "Check if course item was completed by a client" completed_by_client(client_id: ID): Boolean "The completed course item" completed_course_item(course_membership_id: ID): CompletedCourseItem "The number of members who completed the item" completed_memberships_count: Int "Determines whether or not completion of the course item is necessary to access the next" completion_required_for_next_module: Boolean! "The associated course" course: Course "id of course associated with item" course_id: ID "name of course that item belongs to" course_name: String "when item was created" created_at: String! "type of custom module of a course item (if app)" custom_module_type: String "Shows if the current course item is blocked due to course membership date restriction" date_restricted(course_membership_id: ID): Boolean "description of item" description: String "The path to edit the item" edit_url: String "This is the first required module that is incomplete, and will block items in higher positions" first_incomplete_required_module: CourseItem "Course item has matrix field" has_matrix_field: Boolean "The unique identifier of the item" id: ID! "The ID of an incomplete form associated with the item" incomplete_course_item_id(course_membership_id: ID): ID "id of item" item_id: ID "type of course item" item_type: String "name of item" name: String "The next item in the course" next_item: CourseItem "Check if course item is available to a client" not_available_for_client(client_id: ID): Boolean "Check if course item is available to any client" not_available_to_any_clients: Boolean "The position of the course item type when shown in a list of other modules on the same day" position: Int "The previous item in the course" prev_item: CourseItem "The number of days after a client's course start date when this item becomes available" scheduled_release: String "when item was updated" updated_at: String! "id of user associated with item" user_id: ID "The path to view the item" view_url: String } "Relationship between a user and a course" type CourseMembership { "the course associated with this membership" course: Course "id of course related to this membership" course_id: ID "status of related course completion" course_status: String! "date membership was created" created_at: String! "Pagination cursor" cursor: Cursor! "The unique identifier of the membership" id: ID! "Whether the membership is currently paused" is_paused: Boolean! "The next incomplete item" next_incomplete_item: CourseItem "The incomplete item after the next incomplete item" next_next_incomplete_item: CourseItem "Timestamp the membership was paused; null when not paused" paused_at: ISO8601DateTime "start of course" start_at: String "Cumulative paused duration in seconds across all pause/resume cycles" total_paused_duration: Int! "date membership was updated" updated_at: String! "the user associated with this membership" user: User "id of user related to this membership" user_id: ID } "The CPT code" type CptCode { "The CPT code category" category: String @deprecated(reason: "Always returns nil") "The CPT code" code: String "The date when the CPT code was created" created_at: String! "Pagination cursor" cursor: Cursor! "The description of the CPT code" description: String "The name of the CPT code for use in labels" display_name: String "The price per unit from the organization's service catalog" fee_per_unit: Float "The unique identifier of the CPT code" id: ID! "Whether a CPT code marked as favorite" is_favorite(known_value: Boolean): Boolean "The last fee applied to this CPT code by a provider" last_fee: Float "The date when the CPT code was updated" updated_at: String! } "cpt codes cms 1500s join table" type CptCodesCms1500 { "cms 1500 id" cms1500_id: ID "The CPT code itself" cpt_code: CptCode "icd code id" cpt_code_id: ID @deprecated(reason: "Use cpt_code instead") "date created" created_at: String "The Early and Periodic Screening, Diagnostic and Treatment" epsdt: String "Self descriptive" family_planning_service: Boolean "fee" fee: String "The unique identifier of the cms 1500" id: ID "Line-level insurance payments for this service line" line_payments(include_voided: Boolean = false): [LinePayment!]! "Payer-balance write-offs for this service line" line_write_offs(include_voided: Boolean = false): [LineWriteOff!]! "First Modification" mod1: String "Second Modification" mod2: String "Third Modification" mod3: String "Fourth Modification" mod4: String "Diagnostic pointers. These are used to connect Diagnosis(ICD) with appropriate Billing Item(CPT) in CMS1500 form" pointers: [String] "service date" service_date: String "The end date of service (if the line item covers a date range). Can be nil if service was delivered on one day" service_end_date: String "Total billed amount for this line item (fee × units)" total_line_item_fee: String "units" units: String "date updated" updated_at: String } "cpt codes policies join table" type CptCodesPolicy { "cpt code" code: String "id of instance of joins between cpt_code and policy" cpt_code_id: ID "date created" created_at: String! "cpt code description" description: String "The unique identifier of the join between cpt_code and policy." id: ID! "policy id" policy_id: ID "date updated" updated_at: String! } "cpt codes super bills join table" type CptCodesSuperBill { "billing item id" billing_item_id: ID "cpt code" cpt_code: CptCode "cpt code id" cpt_code_id: ID "date created" created_at: String! "fee" fee: String "The unique identifier of the join" id: ID! "First Modification" mod1: String "Second Modification" mod2: String "Third Modification" mod3: String "Fourth Modification" mod4: String "Pointers" pointers: [String!] "service date" service_date: String "super bill id" super_bill_id: ID "units" units: String "date updated" updated_at: String! } "Autogenerated return type of CreateAlertTemplate." type CreateAlertTemplatePayload { "The created alert template" alert_template: AlertTemplate "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateAutomation." type CreateAutomationPayload { "The created automation" automation: Automation "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateAvailabilityWithAppointmentTypes." type CreateAvailabilityWithAppointmentTypesPayload { "The created one-time or recurring availability and the appointment types it covers." availability: Availability "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateCareAlert." type CreateCareAlertPayload { "The created care alert" care_alert: CareAlert "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateChangeHealthPatient." type CreateChangeHealthPatientPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of CreateClientViaForm." type CreateClientViaFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateCustomModuleFileAttachment." type CreateCustomModuleFileAttachmentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The file attachment record" file_attachment: FileAttachment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateCustomModuleFileAttachmentUploadUrl." type CreateCustomModuleFileAttachmentUploadUrlPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "Headers to include in the upload request." headers: [HttpHeader!] "The list of errors occurred during the mutation" messages: [FieldError] "The ID of the upload. This is needed after the upload is complete, when creating the custom module file attachment." upload_id: ID "The direct upload URL" upload_url: String } "Autogenerated return type of CreateDocumentDraft." type CreateDocumentDraftPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") document_draft: DocumentDraft "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateEncounterSummary." type CreateEncounterSummaryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "Whether generation was enqueued; false when the encounter has no locked Scribe note or is not eligible" enqueued: Boolean! "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateGeneratedSummary." type CreateGeneratedSummaryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The persisted encounter summary" generated_summary: GeneratedSummary "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateInternalComment." type CreateInternalCommentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") internal_comment: InternalComment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateLinePayment." type CreateLinePaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The newly-created line payment" line_payment: LinePayment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateLineWriteOff." type CreateLineWriteOffPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The newly-created write-off" line_write_off: LineWriteOff "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of CreateSecondaryClaim." type CreateSecondaryClaimPayload { "The created secondary claim" claim: Claim "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "A custom email" type CustomEmail { "created at" created_at: String! "Pagination cursor" cursor: Cursor! "type of email" email_type: String "email greeting" greeting: String "The unique identifier of the email" id: ID! "message body" message_body: String "subject of email" name: String "reactivation_wait_days" reactivation_wait_days: String "Appointment Type, Program or Package object" related_object: CustomEmailRelatedObject "subject of email" subject: String "updated at" updated_at: String! "user id of provider" user_id: ID } "A custom metric for a user" type CustomMetric { "The associated autoscored custom module form" custom_module_form: CustomModuleForm "The ID of the autoscored custom module form" custom_module_form_id: ID "feature toggle id this custom metric belongs to" feature_toggle_id: Int "The high end of the normal range" high_warning_threshold: Int "The unique identifier of the metric" id: ID! "The low end of the normal range" low_warning_threshold: Int "The name of the custom metric" name: String "if yes, should show based on if there is custom metric override" should_show: Boolean "if yes, should show the client based on if there is a custom metric override" should_show_client: Boolean "if yes, show the custom metric" show: Boolean! "if yes, show the custom metric to client" show_client: Boolean! "if yes, track the custom metric" track: Boolean! "user id this custom metric belongs to" user_id: Int } "A custom metric for a user" type CustomMetricOverride { "custom metric" custom_metric: CustomMetric "id of the custom metric" custom_metric_id: ID "feature toggle id this custom metric belongs to" feature_toggle_id: Int "id form helper. Equivalent to the `id` field" form_id: String "The unique identifier of the override. Returns 0 for objects that exist only in memory and have not yet been saved to preserve non-nullability" id: ID! "The name of the custom metric" name: String "if yes, show the custom metric" show: Boolean! "if yes, show the custom metric to the client" show_client: Boolean! "if yes, track the custom metric" track: Boolean "user id this custom metric belongs to" user_id: Int } "A question in a template" type CustomModule { "True if there are conditionally displayed custom modules which rely on state of this module" controls_conditional_modules: Boolean "The name of the form this custom module has been originally copied from" copied_from_form_name: String "The conditional logic for showing/hiding the custom module" custom_module_condition: CustomModuleConditionType "The template that this question is a part of" custom_module_form: CustomModuleForm "The ID of the template the question is a part of" custom_module_form_id: String "The ID of the form section this custom module belongs to. Used for autoscoring" custom_module_form_section_id: ID "When true, this field is stripped from the AI Scribe LLM payload and its original value is preserved after the Scribe response" exclude_from_scribe: Boolean! "Custom column used by API users. Used to relate our form objects with objects in third-party systems" external_id: String "Custom column used by API users. Used to relate our form objects with objects in third-party systems" external_id_type: String """ The image attachment for this custom module. Only returns a value when mod_type is "image" and an image has been attached. """ file_attachment: FileAttachment "The name to use in the HIPAA form" hipaa_name: String "The unique identifier of the module" id: ID! "Whether this module is a custom module" is_custom: Boolean! "The label of the question" label: String "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String "The type of question" mod_type: String "The default options for this question" options: String "The options, broken up into an array" options_array: [String] "IDs of of other modules to include in the autoscore calculation" other_module_ids_to_autoscore_on: [ID] "ID of the parent custom module" parent_custom_module_id: String "The position of the question (the lower the earlier the question is shown)" position: Float "Eventually will replace position, currently unused. The position of the question (the lower the earlier the question is shown)" position_integer: Int "Whether this question is required to be completed before the form it's in can be saved" required: Boolean "The sublabel (description) of the question" sublabel: String } "Condition under which to show a custom module" type CustomModuleConditionType { "The ID of the custom module whose value determines whether to show or hide the custom module" conditional_custom_module_id: ID "The ID of the custom module that will be shown or hidden" custom_module_id: ID "The type of filter" filter_type: String "The unique identifier of the condition" id: ID! "The value to check the filter against" value_to_filter: String } "An edge in a connection." type CustomModuleEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: CustomModule } "A template for a form, that can then be filled out" type CustomModuleForm { "The date on which the template was created" created_at: String! "Pagination cursor" cursor: Cursor! "Form-level general instructions passed to AI Scribe alongside the form title (tone, style, structure preferences). Available for charting forms only. Backed by AiScribeFormInstruction so the form schema stays Scribe-agnostic." customInstructions: String "The questions in the template" custom_modules: [CustomModule!]! "The date on which the template was deleted" deleted_at: ISO8601DateTime "Custom column used by API users. Used to relate our form objects with objects in third-party systems" external_id: String "Custom column used by API users. Used to relate our form objects with objects in third-party systems" external_id_type: String "All filled out forms for this template" form_answer_groups: [FormAnswerGroup!]! "The form has matrix field" has_matrix_field: Boolean "When true, the form has modules that the user has to fill out" has_non_readonly_modules: Boolean "The unique identifier of the module form" id: ID! "Whether this form is linked to an appointment type as an AI Scribe autocomplete form" is_scribe_form: Boolean! "Whether the form contains only one custom_module with mod_type 'video' and was created as part of a program" is_video: Boolean "User who last updated this form" last_updated_by_user: User "A serialized JSON string of metadata. Maximum character limit of 10,000." metadata: String "The given name of the template" name: String "Whether subsequent times filling out the template, will start with the template prefilled with the previous answers" prefill: Boolean "The date on which the template was updated" updated_at: String! "Whether or not this form was uploaded by Healthie team member" uploaded_by_healthie_team: Boolean! "Whether the template can be used to chart with" use_for_charting: Boolean! "Whether the template was made for a program" use_for_program: Boolean! "The owner of the template" user: User } "The connection type for CustomModule." type CustomModulePaginationConnection { "A list of edges." edges: [CustomModuleEdge] "A list of nodes." nodes: [CustomModule] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A custom sidebar override" type CustomSidebarOverride { """ Extra iframe permissions to append to the allow attribute (e.g. "loopback-network") """ additional_allow: String "If true, the current user ID will be appended to the URL" append_current_user_id: Boolean "The icon of the image that will be display on the sidebar" icon: String "The unique identifier of the override" id: ID! "The label of the sidebar item that will be shown or hidden" label: String "If true, the sidebar item will be open in an iframe within the Healthie UI" open_in_iframe: Boolean "If true, the sidebar item will be displayed" show: Boolean "The link to the custom icon that will be displayed on the sidebar" svg_url: String "Where the link will open if clicked" target: String "If set, this tab uses JWT-based third-party app auth for the linked ThirdPartyApp" third_party_app_id: ID "The link that the sidebar item will direct to" url: String } "Each day range is a time range and the days of the week that are in that time range" type DayRangeType { "The days of the week that are in this time range" days: [String] "The time range that is in this time range" time_range: String } "Autogenerated return type of DeleteAlertTemplate." type DeleteAlertTemplatePayload { "The deleted alert template" alert_template: AlertTemplate "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of DeleteAutomation." type DeleteAutomationPayload { "The deleted automation" automation: Automation "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of DeleteCareAlert." type DeleteCareAlertPayload { "The deleted care alert" care_alert: CareAlert "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of DeleteCustomModuleFileAttachment." type DeleteCustomModuleFileAttachmentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The file attachment that was deleted" file_attachment: FileAttachment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of DeleteTranscript." type DeleteTranscriptPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success: Boolean transcript_id: String } "Autogenerated return type of DestroyInternalComment." type DestroyInternalCommentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") internal_comment: InternalComment "The list of errors occurred during the mutation" messages: [FieldError] } "A Dexcom Connection" type DexcomConnection { "The unique identifier of the connection" id: ID! "The last time Dexcom was synced" last_sync_date: String } "A diagnosis" type Diagnosis { "Active diagnosis" active: Boolean! "custom module id" custom_module_id: ID "A display name - for use in labels" display_name: String "End date" end_date: String "First symptom date" first_symptom_date: String "icd code" icd_code: IcdCode "icd code id" icd_code_id: ID "icd codes cms1500s id" icd_codes_cms1500s_id: ID "icd codes super bill id" icd_codes_super_bill_id: ID "The unique identifier of the diagnosis" id: ID! "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON "Primary diagnosis" primary: Boolean "Date diagnosis was last updated" updated_at: String "Owner of this diagnosis" user: User "user id" user_id: ID } "A single diagnosis entry in a diagnosis_list answer" type DiagnosisEntry { "End date" end_date: String "ICD code" icd_code: String "Diagnosis name" name: String "Onset date" onset_date: String "Whether the diagnosis is active or inactive" status: DiagnosisStatusEnum "Client-generated UUID" uuid: String } "Structured representation of a diagnosis_list form answer" type DiagnosisListAnswer { "List of diagnosis entries" diagnoses: [DiagnosisEntry!]! } "Information on the direct message attachment" type DirectMessageAttachment { "The file name of the attachment" attachment_name: String "The unique ID of the direct message attachment" id: ID } "A discount from stripe as object" type Discount { "Amount off in cents" amount_off: Int "Annual discount in cents" annual_discount: String "Duration of the discount" duration: String "Duration in months" duration_in_months: Int "The unique identifier of the discount" id: String! "Monthly discount in cents" monthly_discount: String "The name of the discount" name: String "Percent off in cents" percent_off: Int } "A document file that contains an attachment and information about the attachment" type Document { "When true, the user cannot adjust settings for the document besides sharing." can_only_share: Boolean "The date the document was made available to the given client" created_at(viewable_user_id: String): String! "Pagination cursor" cursor: Cursor! "The description of the document" description: String "The display name of the document" display_name: String "The record (if any) for edits on the document" draft: DocumentDraft "Include the file in new clients welcome email" email_on_welcome: Boolean! "A URL to download the file, good for 10 seconds" expiring_url: String "The extension of the document" extension: String "The file type of the document" file_content_type: String "The form answer groups associated with this document" form_answer_groups: [FormAnswerGroup!] "The file extension in human-readable format e.g.: 'Video'/'Audio'/'Excel' etc" friendly_type: String "The unique idenitifer of the document" id: ID! "Include the document within the private charts section" include_in_charting: Boolean! "Notes on the document (not visible to the client)" internal_notes: String "The draft status of the document" is_draft: Boolean! "A serialized JSON string of metadata. Maximum character limit of 128,000. Only accessible by staff and providers" metadata: String "Instances of the document being viewed/opened" opens: [DocumentViewing!] "Owner of this document" owner: User "In the case of a private document, the user that this document is for" rel_user: User "ID of the assigned client" rel_user_id: ID "The organization members who may have access to the shareable record" shareable_org_members(after: String, before: String, first: Int, last: Int, keywords: String, order_by: UserOrderKeys = LAST_NAME_ASC, shared: Boolean): UserConnection "The patients who may have access to the shareable record" shareable_patients(after: String, before: String, first: Int, last: Int, keywords: String, order_by: UserOrderKeys = LAST_NAME_ASC, shared: Boolean): UserConnection "The user groups that may have access to the shareable record" shareable_user_groups(after: String, before: String, first: Int, last: Int, keywords: String, order_by: UserGroupOrderKeys = NAME_ASC, shared: Boolean): UserGroupPaginationConnection "The document shared" shared: Boolean "Share the file with new clients automatically" shared_on_welcome: Boolean! "The number of user groups who the document is shared" shared_user_groups_count: Int "The number of users who the document is directly shared with (not through groups)" shared_users_count: Int "Share with all members of the organization" shared_with_dietitians: Boolean! "The number of patients who do not have this item shared with them" unshared_patients_count: Int! "The date the document was updated" updated_at: String! "The user groups who have access to this document" user_groups: [UserGroup!]! "The users who have access to this document" users(after: Cursor, should_paginate: Boolean = false, page_size: Int = 100, order_by: UserOrderKeys = LAST_NAME_ASC): [User!]! "The number of users who have access to this document" users_count: Int! } "A draft for editing a document" type DocumentDraft { "Annotations for document edits in JSON format" annotations: JSON! "The document being edited" document: Document! "The unique identifier of the document draft" id: ID! "The current lock version" lock_version: Int! "Whether the draft has an active lock" locked: Boolean "The original document copied for editing" original_document: Document! "Whether the draft has been published" published: Boolean "When the document draft was published" published_at: ISO8601DateTime "Enum status of draft or published" status: DocumentDraftStatusTypeEnum! "When the current version lock expires" unlock_at: ISO8601DateTime } "Information about a document being opened" type DocumentViewing { "Pagination cursor" cursor: Cursor! "The ID of the document that was opened" document_id: ID! "The unique identifier of the viewing" id: ID! "The user who opened the document" user: User "The ID of the user who opened the document" user_id: ID! "When the document was opened" viewed_at: String! } "Dosage of a medication or prescription" type DosageType { "The unique identifier of the dosage" id: ID! "The medication's national drug code" ndc: String "The medication's RxNorm concept unique identifier (RxCUI)" rxcui: String "The strength of the dosage" strength: String! } "Only available to Internal Healthie Users -- Roles assigned to a given User" type DoseSpot { "State of account being approved" approved: Boolean! "User's Clinic ID" clinic_id: String "User's Clinic Key" clinic_key: String "Date the object was created" created_at: String! "User ID associated with DoseSpot" dosespot_user_id: String "Whether the user's DoseSpot credentials are currently accepted; null when DoseSpot is unreachable" has_valid_credentials: Boolean "The unique identifier of the type" id: ID! "This user is a clinic admin in dosespot" is_clinic_admin: Boolean "Number of notifications on dosespot the User has" notification_count: String! "ID of the user prescribing the dosespot" prescribing_dosespot_user_id: String "The dosespot status" registration_status: Boolean "Role assigned to this user in DoseSpot" role: DosespotRoleEnum "Date the object was last updated" updated_at: String! "User ID associated with the dosespot object in Healthie" user_id: String } "draft of a conversation note" type Draft { "content of draft" content: String "id of linked conversation membership" conversation_membership_id: ID "The unique identifier of the draft" id: ID! } "Allergen information" type DrugAllergenType { "The brand name of the allergen" brand_name: String! "The unique identifier of the allergen" id: ID! "The name of the allergen" name: String! "The type of allergen" type: DrugAllergenTypeEnum! } "An allergy/sensitivity/preference for a client" type DsiComment { "The content of the comment" content: String! "The unique identifier of the comment" id: ID! "The type of intervention" intervention_type: InterventionType! "The organization that the comment belongs to" organization_id: ID! } "Organization level settings for E-Labs" type ELabsSettings { "A list of acceptable billing types" billing_types: [LabOrderBilling!] "A list of acceptable lab vendors" lab_vendors: [LabOrderLabVendor!] } "Autogenerated return type of EditAvailabilityWithAppointmentTypes." type EditAvailabilityWithAppointmentTypesPayload { "The updated availability and the appointment types it now supports. When a recurring series is split, this is the successor series covering occurrences from the next one forward." availability: Availability "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "A processed eligibility check" type EligibilityCheck { "The time the eligibility check was run" created_at: ISO8601DateTime "The unique identifier of the check" id: ID! "The policy associated with this check" policy: Policy "The ID of the associated policy" policy_id: ID! "A JSON object containing the eligibility details" response: String "A basic HTML representation of the eligibility response (nil if errors exist)" response_as_html: String } "A step that embeds a widget" type EmbedWidgetStepType { "The unique identifier of the step" id: String! "The title of the step" title: String } "JWT and ZAK credentials for joining an embedded Zoom meeting" type EmbeddedZoomCredentials { "Meeting SDK JWT for authenticating with the Zoom Web SDK. Valid for the Zoom Meeting SDK signature parameter." jwt: String! "Fresh, short-lived (~2 hours) ZAK for starting/joining as host (role 1). Null for participants (role 0). Fetch fresh per call; do not cache." zak: String } "A post about a client, with different category options" type Entry { "User who added the entry" added_by_user: User "the user who actually put in the entry (not always the user who the entry is about)" added_by_user_id: ID "The category of this entry" category: String "All comments association with this entry." comments: [Comment!]! "Although this field is called created_at, it really represents when the entry occurred. For the real representation of when the database row was created, see record_created_at." created_at: String! "Pagination cursor" cursor: Cursor! "Default water intake for this entry user" default_water_intake_for_entry_user: Int "The description for the entry" description: String "A more granular 1-10 scale of how hungry the user thought they were after eating" ed_posthunger: String "A more granular 1-10 scale of how hungry the user thought they were after eating" ed_posthunger_string: String "A more granular 1-10 scale of how hungry the user thought they were before eating" ed_prehunger: String "A more granular 1-10 scale of how hungry the user thought they were before eating" ed_prehunger_string: String "The users emotions towards the meal as a numerical value" emotions: String "A descriptive string of the users emotions towards the meal based on the emotions value. Comes from the mapping: ['Stressed', 1], ['Anxious', 2], ['Tired', 3], ['Bored', 4], ['Confident', 5], ['Happy', 6], ['Sad', 7 or 0], ['Angry', 8]" emotions_string: String "If average of any type, value indicates amount of entries already included in average calculation" entries_in_average: Int "Third party external ID associated with this entry" external_id: String "Third party associated with the external ID on this entry. One option currently supported is 'AppleHealth'" external_id_type: String "True if the entry has subentries" has_subentries: Boolean "A hexadecimal value corresponding to the metric stat of a food entry" healthiness_info_hex_value: String "A boolean to check if the entry should be hidden from the main client feed" hide_from_main_feed: Boolean! "The unique identifier of the entry" id: ID! "The associated image of the entry" image: Upload "The URL of the entry's associated image" image_url(style: EntryImageStyleEnum): String "True if the custom metric is linked to an auto-scored form template" linked_to_autoscored_form: Boolean "Meal entries of FoodEntry" meals: [Meal!] "The value of the metric for the entry" metric_stat: Float "Metric stat as a string" metric_stat_string: String "The name for this entry" name: String "Other symptom typed by the client" other_symptom: String "How hungry the poster thinks they were before eating" percieved_hungriness: Float "User who the entry is about" poster: User "The water intake previously added" previous_water_intake_stat: Int! "The time at which this entry was created. Cannot be updated" record_created_at: ISO8601DateTime! "The user's free-text reflection or notes about the meal" reflection: String "A name of third party source or full name of user who have created the entry" source: String "subentries of the Entry" subentries: [Entry!] "Comma-separated list of symptom names" symptom_names: String "Comma-separated list of symptom IDs selected by the client for this entry" symptoms: String "A name of third party source which actually created the entry" third_party_source: String "The type for this entry, options are - FoodEntry, WorkoutEntry, MirrorEntry, SleepEntry, NoteEntry, WaterIntakeEntry, PoopEntry', null: false" type: String "The last date and time that the entry was updated" updated_at: String! "A check to see if the entry has been viewed or not" viewed: Boolean! } "The episode of care for a patient encounter" type EpisodeOfCare { "The diagnosis code for the episode of care" diagnosis: Diagnosis "The end date for the episode of care" end_date: ISO8601Date "The unique identifier of the episode of care" id: ID! "The patient associated with the episode of care" patient: User "All patient encounters associated with this episode of care" patient_encounters: [PatientEncounter!] "The provider associated with the episode of care" provider: User "The start date for the episode of care" start_date: ISO8601Date } "The connection type for EpisodeOfCare." type EpisodeOfCareConnection { "A list of edges." edges: [EpisodeOfCareEdge] "A list of nodes." nodes: [EpisodeOfCare] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type EpisodeOfCareEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: EpisodeOfCare } "An Electronic Remittance Advice (ERA) type" type Era { "The ACH or check number for the payment" ach_check_number: String "The service lines for the claim" era_service_lines(after: String, before: String, first: Int, last: Int): EraServiceLineConnection! "The ID of the ERA in the remote system" external_era_id: String! "The unique identifier of the ERA" id: ID! "The status of the insurance" insurance_status: String "The ID of the member" member_id: String "The name of the member" member_name: String "The date the payment was made" paid_date: ISO8601Date "The contact information for the payer" payer_id: String "The name of the payer" payer_name: String "The PCN (Processor Control Number)" pcn: String "Base64-encoded PDF representation of the ERA" pdf: String } "An adjustment for an ERA service line" type EraAdjustment { "The adjustment group" adjustment_group: AdjustmentGroup! "The adjustment amount in dollars" amount: Float! "The adjustment code" code: String! } "The connection type for Era." type EraConnection { "A list of edges." edges: [EraEdge] "A list of nodes." nodes: [Era] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type EraEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: Era } "A service line for the claim" type EraServiceLine { "The billed amount" billed_amount: Float! "The contractual obligation adjustments" contractual_obligation_adjustments: [EraAdjustment!] "The end date of the service" end_date: ISO8601Date "The unique identifier of the service line" id: ID! "Other adjustments" other_adjustments: [EraAdjustment!] "The paid amount for the service" paid_amount: Float! "The patient responsibility adjustments" patient_responsibility_adjustments: [EraAdjustment!] "Payer initiated adjustments" payer_initiated_adjustments: [EraAdjustment!] "The service code" service_code: String! "The start date of the service" start_date: ISO8601Date! } "The connection type for EraServiceLine." type EraServiceLineConnection { "A list of edges." edges: [EraServiceLineEdge] "A list of nodes." nodes: [EraServiceLine] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type EraServiceLineEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: EraServiceLine } "An eRx (DoseSpot) clinic associated with an organization" type ErxClinic { "The eRx vendor's clinic identifier" external_identifier: String! "The unique identifier of the eRx clinic" id: ID! "The clinic name" name: String! } "An edge in a connection." type ErxClinicEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: ErxClinic } "The connection type for ErxClinic." type ErxClinicPaginationConnection { "A list of edges." edges: [ErxClinicEdge] "A list of nodes." nodes: [ErxClinic] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An object containing info about the provider's external calendar" type ExternalCalendar { "Send appointments to the external calendar" add_to_calendar: Boolean "A list of potential calendars" calendar_list: [String] "Email of external calendar" email: String "The type of external calendar" external_type: String "Calendar has ran first sync" has_ran_first_sync: Boolean "Calendar has refresh token" has_refresh_token: Boolean "The unique identifier of the calendar" id: ID! "Pull in appointments from the external calendar" pull_from_calendar: Boolean "Calendar has pulled in location and note info otherwise it will contain 'Busy'" pull_in_event_details: Boolean "Selected calendars to pull in appointments from" pulled_in_calendars: [String] "The resource name (sync partner assigned ID) for the sync" resource_name: String "ID of the provider associated with the calendar" user_id: ID } "The connection type for ExternalCalendar." type ExternalCalendarConnection { "A list of edges." edges: [ExternalCalendarEdge] "A list of nodes." nodes: [ExternalCalendar] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type ExternalCalendarEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: ExternalCalendar } "A family history condition record for a client" type FamilyHistoryCondition { "The unique identifier of the family history condition" id: ID! "Enum field for family relationships" relationships: [String!] "snomed term associated with the condition" snomed_term: SnomedTerm } "An object containing info about the user' s fax line requests" type FaxLineRequest { "The area_code" area_code: String "The file type of the bill" bill: String "The city" city: String "The date and time that the fax line request was created" created_at: String! "The file type of the loa" loa: String "The request type" request_type: String "The state" state: String } "Feature flag" type FeatureFlag { name: FeatureFlagNameEnum! value: Boolean! } "An object containing details about what the client can and can't do" type FeatureToggle { "Activity level of the user" activity_level: String "Allow clients to sync with Apple Health" allow_apple_health_sync: Boolean! "Allow clients to sync with Clearstep" allow_clearstep_sync: Boolean! "Allow send messages to community chat" allow_community_chat: Boolean! "Allow clients to sync with Dexcom" allow_dexcom_sync: Boolean "Allow send messages to direct chat" allow_direct_chat: Boolean! "Allow clients to sync with Fitbit" allow_fitbit_sync: Boolean! "Allow clients to sync with Google Fit" allow_google_fit_sync: Boolean! "Allow clients to sync with Google Health Connect" allow_google_health_connect_sync: Boolean! "Allow clients to sync with Shapa" allow_shapa_sync: Boolean! "Allow clients to sync with Withings" allow_withings_sync: Boolean! "whether or not the eating disorder defaults are applied" apply_eating_disorder_default: Boolean! "The status of whether the linked user can view and schedule appointments" can_schedule_appointments: Boolean! "Whether or not clients can track poop in their journal entries" can_track_poop: Boolean! "Whether or not the client can track symptoms" can_track_symptoms: Boolean! "Whether or not clients can track water intake in their journal entries" can_track_water_intake: Boolean! "The status of whether the linked user can view care plan" can_view_care_plan: Boolean! "The status of whether the linked user can view and upload documents" can_view_documents: Boolean! "The status of whether the linked user can view and complete intake forms" can_view_forms: Boolean! "The status of whether the linked user can view and create goals" can_view_goals: Boolean! "The status of whether the linked user can view and create journal entries" can_view_journal_entries: Boolean! "The status of whether the linked user can view and purchase packages" can_view_packages: Boolean! "The status of whether the linked user can view and make payments" can_view_payments: Boolean! "The status of whether the linked user can view and complete programs" can_view_programs: Boolean! "The care plan associated with this feature toggle" care_plan: CarePlan "The id of the care plan associated with this feature toggle" care_plan_id: ID "The date and time the entry was done" created_at: String! "Custom Metrics for this toggle" custom_metrics: [CustomMetric!] "Default date range selector when provider opens date picker in metrics tab" date_range_preference: String! "Default water intake set by provider" default_water_intake: String! "When true, it will not auto submit the CMS1500 to the clearing house" do_not_auto_submit_cms1500: Boolean! "The frequency with which clients get email notifications about their goals" email_notification_frequency: String "Food categories" food_categories: [String!]! "If true, user has at least one entry type to track" has_any_entry_types: Boolean "CCDA is available if true" has_ccda: Boolean "The unique identifier of the feature toggle" id: ID "Food categories" initial_custom_metric_overrides: [CustomMetricOverride!] "Default date range when provider opens date picker in journal tab" last_journal_date_range_preference: String "Default from_date when provider opens date picker in journal tab" last_journal_from_date: String "Default to_date when provider opens date picker in journal tab" last_journal_to_date: String "Metric Graphs to show in line graph form" line_graph_metric_categories(user_id: ID): [String] "Sleep Graphs to show in line graph form" line_graph_sleep_categories(user_id: ID): [String] "Metric categories based on users toggle features" metric_categories(user_id: ID): [String!]! "Metric category objects (including defaults) based on users toggle features" metric_category_objects(user_id: ID): [CustomMetric!] "Mirror categories" mirror_categories: [String!]! "When true, locks inactive clients from login and outbound emails" prevent_inactive_access: Boolean! "The frequency with which clients get push notifications about their goals" push_notification_frequency: String "When true, clients must complete their intake forms before they can access chat or join platform-hosted video calls (external video links are unaffected)" require_intake_for_communication: Boolean! "Metrics that should be on for this feature toggle" returned_custom_metrics: [String!]! "Send unpaid invoice reminder" send_unpaid_invoice_reminder: Boolean "The status of whether entries on graphs are separated by the poster" separate_provider_metric_from_client: Boolean "The status of whether entries on graphs are separated by the poster" seperate_provider_metric_from_client: Boolean @deprecated(reason: "Use `separate_provider_metric_from_client` instead") "The status of whether the provider can see the A1C of the client" show_a1c_metric: Boolean "The status of whether the provider can view and track the client's body fat percentage" show_bf_percent_metric: Boolean "The status of whether the provider can view and track the client's blood pressure" show_blood_pressure_metric: Boolean "The status of whether the provider can see the blood sugar metrics of the client" show_blood_sugar_metric: Boolean "The status of whether the provider can see the calculated BMI of the client" show_bmi_graph: Boolean "The status of whether the provider can see the bmi-growth chart of the client" show_bmi_growth_chart: Boolean "The status of whether the provider can see the calculated BMR (using MFJ) of the client" show_bmr_metric: Boolean "The status of whether the provider can see the body temperature entries of the client" show_body_temperature_metric: Boolean "The status of whether the client can see A1C metrics of the client" show_client_a1c_metric: Boolean "The status of whether the client can view and track the client's body fat percentage" show_client_bf_percent_metric: Boolean "The status of whether the client can view and track the client's blood pressure" show_client_blood_pressure_metric: Boolean "The status of whether the client can see the blood sugar metrics of the client" show_client_blood_sugar_metric: Boolean "The status of whether the client can see the calculated BMI of the client" show_client_bmi_graph: Boolean "The status of whether the client can see the bmi-growth chart of the client" show_client_bmi_growth_chart: Boolean "The status of whether the client can see the calculated BMR (using MFJ) of the client" show_client_bmr_metric: Boolean "The status of whether the client can see the body temperature entries of the client" show_client_body_temperature_metric: Boolean "The status of whether the client can see the calculated BMR (using HB) of the client" show_client_harris_benedict: Boolean "The status of whether the client can view and track the client's height" show_client_height_graph: Boolean "The status of whether the client can see the height-growth chart of the client" show_client_height_growth_chart: Boolean "The status of whether the client can see oxygen saturation metrics of the client" show_client_ox_sat_metric: Boolean "The status of whether the client can view and track the client's waist circumference" show_client_waist_circumference_metric: Boolean "The status of whether the client can see the weight-growth chart of the client" show_client_weight_growth_chart: Boolean "The status of whether the client can view and track the client's weight" show_client_weight_metric: Boolean "The status of whether the client is asked to track expanded (1-10) postmeal hunger level" show_ed_posthunger: Boolean "The status of whether the client is asked to track expanded (1-10) premeal hunger level" show_ed_prehunger: Boolean "The status of whether the client can post food entries" show_food: Boolean "The status of whether the client is asked to track the category (meal or snack) of the food" show_food_category: Boolean "The status of whether the client is asked to track (1-10) emotion towards the food" show_food_emotion: Boolean "The status of whether the client is asked to post a (text) reflection towards the food" show_food_reflection: Boolean "The status of whether the provider can see the calculated BMR (using HB) of the client" show_harris_benedict: Boolean "The status of whether the client is asked to track perceived healthiness" show_healthiness: Boolean "The status of whether the provider can see the height graph of the client" show_height_graph: Boolean "The status of whether the provider can see the height-growth chart of the client" show_height_growth_chart: Boolean "The status of whether the client can post metric entries" show_metric: Boolean "The status of whether the client can post selfie entries" show_mirror: Boolean "The status of whether the client is asked to track normal (1-3) hunger level" show_normal_hunger: Boolean "The status of whether the client can post note entries" show_note: Boolean "The status of whether the client is asked to track (1-10) emotion towards the note" show_note_emotion: Boolean "The status of whether the client can include macro and micro nutrients for the food they track" show_nutrients_tracking: Boolean "The status of whether the provider can see the oxygen saturation of the client" show_ox_sat_metric: Boolean "The status of whether the client can post sleep entries" show_sleep: Boolean "The status of whether the provider can view and track the client's waist circumference" show_waist_circumference_metric: Boolean "The status of whether the provider can see the weight-growth chart of the client" show_weight_growth_chart: Boolean "The status of whether the provider can view and track the client's weight" show_weight_metric: Boolean "The status of whether the client can post workout entries" show_workout: Boolean "Symptom options for symptom entry type" symptom_options: [SymptomOption!]! "The status of whether the client uses the metric system (versus imperial)" use_metric_system: Boolean "Associated user" user: User "The user group associated with this feature toggle" user_group: UserGroup "The user group associated with this feature toggle" user_group_id: ID "The user associated with this feature toggle" user_id: ID "If true, the user has active_care_plan" uses_feature_toggle_from_care_plan: Boolean "Whether the client can view medications and prescriptions" view_medications: Boolean "When enabled, let's providers choose to have metrics that clients can view, but not enter" view_not_track: Boolean "Workout categories" workout_categories: [String!]! } "Information about field that didn’t pass validation" type FieldError { "Field name that caused these errors" field: String "Validation message" message: String! } "A file attachment representing an uploaded file" type FileAttachment { "The ID of the file attachment" id: ID! "The pre-signed expiring URL to access the file" url: String } "A Fitbit Sync" type Fitbit { "The unique identifier of the fitbit" id: ID! "Checking is active sync in current moment" is_enabled: Boolean! "The last time the fitbit was synced" last_sync_date: String } "A folder that contains documents and other folders" type Folder { "When true, the user cannot adjust settings for the folder besides sharing." can_only_share: Boolean "The date the folder was made available to the given user" created_at(viewable_user_id: String): String! "If true, the current user can edit the folder" current_user_can_edit: Boolean "The description of the folder" description: String "The number of documents within this folder" documents_count: Int "Include the file in new clients welcome email" email_on_welcome: Boolean! "The ID of the parent folder" folder_id: String "The list of parent folders for this folder" folder_path(client_id: String): [Folder!] "The unique identifier of the folder" id: ID! "The name of the folder" name: String "Owner of this folder" owner: User "The parent folder of this folder (nil if there is no parent)" parent_folder: Folder "In the case of a private folder, the user that this folder is for" rel_user: User "The ID of the connected user" rel_user_id: String "The organization members who may have access to the shareable record" shareable_org_members(after: String, before: String, first: Int, last: Int, keywords: String, order_by: UserOrderKeys = LAST_NAME_ASC, shared: Boolean): UserConnection "The patients who may have access to the shareable record" shareable_patients(after: String, before: String, first: Int, last: Int, keywords: String, order_by: UserOrderKeys = LAST_NAME_ASC, shared: Boolean): UserConnection "The user groups that may have access to the shareable record" shareable_user_groups(after: String, before: String, first: Int, last: Int, keywords: String, order_by: UserGroupOrderKeys = NAME_ASC, shared: Boolean): UserGroupPaginationConnection "The folder is shared" shared: Boolean "Share the file with new clients automatically" shared_on_welcome: Boolean! "The number of user groups who the folder is shared" shared_user_groups_count: Int "The number of users who the folder is directly shared with (not through groups)" shared_users_count: Int "Share with all members of the organization" shared_with_dietitians: Boolean! "The number of subfolders within this folder" subfolders_count: Int "The folder has a reserved name generated by the system" system_generated: Boolean! "The number of patients who do not have this item shared with them" unshared_patients_count: Int! "The user groups who have access to this folder" user_groups: [UserGroup!]! "The users who have access to this folder" users(after: Cursor, should_paginate: Boolean = false, page_size: Int = 100, order_by: UserOrderKeys = LAST_NAME_ASC): [User!]! "The number of users who have access to this folder" users_count: Int! } "A food object" type Food { "The name of the food creator" creator_name: String "Pagination cursor" cursor: Cursor! "first serving size of the food object" default_serving_size: ServingSize "The name of the food to display" display_name: String "The id of the food in the Edamam database" edamam_import_id: String "Whether the food was imported from the FDC database" fdc_import: Boolean! "The unique identifier of the food" id: ID! "The name of the food" name: String! "Nutrients of the food object" nutrients: [FoodNutrient!] "Serving sizes of the food object" serving_sizes: [ServingSize!] "The ID of the user who created the food" user_id: String } "A food item to be served" type FoodItem { "The food to be served" food: Food "The unique identifier of the food item" id: ID! "The modifier for the serving size" modifier: Float "The serving size" serving_size: ServingSize } "A food nutrient item object" type FoodNutrient { "The category of the nutrient" category: String "Whether the nutrient is imported from the FDC database" fdc_import: Boolean! "The unique identifier of the food" food_id: String "The unique identifier of the nutrient" id: ID! "The name of the nutrient" name: String "The unit of the nutrient" nutrient_unit: String "The value of the nutrient" nutrient_value: Float } "An answer in a filled form" type FormAnswer { "The answer to the question" answer: String "The ID of the custom module whose value determines whether to show or hide the custom module" conditional_custom_module_id: ID "The creation time of the form answer" created_at: String! "The type of question that was filled out" custom_module: CustomModule "The id of the question template" custom_module_id: String "The answer to display (some conversions are made verse raw answer data)" displayed_answer: String "The file attachments associated with this form answer" file_attachments: [FileAttachment!] "The type of filter" filter_type: String "The filled form that this answer is a part of" form_answer_group: FormAnswerGroup "The unique identifier of the answer" id: ID! "The label of the question" label: String "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String "The answer as a parsed, typed object instead of a raw string. The shape depends on the question type — for example, a location question returns line1, city, state, etc. as separate fields rather than a single delimited string. This is null for question types we haven't broken out into a structured shape yet; for those, read `answer` or `displayed_answer` directly." structured_answer: FormAnswerStructuredAnswer "The time of the last update" updated_at: ISO8601DateTime "The id of the user that the answered question is for" user_id: String "The value to check the filter against" value_to_filter: String } "A completed form, with metadata about the completion, and the saved answers" type FormAnswerGroup { "The appointment the note is connected to" appointment: Appointment "The autoscored sections for the filled form" autoscored_sections: [AutoscoredSectionType!]! "The status of the charting note" chart_note_status: ChartNoteStatus "The addendums added to the locked charting note" charting_note_addendums: [ChartingNoteAddendumType!] "The CMS1500 created from the form answer group" cms1500: Cms1500 "The date on which the filled form was saved. If form is associated with an appointment, this is the date and time of service." created_at: String! "The most recent generated summary. Null if no summary has been generated" current_summary: GeneratedSummary "Pagination cursor" cursor: Cursor! "The form template that was filled out" custom_module_form: CustomModuleForm "The date the form was deleted" deleted_at: String "The documents associated with the form answer group" documents: [Document!] "An external ID stored on the filled form or charting note" external_id: String "The user who filled out the form" filler: User "Whether the filled form has been saved by the user (verse a hidden draft)" finished: Boolean! "The history when a charting note was locked, unlocked or signed" form_answer_group_audit_events: [FormAnswerGroupAuditEvent!]! "A list of associated dosespot prescriptions" form_answer_group_prescriptions: [Prescription!]! "Signatures for the form" form_answer_group_signings: [FormAnswerGroupSigning!]! "A list of connections between a form_answer_group and group appointment users" form_answer_group_users_connections: [FormAnswerGroupUserConnection!] "The visible answers for the filled form" form_answers(is_for_editing: Boolean = false, custom_module_ids: [ID]): [FormAnswer!]! "when true, the note cannot be edited" frozen: Boolean "All patients that have attended in the related group appointment" group_appointment_attendees: [User!] "The unique identifier of the group" id: ID! "A collection of individual charting notes related to the main group charting note" individual_client_notes(order_by: IndividualClientNoteOrderKeys): [IndividualClientType!] "Same as individual_client_notes but returns a specific instance for given user" individual_note(user_id: ID): IndividualClientType "Indicates whether the answer group is related to group appointment (charting note created for group appointment)" is_group_appt_note: Boolean "Shows whether `FormAnswerGroup` is locked" is_locked: Boolean! "The lab orders associated with the form answer group" lab_orders: [LabOrder!] "The date and time when the charting note was locked" locked_at: String "The provider who have locked the charting note" locked_by: User "A serialized JSON string of metadata. Maximum character limit of 128,000. Only accessible by staff and providers" metadata: String "The given name of the filled form" name: String "A list of associated dosespot Narx checks, sorted by timestamp ascending" narx_checks: [NarxCheck!]! "If you have product recommendation algorithm enabled, this will return a package containing the products recommended by the algorithm" offering_with_recommended_products: Offering "If you have product recommendation algorithm enabled, this will return a package containing a URL to purchase the products recommended by the algorithm" packages_with_recommended_products_purchase_url: String @deprecated(reason: "Not used anywhere, will cause an error") "Whether current user or given user can add addendum to this `form_answer_group`" provider_can_add_addendum(provider_id: ID = null): Boolean! "Whether current user or given user can lock this `form_answer_group`" provider_can_lock(provider_id: ID = null): Boolean! "Whether current user or given user can sign this `form_answer_group`" provider_can_sign(provider_id: ID = null): Boolean! "Whether current user or given user can unlock this `form_answer_group`" provider_can_unlock(provider_id: ID = null): Boolean! "The date that the note was actually created" record_created_at: String "The form request associated with the completed form" requested_form_completion: RequestedFormCompletion "The last updated date for the filled form" updated_at: String! "The user the form is about" user: User "ID of the user" user_id: String "The name of the signed stream to track changes in `form_answers`" versioning_stream_name: String } "Base class for types" type FormAnswerGroupAuditEvent { "Action type" action: Action! "When the action was made" committed_at: ISO8601DateTime! "Who made the action" committed_by: User! created_at: ISO8601DateTime! description: String form_answer_group: FormAnswerGroup! id: ID! "Additional structured data about the action, e.g. the previous and new appointment for appointment_relinked events" metadata: JSON related_object: RelatedObjectUnion updated_at: ISO8601DateTime! } "An instance representing connection between a charting note(form_answer_group) and a user signing the note" type FormAnswerGroupSigning { "The date and time the form was signed" created_at: String! "The id of the form that was signed" form_answer_group_id: String "The unique identifier of the signing" id: ID! "A provider who signed the form" user: User "The avatar URL of the user who signed the form" user_avatar_url: String "The full legal name of the user who signed the form" user_full_legal_name: String "The qualifications of the user who signed the form" user_qualifications: String } "An instance representing connection between a group charting note(form_answer_group.appointment.is_group == true) and a user" type FormAnswerGroupUserConnection { "The unique identifier of the connection" id: ID! "The user associated with the connection" user: User } "A form history object" type FormHistory { "Action of the form history object" action: FormHistoryAction "Date/Time created" created_at: String "The User who created form history object or dietitian of the patient" creator: User "The unique identifier of the form history object" id: ID! "The patient who owns the form history object" patient: User "The title describing form history creation" title: String } "types of forms that can be requested" type FormTypesToRequest { "The unique identifier of the object" id: String! "Whether the form contains only one custom_module with mod_type 'video' and was created as part of a program" is_video: Boolean "Type of form to request" item_type: String "The given name of the template" name: String } "Fullscript Practitioner" type FullscriptPractitionerType { "Email address of the practitioner" email: String "External reference of the practitioner" external_ref: String "First name of the practitioner" first_name: String "The unique identifier of the practitioner" id: String! "Last name of the practitioner" last_name: String "The ID of the practitioner type" practitioner_type_id: String } "The type of practitioners" type FullscriptPractitionerTypeType { "The code for the practitioner type" code: String "The description of the practitioner type" description: String "The unique identifier of the practitioner type" id: String! } "Fullscript Product Type" type FullscriptProductType { "Additional Info" additional_info: String "Dosage of the product" dosage: String "The unique identifier of the product fullscript" id: String! "Ordered" ordered: String "The name of the product" product_name: String } "Fullscript Treatment Plan" type FullscriptTreatmentPlanType { "Date the treatment plan was activated" activation_date: String "The unique identifier of the plan" id: String! "Number of times the plan has been ordered" ordered_count: Int "Personal message from the practitioner" personal_message: String "The name of the practitioner" practitioner_name: String "The products recommended in the plan" recommendations: [FullscriptProductType!] } "FunctionalStatus object" type FunctionalStatus { "Functional condition" functional_condition: String "The unique identifier of the functional status" id: ID! "The start date of the functional status" start_date: String "The ID of the user who created the functional status" user_id: ID! } "Structured representation of a `gender` form_answer answer" type GenderAnswer { "The selected gender as an enum member, or null when the stored answer matches no member" gender_code: Gender "The selected gender as its display label, or null when the stored answer matches no member" value: String } "Autogenerated return type of GenerateActivationLink." type GenerateActivationLinkPayload { "Activation URL for the user to activate their account" activation_link: String "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "AI-Generated Form Answer Group" type GeneratedFormAnswerGroupType { "The appointment the note is connected to" appointment: Appointment "The ID of the appointment the note is connected to" appointment_id: ID "The date of the item' creation" created_at: ISO8601DateTime! "The form AI Scribe used to structure the proposed chart note" custom_module_form: CustomModuleForm! "Feedback for the generated form answer group" feedback: String "The chart note created from this proposed note, if it has been converted" form_answer_group: FormAnswerGroup "The visible answers for the filled form" generated_form_answers: [GeneratedFormAnswerType!]! id: ID! "The AI Scribe kind (ambient or video_call)" kind: String "The reasons the provider selected when rejecting this proposed note. Null if the note has not been rejected, empty array if rejected without selecting specific reasons." rejection_reason: [String!] } "AI-Generated Form Answer" type GeneratedFormAnswerType { "The answer to the custom module" answer: String "The custom module associated with the generated answer" custom_module: CustomModule "The user-friendly displayable answer to the custom module" displayed_answer: String id: ID } "A generated summary for an associated Healthie object" type GeneratedSummary { "The datetime the summary was generated" created_at: ISO8601DateTime! "The datetime the summary text was last edited by a user" edited_at: ISO8601DateTime "The user who last edited the summary text" edited_by: User "The unique identifier of the group" id: ID! "A summary (most often new-line separated bullet points) of the associated object" summary: String } "a goal" type Goal { "Completion Percentage of a goal for a given date range. start_range/end_range should be of the form: 'yyyy-mm-dd'" completion_percentage_for_range(end_range: String, start_range: String!): Int "The rate at which this goal is completed" completion_rate: String @deprecated(reason: "should use completion_percentage_for_range") "The creation timestamp of the goal" created_at: String! "User who created this goal" created_user: User "created user of goal" created_user_id: ID "Pagination cursor" cursor: Cursor! "description of goal" description: String "due date of goal" due_date: String "All goal histories associated with this goal histories." goal_histories: [GoalHistory!]! "The unique identifier of the goal" id: ID! "If true, the goal is complete for the given day. date should be of the form: 'yyyy-mm-dd'" is_completed_for_date(date: String!): Boolean "if true, the goal is currently active" is_current: Boolean @deprecated(reason: "should use is_completed_for_date field to determine if a goal is completed for a given day") "if true, a template has been created based off this goal" is_used_as_template: Boolean "name of goal" name: String "parent id" parent_id: ID "The rate at which the parent goal has subgoals completed" parent_subgoal_completion_rate: String "Reminder object for a given goal" reminder: Reminder "frequency of goal" repeat: String "The id of the template used to make this goal" source_template_id: String "start date of goal" start_on: String! "Streak info for goal" streak_info(end_range: String, start_range: String!): [GoalStreakInfo!] "The rate at which a subgoal is completed" subgoal_completion_rate: String @deprecated(reason: "should use completion_percentage_for_range") "Subgoals for a given goal" subgoals: [Goal!] "count of subgoals" subgoals_count: String "Title hyperlink. Opens when the title is clicked on." title_link: String "Owner of this goal" user: User "user id of goal" user_id: ID } "Goal data" type GoalDataType { "All goals frequency count" all_goals_frequency_count: Int "All goals status count" all_goals_status_count: Int "All time goals count" all_time_goals_count: Int "Completed goals count" completed_goals_count: Int "Daily goals count" daily_goals_count: Int "Goal list" goals: [Goal!] "Goals count" goals_count: Int "Goals overall completion rate info" goals_overall_completion_rate_info: GoalOverallCompletionRateInfo "Goals streak count" goals_streak_count: Int "Not completed goals count" not_completed_goals_count: Int "One time goals count" one_time_goals_count: Int "Weekly goals count" weekly_goals_count: Int } "a goal history" type GoalHistory { "The action type that was performed on a specific goal that created this history record" action: GoalHistoryActionTypeEnum "The date the goal is marked completed" completed_on: String! "The completion timestamp of the goal" created_at: String! "Pagination cursor" cursor: Cursor! "The description of the goal" description: String "goal that was completed" goal: Goal "goal id of goal history" goal_id: ID "The unique identifier of the history" id: ID! "If true, the goal is a subgoal" is_subgoal: Boolean "The name of the goal" name: String "The repeat frequency of the goal" repeat: String "client of this goal" user: User "user id of goal history" user_id: ID } "a goal instance. gives a snapshot of a goal over a specific interval(start_range and end_range )" type GoalInstance { "Pagination cursor" cursor: Cursor! "The date the interval starts for this goal instance" end_range: String "the relevant goal" goal: Goal "If true, the goal was completed in between the start and end range" is_completed_for_interval: Boolean "The date the interval starts for this goal instance" start_range: String } "Related info for a collection of goals overall completion rate" type GoalOverallCompletionRateInfo { "The number of times the goals were completed" actual_times_completed: Int "The actual percentage of the completion rate" percent: Int "The total number of times the goals could have been completed" possible_times_completed: Int } "Related info of a specific goal's streak" type GoalStreakInfo { "The length of intervals (ie: days, weeks, etc) this streak lasted" count: Int "The day this streak ended" end_date: String "The day this streak began" start_date: String } "a goal template" type GoalTemplate { "description of template from associated goal" description: String "id of the goal this template was based on" goal_id: String "id of the the relevant goal template" id: String! "is_healthie_default of the the relevant goal template" is_healthie_default: Boolean! "name of template from associated goal" name: String "frequency of template from associated goal" repeat: String! "Subgoal templates for a given template" subgoal_templates: [GoalTemplate!] "Title hyperlink. Opens when the title is clicked on." title_link: String "user associated with this template" user: User "user who owns this goal template" user_id: String } "A GoogleFit Sync" type GoogleFit { "The unique identifier of the Google fit" id: ID! "The last time the apple health was synced" last_sync_date: String } "A connection between a user and a care plan" type GroupCarePlanUserConnection { "The care plan active status" active: Boolean! "The ID of the care plan" care_plan_id: ID "The unique identifier of the join" id: ID! "The ID of the user_group" user_group_id: ID "The ID of the client" user_id: ID } "Health Assessment contains in-depth help info and goals for a client" type HealthAssessment { "The body report for the client" body_report: BodyReport "The date the health assessment was created" created_at: String! "gen" gender: String "The health report for the client" health_report: HealthReport "The height of the client" height: String "The unique identifier of the health accessment" id: ID! "Is the client diabetic?" is_diabetic: Boolean "The race of the client" race: String "The recommendation for the client" recommendation: HealthAssessmentRecommendation "The title of the health assessment" title: String } "Health Assessment Recommendation is a sub category of a HealthAssessment" type HealthAssessmentRecommendation { "cal_deficit of user" cal_deficit: String "carbs_cal of user" carbs_cal: String "carbs_grams of user" carbs_grams: String "Carbs percent" carbs_percent: String "current_body_fat of user" current_body_fat: String "current_body_weight of user" current_body_weight: String "current_daily_caloric_intake of user" current_daily_caloric_intake: String "current_time_to_goal of user" current_time_to_goal: String "fat_cal of user" fat_cal: String "fat_grams of user" fat_grams: String "Fat Percent" fat_percent: String "high_end_caloric_intake of user" high_end_caloric_intake: String "Ideal body fat of user" ideal_body_fat: String "ideal_body_weight of user" ideal_body_weight: String "ideal_daily_caloric_intake of user" ideal_daily_caloric_intake: String "ideal_time_to_goal of user" ideal_time_to_goal: String "low_end_caloric_intake of user" low_end_caloric_intake: String "protein_cal of user" protein_cal: String "protein_grams of user" protein_grams: String "Protein Percent" protein_percent: String } "Autogenerated return type of HealthAssessmentServiceSignup." type HealthAssessmentServiceSignupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") deeplink_url: String "The list of errors occurred during the mutation" messages: [FieldError] } "HealthConcern object" type HealthConcern { "The code for the health concern" code: String "The description of the health concern" description: String "The display name of the health concern" display_name: String "The effective time of the health concern" effective_time: String "The unique identifier of the" id: ID! } "Health Report is a sub category of a HealthAssessment" type HealthReport { "cancer of user" cancer: String "diabetes of user" diabetes: String "The fit score of the user" fit_score: String "lean_body_mass of user" heart: String "respiratory of user" respiratory: String "stroke of user" stroke: String } "An HTTP header (case-insensitive name; duplicates allowed)." type HttpHeader { name: String! value: String! } "Human object controls authentication for users" type Human { "The current user" current_user: User "The Id of the human's currently selected user" current_user_id: ID "The email of the human" email: String "The unique identifier of the human" id: ID! "last date the human signed in" last_sign_in_at: String } "icd code" type IcdCode { "The category of the ICD code" category: String "The ICD code" code: String "The date the ICD code was created" created_at: String! "Pagination cursor" cursor: Cursor! "The description of the ICD code" description: String "A display name - for use in labels" display_name: String "The unique identifier of the ICD code" id: ID! "Whether the ICD code is marked as favorite" is_favorite(known_value: Boolean): Boolean "The date the ICD code was updated" updated_at: String! } "icd codes cms 1500s join table" type IcdCodesCms1500 { "Active IcdCodesCms1500" active: Boolean "cms 1500 id" cms1500_id: ID "date created" created_at: String "display name" display_name: String "End date" end_date: String "ICD codes in use for this claim" first_symptom_date: String "ICD code" icd_code: IcdCode "icd code id" icd_code_id: ID @deprecated(reason: "Use icd_code instead") "The unique identifier of the CMS 1500 ICD code" id: ID "date updated" updated_at: String } "icd codes individual client note join table" type IcdCodesIndividualClientNote { "icd code" icd_code: IcdCode "Attached ICD Code ID" icd_code_id: ID "The unique identifier of the CMS 1500 ICD code" id: ID "Position of the diagnosis" position: Int } "icd codes policies join table" type IcdCodesPolicy { "The ICD code" code: String "The date when the join was created" created_at: String "The description of the join" description: String "The ICD code object" icd_code: IcdCode "The ID of the joined ICD code" icd_code_id: ID "The unique identifier of the join between ICD code and policy." id: ID "The ID of the joined policy" policy_id: ID "The date updated" updated_at: String } "icd codes super bills join table" type IcdCodesSuperBill { "The date the join was created" created_at: String "The joined ICD code object" icd_code: IcdCode "The ID of the ICD code" icd_code_id: ID "The unique identifier of the join" id: ID! "The ID of the super bill" super_bill_id: ID "The last date when the join was updated" updated_at: String } "User immunization" type Immunization { "Additional notes" additional_notes: String "The cvx_code" cvx_code: Int! "The unique identifier of the type" id: ID! "Time when the immunization was received" received_at: String! "The immunization status" status: String! "The identifier of the user" user_id: ID! "The description of the code" vaccine_name: String! } "An implantable device" type ImplantableDevice { "Brand name of the implantable device." brand_name: String "Name of the company that manufactures the implantable device." company_name: String "A string representation of the date/time when the device record was created in the database." created_at: String "A unique identifier assigned to the device." device_id: String "The agency that issued the device identifier." device_id_issuing_agency: String "Dun & Bradstreet number (DUNS number) is a unique nine-digit identifier for businesses." duns_number: String "Global Medical Device Nomenclature (GMDN) terms, a system of internationally agreed generic descriptors used to identify all medical device products." gmdn_terms: String "The unique identifier of the implantable device type" id: ID! "Whether the device contains natural rubber latex or not." labeled_contains_nrl: String "Status of the device's safety in an MRI environment (e.g., safe, conditional, unsafe)." mri_safety_status: String "Key of the device's public record." public_device_record_key: String "Date when the public version of the device record was created or updated." public_version_date: String "Version number of the public device record." public_version_number: String "Status of the public version of the device record (e.g., active, retired)." public_version_status: String "A string representation of the date/time when the device record was last updated in the database." updated_at: String "Version or model number of the device." version_model_number: String } "An Implantable Device User" type ImplantableDeviceUser { "A boolean value representing if the Implantable Device is currently active." active: Boolean "Unique identifier for the Implantable Device User connection record." id: ID "Details of the Implantable Device." implantable_device: ImplantableDevice "Unique identifier for the associated Implantable Device record." implantable_device_id: ID "User provided name for the Implantable Device." name: String "Recorded UDI for this associated Implantable Device User record." udi: String "User associated with the Implantable Device, including all User details." user: User "Unique identifier for the associated User record." user_id: ID } "An object containing info about the import data request" type ImportDataRequest { "The file type of import" clients_template: String "The date and time that the import data request was created" created_at: String! "The file name" display_name: String "The file extension" extension: String "The optional comment of import" optional_comment: String "The request type" request_type: String! } "An object containing an individual note for certain patient associated with group charting note" type IndividualClientType { "The ID of related appointment_inclusion" appointment_inclusion_id: ID "True if user has attended the appointment" attended: Boolean "The content of the note" content: String "Diagnoses connected to the individual client attendance" icd_codes_individual_client_notes: [IcdCodesIndividualClientNote!] "The unique identifier of the note" id: ID! "The datetime that the attendee joined the appointment (comes from the related appointment inclusion)" join_time: String "The datetime that the attendee left the appointment (comes from the related appointment inclusion)" leave_time: String "The time of the last update" updated_at: ISO8601DateTime "Associated patient" user: User } "An object containing information about the chart for an insurance authorization type" type InsuranceAuthorizationChartType { "The title of the earliest date value of the chart" earliest_date_title: String "The value of the earliest date value of the chart" earliest_date_value: String "The title of the latest date value of the chart" latest_date_title: String "The value of the latest date value of the chart" latest_date_value: String "The percentage width of the left section of the chart" left_section_width: String "The title of the middle date value of the chart" middle_date_title: String "The value of the middle date value of the chart" middle_date_value: String "The percentage width of the right section of the chart" right_section_width: String } "An insurance authorization" type InsuranceAuthorizationType { "The authorization number" authorization_number: String "Chart info for the insurance authorization" chart_info: InsuranceAuthorizationChartType "The day that visits authorized by the insurance company have no effect" end_on: String "The unique identifier of the authorization" id: ID! "The day that visits authorized by the insurance company take effect" start_on: String "The type of units (visits, units, hours)" unit_type: String "The amount of units authorized by the insurance company" units_authorized: String "The amount of units left" units_left: String "Most units/hours allowed per visit" units_limit_per_visit: String "The amount of units used by the client" units_used: String "Most recent date authorization was updated" updated_at: String "The ID of the user for whom the authorization was created" user_id: ID "The amount of units authorized by the insurance company" visits_authorized: String "The amount of units left" visits_left: String "The amount of units used by the client" visits_used: String } "An insurance payment object" type InsurancePayment { "The ACH or check number" ach_check_number: String "When the payment record was created" created_at: ISO8601DateTime! "The ID of the user who created this payment (for manual payments)" created_by_id: ID "The deposit status of the insurance payment" deposit_status: InsurancePaymentsDepositStatusEnum! "The associated ERA ID" era_id: ID "The insurance payment ID" id: ID! "The NPI number" npi: String "The ID of the organization this payment belongs to" organization_id: ID! "The amount paid" paid_amount: Float! "The date the payment was made" paid_date: ISO8601Date! "The name of the payer" payer_name: String! "The source of the payment (automatic or manual)" source: String! "When the payment record was last updated" updated_at: ISO8601DateTime! } "An Insurance Plan" type InsurancePlan { "The Eligibility Payer ID for eligibility requests in Change that this maps to" change_healthcare_eligibility_payer_id: String @deprecated(reason: "ChangeHealth integration has been discontinued.") "The Payer ID for claims requests in Change that this maps to" change_healthcare_payer_id: String @deprecated(reason: "ChangeHealth claims integration has been discontinued.") "Pagination cursor" cursor: Cursor! "Location of the first policy associated to the current user and insurance plan" default_payer_location(ids: String): Location "The unique identifier of the plan" id: ID! "Insurance Plan marked as accepted" is_accepted(known_value: Boolean): Boolean "Insurance plan marked as custom" is_custom: Boolean "Whether or not this insurance plan is associated with fee schedule for the logged in user." is_in_fee_schedules: Boolean "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "A combined string to use for labels" name_and_id: String "The Payer ID of the insurance plan" payer_id: String "The name of the insurance plan" payer_name: String "Owner of this insurance plan" user: User @deprecated(reason: "Insurance Plans do not have an associated user") } "An edge in a connection." type InsurancePlanEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: InsurancePlan } "The connection type for InsurancePlan." type InsurancePlanPaginationConnection { "A list of edges." edges: [InsurancePlanEdge] "A list of nodes." nodes: [InsurancePlan] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "The intake flow item" type IntakeFlowItem { "Attached object" attached_object_edit_url: String "The completed onboarding item for the given user id (from args)" completed_onboarding_item: CompletedOnboardingItem "The form to fill out" custom_module_form: CustomModuleForm "The relevant date to show" date_to_show: String "The display name" display_name: String "The id of the filled form that completes the request. Only present if form_type is RequestedForm" form_answer_group_id: String "Form type" form_type: String "The unique idenitifier of the item" id: ID! "Return the ID of the incomplete form" incomplete_form_id: String "The type of item" item_type: String "The onboarding item that was completed" onboarding_item: OnboardingItem "Recurring form related to the request" recurring_form: RecurringForm "The intake flow item request details" request_info: IntakeFlowItemRequestInfo "Skipped" skipped: Boolean "Form status" status: String "Tab type" tab_type: String "Corrected typename of the intake flow item object" typename: String "View url" view_url: String } "The intake flow item request details" type IntakeFlowItemRequestInfo { "Completion date of the form" complete_date: String "User who completed the form" completed_by: User "Info how client received the form" details: String "Requested / Auto-Requested" label: String "Request date of the form" request_date: String "User who requested the form" requested_by: User } "Intake Flow" type IntakeFlowType { "All forms in the intake flow" all_forms: [IntakeFlowItem!] "Completed and skipped forms in the intake flow" completed_skipped: [IntakeFlowItem!] "Forms in the intake flow" forms: [IntakeFlowItem!] "Intake flows" intake_flows: [IntakeFlowItem!] "Not started and incomplete forms in the intake flow" not_started_incomplete: [IntakeFlowItem!] "Requested forms in the intake flow" requested: [IntakeFlowItem!] } "Configuration for the button when the integration is not connected" type IntegrationButtonConfig { href: String payload: JSON text: String! } "Integration Category" type IntegrationCategoryType { "The description of the integration category" description: String "The unique identifier of the category" id: ID! "The name of the integration category" name: String "The list of category options" options: [IntegrationOptionType!] } "Parsed integration details extracted from long_description" type IntegrationDetailsType { "Plan tiers the integration is available for" available_for: [IntegrationPlanTiersType!] "Any additional information below the long description" extra_info: String "The integration fee description" fee: String "The cleaned long description with tags removed" formatted_description: String @deprecated(reason: "This field is being deprecated in favor of structured jsonb data in integration_option") "Whether the integration needs to be setup for the user or if automatically is enabled" is_setup_required: Boolean } "The option of an integration" type IntegrationOptionType { button_not_connected: IntegrationButtonConfig "The name of the status when the option is disabled" disabled_status_name: String "The label of the button to enable the option" enable_button_label: String "The url of the button to enable the option" enable_button_url: String "The name of the status when the option is enabled" enabled_status_name: String "List of connected members" erx_connected_members: [String!] "The unique identifier of the option" id: ID! "The unique identifier of the category the option belongs to" integration_category_id: ID "The details of the option" integration_details: IntegrationDetailsType "Status of the current org's integration request for this option (pending, approved, rejected), or null if none exists" integration_request_status: String "Whether the option is active" is_active: Boolean "Whether the option is pending" is_pending: Boolean "The long description of the option" long_description: String "The name of the option" name: String "Partner type options" partner_type: PartnerType "The short description of the option" short_description: String "The type of the option" type: String } "An internal comment for tracking work on tasks and other objects" type InternalComment { "The content of this comment" content: String! "The date on which the comment was created" created_at: ISO8601DateTime! "Has the comment been edited since it was first created?" edited: Boolean! "The unique identifier of the internal comment" id: ID! "Provider who created the comment" provider: User! "The date on which the comment was last updated" updated_at: ISO8601DateTime! } "An edge in a connection." type InternalCommentEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: InternalComment } "The connection type for InternalComment." type InternalCommentPaginationConnection { "A list of edges." edges: [InternalCommentEdge] "A list of nodes." nodes: [InternalComment] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A single service line from a CMS1500 claim, scoped to fields safe for invoice display" type InvoiceCms1500LineItem { "The CPT procedure code" cpt_code: CptCode "Billed fee per unit" fee: String "Service line identifier" id: ID! "Date the service was rendered" service_date: ISO8601Date "Sum of CO/OA/PI CARC adjustments and manual write-offs (non-patient-responsibility reductions)" total_adjustments: Float! "Sum of all active insurance payments on this line" total_insurance_paid: Float! "Sum of PR-group CARC adjustments — the canonical patient-owed amount per EOB" total_patient_responsibility: Float! "Number of units billed" units: Int } "Options for lab filters" type LabFiltersDataType { "The list of the data clients" clients: [User!] "The list of the labs" labs: [String] "The list of the normalized statuses" normalized_statuses: [String] "The list of the ordering providers" providers: [User!] "The list of the reviewing providers" reviewing_providers: [User!] "The list of the statuses" statuses: [String] } "A lab observation request" type LabObservationRequest { "The unique identifier of the request" id: ID! "The name of the lab analyte" lab_analyte: String "Lab observation results for lab request" lab_observation_results: [LabObservationResult]! } "A lab observation result" type LabObservationResult { "The flag of abnormality in the observation" abnormal_flag: String "The unique identifier of the result" id: ID! "The interpretation of the lab observation result" interpretation: LabOrderInterpretation! "True indicates the result is abnormal" is_abnormal: Boolean "The notes of the lab observation" notes: String "The qualitative result of the lab observation" qualitative_result: String "The quantitative result of the lab observation" quantitative_result: String "The reference range of the lab observation" reference_range: String "The units of the lab observation measurement" units: String } "Lab Option" type LabOption { "The unique identifier of the option" id: ID! "If available, the name of the Lab that offers this option" lab_name: String "If available, markers included in the test will be returned" markers: [LabOptionMarker!] "Name of the option" name: String! "The unique identifier of the option" provider_identifier: ID } "Lab Option Marker" type LabOptionMarker { "A more detailed description of the marker" description: String "The name of the marker" name: String! } "Lab Order Object" type LabOrder { "abnormality in results" abnormal: Boolean "Confirmation Code of Scheduled Appointment" appt_confirmation_code: String "Date Lab Order was Placed" created_at: String! "Pagination cursor" cursor: Cursor! "Get result document" document: Document "The order id for the lab vendor" external_identifier: ID "Associated chart note" form_answer_group: FormAnswerGroup "The unique identifier of the order" id: ID! "Order integration (lab_testing_api, evexia, rupa, vital)" integration: String! "The highest level interpretation of the lab results" interpretation: LabOrderInterpretation! "Name of the lab" lab: String "Name of the lab" lab_company: String "Lab options included in lab order" lab_options: [LabOption!]! "Lab results" lab_results: [LabResult!]! "Timestamp for recording when lab order last received results, if applicable" latest_result_received_at: ISO8601DateTime "Order ID" lta_id: String "The normalized status of the order" normalized_status: String "Provider who ordered lab order" orderer: User "Patient for lab order" patient: User "Get most recent pdf document" pdf_document: Document "The requisition of the order. Contact support for more info." requisition_document: Document "Provider for review of lab order" reviewing_provider: User "Order ID on the rupa health" rupa_order_id: String "Show lab result with PDF document" show_pdf_messages: Boolean "Status of the Lab Order" status: String "Date of Test" test_date: String "Date Lab Order was updated" updated_at: String! "Link to view the rupa order" view_rupa_order_url: String } "Lab Result" type LabResult { "The time the lab result record was created" created_at: ISO8601DateTime! "Document for lab result" document: Document "The unique identifier of the result" id: ID! "The interpretation of the lab result" interpretation: LabOrderInterpretation! "Lab observation requests for lab result" lab_observation_requests: [LabObservationRequest] "The ID of the corresponding lab order" lab_order_id: ID! "Ordering Physician for lab result" ordering_physician: User "Patient for lab result" patient: User "The type of the lab result" result_type: String "The status of the result" status_flag: String } "A line-level insurance payment on a claim service line" type LinePayment { "Date the payer adjudicated this line" adjudication_date: ISO8601Date "Amount the payer allowed on this line" allowed_amount: Float "The unique identifier of the line payment" id: ID! "The payer (insurance plan) identity" insurance_plan: InsurancePlan "CARC adjustments on this payment" line_payment_adjustments: [LinePaymentAdjustment!]! "Free-text notes captured for a manual entry" notes: String "Amount the payer paid on this line" paid_amount: Float! "COB position of the paying payer" payer_responsibility: PayerResponsibility! "Where the payment came from (era or manual)" source: LinePaymentSource! "When the payment was voided (null = active)" voided_at: ISO8601DateTime } "A CARC adjustment on a line payment" type LinePaymentAdjustment { "Claim Adjustment Segment (CAS) group type" adjustment_group: LinePaymentAdjustmentGroup! "Adjusted amount for this CARC" amount: Float! "The unique identifier of the adjustment" id: ID! "CARC reason code (e.g. 45; PR 1/2/3 = deductible/coinsurance/copay)" reason_code: String! } "A payer-balance write-off on a claim service line" type LineWriteOff { "Amount written off" amount: Float! "The unique identifier of the write-off" id: ID! "Free-text notes captured for a manual entry" notes: String "Why the payer balance was written off" reason: LineWriteOffReason! "Where the write-off came from (era or manual)" source: LinePaymentSource! "When the write-off was voided (null = active)" voided_at: ISO8601DateTime } "Link/Unlink type for patient encounter and episode of care" type LinkUnlinkEncounterToEpisodeOfCare { "The unique identifier of the episode of care" episode_of_care_id: ID "Short description if the linking/unlinking failed" failed_reason: String "The unique identifier for the patient encounter" patient_encounter_id: ID "Whether or not the link/unlinking was successful" success: Boolean } "A location" type Location { "The city of the address" city: String "The Country Code of the address" country: String "Pagination cursor" cursor: Cursor! "The unique identifier of the location" id: ID! "The first line of the address" line1: String "The second line of the address" line2: String "The name of the location" name: String "The NPI of the location" npi: String "The Other ID of the location" other_id: String "The Other ID Qualification of the location" other_id_qual: String "The place of service associated with this location" place_of_service: PlaceOfService "The place of service id of the location" place_of_service_id: String "The state of the address (Uses the 2 letter abbreviation if in US)" state: String "The location condensed to a single line" to_oneline: String "Owner of this location" user: User "The ID of the user" user_id: String "The zip/postal code of the address" zip: String } "Structured address data for a `location` form answer" type LocationAnswer { "City" city: String "Country" country: String "Street address line 1" line1: String "Street address line 2" line2: String "State or province" state: String "Postal / zip code" zip: String } "Location resource" type LocationResourceType { "The resource ID" resourceId: String "The resource title" resourceTitle: String } "Autogenerated return type of Lock." type LockPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "A meal that a user has created" type Meal { "Pagination cursor" cursor: Cursor! "The food items that are part of the meal" food_items: [FoodItem!] "The unique identifier of the meal" id: ID! "The name of the meal" name: String "The user that owns the meal" user_id: String } "A meal plan" type MealPlan { "If true, meal plan is active (most recent) on client's Living Plate account" active: Boolean "Date meal plan was added to client's Living Plate account" date_added: String "The unique identifier of the plan" id: ID! "name of the meal plan on Living Plate" name: String "If one exists, name of offering that was purchased that added meal plan to client's Living Plate account" offering_name: String } "Medication query result" type MedicationOptionType { "The dosage options of the medication option" dosage_options: [DosageType] "The dosages of the medication option" dosages: [String!] "The unique identifier of the medication option" id: ID! "The monograph of the medication option" monograph(format: MonographFormat = HTML): String "The name of the medication option" name: String! } "Medication belonging to client" type MedicationType { "Indicates if medication is still active (medication can also be inactive if current date doesn't fall between start and end date)" active: Boolean "CCDA code for this medication" code: String "Comments entered by provider" comment: String "The time the medication was created" created_at: String! "Directions to use medication entered by provider" directions: String "Dosage of medication entered by provider" dosage: String "last date patient should be able to use medication" end_date: String "Frequency of this medication" frequency: String "The unique identifier of the medication" id: ID! "A JSON object of key-value string pairs. Max 50 keys, max key length 40 chars, max value length 2000 chars, max total length 2000 chars." metadata: JSON "If the medication is synchronized with an external system (e.g., an E-Rx system)" mirrored: Boolean! "Name of medication" name: String "National Drug Code (NDC) for this medication" ndc: String "The normalized status of the medication" normalized_status: PrescriptionMedicationStatus "When true, this object must be consolidated as part of a CCDA Ingest" requires_consolidation: Boolean "The way this medication is administered" route: String "RxNorm Concept Unique Identifier (RxCUI) for this medication" rxcui: String "First active date of medication" start_date: String "The last time the medication was updated" updated_at: String "User ID of the client this medication belongs to" user_id: ID } "A data point for a metric" type MetricDataPointType { "The time the data point was created" created_at: String! "The entry id of the data point" entry_id: String "The value of the data point" flex_value: String "The value of the data point" value: Float @deprecated(reason: "Use flex value, which supports both string and number values") } "Metric Graph data" type MetricGraphDataType { """ Category of the metric, e.g. "Weight" or "Steps" """ category: String """ Label for the category, e.g. "Weight" or "Steps" """ category_label: String "Data points for the graph" data_points: [MetricDataPointType!] "False if the category has no entry" has_entry: Boolean "Maximum value of the data points" max: Float "Minimum value of the data points" min: Float """ Type of xtick, e.g. "date" or "time" """ xtick_type: String """ Type of ytick, e.g. "date" or "time" """ ytick_type: String } "Mobile health data integration" type MobileHealthDataIntegration { "ID of the integration" id: ID! "Type of integration" type: MobileHealthDataIntegrationType! } "Mobile health data snapshot" type MobileHealthDataSnapshot { "When the snapshot was created" created_at: ISO8601DateTime! "Current status of the snapshot" current_status: MobileHealthDataSnapshotStatus! "ID of the snapshot" id: ID! "Type of integration" integration_type: MobileHealthDataSnapshotIntegrationType! "ID of the organization" organization_id: ID! "ID of the parent organization" parent_organization_id: ID! "ID of the patient" patient_id: ID! "Presigned S3 URL for uploading snapshot data" s3_object_expiring_url: String "S3 object key for the snapshot data" s3_object_key: String! "When the sync ended" sync_ended_at: ISO8601DateTime! "When the sync started" sync_started_at: ISO8601DateTime! "When the snapshot was last updated" updated_at: ISO8601DateTime! } "Monthly billing items data" type MonthlyBillingItemsDataType { "Amount of monthly billing items" amount: Int "Month the data relates to" month: String } "Multi line metric graph data type" type MultiLineMetricGraphDataType { "Category name" category: String "Category label" category_label: String "False if the category has no entry" has_entry: Boolean "Metric graph data" metric_graph_datas: [MetricGraphDataType!] } "The mutation root of this schema. See available mutations." type Mutation { "Add a pharmacy to the user" addPharmacy(input: addPharmacyInput): addPharmacyPayload "async bulk create OrganizationMemberships for an organization" asyncBulkCreateOrganizationMemberships(input: asyncBulkCreateOrganizationMembershipsInput): asyncBulkCreateOrganizationMembershipsPayload "Apply selected tags on a specific user" bulkApply(input: bulkApplyInput): bulkApplyPayload "Apply care plan to the passed array of clients and/or groups" bulkApplyCarePlanTemplate(input: bulkApplyCarePlanTemplateInput): bulkApplyCarePlanTemplatePayload "bulk create Availability" bulkCreateAvailability(input: bulkCreateAvailabilityInput): bulkCreateAvailabilityPayload "creates bulk Entries (intended for apple health only for the time being)" bulkCreateEntries(input: bulkCreateEntriesInput): bulkCreateEntriesPayload "bulk create OrganizationMemberships for a user" bulkCreateOrganizationMemberships(input: bulkCreateOrganizationMembershipsInput): bulkCreateOrganizationMembershipsPayload "Bulk delete Availability records by IDs. Use with caution. This mutation does not trigger webhooks and bulk deleted availability is not recoverable. ." bulkDeleteAvailability(input: BulkDeleteAvailabilityInput): BulkDeleteAvailabilityPayload "Delete tasks" bulkDeleteTasks(input: bulkDeleteTasksInput): bulkDeleteTasksPayload "Update unseen card issues on a provider" bulkUpdateCardIssues(input: bulkUpdateCardIssuesInput): bulkUpdateCardIssuesPayload "Trigger notification email or care plan activation for each user related to the selected care plans. In case of activation, a group care plan will be activated for each user of user_group(unless a user already have an active care plan). If you want to activate selected care plan for only one user(user of group) use ToggleCarePlanStatusForSpecificUser mutation" bulkUpdateCarePlanUsers(input: bulkUpdateCarePlanUsersInput): bulkUpdateCarePlanUsersPayload "Update multiple clients at once. Will change user group for multiple clients if user_group_id passed, otherwise clients will be archived" bulkUpdateClients(input: bulkUpdateClientsInput): bulkUpdateClientsPayload "Cancels the recurring payment for a patient." cancelRecurringPayment(input: cancelRecurringPaymentInput): cancelRecurringPaymentPayload "disabled devices in video chat" changeDevicesAvailability(input: ChangeDevicesAvailabilityInput): ChangeDevicesAvailabilityPayload "Delete unreconciled allergies/problems/medications" clearUnreconciledObjects(input: clearUnreconciledObjectsInput): clearUnreconciledObjectsPayload "Complete a CCDA Reconciliation, based on user choice" completeCcdaReconciliation(input: CompleteCcdaReconciliationInput): CompleteCcdaReconciliationPayload "Complete the checkout for booking or buying" completeCheckout(input: completeCheckoutInput): completeCheckoutPayload "Create CompletedCourseItem for related document" completeCourseDocument(input: completeCourseDocumentInput): completeCourseDocumentPayload "Converts a generated form answer group to a form answer group" convertGeneratedFormAnswerGroup(input: convertGeneratedFormAnswerGroupInput): convertGeneratedFormAnswerGroupPayload "Copy a Course" copyCourse(input: copyCourseInput): copyCoursePayload "Copy Custom Module" copyCustomModule(input: copyCustomModuleInput): copyCustomModulePayload "copy Custom Module Form" copyCustomModuleForm(input: copyCustomModuleFormInput): copyCustomModuleFormPayload "Copy an Offering" copyOffering(input: copyOfferingInput): copyOfferingPayload "Create Accepted Insurance Plans" createAcceptedInsurancePlan(input: createAcceptedInsurancePlanInput): createAcceptedInsurancePlanPayload "Create a new addendum for the selected charting note" createAddendum(input: createAddendumInput): createAddendumPayload "Creates a new AlertTemplate for the current organization" createAlertTemplate(input: CreateAlertTemplateInput!): CreateAlertTemplatePayload "Create AllergySensitivity" createAllergySensitivity(input: createAllergySensitivityInput): createAllergySensitivityPayload "Create Announcement" createAnnouncement(input: createAnnouncementInput): createAnnouncementPayload "create API Key. This capability needs to be turned on for your account first" createApiKey(input: createApiKeyInput): createApiKeyPayload "Create AppleHealth" createAppleHealth(input: createAppleHealthInput): createAppleHealthPayload "create appointment mutation for providers. Clients use the completeCheckout mutation" createAppointment(input: createAppointmentInput): createAppointmentPayload "Create a connection between a form answer group and an appointment." createAppointmentFormAnswerGroupConnection(input: createAppointmentFormAnswerGroupConnectionInput): createAppointmentFormAnswerGroupConnectionPayload "Create a new appointment request as a part of the booking flow" createAppointmentRequest(input: createAppointmentRequestInput): createAppointmentRequestPayload "create an Appointment Setting" createAppointmentSetting(input: createAppointmentSettingInput): createAppointmentSettingPayload "create Appointment Type" createAppointmentType(input: createAppointmentTypeInput): createAppointmentTypePayload "Create an Appointment Type CPT Code Object" createAppointmentTypeCptCode(input: createAppointmentTypeCptCodeInput): createAppointmentTypeCptCodePayload "Create auto task generator" createAutoTaskGenerator(input: createAutoTaskGeneratorInput): createAutoTaskGeneratorPayload "create automated insurance billing setting" createAutomatedInsuranceBillingSetting(input: createAutomatedInsuranceBillingSettingInput): createAutomatedInsuranceBillingSettingPayload "Create a new automation" createAutomation(input: CreateAutomationInput): CreateAutomationPayload "Create availability" createAvailability(input: createAvailabilityInput): createAvailabilityPayload "Create a one-time availability associated with multiple appointment types" createAvailabilityWithAppointmentTypes(input: CreateAvailabilityWithAppointmentTypesInput!): CreateAvailabilityWithAppointmentTypesPayload @deprecated(reason: "Deprecated. Use createAvailability instead.") "create billing item" createBillingItem(input: createBillingItemInput): createBillingItemPayload "create Brand" createBrand(input: createBrandInput): createBrandPayload "Creates a new Care Alert for a patient" createCareAlert(input: CreateCareAlertInput!): CreateCareAlertPayload "Create and return a care plan" createCarePlan(input: createCarePlanInput): createCarePlanPayload createCarePlanRecommendationCategory(input: createCarePlanRecommendationCategoryInput): createCarePlanRecommendationCategoryPayload "creates ChangeHealth patient record" createChangeHealthPatient(input: CreateChangeHealthPatientInput): CreateChangeHealthPatientPayload "create an Chat Setting" createChatSetting(input: createChatSettingInput): createChatSettingPayload "Create a Client" createClient(input: createClientInput): createClientPayload "Create client restriction authorization" createClientRestrictionAuthorization(input: createClientRestrictionAuthorizationInput): createClientRestrictionAuthorizationPayload "create a client account via a form (e.g a lead capture form) or match to an existing client by name and email. This endpoint is meant to be called unauthenticated. If you want the client to buy or book something at the same time, use the CompleteCheckout mutation." createClientViaForm(input: CreateClientViaFormInput): CreateClientViaFormPayload @deprecated(reason: "Replaced by completeCheckout") "create CMS1500" createCms1500(input: createCms1500Input): createCms1500Payload "Create a CognitiveStatus Object" createCognitiveStatus(input: createCognitiveStatusInput): createCognitiveStatusPayload "create Comment" createComment(input: createCommentInput): createCommentPayload "create CompletedCourseItem" createCompletedCourseItem(input: createCompletedCourseItemInput): createCompletedCourseItemPayload "create CompletedOnboardingItem" createCompletedOnboardingItem(input: createCompletedOnboardingItemInput): createCompletedOnboardingItemPayload "Creates a Contact" createContact(input: createContactInput): createContactPayload "Create a conversation. Maximum of 256 members allowed per conversation." createConversation(input: createConversationInput): createConversationPayload "create Course" createCourse(input: createCourseInput): createCoursePayload "create CourseBenefit" createCourseBenefit(input: createCourseBenefitInput): createCourseBenefitPayload "create CourseItem" createCourseItem(input: createCourseItemInput): createCourseItemPayload "create custom email" createCustomEmail(input: createCustomEmailInput): createCustomEmailPayload "Create a Custom Food" createCustomFood(input: createCustomFoodInput): createCustomFoodPayload "create Custom Module" createCustomModule(input: createCustomModuleInput): createCustomModulePayload "Attach an already uploaded file to a form answer" createCustomModuleFileAttachment(input: CreateCustomModuleFileAttachmentInput): CreateCustomModuleFileAttachmentPayload "Create a pre-signed expiring upload URL for uploading a custom module file attachment." createCustomModuleFileAttachmentUploadUrl(input: CreateCustomModuleFileAttachmentUploadUrlInput): CreateCustomModuleFileAttachmentUploadUrlPayload "create Custom Module Form" createCustomModuleForm(input: createCustomModuleFormInput): createCustomModuleFormPayload "create Document" createDocument(input: createDocumentInput): createDocumentPayload "Copy document and create a draft for editing" createDocumentDraft(input: CreateDocumentDraftInput!): CreateDocumentDraftPayload "Create dosespot clinician" createDosespotClinician(input: createDosespotClinicianInput): createDosespotClinicianPayload "create Draft" createDraft(input: createDraftInput): createDraftPayload "Create a DSI comment" createDsiComment(input: createDsiCommentInput): createDsiCommentPayload "create ebook" createEbook(input: createEbookInput): createEbookPayload "Request AI encounter-summary generation for a locked charting note" createEncounterSummary(input: CreateEncounterSummaryInput!): CreateEncounterSummaryPayload "creates a new Entry" createEntry(input: createEntryInput): createEntryPayload "Create an Episode of Care" createEpisodeOfCare(input: createEpisodeOfCareInput): createEpisodeOfCarePayload "Create an External Calendar" createExternalCalendar(input: createExternalCalendarInput): createExternalCalendarPayload "Create Family History" createFamilyHistory(input: createFamilyHistoryInput): createFamilyHistoryPayload "create Fax Acct Info" createFaxAcctInfo(input: createFaxAcctInfoInput): createFaxAcctInfoPayload "Create and return a fax line request" createFaxLineRequest(input: createFaxLineRequestInput): createFaxLineRequestPayload "Create a FeatureToggle and Return FeatureToggle" createFeatureToggle(input: createFeatureToggleInput): createFeatureTogglePayload "Create Fitbit" createFitbit(input: createFitbitInput): createFitbitPayload "create Folder" createFolder(input: createFolderInput): createFolderPayload "Attach an already uploaded file to a form answer" createFormAnswerFileAttachment(input: createFormAnswerFileAttachmentInput): createFormAnswerFileAttachmentPayload "Create a pre-signed expiring upload URL for uploading a form answer file attachment." createFormAnswerFileAttachmentUploadUrl(input: createFormAnswerFileAttachmentUploadUrlInput): createFormAnswerFileAttachmentUploadUrlPayload "create FormAnswerGroup" createFormAnswerGroup(input: createFormAnswerGroupInput): createFormAnswerGroupPayload "Create FormAnswerGroupSigning" createFormAnswerGroupSigning(input: createFormAnswerGroupSigningInput): createFormAnswerGroupSigningPayload @deprecated(reason: "Use `signFormAnswerGroup` mutation") "Create a Fullscript practitioner account using the Fullscript API" createFullscriptPractitioner(input: createFullscriptPractitionerInput): createFullscriptPractitionerPayload "Create a FunctionalStatus Object" createFunctionalStatus(input: createFunctionalStatusInput): createFunctionalStatusPayload "INTERNAL: persists an AI-generated encounter summary" createGeneratedSummary(input: CreateGeneratedSummaryInput!): CreateGeneratedSummaryPayload "create Goal" createGoal(input: createGoalInput): createGoalPayload "create Goal History" createGoalHistory(input: createGoalHistoryInput): createGoalHistoryPayload "Create GoogleFit" createGoogleFit(input: createGoogleFitInput): createGoogleFitPayload "Create a Group" createGroup(input: createGroupInput): createGroupPayload "Create a HealthConcern Object" createHealthConcern(input: createHealthConcernInput): createHealthConcernPayload "Create an Immunization" createImmunization(input: createImmunizationInput): createImmunizationPayload "Create Implantable Device User association" createImplantableDeviceUser(input: createImplantableDeviceUserInput): createImplantableDeviceUserPayload "Create an import data request" createImportDataRequest(input: createImportDataRequestInput): createImportDataRequestPayload "create an insurance authorization" createInsuranceAuthorization(input: createInsuranceAuthorizationInput): createInsuranceAuthorizationPayload "Create a manual insurance payment" createInsurancePayment(input: createInsurancePaymentInput): createInsurancePaymentPayload "Create Insurance Plan" createInsurancePlan(input: createInsurancePlanInput): createInsurancePlanPayload "Create an internal comment on a task or other commentable object." createInternalComment(input: CreateInternalCommentInput): CreateInternalCommentPayload "Create Lab Order" createLabOrder(input: createLabOrderInput): createLabOrderPayload "Manually post a line-level insurance payment on a claim service line" createLinePayment(input: CreateLinePaymentInput!): CreateLinePaymentPayload "Manually record a payer-balance write-off on a claim service line" createLineWriteOff(input: CreateLineWriteOffInput!): CreateLineWriteOffPayload "create Location" createLocation(input: createLocationInput): createLocationPayload "Create a Meal" createMeal(input: createMealInput): createMealPayload "Create Medication" createMedication(input: createMedicationInput): createMedicationPayload "create Message Blast" createMessageBlast(input: createMessageBlastInput): createMessageBlastPayload "Create a note. Cannot create notes in conversations exceeding 256 members." createNote(input: createNoteInput): createNotePayload "create a Notification Contact" createNotificationContact(input: createNotificationContactInput): createNotificationContactPayload "create offering" createOffering(input: createOfferingInput): createOfferingPayload "Create an Offering Coupon" createOfferingCoupon(input: createOfferingCouponInput): createOfferingCouponPayload "create OfficeallySftpAccount" createOfficeallySftpAccount(input: createOfficeallySftpAccountInput): createOfficeallySftpAccountPayload "create OnboardingFlow" createOnboardingFlow(input: createOnboardingFlowInput): createOnboardingFlowPayload "create OnboardingItem" createOnboardingItem(input: createOnboardingItemInput): createOnboardingItemPayload "creates a new entry or add to existing water intake entry for the day" createOrAddToWaterIntakeEntry(input: createOrAddToWaterIntakeEntryInput): createOrAddToWaterIntakeEntryPayload "create Organization" createOrganization(input: createOrganizationInput): createOrganizationPayload "Create an Organization CPT Code Object" createOrganizationCptCode(input: createOrganizationCptCodeInput): createOrganizationCptCodePayload "create OrganizationMembership" createOrganizationMembership(input: createOrganizationMembershipInput): createOrganizationMembershipPayload "Creates a Partner" createPartner(input: createPartnerInput): createPartnerPayload "Create a Stripe Payment Intent. Currently used for supporting additional payment methods via a custom front-end. When the payment succeeds, Healthie will receive a webhook and automatically complete the checkout." createPaymentIntent(input: createPaymentIntentInput): createPaymentIntentPayload "Create `PdfLetterheadTemplate`" createPdfLetterheadTemplate(input: createPdfLetterheadTemplateInput): createPdfLetterheadTemplatePayload "create Permission Template" createPermissionTemplate(input: createPermissionTemplateInput): createPermissionTemplatePayload "create Personalization Questionnaire" createPersonalizationQuestionnaire(input: createPersonalizationQuestionnaireInput): createPersonalizationQuestionnairePayload "Create favorite CPT/ICD code" createPreferredMedicalCode(input: createPreferredMedicalCodeInput): createPreferredMedicalCodePayload "Create a Procedure Object" createProcedure(input: createProcedureInput): createProcedurePayload "Create a product" createProduct(input: createProductInput): createProductPayload "Create one or more accepted insurance plan associations for a specific provider." createProviderAcceptedInsurancePlans(input: createProviderAcceptedInsurancePlansInput): createProviderAcceptedInsurancePlansPayload "Create ProviderCPTCode Objects" createProviderCptCodes(input: createProviderCptCodesInput): createProviderCptCodesPayload "Create a care plan recommendation" createRecommendation(input: createRecommendationInput): createRecommendationPayload "Create new Referring Physician" createReferral(input: createReferralInput): createReferralPayload "Create new Referring Physician" createReferringPhysician(input: createReferringPhysicianInput): createReferringPhysicianPayload "create requested form, creates the RequestedFormCompletion in the background and returns only a status message unless using the legacy recipient_id argument which returns the created RequestedFormCompletion" createRequestedFormCompletion(input: createRequestedFormInput): createRequestedFormPayload "create requested payment" createRequestedPayment(input: createRequestedPaymentInput): createRequestedPaymentPayload "Create a Rupa order" createRupaOrder(input: createRupaOrderInput): createRupaOrderPayload "Create a new saved filter" createSavedFilter(input: createSavedFilterInput): createSavedFilterPayload "Create a secondary claim from a primary claim for COB submission" createSecondaryClaim(input: CreateSecondaryClaimInput): CreateSecondaryClaimPayload "Create a sent direct message" createSentDirectMessage(input: createSentDirectMessageInput): createSentDirectMessagePayload "create Sent Fax" createSentFax(input: createSentFaxInput): createSentFaxPayload "Create a Stripe Setup Intent. Used for setting up payment methods for future usage without immediately charging." createSetupIntent(input: createSetupIntentInput): createSetupIntentPayload "Create document or folder sharings for clients, providers, and/or groups" createSharings(input: CreateSharingsInput): Shareable "Create a Smart Phrase" createSmartPhrase(input: createSmartPhraseInput): createSmartPhrasePayload "Create a Smoking Status" createSmokingStatus(input: createSmokingStatusInput): createSmokingStatusPayload "Creates a new payment card" createStripeCustomerDetail(input: createStripeCustomerDetailInput): createStripeCustomerDetailPayload "create Subscription" createSubscription(input: createSubscriptionInput): createSubscriptionPayload "create super bill" createSuperBill(input: createSuperBillInput): createSuperBillPayload "Create a custom user tag" createTag(input: createTagInput): createTagPayload "Create a task for provider" createTask(input: createTaskInput): createTaskPayload "Create a UniqueDeviceIdentifier Object" createUniqueDeviceIdentifier(input: createUniqueDeviceIdentifierInput): createUniqueDeviceIdentifierPayload "Creates a Visitor" createVisitor(input: createVisitorInput): createVisitorPayload "Create Webhook" createWebhook(input: createWebhookInput): createWebhookPayload "Create a Write-off" createWriteOff(input: createWriteOffInput): createWriteOffPayload "Destroy Accepted Insurance Plan" deleteAcceptedInsurancePlan(input: deleteAcceptedInsurancePlanInput): deleteAcceptedInsurancePlanPayload "Soft-deletes an AlertTemplate" deleteAlertTemplate(input: DeleteAlertTemplateInput!): DeleteAlertTemplatePayload "Destroy AllergySensitivity" deleteAllergySensitivity(input: deleteAllergySensitivityInput): deleteAllergySensitivityPayload "Destroy Announcement" deleteAnnouncement(input: destroyAnnouncementInput): destroyAnnouncementPayload "Destroy API Key" deleteApiKey(input: deleteApiKeyInput): deleteApiKeyPayload "Destroy AppleHealth" deleteAppleHealth(input: deleteAppleHealthInput): deleteAppleHealthPayload "Delete an Appointment" deleteAppointment(input: deleteAppointmentInput): deleteAppointmentPayload "Remove a form_answer_groups connection to an appointment" deleteAppointmentFormAnswerGroupConnection(input: deleteAppointmentFormAnswerGroupConnectionInput): deleteAppointmentFormAnswerGroupConnectionPayload "Delete an existing appointment request" deleteAppointmentRequest(input: deleteAppointmentRequestInput): deleteAppointmentRequestPayload "Destroy an AppointmentType" deleteAppointmentType(input: deleteAppointmentTypeInput): deleteAppointmentTypePayload "Delete a AppointmentTypeCptCode Object" deleteAppointmentTypeCptCode(input: deleteAppointmentTypeCptCodeInput): deleteAppointmentTypeCptCodePayload "Delete auto task generator" deleteAutoTaskGenerator(input: deleteAutoTaskGeneratorInput): deleteAutoTaskGeneratorPayload "Delete an automation and all nested records" deleteAutomation(input: DeleteAutomationInput): DeleteAutomationPayload "delete Availability" deleteAvailability(input: deleteAvailabilityInput): deleteAvailabilityPayload "Destroy a Billing Item" deleteBillingItem(input: deleteBillingItemInput): deleteBillingItemPayload "Soft-deletes a Care Alert" deleteCareAlert(input: DeleteCareAlertInput!): DeleteCareAlertPayload "Destroy a Care Plan" deleteCarePlan(input: deleteCarePlanInput): deleteCarePlanPayload "Remove connection for related item(document/goal/recommendation)" deleteCarePlanConnection(input: deleteCarePlanConnectionInput): deleteCarePlanConnectionPayload deleteCarePlanRecommendationCategory(input: deleteCarePlanRecommendationCategoryInput): deleteCarePlanRecommendationCategoryPayload "Delete client restriction authorization" deleteClientRestrictionAuthorization(input: deleteClientRestrictionAuthorizationInput): deleteClientRestrictionAuthorizationPayload "Destroy a Cms1500" deleteCms1500(input: deleteCms1500Input): deleteCms1500Payload "Delete a CognitivesStatus Object" deleteCognitiveStatus(input: deleteCognitiveStatusInput): deleteCognitiveStatusPayload "Destroy a Comment" deleteComment(input: deleteCommentInput): deleteCommentPayload "Destroy a Conversation Membership" deleteConversationMembership(input: deleteConversationMembershipInput): deleteConversationMembershipPayload "Destroy a Course" deleteCourse(input: deleteCourseInput): deleteCoursePayload "Destroy a Course Benefit" deleteCourseBenefit(input: deleteCourseBenefitInput): deleteCourseBenefitPayload "Destroy a Course Group" deleteCourseGroup(input: deleteCourseGroupInput): deleteCourseGroupPayload "Destroy a Course Item" deleteCourseItem(input: deleteCourseItemInput): deleteCourseItemPayload "Destroy a Course Membership" deleteCourseMembership(input: deleteCourseMembershipInput): deleteCourseMembershipPayload "Destroy a Custom Email" deleteCustomEmail(input: deleteCustomEmailInput): deleteCustomEmailPayload "Destroy a Custom Food" deleteCustomFood(input: deleteCustomFoodInput): deleteCustomFoodPayload "Destroy an CustomModule" deleteCustomModule(input: deleteCustomModuleInput): deleteCustomModulePayload "Delete a CustomModule file attachment. If the underlying blob is shared by other attachments, only the attachment record is removed. Otherwise, the blob is purged from storage. Requires edit permissions on the CustomModule." deleteCustomModuleFileAttachment(input: DeleteCustomModuleFileAttachmentInput): DeleteCustomModuleFileAttachmentPayload "Destroy an CustomModuleForm" deleteCustomModuleForm(input: deleteCustomModuleFormInput): deleteCustomModuleFormPayload "Destroy Dexcom Connection" deleteDexcomConnection(input: deleteDexcomConnectionInput): deleteDexcomConnectionPayload "Destroy a Document" deleteDocument(input: deleteDocumentInput): deleteDocumentPayload "Destroy a Entry" deleteEntry(input: deleteEntryInput): deleteEntryPayload "Delete an Episode of Care" deleteEpisodeOfCare(input: deleteEpisodeOfCareInput): deleteEpisodeOfCarePayload "Destroy an External Calendar" deleteExternalCalendar(input: deleteExternalCalendarInput): deleteExternalCalendarPayload "Delete a Family History Condition" deleteFamilyHistory(input: deleteFamilyHistoryInput): deleteFamilyHistoryPayload "destroy Fax Acct Info" deleteFaxAcctInfo(input: destroyFaxAcctInfoInput): destroyFaxAcctInfoPayload "Destroy Fitbit" deleteFitbit(input: deleteFitbitInput): deleteFitbitPayload "Destroy a Folder" deleteFolder(input: deleteFolderInput): deleteFolderPayload "Delete a FormAnswer file attachment" deleteFormAnswerFileAttachment(input: deleteFormAnswerFileAttachmentInput): deleteFormAnswerFileAttachmentPayload "Destroy a Form Answer Group" deleteFormAnswerGroup(input: deleteFormAnswerGroupInput): deleteFormAnswerGroupPayload "Destroy FormAnswerGroupSigning" deleteFormAnswerGroupSigning(input: deleteFormAnswerGroupSigningInput): deleteFormAnswerGroupSigningPayload "Delete a FunctionalStatus Object" deleteFunctionalStatus(input: deleteFunctionalStatusInput): deleteFunctionalStatusPayload "Destroy a Goal" deleteGoal(input: deleteGoalInput): deleteGoalPayload "Destroy a Goal GoalHistory" deleteGoalHistory(input: deleteGoalHistoryInput): deleteGoalHistoryPayload "Destroy GoogleFit" deleteGoogleFit(input: deleteGoogleFitInput): deleteGoogleFitPayload "Delete a HealthConcern Object" deleteHealthConcern(input: deleteHealthConcernInput): deleteHealthConcernPayload "Delete an Implantable Device User association" deleteImplantableDeviceUser(input: deleteImplantableDeviceUserInput): deleteImplantableDeviceUserPayload "delete an insurance authorization" deleteInsuranceAuthorization(input: deleteInsuranceAuthorizationInput): deleteInsuranceAuthorizationPayload "Delete Insurance Plan" deleteInsurancePlan(input: deleteInsurancePlanInput): deleteInsurancePlanPayload "Destroy a Location" deleteLocation(input: deleteLocationInput): deleteLocationPayload "Delete a manual insurance payment (soft delete)" deleteManualInsurancePayment(input: deleteManualInsurancePaymentInput): deleteManualInsurancePaymentPayload "Destroy a Meal" deleteMeal(input: deleteMealInput): deleteMealPayload "Destroy Medication" deleteMedication(input: destroyMedicationInput): destroyMedicationPayload "Destroy a Note" deleteNote(input: deleteNoteInput): deleteNotePayload "delete a Notification Contact" deleteNotificationContact(input: deleteNotificationContactInput): deleteNotificationContactPayload "Destroy an Offering" deleteOffering(input: deleteOfferingInput): deleteOfferingPayload "Destroy an Offering Coupon" deleteOfferingCoupon(input: deleteOfferingCouponInput): deleteOfferingCouponPayload "Destroy a OnboardingFlow" deleteOnboardingFlow(input: deleteOnboardingFlowInput): deleteOnboardingFlowPayload "Destroy a OnboardingItem" deleteOnboardingItem(input: deleteOnboardingItemInput): deleteOnboardingItemPayload "Delete a OrganizationCptCode Object" deleteOrganizationCptCode(input: deleteOrganizationCptCodeInput): deleteOrganizationCptCodePayload "Destroy an organization info" deleteOrganizationInfo(input: deleteOrganizationInfoInput): deleteOrganizationInfoPayload "Destroy a Organization Membership" deleteOrganizationMembership(input: deleteOrganizationMembershipInput): deleteOrganizationMembershipPayload @deprecated(reason: "Organization Memberships Cannot Be Destroyed") "delete Permission Template" deletePermissionTemplate(input: deletePermissionTemplateInput): deletePermissionTemplatePayload "Delete favorite CPT/ICD code" deletePreferredMedicalCode(input: deletePreferredMedicalCodeInput): deletePreferredMedicalCodePayload "Delete a Procedure Object" deleteProcedure(input: deleteProcedureInput): deleteProcedurePayload "Delete a product" deleteProduct(input: deleteProductInput): deleteProductPayload "Delete an existing provider accepted insurance plan" deleteProviderAcceptedInsurancePlan(input: deleteProviderAcceptedInsurancePlanInput): deleteProviderAcceptedInsurancePlanPayload "Delete a ProviderCptCode Object" deleteProviderCptCode(input: deleteProviderCptCodeInput): deleteProviderCptCodePayload "Destroy a received fax" deleteReceivedFax(input: deleteReceivedFaxInput): deleteReceivedFaxPayload "Destroy a care plan recommendation" deleteRecommendation(input: deleteRecommendationInput): deleteRecommendationPayload "Delete recurring form request" deleteRecurringForm(input: destroyRecurringFormInput): destroyRecurringFormPayload "Delete referral" deleteReferral(input: deleteReferralInput): deleteReferralPayload "Delete referring physician" deleteReferringPhysician(input: deleteReferringPhysicianInput): deleteReferringPhysicianPayload "Destroy a requested form" deleteRequestedFormCompletion(input: deleteRequestedFormInput): deleteRequestedFormPayload "destroy requested payment" deleteRequestedPayment(input: deleteRequestedPaymentInput): deleteRequestedPaymentPayload "Delete a saved filter" deleteSavedFilter(input: deleteSavedFilterInput): deleteSavedFilterPayload "Destroy Shapa Connection" deleteShapaConnection(input: deleteShapaConnectionInput): deleteShapaConnectionPayload "Destroy document or folder sharings for clients, providers, and/or groups" deleteSharings(input: DestroySharingsInput): Shareable "Destroy a Smart Phrase" deleteSmartPhrase(input: deleteSmartPhraseInput): deleteSmartPhrasePayload "Delete a Smoking Status" deleteSmokingStatus(input: deleteSmokingStatusInput): deleteSmokingStatusPayload "Deletes a payment card" deleteStripeCustomerDetail(input: deleteStripeCustomerDetailInput): deleteStripeCustomerDetailPayload "Destroy a Super Bill" deleteSuperBill(input: deleteSuperBillInput): deleteSuperBillPayload "Delete a custom user tag" deleteTag(input: deleteTagInput): deleteTagPayload "Destroy a task" deleteTask(input: deleteTaskInput): deleteTaskPayload "Delete a transcript (realtime capture or processed recording)" deleteTranscript(input: DeleteTranscriptInput): DeleteTranscriptPayload "Delete a UniqueDeviceIdentifier Object" deleteUniqueDeviceIdentifier(input: deleteUniqueDeviceIdentifierInput): deleteUniqueDeviceIdentifierPayload "Delete a Group" deleteUserGroup(input: deleteUserGroupInput): deleteUserGroupPayload "Destroy Webhook" deleteWebhook(input: deleteWebhookInput): deleteWebhookPayload "Destroy Withings Connection" deleteWithingsConnection(input: deleteWithingsConnectionInput): deleteWithingsConnectionPayload "Delete a write-off" deleteWriteOff(input: deleteWriteOffInput): deleteWriteOffPayload "Delete a Zoom Recording File either via ID OR appointment and file ID" deleteZoomRecordingFile(input: deleteZoomRecordingFileInput): deleteZoomRecordingFilePayload "Destroy an internal comment on a task or other commentable object." destroyInternalComment(input: DestroyInternalCommentInput): DestroyInternalCommentPayload "Delete `PdfLetterheadTemplate`" destroyPdfLetterheadTemplate(input: destroyPdfLetterheadTemplateInput): destroyPdfLetterheadTemplatePayload "Dismiss All Announcements For A User" dismissAllAnnouncements(input: dismissAllAnnouncementsInput): dismissAllAnnouncementsPayload "Dismiss Announcement" dismissAnnouncement(input: dismissAnnouncementInput): dismissAnnouncementPayload "edit Availability" editAvailability(input: editAvailabilityInput): editAvailabilityPayload "Edit a one-time availability associated with multiple appointment types" editAvailabilityWithAppointmentTypes(input: EditAvailabilityWithAppointmentTypesInput!): EditAvailabilityWithAppointmentTypesPayload @deprecated(reason: "Deprecated. Use editAvailability instead.") "Expires the webhook signature" expireWebhookSignature(input: expireWebhookSignatureInput): expireWebhookSignaturePayload "Creates a template from existing Care Plan. Original object is not touched" exportCarePlanToTemplate(input: exportToTemplateInput): exportToTemplatePayload "Export Client EHI data" exportClientEhi(input: exportClientEhiInput): exportClientEhiPayload "Generate a Frontegg activation link for E2E test user activation. Non-production only." generateActivationLink(input: GenerateActivationLinkInput!): GenerateActivationLinkPayload "Generate a PDF of charting notes for a client" generateChartingPdf(input: generateChartingPdfInput): generateChartingPdfPayload "Sign up Healthie User in the Health Assessment Service" healthAssessmentServiceSignup(input: HealthAssessmentServiceSignupInput): HealthAssessmentServiceSignupPayload @deprecated(reason: "Deprecated, do not use") "ingest med history from surescripts" ingestMedicationsFromSurescripts(input: ingestMedicationsFromSurescriptsInput): ingestMedicationsFromSurescriptsPayload "Link patient encounter(s) to an Episode of Care" linkEncounterToEpisodeOfCare(input: linkEncounterToEpisodeOfCareInput): linkEncounterToEpisodeOfCarePayload "Lock `FormAnswerGroup`" lockFormAnswerGroup(input: LockInput): LockPayload "Log that a patient has consented to having their medication history pulled via Surescripts/Dosespot" logMedicationHistoryConsent(input: logMedicationHistoryConsentInput): logMedicationHistoryConsentPayload "all data related to the merging account (form answers, billing items, charting notes, etc) will be associated with the selected account after merging. The selected account's client profile information will remain unchanged (name, DOB, etc)" mergeClients(input: mergeClientsInput): mergeClientsPayload "Import client from a CCDA file" parseCcdaDocument(input: parseCcdaDocumentInput): parseCcdaDocumentPayload "Pause a course group, bulk-pausing all active member enrollments" pauseCourseGroup(input: PauseCourseGroupInput!): PauseCourseGroupPayload "Pause a client's program enrollment" pauseCourseMembership(input: PauseCourseMembershipInput!): PauseCourseMembershipPayload "Publish a draft document draft with annotations applied to file" publishDocumentDraft(input: PublishDocumentDraftInput!): PublishDocumentDraftPayload "refetch ChangeHealth Lab Orders for a specified patient" refetchChangeHealthLabOrder(input: RefetchChangeHealthLabOrderInput): RefetchChangeHealthLabOrderPayload "Rejects an AI-generated form answer group" rejectGeneratedFormAnswerGroup(input: rejectGeneratedFormAnswerGroupInput): rejectGeneratedFormAnswerGroupPayload "Remove applied tag on a specific user" removeAppliedTag(input: removeAppliedTagInput): removeAppliedTagPayload "remove Draft" removeDraft(input: removeDraftInput): removeDraftPayload "Remove group care plan user connection for a specific user" removeUserFromGroupCarePlan(input: removeUserFromGroupCarePlanInput): removeUserFromGroupCarePlanPayload "Send an email asking support to enable a given integration." requestIntegration(input: RequestIntegrationInput): RequestIntegrationPayload "resend Sent Fax" resendSentFax(input: resendSentFaxInput): resendSentFaxPayload "Set system default `PdfLetterheadTemplate` for current_user's organization" resetDefaultPdfLetterheadTemplate(input: resetDefaultPdfLetterheadTemplateInput): resetDefaultPdfLetterheadTemplatePayload "Unenrolls the user from multi-factor authentication (MFA), removing their current MFA devices and requiring them to re-enroll if MFA is enforced. Requires permission to edit the target user." resetMfa(input: ResetMfaInput): ResetMfaPayload "send the human a password reset email" resetPassword(input: resetPasswordInput): resetPasswordPayload "Resume a paused course group, bulk-resuming all paused member enrollments" resumeCourseGroup(input: ResumeCourseGroupInput!): ResumeCourseGroupPayload "Resume a paused program enrollment" resumeCourseMembership(input: ResumeCourseMembershipInput!): ResumeCourseMembershipPayload "Resync existed rupa lab orders data for a specific rupa connection of the current user" resyncRupaLabOrders(input: resyncRupaLabOrdersInput): resyncRupaLabOrdersPayload "revoke token or API key." revokeToken(input: revokeTokenInput): revokeTokenPayload "Run an eligibility check on a policy" runEligibilityCheck(input: runEligibilityCheckMutationInput): runEligibilityCheckMutationPayload "Trigger care plan email for given client" sendCarePlanEmail(input: sendCarePlanEmailInput): sendCarePlanEmailPayload "Send the trainer an email that the client wants to speak to them" sendSpeakToTrainerNotification(input: SendSpeakToTrainerNotificationInput): SendSpeakToTrainerNotificationPayload @deprecated(reason: "Deprecated, do not use") "Sends a test webhook to the specified URL" sendTestWebhook(input: sendTestWebhookInput): sendTestWebhookPayload "Set or clear form-level AI Scribe instructions on a charting CustomModuleForm." setCustomModuleFormScribeInstructions(input: SetCustomModuleFormScribeInstructionsInput!): SetCustomModuleFormScribeInstructionsPayload "Set `PdfLetterheadTemplate` default for the org" setDefaultPdfLetterheadTemplate(input: setDefaultPdfLetterheadTemplateInput): setDefaultPdfLetterheadTemplatePayload "Add form answer group answers as document viewable by client" shareAnswersAsDocument(input: shareAnswersAsDocumentInput): shareAnswersAsDocumentPayload "share Course with another provider" shareCourse(input: shareCourseInput): shareCoursePayload "share Custom Module Form" shareCustomModuleForm(input: shareCustomModuleFormInput): shareCustomModuleFormPayload "Sign `FormAnswerGroup`" signFormAnswerGroup(input: SignInput): SignPayload "SignIn" signIn(input: signInInput): signInPayload "Sign up" signUp(input: signUpInput): signUpPayload "Submit secondary claims with COB data to ClaimMD" submitSecondaryClaim(input: SubmitSecondaryClaimInput): SubmitSecondaryClaimPayload "Deactivate/activate a group/single Care Plan for a given user" toggleCarePlanStatusForSpecificUser(input: toggleCarePlanStatusForSpecificUserInput): toggleCarePlanStatusForSpecificUserPayload "Unlink patient encounter(s) from an Episode of Care" unlinkEncounterToEpisodeOfCare(input: unlinkEncounterToEpisodeOfCareInput): unlinkEncounterToEpisodeOfCarePayload "Unlock `FormAnswerGroup`" unlockFormAnswerGroup(input: UnlockInput): UnlockPayload "Update a Notification Setting to unsubscribe from a specific notification type" unsubscribeFromNotification(input: unsubscribeFromNotificationInput): unsubscribeFromNotificationPayload "THIS MUTATION DOES NOTHING, AND SHOULD NOT BE USED." updateAddendum(input: updateAddendumInput): updateAddendumPayload @deprecated(reason: "Deprecated. Does nothing") "Updates an existing AlertTemplate" updateAlertTemplate(input: UpdateAlertTemplateInput!): UpdateAlertTemplatePayload "Update AllergySensitivity" updateAllergySensitivity(input: updateAllergySensitivityInput): updateAllergySensitivityPayload "Update Announcement" updateAnnouncement(input: updateAnnouncementInput): updateAnnouncementPayload "Update AppleHealth" updateAppleHealth(input: updateAppleHealthInput): updateAppleHealthPayload "Update the Appointment" updateAppointment(input: updateAppointmentInput): updateAppointmentPayload "Update the appointment linked to a form answer group." updateAppointmentFormAnswerGroupConnection(input: UpdateAppointmentFormAnswerGroupConnectionInput!): UpdateAppointmentFormAnswerGroupConnectionPayload "Update AppointmentInclusion" updateAppointmentInclusion(input: updateAppointmentInclusionInput): updateAppointmentInclusionPayload "Update an existing appointment request" updateAppointmentRequest(input: updateAppointmentRequestInput): updateAppointmentRequestPayload "update Appointment Setting" updateAppointmentSetting(input: updateAppointmentSettingInput): updateAppointmentSettingPayload "Update an Appointment Type and return Appointment Type" updateAppointmentType(input: updateAppointmentTypeInput): updateAppointmentTypePayload "Update a AppointmentTypeCptCode Object" updateAppointmentTypeCptCode(input: updateAppointmentTypeCptCodeInput): updateAppointmentTypeCptCodePayload "Update auto task generator" updateAutoTaskGenerator(input: updateAutoTaskGeneratorInput): updateAutoTaskGeneratorPayload "update automated insurance billing setting" updateAutomatedInsuranceBillingSetting(input: updateAutomatedInsuranceBillingSettingInput): updateAutomatedInsuranceBillingSettingPayload "Update an existing automation" updateAutomation(input: UpdateAutomationInput): UpdateAutomationPayload "Update a BillingItem" updateBillingItem(input: updateBillingItemInput): updateBillingItemPayload "Update a Brand and return Brand" updateBrand(input: updateBrandInput): updateBrandPayload "Update Care Plan by Care Plan Template" updateByTemplate(input: updateByTemplateInput): updateByTemplatePayload "Update and return calendar view setting" updateCalendarViewSetting(input: updateCalendarViewSettingInput): updateCalendarViewSettingPayload "Update Calorie Levels in the Health Assessment Service" updateCalorieLevel(input: UpdateCalorieLevelInput): UpdateCalorieLevelPayload @deprecated(reason: "Deprecated, do not use") "Updates an existing Care Alert" updateCareAlert(input: UpdateCareAlertInput!): UpdateCareAlertPayload "Update and return a Care Plan" updateCarePlan(input: updateCarePlanInput): updateCarePlanPayload updateCarePlanRecommendationCategory(input: updateCarePlanRecommendationCategoryInput): updateCarePlanRecommendationCategoryPayload "Update ChangeHealthAccount (used for Labs)" updateChangeHealthAccount(input: updateChangeHealthAccountInput): updateChangeHealthAccountPayload "Update ChargeBack" updateChargeBack(input: updateChargeBackInput): updateChargeBackPayload "update Chat Setting" updateChatSetting(input: updateChatSettingInput): updateChatSettingPayload "Update Client" updateClient(input: updateClientInput): updateClientPayload "update CMS1500" updateCms1500(input: updateCms1500Input): updateCms1500Payload "Update a CognitiveStatus Object" updateCognitiveStatus(input: updateCognitiveStatusInput): updateCognitiveStatusPayload "Update a conversation and return the conversation. Maximum of 256 members allowed per conversation." updateConversation(input: updateConversationInput): updateConversationPayload "Update a ConversationMembership and return ConversationMembership" updateConversationMembership(input: updateConversationMembershipInput): updateConversationMembershipPayload "Update a Course" updateCourse(input: updateCourseInput): updateCoursePayload "update a Course Group" updateCourseGroup(input: updateCourseGroupInput): updateCourseGroupPayload "Update a CourseItem" updateCourseItem(input: updateCourseItemInput): updateCourseItemPayload "update a Course Membership" updateCourseMembership(input: updateCourseMembershipInput): updateCourseMembershipPayload "Update a Custom Email" updateCustomEmail(input: updateCustomEmailInput): updateCustomEmailPayload "Update a Custom Food" updateCustomFood(input: updateCustomFoodInput): updateCustomFoodPayload "Update an Custom Module and return Custom Module" updateCustomModule(input: updateCustomModuleInput): updateCustomModulePayload "Update an Custom Module Form and return Custom Module Form" updateCustomModuleForm(input: updateCustomModuleFormInput): updateCustomModuleFormPayload "Update a Document and return Document" updateDocument(input: updateDocumentInput): updateDocumentPayload "Update a document draft with annotations and refreshed lock" updateDocumentDraft(input: UpdateDocumentDraftInput!): UpdateDocumentDraftPayload "Update a DSI comment" updateDsiComment(input: updateDsiCommentInput): updateDsiCommentPayload "Updates an Entry and returns an Entry" updateEntry(input: updateEntryInput): updateEntryPayload "Update an Episode of Care" updateEpisodeOfCare(input: updateEpisodeOfCareInput): updateEpisodeOfCarePayload "Update an External Calendar" updateExternalCalendar(input: updateExternalCalendarInput): updateExternalCalendarPayload "Update Family History" updateFamilyHistory(input: updateFamilyHistoryInput): updateFamilyHistoryPayload "update Fax Acct Info" updateFaxAcctInfo(input: updateFaxAcctInfoInput): updateFaxAcctInfoPayload "Update a FeatureToggle and Return FeatureToggle" updateFeatureToggle(input: updateFeatureToggleInput): updateFeatureTogglePayload "Update Fitbit" updateFitbit(input: updateFitbitInput): updateFitbitPayload "Update a Folder and return Folder" updateFolder(input: updateFolderInput): updateFolderPayload "update FormAnswerGroup" updateFormAnswerGroup(input: updateFormAnswerGroupInput): updateFormAnswerGroupPayload "Update a FunctionalStatus Object" updateFunctionalStatus(input: updateFunctionalStatusInput): updateFunctionalStatusPayload "Updates feedback for an AI-generated form answer group" updateGeneratedFormAnswerGroupFeedback(input: updateGeneratedFormAnswerGroupFeedbackInput): updateGeneratedFormAnswerGroupFeedbackPayload "Update the text of a generated summary" updateGeneratedSummary(input: UpdateGeneratedSummaryInput!): UpdateGeneratedSummaryPayload "Update a Goal" updateGoal(input: updateGoalInput): updateGoalPayload "Update GoogleFit" updateGoogleFit(input: updateGoogleFitInput): updateGoogleFitPayload "Updates the care plan status for groups" updateGroupCarePlan(input: updateGroupCarePlanInput): updateGroupCarePlanPayload "Update a HealthConcern Object" updateHealthConcern(input: updateHealthConcernInput): updateHealthConcernPayload "Update a Human" updateHuman(input: updateHumanInput): updateHumanPayload "Update an Immunization and return Immunization" updateImmunization(input: updateImmunizationInput): updateImmunizationPayload "Update Implantable Device User association" updateImplantableDeviceUser(input: updateImplantableDeviceUserInput): updateImplantableDeviceUserPayload "update an insurance authorization" updateInsuranceAuthorization(input: updateInsuranceAuthorizationInput): updateInsuranceAuthorizationPayload "Update the deposit status of an insurance payment" updateInsurancePaymentDepositStatus(input: updateInsurancePaymentDepositStatusInput): updateInsurancePaymentDepositStatusPayload "Update Insurance Plan" updateInsurancePlan(input: updateInsurancePlanInput): updateInsurancePlanPayload "Update an internal comment on a task or other commentable object. Only usable by the comment author." updateInternalComment(input: UpdateInternalCommentInput): UpdateInternalCommentPayload "Update Lab Order" updateLabOrder(input: updateLabOrderInput): updateLabOrderPayload "update Location" updateLocation(input: updateLocationInput): updateLocationPayload "Update Macronutrient Split in the Health Assessment Service" updateMacronutrientSplit(input: UpdateMacronutrientSplitInput): UpdateMacronutrientSplitPayload @deprecated(reason: "Deprecated, do not use") "Update a manual insurance payment" updateManualInsurancePayment(input: updateManualInsurancePaymentInput): updateManualInsurancePaymentPayload "Update a Meal" updateMeal(input: updateMealInput): updateMealPayload "Update Medication" updateMedication(input: updateMedicationInput): updateMedicationPayload "Update a Note" updateNote(input: updateNoteInput): updateNotePayload "Update a Note Scheduler and return NoteSchedulerType" updateNoteScheduler(input: updateNoteSchedulerInput): updateNoteSchedulerPayload "update a notification" updateNotification(input: updateNotificationInput): updateNotificationPayload "Update a Notification Contact" updateNotificationContact(input: updateNotificationContactInput): updateNotificationContactPayload "Update multiple notification records at once" updateNotificationRecords(input: bulkUpdateNotificationRecordsInput): bulkUpdateNotificationRecordsPayload "Update a Notification Setting and return Notification Setting" updateNotificationSetting(input: updateNotificationSettingInput): updateNotificationSettingPayload "update multiple notifications at once" updateNotifications(input: bulkUpdateNotificationsInput): bulkUpdateNotificationsPayload "Update an Offering" updateOffering(input: updateOfferingInput): updateOfferingPayload "update OfficeallySftpAccount" updateOfficeallySftpAccount(input: updateOfficeallySftpAccountInput): updateOfficeallySftpAccountPayload "Update a OnboardingFlow and return OnboardingFlow" updateOnboardingFlow(input: updateOnboardingFlowInput): updateOnboardingFlowPayload "Update a OnboardingItem and return OnboardingItem" updateOnboardingItem(input: updateOnboardingItemInput): updateOnboardingItemPayload "Update Organization" updateOrganization(input: updateOrganizationInput): updateOrganizationPayload "Update an organization configuration" updateOrganizationConfiguration(input: UpdateOrganizationConfigurationInput!): UpdateOrganizationConfigurationPayload "Update a OrganizationCptCode Object" updateOrganizationCptCode(input: updateOrganizationCptCodeInput): updateOrganizationCptCodePayload "Update org members" updateOrganizationMember(input: updateOrganizationMemberInput): updateOrganizationMemberPayload "Update a OrganizationMembership" updateOrganizationMembership(input: updateOrganizationMembershipInput): updateOrganizationMembershipPayload updateOrganizationUiConfiguration(input: UpdateUiConfigurationInput): UpdateUiConfigurationPayload "Update `PdfLetterheadTemplate`" updatePdfLetterheadTemplate(input: updatePdfLetterheadTemplateInput): updatePdfLetterheadTemplatePayload "update Permission Template" updatePermissionTemplate(input: updatePermissionTemplateInput): updatePermissionTemplatePayload "Update a policy" updatePolicy(input: updatePolicyMutationInput): updatePolicyMutationPayload "Update a Procedure Object" updateProcedure(input: updateProcedureInput): updateProcedurePayload "Update a product" updateProduct(input: updateProductInput): updateProductPayload "Update ProviderCptCode Objects" updateProviderCptCodes(input: updateProviderCptCodesInput): updateProviderCptCodesPayload "Update a Received Direct Message" updateReceivedDirectMessage(input: updateReceivedDirectMessageInput): updateReceivedDirectMessagePayload "update a received fax" updateReceivedFax(input: updateReceivedFaxInput): updateReceivedFaxPayload "Update a care plan recommendation" updateRecommendation(input: updateRecommendationInput): updateRecommendationPayload "update a recurring form" updateRecurringForm(input: updateRecurringFormInput): updateRecurringFormPayload "Update Referral" updateReferral(input: updateReferralInput): updateReferralPayload "Update Referring Physician" updateReferringPhysician(input: updateReferringPhysicianInput): updateReferringPhysicianPayload "update requested payment" updateRequestedPayment(input: updateRequestedPaymentInput): updateRequestedPaymentPayload "Update an existing saved filter" updateSavedFilter(input: updateSavedFilterInput): updateSavedFilterPayload "Update COB overrides on a secondary claim" updateSecondaryClaim(input: UpdateSecondaryClaimInput): UpdateSecondaryClaimPayload "Update a Smart Phrase" updateSmartPhrase(input: updateSmartPhraseInput): updateSmartPhrasePayload "Update a Smoking Status" updateSmokingStatus(input: updateSmokingStatusInput): updateSmokingStatusPayload "Archive/Unarchive a Course" updateState(input: updateStateInput): updateStatePayload "Updates a payment card" updateStripeCustomerDetail(input: updateStripeCustomerDetailInput): updateStripeCustomerDetailPayload "Update Stripe Verification Details" updateStripeVerificationDetails(input: updateStripeVerificationDetailsInput): updateStripeVerificationDetailsPayload "update Subscription" updateSubscription(input: updateSubscriptionInput): updateSubscriptionPayload "Update a SuperBill" updateSuperBill(input: updateSuperBillInput): updateSuperBillPayload "Update a custom user tag" updateTag(input: updateTagInput): updateTagPayload "Update a task for provider" updateTask(input: updateTaskInput): updateTaskPayload "Bulk update multiple tasks with completion status, seen status, and filtering options. Can update all tasks matching filters or specific tasks by ID." updateTasksBulk(input: bulkUpdateTasksInput): bulkUpdateTasksPayload "Update a UniqueDeviceIdentifier Object" updateUniqueDeviceIdentifier(input: updateUniqueDeviceIdentifierInput): updateUniqueDeviceIdentifierPayload "Update the current user, or a patient that the current user has access to. To update other org members, use updateOrganizationMembership" updateUser(input: updateUserInput): updateUserPayload "Updates the appointment pricing for this user" updateUserAppointmentPricing(input: updateUserAppointmentPricingInput): updateUserAppointmentPricingPayload "Update a Group" updateUserGroup(input: updateUserGroupInput): updateUserGroupPayload "Update Webhook" updateWebhook(input: updateWebhookInput): updateWebhookPayload "Update a Write-off" updateWriteOff(input: updateWriteOffInput): updateWriteOffPayload "Upload a CMS1500 batch to CandidHealth" uploadBatchToCandidHealth(input: uploadBatchToCandidHealthInput): uploadBatchToCandidHealthPayload "Upload a CMS1500 batch to ChangeHealth" uploadBatchToChangeHealth(input: uploadBatchToChangeHealthInput): uploadBatchToChangeHealthPayload @deprecated(reason: "ChangeHealth claims integration has been discontinued.") "Upload a CMS1500 batch to OfficeAlly" uploadBatchToOfficeally(input: uploadBatchToOfficeallyInput): uploadBatchToOfficeallyPayload "Upload a CMS1500 to integrations: ChangeHealth, OfficeAlly, CandidHealth" uploadCms1500sToIntegrations(input: uploadToIntegrationsInput): uploadToIntegrationsPayload "Verify 2FA code for Human" validateVerificationToken(input: validateVerificationTokenInput): validateVerificationTokenPayload "Void (soft-delete) a line-level insurance payment" voidLinePayment(input: VoidLinePaymentInput!): VoidLinePaymentPayload "Void (soft-delete) a payer-balance write-off on a claim service line" voidLineWriteOff(input: VoidLineWriteOffInput!): VoidLineWriteOffPayload } "A record of a DoseSpot Narx check" type NarxCheck { "The provider who initiated the Narx check retrieval" provider: User! "When the Narx check was performed" timestamp: ISO8601DateTime! } "Chat message object" type Note { "url for note audio" attached_audio_url: String "url for note image" attached_image_url: String "note content" content: String "conversation id" conversation_id: ID "The time at which this note was created" created_at: String! "User who created note" creator: User "Display name of the creator based on conversation type and user permissions" creator_display_name: String "Pagination cursor" cursor: Cursor! "True if this note deleted by a user" deleted_by_user: Boolean! "id for note document" document_id: ID "Name of attached document" document_name: String "The unique identifier of the note" id: ID! "Name of attached image" image_name: String "True if this note is using as auto response message" is_autoresponse: Boolean! "A User which created a Note on behalf of a Conversation Owner" on_behalf_user: User "receiver of note" recipient_id: ID @deprecated(reason: "Use conversation_memberships of conversation instead") "Scheduled sent at" scheduled_at: String "The conversation id associated with the note scheduler of a note, if any" scheduled_conversation_id: ID "Get associated task with a chat message" task: Task "The time at which this note was updated or marked as deleted by a user" updated_at: String! "creator of note" user_id: ID "conditional to see if user recipient viewed note. In community chats, you need to pass in a viewer_id" viewed(viewer_id: ID): Boolean } "Scheduled chat notes" type NoteScheduler { "Scheduled messsage blast: get first four users" first_four_invitees: [User!]! "The unique identifier of the scheduler" id: ID! "Scheduled messsage blast: get all invitees" invitees: [User!]! "The number of invitees" invitees_count: Int "Get last conversation task" last_task: Task "The note" note: Note "The content of the note" note_content: String "Get all directly selected user ids" participant_ids: [ID] "Get all directly selected user groups" selected_user_groups: [UserGroup!] "Get all directly selected users" selected_users: [User!] "The date and time when the scheduler was last updated." updated_at: String! "Owner user of a note scheduler" user: User } "A notification" type Notification { "returns the associated entry if type is EntryNotification, otherwise, nil" associated_entry: Entry "The id of the object associated with the notification" associated_object: String "The creation time of the notification" created_at: String! "creator name of this notification" creator_user_name: String "Pagination cursor" cursor: Cursor! "The unique identifier of the notification" id: ID! "The link that the notification goes to" link: String "The full link that the notification goes to" link_string: String "The message body of the notification" message: String "recipient of this notification" other_party: User "The recipient of the notification" other_party_id: String "This turns to true if the user clicks on the notification" read: String "This turns to true if the user loads the notification" seen: Boolean! "The type of notification" type: String "creator of this notification" user: User "The creator of the notification" user_id: String } "A notification contact" type NotificationContact { "Has personal client portal access" client_portal_access: Boolean! "Client portal settings" client_portal_setting: ClientPortalSetting "contact type" contact_type: String "should a notifications of user be copied to contact" copy_notifications: Boolean! "contact email" email: String "is emergency contact" emergency: Boolean! "first name of a contact" first_name: String "full legal name with preferred" full_legal_name_with_preferred: String "full name of a contact" full_name: String "The unique identifier of the contact" id: ID! "last name of a contact" last_name: String "Linked user to notification contact" linked_client: User "ID of the linked user account" linked_client_id: String "contact phone number" phone_number: String "relationship between contact and user" relationship: String "Date notification contact was last updated" updated_at: String! "Owner of this notification contact" user: User "user id" user_id: ID } "An object containing the users preferences on notification" type NotificationSetting { "The unique identifier of the setting" id: ID! "An option of receiving updates and special offers [email/sms]" marketing_communcation_preference: String! @deprecated(reason: "Use `marketing_communication_preference` instead") "An option of receiving updates and special offers [email/sms]" marketing_communication_preference: String "Send an email when a course module is completed" notification_on_module_completion: Boolean! "Receive updates and special offers" receive_updates_and_offers: Boolean! "Get an email whenever a client posts a comment" send_comment_emails: Boolean "Get a push notification when there is a new comment" send_comment_push: Boolean "Send an email when a client completes a program" send_course_complete_email: Boolean "Send an email 5 minutes before the appointment" send_email_before_appointment: Boolean "Send an email when a new appointment is booked" send_email_on_appointment_book: Boolean "Send an email when an appointment is cancelled" send_email_on_appointment_cancel: Boolean "Send an email when an appointment is rescheduled" send_email_on_appointment_reschedule: Boolean "Get an email whenever client creates an appointment request for anyone in the organization" send_email_on_appt_request_for_anyone: Boolean "Get an email whenever client creates an appointment request for you" send_email_on_appt_request_for_you: Boolean "Send an email to provider when client has been assigned" send_email_on_client_has_been_assigned_to_you: Boolean "Get an email when fax delivery fails" send_email_on_fax_delivery_failure: Boolean "Get an email when a fax is received" send_email_on_fax_received: Boolean "Get an email if client completed an intake flow" send_email_on_intake_flow_complete: Boolean "Get an email if client completed an intake flow item" send_email_on_intake_flow_item_complete: Boolean "Get an email if client started an intake flow" send_email_on_intake_flow_start: Boolean "Get an email when a new document is uploaded" send_email_on_new_document: Boolean "Get an email when a new folder is created" send_email_on_new_folder: Boolean "Send an email when a client purchases a package" send_email_on_package_purchase: Boolean "Get an email when a scheduled payment fails" send_email_on_scheduled_payment_failed: Boolean "Send an email to primary account holder when subscription payment is made" send_email_receipt_for_subscription_payment: Boolean "Get an email when provider adds an emoji to a journal entry" send_emoji_email: Boolean "Get a push notification when provider adds an emoji to a journal entry" send_emoji_push: Boolean "Get an email whenever a client posts an entry" send_entry_emails: Boolean "Send an email to client when reminder to complete goal checked" send_goal_reminder_email: Boolean "Send a push notification to client when reminder to complete goal checked" send_goal_reminder_push: Boolean "Get an email whenever you get a new message in a group chat" send_group_message_emails: Boolean "Get a push notification when there is a new message in a group chat" send_group_message_push: Boolean "Sends an email to the client provider when their insurance is about to expire" send_insurance_expiry_notifications: Boolean "Get an email whenever you get a new message" send_message_emails: Boolean "Get a push notification when there is a new message" send_message_push: Boolean "Get an email when a new client is added to the organization" send_new_clients_emails: Boolean "Send an email to the client provider when client has updated their insurance information" send_new_insurance_added_notifications: Boolean "Send an email to client when new program module is available" send_new_module_email: Boolean "Send a push notification to client when new program module is available" send_new_module_push: Boolean "Get a push notification 5 minutes before the appointment" send_push_before_appointment: Boolean "Send an email to the client 24hrs before next payment is due" send_recurring_payment_reminder_emails: Boolean "The date and time of the last update of the setting" updated_at: String "The owner of the notification setting" user: User } "Structured representation of a numeric form_answer answer: the numeric mod_types (number, height, Weight, A1C, ...) and dynamic custom metrics" type NumericAnswer { "The answer parsed as a number; null when blank or not a clean number" numeric_value: Float "The raw answer text, preserved exactly as stored" value: String } "Offering (or Package)" type Offering { "Formatted frequency string abbreviated for offering list page" abbreviated_frequency_times_string: String "Whether or not this packages has been archived" archived: Boolean! "Ask for a CC (even on a free package)" ask_for_cc: Boolean! "frequency client will be billed for package" billing_frequency: String "count of billing items for a given offering" billing_items_count: Int "True if package is allowed to be gifted to other clients. Currently only available for non-recurring offerings" can_be_gifted: Boolean! "If false the payment for the offering should be collected manually at a later time" charge_immediately: Boolean! "course id associated with this package" course_id: ID "created at" created_at: String! "currency used to pay for this package" currency: String "Pagination cursor" cursor: Cursor! "Description of the package, not allowing nil" description: String "ID of the embedded custom module form" embed_question_form_id: String "fb_pixel" fb_pixel: String "first time payment price of package" first_time_payment: String "Formatted frequency string" frequency_times_string: String "The unique identifier of the offering" id: ID! "A URL to purchase the package" immediate_purchase_url: String "Whether the package includes a course that has ended" includes_ended_fixed_course: Boolean "initial payment amount of package" initial_payment_amount: String "initial price of package including applicable taxes" initial_price_with_taxes: String "selected meal plan from living plate" living_plate_meal_plan_id: String "if this offering has a living plate meal plan associated, returns a link to living plate meal plan preview" living_plate_meal_plan_name: String "if this offering has a living plate meal plan associated, returns a link to living plate meal plan preview" living_plate_preview_url: String "Number of times the package could be purchased. Unlimited if set to nil" max_purchases: String "meal plan options in offering (currently only from living plate)" meal_plan_options: [MealPlan!] "minimum_quantity" minimum_quantity: String "name of package" name: String "courses related to offering" offering_courses: [OfferingCourse!] "user groups that are specific to this offering" offering_group_visibilities: [OfferingGroupVisibility!] "offering image" offering_image: OfferingImage "id of offering image" offering_image_id: ID "URL of the offering image to use" offering_image_url: String "appointment types related to offering" offering_includes(appointment_type_id: ID, only_bookable_by_client: Boolean): [OfferingInclude!] "count of offering includes associated with offering" offering_includes_count: Int! "lab options included in offering" offering_lab_options: [OfferingLabOption!] "Taxes on offering products" offering_product_taxes: Float "Products included in the offering" offering_products: [OfferingProduct!] "on on_purchase_ifs_tag_id" on_purchase_ifs_tag_id: String "Shows whether user group should be changed when client which is already in the user group is buying the package" override_group_on_purchase: Boolean! "price of package" price: String "price per minute" price_per_minute: String "repeat times" repeat_times: String "When true, the package requires appointment booking during package purchase" require_booking_purchase: Boolean! "position of package when displayed in packages list" row_order: String "offering image id" selected_image_id: String "show free text to customers on offerings of zero price" show_free_text: Boolean! "show offering toggle" show_offering: Boolean! "show price toggle" show_price: Boolean! "start_fb_pixel" start_fb_pixel: String "total of billing_items.amount_paid for a given offering" total_revenue: Float "When false, the package is at its purchase cap, and cannot be bought by a client" under_purchase_cap: Boolean "updated at" updated_at: String! "The user who owns the package" user: User "user group id associated with this package" user_group_id: ID "User group name associated with this offering" user_group_name: String "id of user" user_id: ID "count of user package selections for a given offering" user_package_selections_count: Int "user pays toggle" user_pays: Boolean! "video associated with offering" video_url: String "Whether the package is visible to all or to a specific group or completely hidden." visibility_status: String! } "Offering Coupon" type OfferingCoupon { "The amount off due to this offering coupon" amount_off: String "The amount off due to this offering coupon" amount_off_string: String "The time this offering coupon is applied" applies_to_string: String "The code of this offering coupon" code: String "The time at which this offering coupon was created" created_at: String! "Pagination cursor" cursor: Cursor! "The time at which this offering coupon was deleted" deleted_at: String "The date the promo code expires at" expires_at: String "The flat amount off due to this offering coupon" flat_amount_off: String "The unique identifier of the coupon" id: ID! "The coupon is expired or valid, returns true if coupon is expired" is_expired: Boolean! "The coupon is expired or valid, returns true if the coupon is valid" is_valid: Boolean! "The amount of times the offering coupon has been used" number_of_times_used: String "The owner of this Offering Coupon" offering_coupon_owner: User "Names of offerings this coupon is connected to" package_connection_names: [String!] "The promo type of this offering coupon" promo_type: String "The repeat times of this offering coupon" repeat_times: String "concatenated string of amount off string and applies to string" to_one_line: String "The time at which this offering coupon was last updated at" updated_at: String! "The amount of times the offering coupon can be used" usage_limit: String "The user id who created this offering coupon" user_id: String } "Offering Course" type OfferingCourse { "course" course: Course "id of related course" course_id: ID! "created at" created_at: String! "The unique identifier of the join" id: ID! "id of related offering" offering_id: ID "updated at" updated_at: String! } "User groups that are specific to this offering will only be visible to clients in these user groups" type OfferingGroupVisibility { "The unique identifier of the visibility" id: ID! "name of the user group" name: String "id of related offering" offering_id: ID "id of related user group" user_group_id: ID } "Offering Image" type OfferingImage { "created at" created_at: String! "The unique identifier of the offering image" id: ID! "image content type" image_content_type: String "image file name" image_file_name: String "image file size" image_file_size: String "when image was updated" image_updated_at: String "url for image" image_url: String "name of image" name: String "updated at" updated_at: String! } "Offering Include" type OfferingInclude { "appointment type" appointment_type: AppointmentType "id of related appointment type" appointment_type_id: ID "created at" created_at: String! "expires in" expires_in: String "form id" form_id: String "The unique identifier of the offering include." id: ID! "whether or not the offering_include (appointment type) should be recurring" is_repeating: Boolean! "id of related offering" offering_id: ID "quantity of appointments in package" quantity: String "whether or not the offering book" required_appointment_type: Boolean! "updated at" updated_at: String! } "Offering Lab Option" type OfferingLabOption { "created at" created_at: String! "The unique identifier of the lab option" id: ID! "lab option" lab_option: LabOption "id of related appointment type" lab_option_id: ID "id of related offering" offering_id: ID "updated at" updated_at: String! } "Offering product type" type OfferingProduct { "If true the quantity of the main product will be reduced, otherwise changing offering_product.quantity won't affect on the main product" deduct_main_quantity: Boolean "The unique identifier of the offering product" id: ID! "ID of related offering" offering_id: ID! "The price of included product. If offering_product.price == nil, the price will be equal to product.price" price: String "A product included into the offering" product: Product "The quantity of included products" quantity: String "Tax amount if product has tax rate" tax_amount: String "If true tax will be added to the price" taxable: Boolean! } "Offerings data type" type OfferingsDataType { "The frequency of the offering" freq: String "The month of the offering" month: String } "Info on SFTP connection to OfficeAlly" type OfficeallySftpAccount { "The OfficeAlly SFTP URL" ftp_url: String "The unique identifier of the connection" id: ID! "True if the SFTP connection is turned by user" is_enabled: Boolean "True if the SFTP connection is working" is_valid: Boolean "The last time we imported from the SFTP" last_imported_from: String "The SFTP OfficeAlly Username" username: String } "An onboarding flow that is comprised of onboarding items" type OnboardingFlow { "The date this onboarding flow was created" created_at: String! "Pagination cursor" cursor: Cursor! "If true, the flow has additional form steps after the welcome screen" has_forms_after_welcome: Boolean "The unique identifier of the flow" id: ID! "Check if current user organization has more than 1 provider" is_multiple_providers: Boolean "The name of this onboarding flow" name: String "All onboarding items that make up the onboarding flow" onboarding_items(custom_module_forms_only: Boolean = false): [OnboardingItem!]! "The number of onboarding items in the flow" onboarding_items_count: Int "Owner of this onboarding flow" user: User "The user groups this onboarding flow is associated with" user_groups: [UserGroup!] "The number of user groups this onboarding flow is associated with" user_groups_count: Int "The combined name list of the user groups this onboarding flow is associated with" user_groups_name_string: String } "An onboarding item that has something for the client to complete" type OnboardingItem { "The URL to go to to edit the attached object" attached_object_edit_url: String "Custom text above the billing info screen" billing_disclaimer: String "Return the ID of the associated completed form_answer_group" completed_form_id: String "The completed onboarding item for the given user id (from args)" completed_onboarding_item: CompletedOnboardingItem "The relevant date to show" date_to_show: String "The display name for the onboarding item (based off the attached object)" display_name: String "Onboarding item has matrix field" has_matrix_field: Boolean "The unique identifier of the onboarding item" id: ID! "Return the ID of the incomplete form" incomplete_form_id: String "Show if it the last item in related onboarding flow" is_last_item(custom_module_forms_only: Boolean = false): Boolean "Whether the user can skip this onboarding item" is_skippable: Boolean! "The ID of the associated item" item_id: String "The type of item attached to this onboarding item" item_type: String "The user group this onboarding flow is assigned to" onboarding_flow: OnboardingFlow "ID of the onboarding flow" onboarding_flow_id: ID "Custom text above the photo ID screen" photo_id_disclaimer: String "Custom text above the insurance policy screen" policy_disclaimer: String "Owner of this onboarding item" user: User "The URL to view the onboarding item" view_url: String "Custom text for the welcome screen" welcome_text: String } "An organization, that is an umbrella group for multiple providers" type Organization { "The insurance plans the organization accepts, sorted by payer name ascending." accepted_insurance_plans(keywords: String, after: String, before: String, first: Int, last: Int): AcceptedInsurancePlanConnection "The active potential care team members of the organization" active_care_team_members(provider_ids: [ID], tag_ids: [ID], record_identifiers: [String], state_licenses: [String], selected_insurance_plan_id: ID, order_by: ActiveCareTeamMemberOrderKeys): [User!] "The active users of the organization used for starting new conversations" active_members_for_conversation(exclude_sub_org_members: Boolean = false, keywords: String = null): [User!] "Returns organization appointment locations" appointment_locations: [AppointmentLocation!] "The automated insurance billing settings for the organization" automated_insurance_billing_setting: AutomatedInsuranceBillingSetting "Billing configuration settings for this organization" billing_configuration: BillingConfiguration "Can have suborgs for this org" can_have_suborgs: Boolean "When true, the organization can link lab orders to chart notes" can_link_labs_to_chart_notes: Boolean "Whether the organization can link E-Rx prescriptions to chart notes" can_link_prescriptions_to_chart_notes: Boolean "Returns general cancellation reasons" cancellation_reasons(reason_type: CancellationReasonTypeEnum = client): [CancellationReason!]! "Fetch paginated Care Plan Recommendation Categories collection" care_plan_recommendation_categories(active: Boolean = false, only_active: Boolean = false): [CarePlanRecommendationCategory!]! "The organization configuration settings" configuration: OrganizationConfigurationType "The creation date of the organization" created_at: String! "The default `PdfLetterheadTemplate` for this organization" default_pdf_letterhead_template: PdfLetterheadTemplate "If enabled for organization, settings for E-Labs" e_labs_settings: ELabsSettings "ERx clinics associated with this organization" erx_clinics(keywords: String = null, order_by: ErxClinicOrderKeys = NAME_ASC, after: String, before: String, first: Int, last: Int): ErxClinicPaginationConnection! "True if any user in the organization is connected to a rupa health account" has_rupa_health_members: Boolean! "Boolean" has_services_cpt_codes: Boolean! "The unique identifier of the organization" id: ID! "Returns the first 20 distinct insurance plans used by providers in an organization, filtered by payer name if provided (considered public)" insurance_plans_used_by_organization_providers(keywords: String): [InsurancePlan!]! "Whether the organization is active. Inactive orgs are blocked from adding clients or creating appointments." is_active: Boolean! "The system default PDF Letterhead Template is used if true" is_using_system_default_pdf_letterhead_template: Boolean "The location of the organization" location: Location "The name of the organization" name: String "The NPI of the organization" npi: String "The number of users in the organization" num_users: String "The ID of the onboarding flow for org providers" onboarding_flow_id: String "The active organization memberships of the organization" only_active_organization_memberships: [OrganizationMembership!] "The active providers of the organization" only_active_providers(include_suborg_providers: Boolean, provider_ids: [ID]): [User!] "The number of active providers of the organization" only_active_providers_count(provider_ids: [ID]): Int "The active standard users of the organization" only_active_standard: [User!] "The number of active standard user of the organization" only_active_standard_count: Int "The active support users of the organization" only_active_support: [User!] "The number of active support user of the organization" only_active_support_count: Int "Potential Organization Roles for this Organization" org_roles: [String!] "Returns organization cpt codes" organization_cpt_codes: [OrganizationCptCodeType!] "The email of organization" organization_email: String! "The first organization info of the organization" organization_info: OrganizationInfo "The organization infos of the organization" organization_infos(id: ID, keywords: String, offset: Int = 0, should_paginate: Boolean = false): [OrganizationInfo!] "The count of organization infos of the organization" organization_infos_count: Int "The organization memberships of the organization" organization_memberships(active: Boolean, exclude_org_ids: [ID!] = [], keywords: String, use_filters: Boolean = false, offset: Int = 0, page_size: Int = 10, should_paginate: Boolean = false): [OrganizationMembership!] "The total count of organization memberships on this organization" organization_memberships_count(active: Boolean, exclude_org_ids: [ID!] = [], keywords: String, use_filters: Boolean = false): Int "The other id" other_id: String "The other ID qualifier (what type of ID it is)" other_id_qual: String "The owner of the organization" owner: User "The ID of the org owner" owner_id: ID "The owner of the org's subscription" owner_subscription: SubscriptionInstance "The users associated with the organization" paginated_users(keywords: String, email: String, active_status: String, include_suborgs: Boolean = false, after: String, before: String, first: Int, last: Int): UserConnection "Parent organization for this org" parent_organization: Organization "ID of the parent organization" parent_organization_id: ID "Whether the organization has the payout accounts feature enabled" payout_accounts_enabled: Boolean! "The list of available `PdfLetterheadTemplate`s" pdf_letterhead_templates: [PdfLetterheadTemplate!] "Permission templates for this org" permission_templates: [PermissionTemplateType!] "The phone number of the organization" phone_number: String "Distinct insurance plans used by providers in an organization, filtered by payer name if provided (considered public). Uses cursor-based pagination (connections)." provider_insurance_plans(keywords: String, after: String, before: String, first: Int, last: Int): InsurancePlanPaginationConnection! "The providers of the organization" providers(keywords: String, exclude_ids: [ID!] = [], active_status: String, licensed_in_state: String, provider_ids: [ID] = [], with_private_notes_for_id: String, with_tag_ids: [ID], include_suborg_providers: Boolean, offset: Int = 0, order_by: UserOrderKeys, page_size: Int = 100, should_paginate: Boolean = false): [User!] "The number of providers in the organization" providers_count(keywords: String, exclude_ids: [ID!] = [], active_status: String, licensed_in_state: String, provider_ids: [ID] = [], with_private_notes_for_id: String, with_tag_ids: [ID], include_suborg_providers: Boolean): Int "Require patients to upload their insurance card via the Insurance Form" require_insurance_card_upload: Boolean "The number of users in the organization connected their rupa health account" rupa_health_members: [User!] "Returns organization state licenses" state_licenses: [String!] "Suborganizations for this org" suborganizations: [Organization!] "Returns organization tags" tags: [Tag!] "Tax ID of organization" tax_id: String "The tax is of the organization" tax_id_type: String "User groups that are in the organization" user_groups: [UserGroup!] "The users of the organization" users(active_status: String, keywords: String, show_all_by_default: Boolean = false): [User!] "Builder ID for the Zus token" zus_builder_id: String } "OrganizationConfiguration object" type OrganizationConfigurationType { "Unique identifier of the organization configuration object" id: ID! "If care alerts are enabled for this organization" internal_care_alerts_enabled: Boolean "If care alerts require acknowledgement for this organization" internal_care_alerts_require_acknowledgement: Boolean } "OrganizationCptCodeInsuranceFeeType object" type OrganizationCptCodeInsuranceFeeType { "Fee (in cents) per unit" fee_per_unit: Int "Unique identifier for the object" id: ID! "The insurance plan that is associated with the org cpt code" insurance_plan: InsurancePlan "The ID associated with organization cpt code object" organization_cpt_code_id: ID } "OrganizationCptCode object" type OrganizationCptCodeType { "The CPT code id" cpt_code_id: ID! "date created" created_at: String! "The unique identifier of the join" id: ID! "Returns specific insurance fees associated with organization cpt codes" organization_cpt_code_insurance_fees: [OrganizationCptCodeInsuranceFeeType!] "Total insurance fees associated with the organization cpt code" organization_cpt_code_insurance_fees_count: String "The organization id" organization_id: ID! "The price per unit" price_per_unit: String "date updated" updated_at: String! } "represents a CPT code in an organization's fee schedule" type OrganizationFeeScheduleCptCodeType { "The CPT code itself" code: String! "The description of the CPT code" description: String! "The name and Code of the CPT code for use in labels" display_name: String! "Deprecated. Fee (in cents) per unit" fee_per_unit: Int @deprecated(reason: "Use `fee_per_unit_cents` instead") "Fee (in cents) per unit" fee_per_unit_cents: Int "Unique identifier for the CPT Code" id: ID! } "The connection type for OrganizationFeeScheduleCptCodeType." type OrganizationFeeScheduleCptCodeTypeConnection { "A list of edges." edges: [OrganizationFeeScheduleCptCodeTypeEdge] "A list of nodes." nodes: [OrganizationFeeScheduleCptCodeType] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type OrganizationFeeScheduleCptCodeTypeEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: OrganizationFeeScheduleCptCodeType } "Specific information for an organization" type OrganizationInfo { "The creation date of the organization" created_at: String! "The External ID of the organization" external_id: String "The unique identifier of the organization info" id: ID! "The number type ID of the organization" id_number_type: String "The location of the organization" location: Location "The name of the organization" name: String "The NPI of the organization" npi: String "The associated organization" organization: Organization "The other id" other_id: String "The other ID qualifier (what type of ID it is)" other_id_qual: String "The phone number of the organization" phone_number: String "Set billing provider as primary" primary: Boolean "The tax id of the organization" tax_id: String "The tax id type of the organization" tax_id_type: String } "An organization membership" type OrganizationMembership { "Can initiate group level actions (e.g. create group conversations in chat, assign groups to course modules, request form completions from a group)" allow_group_level_actions: Boolean! "If true, clients who this org member has been added as a care team member will be able to schedule appointments with them." allow_self_scheduling_in_care_team: Boolean "If true, clients who this org member has been added as a care team member for will automatically see a Chat conversation with this org member." auto_create_convo_for_care_team: Boolean "If true, the user can access calendar quick share" can_access_calendar_quick_share: Boolean! "If true, the user should be able to access other active organization members conversations" can_access_to_members_chat: Boolean "If true, the user can access Zus functionality" can_access_zus: Boolean! "If true, the user can add new clients" can_add_clients: Boolean! "If true, the user can add new people to the organization" can_add_members: Boolean! "If true, the user should be able to add other active organization members to chat" can_add_members_to_chat: Boolean "If true, the user can add appointments on other providers' calendars" can_add_others_appointments: Boolean "If true, the user can add appointments on their own calendar" can_add_own_appointments: Boolean "If true, the user should be able to assign a task to any member of their organization" can_assign_tasks_to_all_org_members: Boolean "If true, charting notes will be autogenerated from the user's Zoom calls" can_autogenerate_charting_notes_from_zoom_calls: Boolean "If true, the user can be added to the care team members list for a client" can_be_care_team_member: Boolean! "If true, the user can charge clients" can_charge_clients: Boolean! "If true, the user can create tags" can_create_tags: Boolean "If true, the user can delete automations" can_delete_automations: Boolean! "If true, the user can delete charting notes" can_delete_charting_notes: Boolean! "If true, the user can delete faxes" can_delete_faxes: Boolean! "If true, the user can permanently delete appointments on other organization members' calendars" can_delete_others_appointments: Boolean "If true, the user can permanently delete appointments on their own calendar (as distinct from marking them Cancelled)" can_delete_own_appointments: Boolean "If true, the user can delete appointment recordings and transcripts" can_delete_recordings: Boolean "If true, the user can edit appointment types" can_edit_appointment_types: Boolean! "If true, the user can create and edit automations" can_edit_automations: Boolean! "If true, the user can edit calendar" can_edit_calendar: Boolean "If true, the user can edit client credit" can_edit_credit: Boolean "If true, the user can edit documents" can_edit_docs: Boolean "If true, the user can edit education content" can_edit_education: Boolean "If true, the user can edit forms" can_edit_forms: Boolean "If true, the user can manage the people and roles in the organization" can_edit_members: Boolean "If true, the user can edit appointments on other organization members' calendars (where another member is the provider/host)" can_edit_others_appointments: Boolean "If true, the user can edit appointments on their own calendar (appointments where they are the provider/host)" can_edit_own_appointments: Boolean "If true, the user can edit client packages" can_edit_packages: Boolean "If true, the user can add ,edit and delete products" can_edit_products: Boolean "If true, the user can edit settings" can_edit_settings: Boolean "If true, the user can enroll and remove clients from programs" can_enroll_clients_to_programs: Boolean "If true, encounter summaries can be generated for the user's encounters" can_generate_encounter_summaries: Boolean "deprecated, use can_lock_own_charting_notes instead" can_lock_form_answer_groups: Boolean @deprecated(reason: "Use `can_lock_own_charting_notes` instead") "If true, the user can lock charting notes other providers created" can_lock_others_charting_notes: Boolean "If true, the user can lock charting notes they created" can_lock_own_charting_notes: Boolean "If true, the user should be able to manage care plan templates" can_manage_care_plan_templates: Boolean "If true, the user can manage other members' availability" can_manage_others_availability: Boolean "If true, the user can manage other members' blocks" can_manage_others_blocks: Boolean "If true, the user can manage their own availability" can_manage_own_availability: Boolean "If true, the user can manage their own blocks" can_manage_own_blocks: Boolean "If true, the user should be able to mark tasks that are assigned to other org members as completed" can_mark_assigned_tasks_to_other_org_members_as_completed: Boolean "If true, the user can merge clients" can_merge_clients: Boolean "If true, view labs page and view patient lab results" can_order_labs: Boolean "If true, the user can remove clients" can_remove_client: Boolean "If true, can remove other org members' signatures from charting notes" can_remove_org_member_signatures: Boolean "If true, the user should be able to rename or delete tags" can_rename_and_delete_tags: Boolean "If true, the user can request to prescribe controlled substances. Requires E-Rx" can_request_to_prescribe_controlled_substances: Boolean "If true, can restrict client" can_restrict_clients: Boolean "If true, the user can view the billing tab" can_see_billing: Boolean "If true, the user can see all calendars in the organization" can_see_calendar: Boolean "If true, the user can see all clients in the organization" can_see_clients: Boolean "If true, the user can see documents within the entire org" can_see_docs: Boolean "If true, the user can see incoming faxes" can_see_faxes: Boolean "If true user should be able to see fullscript tab in client profile and view fullscript box in homepage" can_see_fullscript_tab: Boolean "If true, the user should be able see a button that allows them to signup for dosespot in the overview section of the client profile" can_see_option_to_use_erx_dosespot: Boolean "If true, the user can see sent faxes" can_see_sent_faxes: Boolean "If true, the user can see transfers tab in billing page" can_see_transfers: Boolean "If true, the user can set a password for organization clients" can_set_client_password: Boolean "If true, the user can share documents and folders with organizations members" can_share_documents_and_folders_with_org_members: Boolean "If true, the user can sign charting notes other providers created" can_sign_others_charting_notes: Boolean "If true, the user can sign charting notes they created" can_sign_own_charting_notes: Boolean "If true, the user can change the status (e.g. Occurred, No-Show, Cancelled, Late Cancellation) of appointments on other organization members' calendars" can_status_others_appointments: Boolean "If true, the user can change the status (e.g. Occurred, No-Show, Cancelled, Late Cancellation) of appointments on their own calendar" can_status_own_appointments: Boolean "When true, user can submit to Candid" can_submit_cms_1500s_to_candid_health: Boolean "When true, user can submit to Change" can_submit_cms_1500s_to_change_health: Boolean @deprecated(reason: "ChangeHealth claims integration has been discontinued.") "If true, the user can submit CMS 1500s to Office Ally" can_submit_cms_1500s_to_office_ally: Boolean "If true, the user can unlink chart notes from appointments" can_unlink_chart_note_from_appointment: Boolean! "If `true`, the user can unlock charting notes. Always `true` for org owners and providers w/o an org" can_unlock_charting_notes: Boolean "If true, it will return all organization tasks for current user" can_view_all_org_members_tasks: Boolean "If true, the user can access the audit log API query." can_view_audit_log: Boolean "If true, the user can view automations" can_view_automations: Boolean! "If true, the user can view/edit cms1500s" can_view_cms1500s: Boolean "If true, the user can view encounter summaries" can_view_encounter_summaries: Boolean "If true can use goal favorites that are shared from other members of the organization" can_view_goal_templates: Boolean "If true, the user can edit appointment types" can_view_labs: Boolean "If true, the user can view org dashboard" can_view_org_dashboard: Boolean "If true, the user can view appointment recordings and transcripts" can_view_recordings: Boolean "If true, the user can view organization-level reports" can_view_reports: Boolean "If true, the user can view/edit super bills" can_view_super_bills: Boolean "If true, the user can write addendums for other org members charting notes" can_write_org_addendums: Boolean "If true a chat conversation will be automatically created when a client is assigned to the member" create_chat_when_assigned: Boolean "Pagination cursor" cursor: Cursor! "E-Rx Dosespot role" erx_dosespot_role: String "If true, the user will receive notif about failed notif" gets_failed_fax_notif: Boolean "If true, the user will receive a fax notif" gets_fax_notif: Boolean "If true the user will have their own branding" has_own_branding: Boolean "When true, user sees the primary diagnosis column for diagnoses" has_primary_diagnosis_column: Boolean "When true, calendar tab is hidden from user sidebar" hide_calendar_tab: Boolean "The unique identifier of the of the membership" id: ID! "If true, the user can use instant transcription" instant_transcribe_enabled: Boolean "If true, the user has been noted as being an admin" is_admin: Boolean "When true, the user can view and manage developer features like webhooks." is_developer: Boolean "Whether the org member user is also a member in the given suborgs" is_in_other_orgs(suborg_ids: [String!]!): Boolean "Whether the user is a provider in the organization" is_provider: Boolean "If true, the user is notified when any client activity including intake forms, journal entries, programs, documents" notify_any_client_activity: Boolean "If true the user is notified when any appointment is booked within the organization" notify_on_book: Boolean "If true the user is notified when any appointment is cancelled within the organization" notify_on_cancel: Boolean "if true, the user should get an email notification whenever a client payment fails or there is a chargeback." notify_on_payment_failure: Boolean "The organization role" org_role: String "The org attached to the organization membership" organization: Organization "Last applied permission template" permission_template: PermissionTemplateType "Last applying date of permission template" permission_template_applied_at: String "If true, the user can request eligibility checks" request_eligibility_checks: Boolean "If true, the user will see all org billing, not just individual" sees_all_billing: Boolean "If true, the user will see all org clients, not just individual on clients list page" sees_all_clients: Boolean "Selected licensed in values" selected_licensed_in_filter: [String!] "Selected locations values" selected_locations_filter: [String!] "Selected statuses values" selected_statuses_filter: [String!] "Selected statuses values" selected_tags_filter: [String!] "If true, the user receive email notification when any client in the organization completes an intake flow" send_email_on_intake_flow_complete: Boolean "If true, the user receive email notification when any client in the organization starts an intake flow" send_email_on_intake_flow_start: Boolean "If true, the user will share appointment types with the entire organization" share_appointment_types: Boolean "If true, the user shares custom metrics with entire organization" share_custom_metrics: Boolean "If true user should uses the same API access token for Fullscript" share_fullscript: Boolean "If true has their goal favorites available to other members of the organization" share_goal_templates: Boolean "If true, the user shares packages with entire organization" share_packages: Boolean "If true, all active organization members will see shared smart phrases" share_smart_phrases: Boolean "If true the user will share user groups with the entire org" share_user_groups: Boolean "Show availability in the calendar by default" show_availability_first: Boolean "If true, show org link on left hand side" show_org_tab: Boolean "If true the clients are able to start a new conversation with the member" start_conversation_with: Boolean "The title of the org member" title: String "The user attached to the organization membership" user: User } "Alternative ID numbers for a provider" type OtherIdNumber { "The unique identifier of the other id number" id: ID! "The label to use for the other id" label: String "The associated organization" organization: Organization "The ID of the associated organization" organization_id: String "The other id" other_id: String "The other ID qualifier (what type of ID it is)" other_id_qualifier: String "The associated user" user: User @deprecated(reason: "You never need to query the user of the other_id") "The ID of the associated user" user_id: String } "Information to aid in pagination." type PageInfo { "When paginating forwards, the cursor to continue." end_cursor: Cursor "When paginating forwards, are there more items?" has_next_page: Boolean! "When paginating backwards, are there more items?" has_previous_page: Boolean! "When paginating backwards, the cursor to continue." start_cursor: Cursor } "The details for a patient encounter" type PatientEncounter { "The appointment associated with the patient encounter" appointment: Appointment "The charting notes for the patient encounter" charting_notes: [FormAnswerGroup!] "The CMS1500 for the patient encounter" cms1500: Cms1500 "The unique identifier of the patient encounter" id: ID! "The patient associated with this patient encounter" patient: User "The invoices for the patient encounter" requested_payments: [RequestedPayment!] } "Autogenerated return type of PauseCourseGroup." type PauseCourseGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The paused course group" courseGroup: CourseGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of PauseCourseMembership." type PauseCourseMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseMembership: CourseMembership "The list of errors occurred during the mutation" messages: [FieldError] } "A payout account representing a Stripe Connected Account within an organization" type PayoutAccount { "When the payout account was created" created_at: ISO8601DateTime! "Internal ID" id: ID! "Display name of the payout account" name: String! "When the payout account was last updated" updated_at: ISO8601DateTime! "UUID used for external references and payout routing" uuid: String! } "An edge in a connection." type PayoutAccountEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: PayoutAccount } "The connection type for PayoutAccount." type PayoutAccountPaginationConnection { "A list of edges." edges: [PayoutAccountEdge] "A list of nodes." nodes: [PayoutAccount] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "Base class for types" type PdfLetterheadTemplate { "The source the address should be taken from" address_source: PdfLetterheadTemplateAddressSource! "The source the brand logo should be taken from" brand_logo_source: PdfLetterheadTemplateBrandLogoSource! created_at: ISO8601DateTime! "The source the email address should be taken from" email_source: PdfLetterheadTemplateEmailSource! id: ID! "Whether the address should be shown in PDF" include_address: Boolean! "Whether the appointment details should be shown in PDF" include_appointment_details: Boolean! "Whether the brand logo should be shown in PDF" include_brand_logo: Boolean! "Whether the email address should be shown in PDF" include_email: Boolean! "Whether the name of the organization should be shown in PDF" include_organization_name: Boolean! "Whether the phone number should be shown in PDF" include_phone_number: Boolean! "Whether the name of the team member should be shown in PDF" include_team_member_name: Boolean! "Whether provider's NPI should be shown in PDF" include_team_member_npi: Boolean! "Whether provider's qualifications should be shown in PDF" include_team_member_qualifications: Boolean! "Whether this template is default for the organization" is_default: Boolean! organization: Organization! "Custom email address to use in PDF" other_email: String "Custom phone number to use in PDF" other_phone_number: String "The source the phone number should be taken from" phone_number_source: PdfLetterheadTemplatePhoneNumberSource! "The source the team member's name should be taken from" team_member_name_source: PdfLetterheadTemplateTeamMemberNameSource! "The title for the PDF Letterhead Template" title: String! updated_at: ISO8601DateTime! } "An permission templateType" type PermissionTemplateType { "Can initiate group level actions (e.g. create group conversations in chat, assign groups to course modules, request form completions from a group)" allow_group_level_actions: Boolean! "If true, clients who this org member has been added as a care team member will be able to schedule appointments with them." allow_self_scheduling_in_care_team: Boolean "If true, clients who this org member has been added as a care team member for will automatically see a Chat conversation with this org member." auto_create_convo_for_care_team: Boolean "If true, the user can access calendar quick share" can_access_calendar_quick_share: Boolean! "If true, the user should be able to access other active organization members conversations" can_access_to_members_chat: Boolean "If true, the user can add new clients" can_add_clients: Boolean! "If true, the user can add new people to the organization" can_add_members: Boolean! "If true, the user should be able to add other active organization members to chat" can_add_members_to_chat: Boolean "If true, the user can add appointments on other providers' calendars" can_add_others_appointments: Boolean "If true, the user can add appointments on their own calendar" can_add_own_appointments: Boolean "If true, the user should be able to assign a task to any member of their organization" can_assign_tasks_to_all_org_members: Boolean "If true, the user can autogenerate charting notes by AI Scribe" can_autogenerate_charting_notes_from_zoom_calls: Boolean "If true, the user can be added to the care team members list for a client" can_be_care_team_member: Boolean! "If true, the current user can modify this permission template" can_be_edited: Boolean! "If true, the user can charge clients" can_charge_clients: Boolean! "If true, the user can create tags" can_create_tags: Boolean "If true, the user can delete automations" can_delete_automations: Boolean! "If true, user сan delete charting notes" can_delete_charting_notes: Boolean! "If true, the user can delete faxes" can_delete_faxes: Boolean! "If true, the user can permanently delete appointments on other organization members' calendars" can_delete_others_appointments: Boolean "If true, the user can permanently delete appointments on their own calendar (as distinct from marking them Cancelled)" can_delete_own_appointments: Boolean "If true, the user can delete appointment recordings and transcripts" can_delete_recordings: Boolean "If true, the user can edit appointment types" can_edit_appointment_types: Boolean! "If true, the user can create and edit automations" can_edit_automations: Boolean! "If true, the user can edit calendar" can_edit_calendar: Boolean "If true, the user can edit client credit" can_edit_credit: Boolean "If true, the user can edit documents" can_edit_docs: Boolean "If true, the user can edit education content" can_edit_education: Boolean "If true, the user can edit forms" can_edit_forms: Boolean "If true, the user can manage the people and roles in the organization" can_edit_members: Boolean "If true, the user can edit appointments on other organization members' calendars (where another member is the provider/host)" can_edit_others_appointments: Boolean "If true, the user can edit appointments on their own calendar (appointments where they are the provider/host)" can_edit_own_appointments: Boolean "If true, the user can edit client packages" can_edit_packages: Boolean "If true, the user can add, edit and delete products" can_edit_products: Boolean "If true, the user can edit settings" can_edit_settings: Boolean "If true, the user can enroll and remove clients from programs" can_enroll_clients_to_programs: Boolean "If true, the user can generate encounter summaries" can_generate_encounter_summaries: Boolean "If true, the user can lock charting notes other providers created" can_lock_others_charting_notes: Boolean "If true, the user can lock charting notes they created" can_lock_own_charting_notes: Boolean "If true, the user should be able to manage care plan templates" can_manage_care_plan_templates: Boolean "If true, the user can manage other members' availability" can_manage_others_availability: Boolean "If true, the user can manage other members' blocks" can_manage_others_blocks: Boolean "If true, the user can manage their own availability" can_manage_own_availability: Boolean "If true, the user can manage their own blocks" can_manage_own_blocks: Boolean "If true, can mark tasks complete that are assigned to other org members" can_mark_assigned_tasks_to_other_org_members_as_completed: Boolean "If true, the user can merge clients" can_merge_clients: Boolean "If true, view labs page and view patient lab results" can_order_labs: Boolean "If true, the user can remove clients" can_remove_client: Boolean "If true, can remove other org members' signatures from charting notes" can_remove_org_member_signatures: Boolean "If true, the user should be able to rename or delete tags" can_rename_and_delete_tags: Boolean "If true, can restrict client" can_restrict_clients: Boolean "If true, the user can view the billing tab" can_see_billing: Boolean "If true, the user can see all calendars in the organization" can_see_calendar: Boolean "If true, the user can see all clients in the organization" can_see_clients: Boolean "If true, the user can see documents within the entire org" can_see_docs: Boolean "If true, the user can see incoming faxes" can_see_faxes: Boolean "If true user should be able to see fullscript tab in client profile and view fullscript box in homepage" can_see_fullscript_tab: Boolean "If true, the user can see sent faxes" can_see_sent_faxes: Boolean "If true, the user can see transfers tab in billing page" can_see_transfers: Boolean "If true, user can set client passwords" can_set_client_password: Boolean "If true, the user can share documents and folders with organizations members" can_share_documents_and_folders_with_org_members: Boolean "If true, the user can sign charting notes other providers created" can_sign_others_charting_notes: Boolean "If true, the user can sign charting notes they created" can_sign_own_charting_notes: Boolean "If true, the user can change the status (e.g. Occurred, No-Show, Cancelled, Late Cancellation) of appointments on other organization members' calendars" can_status_others_appointments: Boolean "If true, the user can change the status (e.g. Occurred, No-Show, Cancelled, Late Cancellation) of appointments on their own calendar" can_status_own_appointments: Boolean "If true, the user can submit CMS 1500s to Office Ally" can_submit_cms_1500s_to_office_ally: Boolean "If true, the user can unlink chart notes from appointments" can_unlink_chart_note_from_appointment: Boolean! "If true, the user can unlock charting notes" can_unlock_charting_notes: Boolean! "If true, it will return all organization tasks for current user" can_view_all_org_members_tasks: Boolean "If true, the user can access the audit log API query." can_view_audit_log: Boolean "If true, the user can view automations" can_view_automations: Boolean! "If true, the user can view/edit cms1500s" can_view_cms1500s: Boolean "If true, the user can view encounter summaries" can_view_encounter_summaries: Boolean "If true can use goal favorites that are shared from other members of the organization" can_view_goal_templates: Boolean "If true, the user can edit appointment types" can_view_labs: Boolean "If true, the user can view org dashboard" can_view_org_dashboard: Boolean "If true, the user can view appointment recordings and transcripts" can_view_recordings: Boolean "If true, the user can view organization-level reports" can_view_reports: Boolean "If true, the user can view/edit super bills" can_view_super_bills: Boolean "If true, the user can write addendums for other org members charting notes" can_write_org_addendums: Boolean "If true, a chat conversation will be automatically created when a client is assigned to the member" create_chat_when_assigned: Boolean "The date of creation" created_at: String! "Pagination cursor" cursor: Cursor! "If true, the user will receive notif about failed notif" gets_failed_fax_notif: Boolean "If true, the user will receive a fax notif" gets_fax_notif: Boolean "If true the user will have their own branding" has_own_branding: Boolean "The unique identifier of the template" id: ID! "If true, instant transcription is enabled for members using this template" instant_transcribe_enabled: Boolean "If true, the user has been noted as being an admin" is_admin: Boolean "Whether the user is a developer" is_developer: Boolean "Whether the user is a provider in the organization" is_provider: Boolean "Name of template" name: String "If true, the user is notified when any client activity including intake forms, journal entries, programs, documents" notify_any_client_activity: Boolean "If true the user is notified when any appointment is booked within the org" notify_on_book: Boolean "If true the user is notified when any appointment is cancelled within the org" notify_on_cancel: Boolean "If true, user will notified about all failed payments" notify_on_payment_failure: Boolean "The organization role" org_role: String "If true, the user can request eligibility checks" request_eligibility_checks: Boolean "If true, the user will see all org billing, not just individual" sees_all_billing: Boolean "If true, the user will see all org clients, not just individual on clients list page" sees_all_clients: Boolean "If true, the user receive email notification when any client in the organization completes an intake flow" send_email_on_intake_flow_complete: Boolean "If true, the user receive email notification when any client in the organization starts an intake flow" send_email_on_intake_flow_start: Boolean "If true, the user will share appointment types with the entire org" share_appointment_types: Boolean "If true, the user shares custom metrics with entire org" share_custom_metrics: Boolean "If true user should uses the same API access token for Fullscript" share_fullscript: Boolean "If true has their goal favorites available to other members of the organization" share_goal_templates: Boolean "If true, the user shares packages with entire org" share_packages: Boolean "If true, all active organization members will see shared smart phrases" share_smart_phrases: Boolean "If true the user will share user groups with the entire org" share_user_groups: Boolean "Show availability in the calendar by default" show_availability_first: Boolean "If true, show org link on left hand side" show_org_tab: Boolean "If true the clients are able to start a new conversation with the member" start_conversation_with: Boolean "Date when record was last updated" updated_at: String "The user attached to the organization membership" user: User } "A pharmacy generated from Dosespot" type Pharmacy { "The city of the address" city: String "The unique identifier of the pharmacy" id: ID! "latitude coordinate of the pharmacy" latitude: String "The first line of the address" line1: String "The second line of the address" line2: String "longitude coordinate of the pharmacy" longitude: String "The name of the pharmacy" name: String "The phone number of the pharmacy" phone_number: String "The state of the address (Uses the 2 letter abbreviation if in US)" state: String "The zip/postal code of the address" zip: String } "Alternative ID numbers for a provider" type PlaceOfService { "The code for the place of service" code: String "A combined name and code string, correctly formatted" code_name: String "The unique identifier of the place of service" id: ID! "The name of the place of service" name: String } "Structured representation of single string value form_answer answers as well as numeric values (e.g. height)" type PlainTextAnswer { "The raw answer text" value: String } "A plan that can be used for a subscription" type Plan { "The features of the plan" features: [String] "The header of the plan" header: String "The unique identifier of the plan" id: ID! "The subheader of the plan" subheader: String } "A policy" type Policy { "Benefits associated with policy" benefits: [Benefit!] "Call reference information associated with this policy" call_reference: CallReference "Returns a list of errors associated with the policy after doing a Change Health Insurance Eligibility Check" claim_eligibility_check_errors: [ClaimEligibilityCheckErrors!] "Value if insurance billing method is coinsurance" coinsurance_value: Int "Value (in cents) if insurance billing method is copay" copay_value: Int "CPT codes authorized for this policy" cpt_codes_policies: [CptCodesPolicy!] "Date policy was added" created_at: ISO8601DateTime "Holder's date of birth" dob_to_use: String "Date policy becomes inactive" effective_end: String "Date policy becomes active" effective_start: String "policy group num" group_num: String "policy holder address" holder_address: String "policy holder dob, required" holder_dob: String "holder first name" holder_first: String "holder gender" holder_gender: String "holder last name" holder_last: String "The address of the holder" holder_location: Location "holder location id" holder_location_id: String "holder middle initial" holder_mi: String "policy holder name" holder_name: String "holder phone number" holder_phone: String "policy holder relationship, required" holder_relationship: String "ICD codes authorized for this policy" icd_codes_policies: [IcdCodesPolicy!] "The unique identifier of the policy" id: ID! "Insurance authorization (eligibility) associated with policy" insurance_authorization: InsuranceAuthorizationType "True if insurance authorization is required" insurance_authorization_required: Boolean "The insurance billing method for this policy (No billing method, Copay, Coinsurance, Unmet Deductible)" insurance_billing_method: String "Document Id of insurance card image(back)" insurance_card_back_id: String "Document Id of insurance card image(front)" insurance_card_front_id: String "The insurance plan" insurance_plan: InsurancePlan "policy plan id, required" insurance_plan_id: String "DEPRECATED. The last automated eligibility check run for this Change Health policy." last_eligibility_check: ClaimEligibilityCheck @deprecated(reason: "Use `latest_eligibility_check` instead") "the most recent automated eligibility check run for this policy." latest_eligibility_check: EligibilityCheck "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "The name of the policy" name: String "Notes in client profile recorded by provider user" notes: String "policy num, required" num: String "The address of the insurance plan" payer_location: Location "payer location ID" payer_location_id: String "policy phone number" policy_phone_number: String "Priority of policy for client (primary, secondary, or inactive)" priority_type: String "Referral added to this policy. Optional field that should not be nil if referral_required is true" referral: Referral "True if referral is required for policy" referral_required: Boolean "Same as client address toggle" same_address_as_client: Boolean "Insurance plan type?" type_string: String "Date policy was last updated" updated_at: String "Owner of this policy" user: User "user id, required" user_id: ID } "A potential appointment slot" type PotentialAppointmentSlot { "The ID of the appointment this slot is for" appointment_id: String "The type of appointment the slot is for. Returns nil if not a group appointment. Returning this for many slots can potentially slow down query times." appointment_type: AppointmentType "The hexcode color of the slot (Not used in Healthie's default self-scheduling widget)" color: String "The date of the slot" date: String "Whether this slot has waitlist enabled" has_waitlist_enabled: Boolean "Whether this slot is fully booked" is_fully_booked: Boolean "The length of the appointment type (in minutes)" length: Int "The ID of the user who owns the slot" user_id: String } "Preferred Medical Code" type PreferredMedicalCode { "ICD/CPT code description" code_description: String "ICD/CPT code" code_identifier: String "ICD/CPT code" code_indentifier: String @deprecated(reason: "Use `code_identifier` instead") "Connected Cpt Code Object" cpt_code: CptCode "Formatted name: 'F19.20: psychotics unspecified'" display_name: String "Connected ICD Code Object" icd_code: IcdCode "The unique identifier of the code" id: ID! } "Prescription created in Dosespot" type Prescription { "DoseSpot clinic identifier" clinic_id: ID "Comment entered by provider" comment: String "Date when prescription became ineffective" date_inactive: String "Date prescription was written" date_written: String "Number of days supplied prescription should last" days_supply: Int "Direction provided to patient when taking prescription. Entered by provider" directions: String "DoseSpot dispensable drug identifier" dispensable_drug_id: ID "DoseSpot dispense unit identifier" dispense_unit_id: ID "Display name for the prescription" display_name: String "The dosage (strength) of the prescription" dosage: String "The form of the prescription. Example: tablet, capsule, teaspoon" dose_form: String "The classification of the drug" drug_classification: String "Date when prescription became effective" effective_date: String "DoseSpot eligibility identifier" eligibility_id: ID "Encounter entered by provider" encounter: String "True if Transmission Error; otherwise it is false" error_ignored: Boolean "First prescription diagnosis in dosespot" first_prescription_diagnosis: [PrescriptionDiagnosis!] "True if the prescription was added after a patient's eligibility is retrieved; otherwise, it is false" formulary: Boolean "Free text type information" free_text_type: String "The unique identifier of the prescription" id: ID! "Whether this is a renewal prescription" is_rx_renewal: Boolean "If the prescription is urgent" is_urgent: Boolean "Date prescription was last refilled" last_fill_date: String "Patient Medication Status" medication_status: String "Monograph path entered by provider" monograph_path: String @deprecated(reason: "Deprecated by vendor, use MedicationOptionType.monograph instead") "The prescription's national drug code" ndc: String "If true, pharmacy has been instructed not to dispense a substitute/generic version" no_substitutions: Boolean "Non-DoseSpot prescription reference identifier" non_dose_spot_prescription_id: ID "The normalized status of the prescription" normalized_status: PrescriptionMedicationStatus "Over the counter drug" otc: String "DoseSpot patient medication identifier" patient_medication_id: ID "Pharmacy information assigned in dosespot (Not stored in db)" pharmacy: Pharmacy "Notes for pharmacy entered by provider" pharmacy_notes: String "DoseSpot prescriber agent identifier" prescriber_agent_id: ID "DoseSpot prescriber identifier" prescriber_id: ID "The name of the prescriber" prescriber_name: String "Name and dosage of the prescription. Example: ibuprofen 200 mg tablet" product_name: String "Quantity of medication per refill" quantity: String "Number of refills prescribed" refills: String "Form in which prescription is delivered" route: String "The prescription reference number" rx_reference_number: String "Notes about the prescription renewal" rx_renewal_note: String "The prescription rxcui" rxcui: String "Controlled substance schedule" schedule: String "Second prescription diagnosis in dosespot" second_prescription_diagnosis: [PrescriptionDiagnosis!] "Status of prescription. Example: Entered, Printed, Sending, eRxSent, Deleted" status: String "DoseSpot supervisor identifier" supervisor_id: ID "DoseSpot supply identifier" supply_id: ID "Prescription type. Example: Coded, Supply, Compound" type: String "Unit of medication. Example: tablet, capsule, teaspoon" unit: String } "Prescription Diagnosis created in Dosespot" type PrescriptionDiagnosis { "ICD10 Code in Dosespot for the diagnosis" diagnosis_code: String "Dosespot description of the diagnosis" diagnosis_description: String "Dosespot ID of the diagnosis" diagnosis_id: ID "Primary diagnosis" is_primary: Boolean } "The connection type for PrescriptionMedication." type PrescriptionMedicationConnection { "A list of edges." edges: [PrescriptionMedicationEdge] "A list of nodes." nodes: [PrescriptionMedication!]! "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type PrescriptionMedicationEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: PrescriptionMedication! } "Appointment type price and cpt_code_price" type PriceAndCptPriceType { "The cpt_code_price for this appointment type" cpt_price: String "The price for this appointment type" price: String } "Base class for types" type Problem { "Code of the problem" code: String "Self-descriptive" id: ID! "Name of the problem" name: String "When true, this object must be consolidated as part of a CCDA Ingest" requires_consolidation: Boolean } "Procedure object" type Procedure { "The code of the procedure" code: String "The code system name of the procedure" code_system_name: String "The CPT code id of the procedure" cpt_code_id: ID! "The display name of the procedure" display_name: String "The unique identifier of the procedure" id: ID! "The end date time of the procedure" procedure_end_datetime: String "The start date time of the procedure" procedure_start_datetime: String "The status of the procedure" status: String "The target site of the procedure" target_site: String "The user id of the procedure" user_id: ID } "The product" type Product { "The date and time when the product was created" created_at: String! "Pagination cursor" cursor: Cursor! "The unique identifier of the product" id: ID! "The name of the product" name: String! "The price of the product" price: String! "The available amount of the product" remaining_quantity: String! "Tax description" tax_description: String "Tax rate" tax_rate: String "If product has tax rate" taxable: Boolean "Indicates if the product has unlimited amount" unlimited_quantity: Boolean! "Owner of the product" user: User } "Profession" type Profession { "Unique identifier of the profession" id: ID! "The name of the profession" profession: String! "The category of the profession" profession_category: String! } "Insurance plan accepted by a provider" type ProviderAcceptedInsurancePlanType { "The accepted insurance plan" accepted_insurance_plan: AcceptedInsurancePlan! "The unique identifier of the provider accepted insurance plan" id: ID! "The associated organization" organization: Organization! "The provider assigned to the appointment request, if provided" provider: User! } "A provider appointment location object" type ProviderAppointmentLocation { "The unique identifier of the appointment location" appointment_location_id: ID "The unique identifier of the location" id: ID! "The location (in plain text)" location: String } "Provider appointment type connection" type ProviderApptTypeConnection { "The appointment type ID associated with this connection" appointment_type_id: ID "The unique identifier of the connection" id: ID! "Name of the provider associated with this appointment type connection" provider_name: String "User ID of the provider associated with this appointment type connection" user_id: ID } "A provider bio object" type ProviderBio { "The biography of the provider" bio: String! "The unique identifier of the provider bio" id: ID! } "ProviderCptCode object" type ProviderCptCodeType { "The CPT code ID" cpt_code_id: ID! "The unique identifier of the type" id: ID! "The price per unit" price_per_unit: String "The provider ID" provider_id: ID! } "Autogenerated return type of PublishDocumentDraft." type PublishDocumentDraftPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") document_draft: DocumentDraft "The list of errors occurred during the mutation" messages: [FieldError] } "The query root of this schema. See available queries." type Query { "Fetch advance appointment prices" advanceAppointmentPrices(appointment_type_id: ID, user_id: ID): [AdvanceAppointmentPrice!] "Paginated list of Alert Templates for the current organization" alertTemplates(keywords: String, after: String, before: String, first: Int, last: Int): AlertTemplatePaginationConnection "Search results for allergies, allergens, and reactions" allergySuggestions(category: String): [String] "Fetch an announcement" announcement(id: ID): Announcement "Fetch an array of announcements for a provider" announcements(exclude_dismissed: Boolean, keywords: String = null, offset: Int = 0, should_paginate: Boolean, page_size: Int, after: Cursor): [Announcement!] "Number of announcements for a provider" announcementsCount(exclude_dismissed: Boolean, keywords: String = null): Int "Fetch paginated API Keys collection" apiKeys(keywords: String = null, order_by: ApiKeyOrderKeys = CREATED_AT_DESC, offset: Int = 0, page_size: Int = 20, after: Cursor): [ApiKey!] "Number of API Keys" apiKeysCount(keywords: String = null): Int "An applied tag to a user" appliedTag(id: ID, include_deleted: Boolean): AppliedTag "Applied tags to a users" appliedTags(id: ID, tag_id: ID, order_by: AppliedTagOrderKeys = UNSORTED, updated_after: ISO8601DateTime, updated_before: ISO8601DateTime): [AppliedTag!] "fetch an appointment by id, group appointments are (considered public)" appointment(id: ID, include_deleted: Boolean = false): Appointment "Return potential booking issues for an appointment, date, time, repeats, attendees, and provider." appointmentBookingWarnings(appointment_type_id: ID, attendee_ids: [ID], date: String, is_repeating: Boolean = false, provider_id: ID, repeat_interval: String, repeat_times: String, recurring_appt_id: String, time: String, timezone: String, current_appt_id: String, is_group_appt: Boolean = false, is_editing: Boolean = false, additional_providers: String, length_in_minutes: Int = null): [AppointmentBookingWarning!] "returns metadata about appointments for provider dashboard" appointmentFrequencyData(only_to_current_date: Boolean, org_level: Boolean): [AppointmentDataType!] "fetch an appointment by id, group appointments are (considered public)" appointmentInclusion(id: ID, uuid: ID): AppointmentInclusionType "fetch an appointment location by id (considered public)" appointmentLocation(id: ID): AppointmentLocation "get appointment locations that the current user can use. (considered public)" appointmentLocations(appointment_date: String, appointment_type_id: ID, ids: [Int] = null, keywords: String = null, location_ids: String = null, org_level: Boolean = false, provider_id: ID, provider_ids: [ID] = null, resource: String = null, with_availability: Boolean = null): [AppointmentLocation!] "Returns a json hash of the number of appointments in each day of the month. The month is the month that the passed day is in." appointmentNumberPerDayOfMonth(date: String, include_blockers: Boolean = false): String "Fetch a single appointment requests for a provider or organization" appointmentRequest(id: ID!): AppointmentRequestType "Fetch a collection of appointment requests for a provider or organization" appointmentRequests(order_by: AppointmentRequestOrderKeys, appointment_location_ids: [ID!], current_statuses: [AppointmentRequestStatus!] = [OPEN], range_start: ISO8601Date, range_end: ISO8601Date, after: String, before: String, first: Int, last: Int): AppointmentRequestTypeConnection "fetch a Appointment Setting by id (considered public)" appointmentSetting(id: ID, provider_id: ID): AppointmentSetting "fetch an appointment type by id (considered public)" appointmentType(id: ID): AppointmentType "Fetch credit history for the specific appointment type" appointmentTypeCreditChanges(appointment_type_id: ID, user_id: ID): [AppointmentCreditChange!] "Fetch paginated Appointment Type collection (considered public)" appointmentTypes(appointment_type_ids: String = null, clients_can_book: Boolean = null, embed_or_sharing_link: Boolean = false, keywords: String = null, offering_id: String = null, org_level: Boolean = false, provider_id: String = null, provider_ids: [String] = null, show_group: Boolean = null, with_deleted_appt_types: Boolean = false, order_by: AppointmentTypeOrderKeys = POSITION_ASC, offset: Int = 0, page_size: Int = 1000, should_paginate: Boolean = true, after: Cursor): [AppointmentType!] "Number of appointment types (considered public)" appointmentTypesCount(appointment_type_ids: String = null, clients_can_book: Boolean = null, embed_or_sharing_link: Boolean = false, keywords: String = null, offering_id: String = null, org_level: Boolean = false, provider_id: String, provider_ids: [String] = null, show_group: Boolean = null, with_deleted_appt_types: Boolean = false): Int "Fetch paginated appointment workflow statuses collection" appointmentWorkflowStatuses(range_start: ISO8601Date, range_end: ISO8601Date, client_id: ID, cms1500_statuses: [Cms1500Status] = [], invoice_statuses: [RequestedPaymentStatus] = [], chart_note_statuses: [AppointmentWorkflowChartNoteStatus] = [], provider_ids: [ID!] = [], after: String, before: String, first: Int, last: Int): AppointmentWorkflowStatusConnection "Fetch paginated appointment collection" appointments(currentWeek: Boolean, endDate: String, exclude_appointments_with_invoice: Boolean = false, exclude_group_appointments: Boolean = false, filter: String = "future", filter_by_appointment_location_ids: [ID], filter_by_appointment_status: String, filter_by_appointment_statuses: [String], filter_by_appointment_type_id: ID, filter_by_appointment_type_ids: [ID], filter_by_contact_types: String, filter_by_chart_note_written: Boolean, filter_by_client_confirmed: Boolean, filter_by_location_id: ID, filter_by_provider_confirmed: Boolean, filter_synced_appointments: Boolean = false, filter_by_invoices: Boolean = false, use_provider_inclusions: Boolean = true, include_blockers: Boolean = true, include_nil_blockers: Boolean = false, include_suborganizations: Boolean = false, insurance_plan_ids: [ID], is_active: Boolean, is_confirmed: Boolean, is_org: Boolean, is_upcoming: Boolean, is_with_clients: Boolean, keywords: String = null, provider_id: ID, provider_ids: [ID], show_appointments: Boolean = true, order_by: AppointmentOrderKeys, specificDay: String, startDate: String, unconfirmed: Boolean, organization_id: ID, user_id: ID, with_all_statuses: Boolean = false, with_others: Boolean, without_status: Boolean = false, attendee_ids: [ID], state_license: String, tag_ids: [ID], offset: Int = 0, page_size: Int, should_paginate: Boolean = false, after: Cursor): [Appointment!] "Number of Appointments" appointmentsCount(currentWeek: Boolean, endDate: String, exclude_appointments_with_invoice: Boolean = false, exclude_group_appointments: Boolean = false, filter: String = "future", filter_by_appointment_location_ids: [ID], filter_by_appointment_status: String, filter_by_appointment_statuses: [String], filter_by_appointment_type_id: ID, filter_by_appointment_type_ids: [ID], filter_by_contact_types: String, filter_by_chart_note_written: Boolean, filter_by_client_confirmed: Boolean, filter_by_location_id: ID, filter_by_provider_confirmed: Boolean, filter_synced_appointments: Boolean = false, filter_by_invoices: Boolean = false, use_provider_inclusions: Boolean = true, include_blockers: Boolean = true, include_nil_blockers: Boolean = false, include_suborganizations: Boolean = false, insurance_plan_ids: [ID], is_active: Boolean, is_confirmed: Boolean, is_org: Boolean, is_upcoming: Boolean, is_with_clients: Boolean, keywords: String = null, provider_id: ID, provider_ids: [ID], show_appointments: Boolean = true, order_by: AppointmentOrderKeys, specificDay: String, startDate: String, unconfirmed: Boolean, organization_id: ID, user_id: ID, with_all_statuses: Boolean = false, with_others: Boolean, without_status: Boolean = false, attendee_ids: [ID], state_license: String, tag_ids: [ID]): Int "Data summary for appointment reports" appointmentsSummary(provider_ids: [ID] = [], range_end: String, range_start: String, range_type: String, require_cache_threshold: Int): AppointmentSummaryData "Get the assumed brand for the current user" assumedBrand(brand_id: ID = null, branded_url: String = null, custom_sign_in_path: String = null, partner_name: String = null): AssumedBrand "Fetch paginated audit log." auditLog(acting_user_id: ID, resource_name: AuditEventResourceName, resource_id: ID, event_type: AuditEventType, occurred_after: ISO8601DateTime, occurred_before: ISO8601DateTime, order_by: AuditEventOrderKeys = OCCURRED_AT_DESC, offset: Int = 0, page_size: Int = 50, after: Cursor): [AuditEvent!] "Authentication setting to use" authenticationSetting(brand_identifier: String): AuthenticationSetting "Fetch auto task generators belonging to a specific user" autoTaskGenerators(user_id: String): [AutoTaskGenerator!] "fetch the automated insurance billing setting" automatedInsuranceBillingSetting(user_id: ID): AutomatedInsuranceBillingSetting "Fetch a single automation by ID" automation(id: ID!): Automation "Fetch a single automation run by ID" automationRun(id: ID!): AutomationRun "Fetch paginated AutomationRuns collection" automationRuns(automation_id: ID!, status: AutomationRunStatus = null, after: String, before: String, first: Int, last: Int): AutomationRunPaginationConnection "Fetch paginated Automations collection" automations(keywords: String = null, is_enabled: Boolean = null, after: String, before: String, first: Int, last: Int): AutomationPaginationConnection "Fetch availabilities for range" availabilities(appointment_location_id: String, appointment_type_id: String, appointment_type_ids: [ID], availability_provider_id: ID, contact_type_id: String, endDate: String, end_date_padding: Int = 24, includeRepeating: Boolean, is_org: Boolean, is_repeating: Boolean, one_time: Boolean, provider_id: ID, provider_ids: [ID], include_suborganizations: Boolean = true, show_availability: Boolean = true, startDate: String, start_date_padding: Int = 12, user_id: String, organization_id: ID, timezone: String, state_license: String, tag_ids: [ID], insurance_plan_ids: [ID]): [Availability!] "number of availabilities" availabilitiesCount(appointment_location_id: String, appointment_type_id: String, endDate: String, is_org: Boolean, provider_id: ID, startDate: String): Int "Fetch availability" availability(id: ID): Availability "(Limited availability, subject to breaking changes). JSONified Hash with summary of availability." availabilitySummaryJson(date: String, organization_id: ID): String "Fetch available item types (for use in onboarding items)" availableItemTypes(onboarding_flow_id: String): String "Get open appointment times for a date range. Returns array of dates sorted in ascending order (considered public)" availableSlotsForRange(appointment_to_reschedule_id: ID, appointment_type_ids: [ID], appt_loc_id: String, appt_type_id: String, clients_can_join_waitlist: Boolean = false, contact_type: String, end_date: String, end_date_boundary: String, length: String, licensed_in_state: String = null, accepts_insurance_plan_id: ID = null, exclude_provider_ids: [ID], make_unique: Boolean = true, org_level: Boolean = false, outside_factors: Boolean = true, provider_id: String, provider_ids: [String], tag_ids: [ID], start_date: String, start_date_boundary: String, timezone: String): [PotentialAppointmentSlot!] "Get the Cms1500 Policies object for a given claim and client" baseCms1500ForUser(base_date: String, cms1500_id: String, form_answer_group_id: ID, only_active_policies: Boolean = false, patient_id: ID, rendering_provider_id: String): Cms1500 "Get basic info about User from signup token" basicUserInfoFromToken(token: String = null): User "DEPRECATED: All ICD Codes that are allowed to be used in healthcare claims" billableIcdCodes: [IcdCode!] @deprecated(reason: "All ICD Codes that are allowed to be used in healthcare claims") "fetch a billing item by id" billingItem(id: ID): BillingItem "Fetch paginated billing items collection" billingItems(client_id: ID, created_at_end: String = null, created_at_start: String = null, keywords: String = null, offerings_only: Boolean, provider_id: ID, order_by: BillingItemOrderKeys = CREATED_AT_DESC, status: [String] = [], user_id: ID = null, offset: Int = 0, page_size: Int = 20, after: Cursor): [BillingItem!] "Number of billing items" billingItemsCount(client_id: ID, keywords: String = null, status: [String] = [], provider_id: ID, created_at_start: String = null, created_at_end: String = null): Int "fetch a Brand by id (considered public)" brand(custom_sign_in_path: String, id: ID, locationString: String, provider_id: ID): Brand "fetch a Brand by custom sign in path (considered public)" brandFromCustomSignInPath(custom_sign_in_path: String): Brand "get info used on authentication pages for either a dietitian or partner" brandInfo(code: String = null, dietitian_id: String = null, invite_code: String = null, partner_name: String = null): BrandInfo "Fetch a calendar view settings for current user" calendarViewSetting(saved_filter_id: ID): CalendarViewSetting "Check if the user has access to the package buy limit feature" canCapOfferingPurchases(token: String = null): Boolean "Check if provider has access to client" canInvoiceSenderSeeRecipient(sender_id: ID!, recipient_id: ID!): Boolean "fetch the current users candidhealth connection" candidHealthConnection: CandidHealthConnection "Fetch paginated stripe customer accounts with associated errors or soon to expire credit cards" cardIssues(order_by: StripeCustomerDetailOrderKeys = EXPIRATION_DATE_DESC, offset: Int = 0, after: Cursor): [StripeCustomerDetail!] "Fetch paginated stripe customer accounts with associated errors or soon to expire credit cards" cardIssuesCount: Int "Paginated list of Care Alerts with optional filters" careAlerts(patient_id: ID, priority: CareAlertPriorityEnum, is_deleted: Boolean = false, is_expired: Boolean = false, after: String, before: String, first: Int, last: Int): CareAlertPaginationConnection "fetch a single care plan" carePlan(id: ID): CarePlan "Fetch paginated care plan collection" carePlans(patient_id: ID, template_search_keywords: String, templates_only: Boolean, order_by: CarePlanOrderKeys = STATUS_ASC, offset: Int = 0, page_size: Int = 20, after: Cursor): [CarePlan!] "Number of care plans" carePlansCount(patient_id: ID): Int "Number of care plans templates" carePlansTemplatesCount(keywords: String): Int "Fetch list of patient-initiated CDA activity events" cdaActivityEvents: [CdaActivityEvent!] "fetch the current users Change Health connection" changeClaimSubmitter: ChangeClaimSubmitter "fetch a chargeback by the Healthie ID or the Stripe Dispute ID." chargeBack(id: ID, stripe_dispute_id: ID): ChargeBack "fetch all charge backs for a user or organization" chargeBacks(show_all_for_org: Boolean = false, order_by: ChargeBackOrderKeys, offset: Int = 0, per_page: Int = 10): [ChargeBack!] "fetch count of all charge backs" chargeBacksCount(show_all_for_org: Boolean = false): Int "Fetch Stripe Charge Disputes for an organization" chargeDisputes(after: String, before: String, first: Int, last: Int): ChargeDisputeTypeConnection "Load all charting notes accessible by this user" chartNotes(tag_ids: [ID!] = [], end_date: ISO8601Date = null, start_date: ISO8601Date = null, user_id: ID = null, provider_ids: [ID] = [], chart_note_status: ChartNoteStatus = null, custom_module_form_ids: [ID!] = [], exclude_requested_and_intake_flow_forms: Boolean = false, primary_payer_ids: [ID!] = [], should_paginate: Boolean = true, offset: Int = 0, page_size: Int = 10, after: Cursor): [FormAnswerGroup!] "Count of charting notes accessible by this user" chartNotesCount(tag_ids: [ID!] = [], end_date: ISO8601Date = null, start_date: ISO8601Date = null, user_id: ID = null, provider_ids: [ID] = [], chart_note_status: ChartNoteStatus = null, custom_module_form_ids: [ID!] = [], exclude_requested_and_intake_flow_forms: Boolean = false, primary_payer_ids: [ID!] = []): Int "All items to include in the charting list" chartingItems(custom_module_form_id: ID, date: String, document_id: ID, filler_id: String, form_answer_group_id: String, generated_form_answer_group_id: ID, include_docs: Boolean = true, include_generated_form_answer_groups: Boolean = false, keywords: String = null, name: String, user_id: String, start_date: String, end_date: String): [ChartingItemType!] "All items to include in the charting list" chartingItemsCount(custom_module_form_id: ID, date: String, document_id: ID, filler_id: String, form_answer_group_id: String, include_docs: Boolean = true, keywords: String = null, name: String, user_id: String, start_date: String, end_date: String): Int "Fetch a charting note addendum by id" chartingNoteAddendum(id: ID): ChartingNoteAddendumType "fetch a Chat Setting" chatSetting(id: ID, user_id: ID): ChatSetting "Fetch a claim details era by ID" claimDetailsEra(cms1500_id: ID!): ClaimDetailsEra "get current video chats for a user." closeToCurrentVideoChats(user_id: String): [Appointment!] "Fetch a CMS1500 by ID" cms1500(id: ID): Cms1500 "Fetch paginated Cms1500s collection" cms1500s(appointment_id: ID, client_id: ID, keywords: String = null, provider_id: ID, order_by: Cms1500OrderKeys = CREATED_AT_DESC, status: String, offset: Int = 0, page_size: Int = 20, should_paginate: Boolean = true, after: Cursor): [Cms1500!] "Number of Cms1500s" cms1500sCount(client_id: ID, keywords: String = null, provider_id: ID, status: String): Int "Color Code Options for a given category" colorCodeOptions(appointment_setting_id: String, color_code_by: String): [ColorCodeOption!] "Fetch comment" comment(id: ID = null): Comment "Fetch comments collection" comments(entry_id: ID = null, entry_ids: [ID], offset: Int = 0, page_size: Int = 100, should_paginate: Boolean = false, after: Cursor): [Comment!] "number of comments" commentsCount(entry_id: ID = null, entry_ids: [ID]): Int "fetch a completedCourseItem by course_item_id and user_id" completedCourseItem(course_item_id: ID, user_id: ID): CompletedCourseItem "Get the completed onboarding item by ID" completedOnboardingItem(id: ID!): CompletedOnboardingItem "All Contact Types For Current User" contactTypes: [String!] "fetch a conversation by id" conversation(id: ID): Conversation "fetch a conversation membership by id" conversationMembership(id: ID, conversation_membership_id: ID): ConversationMembership "Fetch a conversationmembership by id and invitees" conversationMembershipInvitees(id: ID): [ConversationMembership!] "Fetch paginated conversation memberships collection" conversationMemberships(active_status: String = "active", client_id: String = null, conversation_type: String = "all", keywords: String = null, notes_type: String = "inbox", only_include_shared_memberships: Boolean = false, org_chat: Boolean = false, provider_id: ID = null, provider_ids: [ID] = null, read_status: String = "all", order_by: ConversationMembershipOrderKeys = UPDATED_AT_DESC, offset: Int = 0, page_size: Int = 20, after: Cursor): [ConversationMembership!] "All conversation membership tab counts in a single query" conversationMembershipsAllCounts(client_id: String = null, conversation_type: String = "all", keywords: String = null, only_include_shared_memberships: Boolean = false, org_chat: Boolean = false, provider_id: ID = null, provider_ids: [ID] = null, read_status: String = "all"): ConversationMembershipsAllCounts "Number of conversation memberships" conversationMembershipsCount(active_status: String = "active", client_id: String = null, conversation_type: String = "all", keywords: String = null, notes_type: String = "inbox", only_include_shared_memberships: Boolean = false, org_chat: Boolean = false, provider_id: ID = null, provider_ids: [ID] = null, read_status: String = "all"): Int "Fetch current user's conversations. It is normally better to use the conversationMemberships query." conversations(user_id: ID): [Conversation!] "Number of conversation" conversationsCount(keywords: String = null): Int "fetch a course by id (considered public)" course(id: ID): Course "fetch clients belonging to a course by course_id" courseClients(course_id: ID, course_status: String, offset: Int = 0): [CourseMembership!] "total number of clients for a specific course" courseClientsCount(course_id: ID, course_status: String): Int "Get course completion info for users and user_groups" courseCompletetionInfo(course_id: ID): CourseCompletionInfoType @deprecated(reason: "Use `course_completion_info` instead") "Get course completion info for users and user_groups" courseCompletionInfo(course_id: ID): CourseCompletionInfoType "Course group memberships for the course" courseGroupClients(course_group_id: String, course_id: ID, course_status: String, offset: Int = 0): [User!] "Total clients in course group memberships" courseGroupClientsCount(course_group_id: String, course_id: ID, course_status: String): Int "fetch a courseitem by id (considered public)" courseItem(course_membership_id: ID, id: ID): CourseItem "Get all custom custom emails for a current user" courseItemCustomEmails: [CustomEmail!] "Get all documents for current user, can optionally include the attached org document by providing course_id and course_item_id." courseItemDocuments(course_item_id: ID): [Document!] "Get all custom module forms for a current user" courseItemForms: [CustomModuleForm!] "Course items info for the course membership" courseItems(client_id: ID, course_id: ID, find_for_provider: Boolean = false, include_emails: Boolean = true): [CourseItem!] "fetch a courseMembership by id" courseMembership(course_id: ID, course_item_id: ID, course_membership_id: ID, id: ID, user_group_id: ID, user_id: ID): CourseMembership "Fetch paginated course membership collection" courseMemberships(client_id: ID, fetch_all: Boolean = false, offset: Int = 0, page_size: Int = 10, after: Cursor): [CourseMembership!] "Number of course memberships" courseMembershipsCount(client_id: ID): Int "Fetch paginated course collection" courses(active: Boolean = true, course_type: String = null, keywords: String = null, only_available: Boolean = null, offset: Int = 0, page_size: Int = null, should_paginate: Boolean = true, after: Cursor): [Course!] "Number of course" coursesCount(active: Boolean = true, course_type: String = null, keywords: String = null): Int "All CPT Codes" cptCodes(for_superbill: Boolean = false, is_favorited: Boolean, keywords: String, offset: Int = 0, page_size: Int = 20, should_paginate: Boolean = false, after: Cursor): [CptCode!] "CPT Codes count" cptCodesCount(is_favorited: Boolean): Int "fetch the current user." currentUser: User "fetch the current users notifications count." currentUserNotificationsCount: UserNotificationsCount "get current video chats for a user." currentVideoChats(only_current: Boolean = false, user_id: String): [Appointment!] "Custom Email object" customEmail(after: Cursor, id: ID): CustomEmail "A HTML string containing mailer template for certain email type" customEmailPreview(course_id: String, email_body_only: Boolean, email_type: String, find_record: Boolean, greeting: String, id: String, message_body: String, preview_email_type: String, reactivation_wait_days: String, subject: String): String "Fetch paginated custom emails collection" customEmails(email_type: String = "Invite Email", provider_id: ID, offset: Int = 0, page_size: Int = 10, after: Cursor): [CustomEmail!] "Number of custom emails" customEmailsCount(email_type: String = "Invite Email"): Int "fetch a custom module form by ID (templates are considered public)" customModuleForm(after: Cursor, charting: Boolean, default: Boolean = false, id: ID): CustomModuleForm "All form templates for the current user" customModuleForms(active_status: Boolean, category: String, keywords: String, offset: Int = 0, page_size: Int = 10, should_paginate: Boolean = false, order_by: CustomModuleFormOrderKeys = UPDATED_AT_DESC, after: Cursor): [CustomModuleForm!] "Fetch paginated count for provider custom module forms" customModuleFormsCount(active_status: Boolean, category: String, keywords: String): Int "Fetch paginated copied fields (is_custom custom modules) for the current user" customModules(keywords: String = null, after: String, before: String, first: Int, last: Int): CustomModulePaginationConnection "get open appointment times for a range (considered public)" daysAvailableForRange(appointment_to_reschedule_id: ID, appt_loc_id: String, appt_type_id: String, clients_can_join_waitlist: Boolean = false, contact_type: String, date_from_month: String, end_date: String, end_date_boundary: String, length: String, licensed_in_state: String = null, accepts_insurance_plan_id: ID = null, exclude_provider_ids: [ID], org_level: Boolean = false, outside_factors: Boolean = true, provider_id: String, provider_ids: [String], tag_ids: [ID], start_date: String, start_date_boundary: String, timezone: String): [String] "fetch a document by id" document(care_plan_id: ID, course_id: ID, course_item_id: ID, custom_module_id: ID, id: ID): Document "Get Document Viewings for a specific document. A 'View' is when a document is downloaded or opened in a new tab" documentViewings(document_id: ID = null, offset: Int = 0, per_page: Int = 10, after: Cursor): [DocumentViewing!] "Number of instances for a document viewings for a specific document" documentViewingsCount(document_id: ID = null): Int "Fetch paginated documents collection" documents(consolidated_user_id: String = null, file_type: String = null, filter: String = "all", folder_id: String = null, for_template_use: Boolean = false, include_drafts: Boolean = false, keywords: String = null, private_user_id: String = null, provider_id: ID, viewable_user_id: String = null, order_by: DocumentOrderKeys = NAME_ASC, offset: Int = 0, page_size: Int = 20, should_paginate: Boolean = false, after: Cursor): [Document!] "Number of documents" documentsCount(consolidated_user_id: String = null, file_type: String = null, filter: String = "all", folder_id: String = null, include_drafts: Boolean = false, keywords: String = null, private_user_id: String = null, provider_id: ID, viewable_user_id: String = null): Int "Fetch User Info on DoseSpot Object" dosespotUserInfo(user_id: ID): DoseSpot "Fetch the iframe link to prescribe for a given patient (patient must have valid phone_number, dob, location.line1, location.city, location.state, and location.zip)" dosespot_ui_link(patient_id: ID, form_answer_group_id: ID): String "draft by conversation_membership id" draft(conversation_membership_id: ID): Draft "Fetch an allergen by ID" drugAllergen(id: ID!): DrugAllergenType "Search for allergens by name" drugAllergens(keywords: String!): [DrugAllergenType!] "Fetch DSI comment for given intervention_type" dsiComment(intervention_type: InterventionType): DsiComment "Fetch a link from Fullscript to create a treatment plan for a given user" dynamicLink(user_id: String, entrypoint: FullscriptEntrypoint = CATALOG): String "Fetch embed steps based off of params" embedWidgetSteps(is_for_web: Boolean = false, locationString: String): [EmbedWidgetStepType!] "Returns Meeting SDK credentials for joining an appointment's embedded Zoom meeting in the browser: a signed jwt (SDK signature) and, for hosts, a zak used to start/join as the host. Providers receive a host credential; patients receive a participant credential (no zak). The zak is short-lived (~2 hours) - request fresh credentials at the start of each call rather than caching them. The meeting number and passcode are obtained separately from the appointment's Zoom join URL. Requires an authenticated user with access to the appointment; returns null if the meeting has not been created or the user lacks access." embeddedZoomJwt(appointment_id: ID!): EmbeddedZoomCredentials "Fetch paginated entries collection" entries(category: String = null, client_id: String = null, end_datetime_range: String = null, end_range: String = null, entry_id: String = null, group_id: String = null, include_inactive: Boolean = false, is_org: Boolean = false, keywords: String = null, order_by: EntryOrderKeys = CREATED_AT_DESC, start_datetime_range: String = null, start_range: String = null, summary_view: Boolean = false, type: String = null, offset: Int = 0, page_size: Int = 10, after: Cursor): [Entry!] "Number of entries" entriesCount(category: String = null, client_id: String = null, end_datetime_range: String = null, end_range: String = null, group_id: String = null, is_org: Boolean = false, keywords: String = null, maximum_count: Int = null, start_datetime_range: String = null, start_range: String = null, type: String = null): Int "fetch an entry by id" entry(client_id: ID = null, id: ID, type: String = null): Entry "Fetch paginated episodes of care collection" episodesOfCare(ids: [ID!] = [], patient_id: ID, provider_id: ID, after: String, before: String, first: Int, last: Int): EpisodeOfCareConnection "Fetch paginated external calendars collection" externalCalendars(calendar_type: CalendarType, calendar_status: CalendarStatus, is_org: Boolean, include_suborganizations: Boolean = false, after: String, before: String, first: Int, last: Int): ExternalCalendarConnection "Get the listed values of feature flags for the current user" featureFlags(flag_names: [FeatureFlagNameEnum]): [FeatureFlag!] "fetch a featureToggle by id" featureToggle(id: ID, user_id: ID): FeatureToggle "fetch a featureToggle by id" featureToggleForEditing(care_plan_id: ID, id: ID, user_group_id: ID, user_id: ID): FeatureToggle "fetch a folder by id" folder(custom_module_id: ID, id: String): Folder "Fetch folders collection" folders(client_id: String = null, consolidated_user_id: String = null, document_to_move_id: ID, filter: String = "all", folder_id: String = null, folder_to_move_id: ID = null, for_template_use: Boolean = false, keywords: String = null, private_user_id: String = null, provider_id: ID, should_paginate: Boolean = false, order_by: FolderOrderKeys = NAME_ASC, viewable_user_id: String = null): [Folder!] "Number of folders" foldersCount(consolidated_user_id: String = null, filter: String = "all", folder_id: String = null, keywords: String = null, private_user_id: String = null, provider_id: ID, viewable_user_id: String = null): Int "Fetch food items" foodSearch(exclude_recent: Boolean = null, food_type: String = null, keywords: String = null, upc: String = null, user_id: String = null, offset: Int = null, page_size: Int = 15, after: Cursor): [Food!] "Get size of food items that matches the keyword" foodSearchCount(exclude_recent: Boolean = null, food_type: String = null, keywords: String = null, upc: String = null, user_id: String = null): Int "Fetch a form answer group by id" formAnswerGroup(for_superbills: Boolean, external_id: String, appointment_form_answer_group_connection_id: ID, id: ID, ids: [ID] = null, track_opened_event: Boolean = false): FormAnswerGroup "All filled forms for a given set of arguments" formAnswerGroups(custom_module_form_id: ID, date: String, end_date: ISO8601Date = null, filler_id: String, form_answer_group_id: String, ids: [ID], include_group_notes: Boolean, name: String, user_id: String, locked_status: Boolean, signed_status: Boolean, start_date: ISO8601Date = null, updated_after: ISO8601DateTime, updated_before: ISO8601DateTime, order_by: FormAnswerGroupOrderKeys = CREATED_AT_DESC, use_for_charting: Boolean = false, offset: Int = 0, page_size: Int = 10, should_paginate: Boolean = false, after: Cursor): [FormAnswerGroup!] "The number of filled forms for a given set of a arguments" formAnswerGroupsCount(custom_module_ids: [ID], date: String, end_date: ISO8601Date = null, filler_id: String, form_answer_group_id: String, ids: [ID], name: String, user_id: String, locked_status: Boolean, signed_status: Boolean, start_date: ISO8601Date = null, updated_after: ISO8601DateTime, updated_before: ISO8601DateTime, use_for_charting: Boolean = false): Int "Form histories owned by a patient and related to a sourceable form (RequestedFormCompletion / OnboardingItem)" formHistories(patient_id: ID, sourceable_id: ID, sourceable_type: FormHistorySourceable, offset: Int = 0): [FormHistory!]! "Total count of form histories owned by a patient and related to a sourceable form (RequestedFormCompletion / OnboardingItem)" formHistoriesCount(patient_id: ID, sourceable_id: ID, sourceable_type: FormHistorySourceable): Int! "Fetch available forms to request" formTypesToRequest(keywords: String): [FormTypesToRequest!] "Fullscript practitioners that share the same clinic id as organization owner" fullscriptPractitionerTypes: [FullscriptPractitionerTypeType!] "Fullscript practitioners that share the same clinic id as organization owner" fullscriptPractitioners: [FullscriptPractitionerType!] "fetch a goal by id" goal(client_id: ID = null, date: String = null, get_client_goal: Boolean = false, id: ID, patient_goal_module: Boolean = false, program_goal: Boolean): Goal "All completed goals for a given set of users" goalHistories(category: String = null, include_subgoals: Boolean = true, unique: Boolean = true, user_id: ID, offset: Int = 0, page_size: Int = 10, should_paginate: Boolean = true, after: Cursor): [GoalHistory!] "All completed goals for a given set of users" goalHistoriesCount(category: String = null, include_subgoals: Boolean = true, offset: Int = 0, unique: Boolean = true, user_id: ID): Int "Fetch goal history" goalHistory(id: ID = null): GoalHistory "A goal's instances" goalInstances(end_range: String = null, goal_id: ID = null, keywords: String = null, start_range: String = null, status_filter: String = null, offset: Int = 0, per_page: Int = 10, after: Cursor): [GoalInstance!] "Number of instances for a goal" goalInstancesCount(end_range: String = null, goal_id: ID = null, keywords: String = null, offset: Int = 0, per_page: Int = 10, start_range: String = null, status_filter: String = null): Int "Goal templates for given user" goalTemplates(category: String = null, keywords: String = null, user_id: ID = null): [GoalTemplate!] "Number of Goal templates for given user" goalTemplatesCount(keywords: String = null, user_id: ID = null): Int "All goals, either for a given user or for all of the providers clients" goals(category: String = null, end_range: String = null, frequency_filter: String = null, keywords: String = null, rel_goal_id: String = null, start_range: String = null, status_filter: String = null, user_id: ID, order_by: GoalOrderKeys = DUE_DATE_START_DATE_DESC, offset: Int = 0, per_page: Int = 10, after: Cursor): [Goal!] "Number of goal" goalsCount(category: String = null, end_range: String = null, frequency_filter: String = null, keywords: String = null, offset: Int = 0, rel_goal_id: String = null, start_range: String = null, status_filter: String = null, user_id: ID = null): Int "All goals data" goalsData(after: Cursor, category: String = null, end_range: String = null, frequency_filter: String = null, keywords: String = null, offset: Int = 0, per_page: Int = 10, rel_goal_id: String = null, order_by: GoalOrderKeys = DUE_DATE_START_DATE_DESC, start_range: String = null, status_filter: String = null, user_id: ID): GoalDataType "Overall completion percentage of goals" goalsOverallCompletionRate(category: String = null, end_range: String = null, frequency_filter: String = null, keywords: String = null, offset: Int = 0, rel_goal_id: String = null, start_range: String = null, status_filter: String = null, user_id: ID = null): Int @deprecated(reason: "Use goalsOverallCompletionRateInfo instead") "Overall completion percentage of goals" goalsOverallCompletionRateInfo(category: String = null, end_range: String = null, frequency_filter: String = null, goal_id: ID = null, keywords: String = null, offset: Int = 0, start_range: String = null, status_filter: String = null, user_id: ID = null): GoalOverallCompletionRateInfo "Overall completion percentage of goals" goalsStreakCount(category: String = null, end_range: String = null, frequency_filter: String = null, goal_id: ID = null, keywords: String = null, offset: Int = 0, start_range: String = null, status_filter: String = null, user_id: ID = null): Int "When true, the user can set up question conditions in the form builder" hasConditionalQuestionEditing: Boolean "Checks if the specified user has any forms to complete." hasFormsToComplete(user_id: ID!): Boolean "When true, the user can add sublabels to questions in the form builder" hasSubLabels: Boolean "DEPRECATED: Fetch a single health assessment" healthAssessment(device_token: String, device_type: String, email: String, run_id: ID, user_id: ID): HealthAssessment @deprecated(reason: "Deprecated, do not use") "Fetch Health Assessments" healthAssessments(device_token: String, device_type: String, email: String, run_id: ID, user_id: ID): [HealthAssessment!] "Fetch ICD Code by ID" icdCode(id: ID): IcdCode "All ICD Codes" icdCodes(is_billable: Boolean = null, is_favorited: Boolean, keywords: String = null, only_valid: Boolean = false, order_by: IcdCodeOrderKeys, offset: Int = 0, should_paginate: Boolean = false, after: Cursor): [IcdCode!] "Count of all ICD Codes" icdCodesCount(is_billable: Boolean = true, is_favorited: Boolean, keywords: String = null, only_valid: Boolean = false): Int "fetch import data request by user_id" importDataRequest(user_id: ID): ImportDataRequest "A new CMS1500 form with some objects already prefilled" initialCms1500(form_answer_group_id: ID, patient_id: ID, provider_id: String): Cms1500 "Initial form answers for a given user and template" initialFormAnswers(custom_module_form_id: ID = null, incomplete_form_id: ID = null, user_id: ID = null): [FormAnswer!] "Initial date of service for a new form answer group" initialServiceDate(appointment_id: ID, user_id: ID): ISO8601DateTime "appointment types related to offering" initializedOfferingIncludes(offering_id: ID = null): [OfferingInclude!] "Insurance Authorization belonging to a client" insuranceAuthorization(client_id: ID, id: ID): InsuranceAuthorizationType "Get all potential insurance plans" insurancePlans(ids: String, is_accepted: Boolean, is_custom: Boolean, keywords: String, order_by: InsurancePlanOrderKeys, offset: Int, should_paginate: Boolean, after: Cursor): [InsurancePlan!] "Get all potential insurance plans" insurancePlansCount(ids: String, is_accepted: Boolean, is_custom: Boolean, keywords: String): Int "Fetch intake flow." intakeFlow(keywords: String = null, order_by: IntakeFlowOrderKeys, user_id: ID = null, statuses: [FormStatus] = [], form_types: [FormType] = []): IntakeFlowType "Fetch list of available integrations" integrationsList(category: String = null): [IntegrationCategoryType!] "Initial date of service for a new form answer group" intitialServiceDate(appointment_id: ID, user_id: ID): String @deprecated(reason: "Use `initialServiceDate` instead") "get the base price for the invoice based off the associated item" invoiceBasePrice(cms1500_id: ID, offering_id: ID): String "Fetch invoice templates collection" invoiceTemplates(keywords: String = null): [RequestedPaymentTemplate!] "Get options for lab filters" labFiltersData: LabFiltersDataType "Fetch all lab options (considered public)" labOptions(search_by_organization: Boolean = false, search_string: String = null): [LabOption!] "Fetch onboarding flows collection" labOrder(id: ID): LabOrder "Fetch lab orders collection" labOrders(client_filter: String = null, client_id: ID, keywords: String = null, lab_filter: String = null, orderer_filter: String = null, provider_filter: String = null, reviewing_provider_filter: String = null, recent_orders: Boolean = false, order_by: LabOrderOrderKeys = UPDATED_AT_DESC, status_filter: String = null, offset: Int = 0, page_size: Int = 10, after: Cursor): [LabOrder!] "Number of lab orders related to the current user" labOrdersCount(client_filter: String = null, keywords: String = null, lab_filter: String = null, provider_filter: String = null, orderer_filter: String = null, reviewing_provider_filter: String = null, status_filter: String = null): Int "Fetch a laboratory result by ID" labResult(id: ID!): LabResult "Fetch most recent conversationMembership" lastCM(active_status: String = "active", provider_id: ID = null): ConversationMembership "The 6 most recently active clients" lastClientActivities(limit: Int = 6): [User!] "has loadMoreNotes been called" loadMoreNotesCalled: Boolean "fetch a location by id" location(id: ID): Location "Get location resources" locationResources(location_ids: String = null): [LocationResourceType!] "Get locations for a given user (or current user)" locations(has_name: Boolean = null, has_service_facilities: Boolean = false, keywords: String, user_id: String = null, offset: Int = 0, page_size: Int = 10, should_paginate: Boolean = false, after: Cursor): [Location!] "A count of available locations for the current user" locationsCount(has_name: Boolean = false, keywords: String, has_service_facilities: Boolean = false): Int "Fetch user meals" mealSearch(keywords: String = null, user_id: String = null, offset: Int = null, page_size: Int = 15, after: Cursor): [Meal!] "Get size of user meals that matches the keyword" mealSearchCount(keywords: String = null, user_id: String = null): Int "Meal plan options from user Living Plate account. Nil if no Living Plate account associated" meal_plan_options: [MealPlan!] "Fetch a medication by ID" medication(id: ID): MedicationType medication_option(id: ID!): MedicationOptionType "Fetch an array of medications options. Considered Public" medication_options(keywords: String): [MedicationOptionType!] "Fetch an array of medications for a given patient" medications(active: Boolean, patient_id: ID, unreconciled_from_ccda_ingest: Boolean = false): [MedicationType!] "Fetch count of medications for a given patient" medications_count(active: Boolean, patient_id: ID): Int "Fetch data for the metric graphs for a given user" metricGraphData(category: String = "", end_date: String, entry_type: String = "MetricEntry", has_third_party_source: Boolean, multiplier: String = null, start_date: String, user_id: String = null): MetricGraphDataType "Fetch data for the metric graphs for a given user" metricGraphsData(end_date: String, has_third_party_source: Boolean, start_date: String, user_id: String = null): [MetricGraphDataType!]! minimumOfferingPrice(lab_option_ids: [ID] = [], state: String): String "returns metadata about monthly payments" monthlyBillingItemsData(gross: Boolean, org_level: Boolean): [MonthlyBillingItemsDataType!] "Graph data with multiple data series for a single specified metric category" multiLineMetricGraphData(category: String = "", end_date: String, entry_type: String = "MetricEntry", food_graph_type: String = "nutrients_split", start_date: String, sub_category: String = "", user_id: String = null): MultiLineMetricGraphDataType "String containing info for the user about the client upgrade price" newClientPriceString(new_client_num: Int): String "String containing info for the user about the org upgrade price" newOrganizationPriceString(new_provider_num: Int): String "String containing info for the user about the org upgrade price when adding a new support user" newOrganizationSupportPriceString(new_support_num: Int): [String] "Fetch closest appointment" nextAppointment: Appointment "get open appointment times for a range (considered public)" nextAvailableSlot(appointment_to_reschedule_id: ID, appt_loc_id: String, appt_type_id: String, contact_type: String, end_date_boundary: String, length: String, licensed_in_state: String = null, accepts_insurance_plan_id: ID = null, org_level: Boolean = false, outside_factors: Boolean = true, provider_id: String, provider_ids: [String], tag_ids: [ID], start_date_boundary: String, timezone: String): String "fetch a courseitem by id (considered public)" nextCourseItem(id: ID): CourseItem "fetch a note by id" note(id: ID): Note "get the viewed status of a note" noteViewedStatus(id: ID): Boolean "Fetch note scheduler by id" note_scheduler(id: ID): NoteScheduler "Fetch paginated note collection for given conversation" notes(conversation_id: ID, ids: [ID], keywords: String = null, org_chat: Boolean = false, provider_id: ID = null, scheduled_notes: Boolean = false, since_note_id: ID, order_by: NoteOrderKeys = CREATED_AT_DESC, with_tasks: Boolean = false, offset: Int = 0, page_size: Int = 10, after: Cursor): [Note!] "Number of notes" notesCount(conversation_id: ID, keywords: String = null, org_chat: Boolean = false, provider_id: ID = null, scheduled_notes: Boolean = false): Int "Get count of notifications for a given user (or for the current user)." notificationCount(other_party_id: String = null, read_status: Boolean = null, seen_status: Boolean = null, types: [String] = null): Int "fetch a Notification Setting by id" notificationSetting(id: ID): NotificationSetting "get notifications for a given user (or for the current user)" notifications(other_party_id: String = null, read_status: Boolean = null, seen_status: Boolean = null, types: [String] = null, order_by: NotificationOrderKeys = CREATED_AT_DESC, offset: Int = 0, page_size: Int = 10, after: Cursor): [Notification!] "fetch an offering by id (considered public)" offering(id: ID): Offering "Fetch paginated list of users associated with an offering" offeringBillingItems(offering_id: ID, offset: Int = 0): [BillingItem!] "Number of users associated with an offering" offeringBillingItemsCount(offering_id: ID): Int "Fetch paginated coupon offerings collection" offeringCoupons(from_package_details: Boolean = false, keywords: String = null, offering_id: ID, user_id: ID, order_by: OfferingCouponOrderKeys = CODE_ASC, page_size: Int = 10, offset: Int = 0, after: Cursor): [OfferingCoupon!] "Number of offering coupons" offeringCouponsCount(from_package_details: Boolean = false, keywords: String, offering_id: ID): Int "Get all user groups relating to offerings" offeringGroupVisibilities(provider_id: ID): [OfferingGroupVisibility!] "Fetch offering images available to the current user" offeringImages: [OfferingImage!] "Fetch paginated offerings collection (considered public)" offerings(client_visibility: String, keywords: String = null, offering_id: ID, offering_ids: [ID], offering_user_group_id: ID, only_client_visible: Boolean = false, provider_id: ID, show_only_visible: Boolean = false, order_by: OfferingOrderKeys = SET_ORDER, status: String, offset: Int = 0, page_size: Int, should_paginate: Boolean = true, after: Cursor): [Offering!] "Number of offerings (considered public)" offeringsCount(client_visibility: String, keywords: String = null, offering_id: ID, offering_ids: [ID], offering_user_group_id: ID, only_client_visible: Boolean = false, provider_id: ID, should_paginate: Boolean = true, status: String): Int "returns metadata about offerings purchased" offeringsData(org_level: Boolean): [OfferingsDataType!] "fetch the current users officeally sftp connection" officeallySftpAccount: OfficeallySftpAccount "Fetch an onboarding flow by id or uuid" onboardingFlow(id: ID, user_id: ID, uuid: String): OnboardingFlow "Fetch onboarding flows collection" onboardingFlows(keywords: String = null, order_by: OnboardingFlowOrderKeys = NAME_ASC, offset: Int = 0, should_paginate: Boolean = true, page_size: Int = 10, after: Cursor): [OnboardingFlow!] "Number of onboarding flows" onboardingFlowsCount(keywords: String = null, offset: Int = 0): Int "fetch an onboarding item by id (considered public)" onboardingItem(id: ID, user_id: ID, track_opened_event: Boolean = false): OnboardingItem "Returns all cpt codes associated with org providers" orgProvidersCptCodes(org_id: ID): [ProviderCptCodeType!] "Fetch an organization by id, by provider id, or by the current_user, demographic org info is (considered public)" organization(email: String, for_client: Boolean, id: ID, provider_id: ID): Organization "Returns organization cpt code object" organizationCptCode(id: ID): OrganizationCptCodeType "Fetch CPT code and fee schedule pricing by CPT code ID" organizationFeeScheduleCptCode(cpt_code_id: ID!): OrganizationFeeScheduleCptCodeType "Provides CPT codes for an organization as configured in their fee schedule" organizationFeeScheduleCptCodes(keywords: String, after: String, before: String, first: Int, last: Int): OrganizationFeeScheduleCptCodeTypeConnection "Fetch organization info by id" organizationInfo(id: ID): OrganizationInfo "fetch members of organization" organizationMembers(conversation_id: ID, keywords: String = null, licensed_in_state: String = null, order_by: UserOrderKeys = LAST_NAME_ASC, offset: Int = 0, page_size: Int = 10): [User!] "org members count" organizationMembersCount(conversation_id: ID, keywords: String = null, licensed_in_state: String = null): Int "Get the organization membership info of the current user, basic org member info is (considered public)" organizationMembership(user_id: ID, id: ID): OrganizationMembership "Get the organization memberships" organizationMemberships(id: String, order_by: OrganizationMembershipOrderKeys, user_ids: [ID]): [OrganizationMembership!] "fetch an Other Id Number by id" otherIdNumber(id: ID): OtherIdNumber "A collection of Other ID's and its Qualifiers for given user" otherIdNumbers(user_id: ID): [OtherIdNumber!] "returns true if the there are more transfers to load" paginate_transfers(limit: Int, payout_account_id: ID, starting_after: String): Boolean "Fetch a patient encounter" patientEncounter(id: ID, appointment_id: ID, patient_id: ID): PatientEncounter "Fetch a single payout account by ID" payoutAccount(id: ID!): PayoutAccount "List all payout accounts for the current organization" payoutAccounts(after: String, before: String, first: Int, last: Int): PayoutAccountPaginationConnection pdfLetterheadTemplate(id: ID!): PdfLetterheadTemplate "PDF Letterhead HTML String. Falls back to the system default template unless `pdf_letterhead_template_id` is given" pdfLetterheadTemplatePreview(pdf_letterhead_template_id: ID, patient_id: ID): String "Fetch permission template" permissionTemplate(id: ID): PermissionTemplateType "Get Permission Templates" permissionTemplates(offset: Int = 0, page_size: Int = 5, after: Cursor): [PermissionTemplateType!] "Number of permission templates" permissionTemplatesCount: Int "Fetch a pharmacy given dosespot pharmacy id" pharamcy(id: String): Pharmacy @deprecated(reason: "Use `pharmacy` instead") "Fetch an array of pharmacies given search parameters" pharmacies(address: String, city: String, name: String, ncpdp_id: String, phone_or_fax: String, specialties: [String], state: String, zip: String): [Pharmacy!] "Fetch a pharmacy given dosespot pharmacy id" pharmacy(id: String): Pharmacy "Get possible phased appointments times for a date. Phased appointments are two appointments that are scheduled back to back or concurrently. Returns an array of two appointment slot pairings that match the requested criteria." phasedAvailableSlotsForRange(organization_id: ID!, phase_type: PhasedAppointmentType = BACK_TO_BACK, appointment_1_filters: FiltersInput!, appointment_2_filters: FiltersInput!, date: ISO8601DateTime, timezone: String = "America/New_York"): [CombinedPotentialAppointmentSlots!] "Fetch all place of services" placeOfServices: [PlaceOfService!] "fetch a Plan by id (considered public)" plan(id: ID): Plan "fetch a policy by id" policy(id: ID): Policy "Fetch collection of preferred CPT/ICD codes" preferred_medical_codes(code_type: String = null): [PreferredMedicalCode!] "Fetch a prescription for a given patient and prescription ID pulled from DoseSpot" prescription(patient_id: ID, prescription_id: String): Prescription "Fetches combined list of prescriptions and medications" prescriptionMedications(patient_id: ID, filters: PrescriptionMedicationQueryFiltersInput, keyword: String, order_by: PrescriptionMedicationOrderBy = NAME_ASC, first: Int = 10, after: Cursor): PrescriptionMedicationConnection "Fetch an array of prescriptions for a given patient pulled from DoseSpot" prescriptions(patient_id: ID, status: String, make_unique: Boolean = true, current_only: Boolean = true): [Prescription!] @deprecated(reason: "Use `prescriptionMedications` instead") "fetch a courseitem by id (considered public)" prevCourseItem(id: ID): CourseItem "Fetch paginated product collection" products(keywords: String = null, order_by: ProductOrderKeys = NAME_ASC, offset: Int = 0, page_size: Int = 20, should_paginate: Boolean = true, after: Cursor): [Product!] "Number of products" productsCount(keywords: String = null): Int "fetch a provider by id" provider(client_id: ID, id: ID, organization_info_id: ID, super_bill_id: ID): User "Fetch a single accepted insurance plan for a provider" providerAcceptedInsurancePlan(id: ID!): ProviderAcceptedInsurancePlanType "Accepted insurance plans for a provider" providerAcceptedInsurancePlans(provider_id: ID!): [ProviderAcceptedInsurancePlanType!]! "get provider appointment locations." providerAppointmentLocations(provider_id: ID): [AppointmentLocation!] "Returns all cpt codes associated with this provider" providerCptCodes(provider_id: ID): [ProviderCptCodeType!] "Fetch generic custom modules for use in the form builder" questionBankModules(category: String = "default", keywords: String = null): [CustomModule!] "Fetch receipt_line_items collection by super_bill_id" receiptLineItems(super_bill_id: ID): [ReceiptLineItem!] "Fetch received direct message via ID" receivedDirectMessage(id: ID): ReceivedDirectMessage "Fetch Received Direct Messages" receivedDirectMessages(offset: Int = 0, keywords: String = null, order_by: ReceivedDirectMessageOrderKeys = CREATED_AT_DESC): [ReceivedDirectMessage!] "Fetch number of Received Direct Messages" receivedDirectMessagesCount(offset: Int = 0, keywords: String = null): Int "Fetch Received Fax by ID" receivedFax(id: ID): ReceivedFax "Fetch paginated Received Faxes collection" receivedFaxes(active_status: String = "active", keywords: String = null, order_by: ReceivedFaxOrderKeys = CREATED_AT_DESC, offset: Int = 0, page_size: Int = 20, after: Cursor): [ReceivedFax!] "Number of Received Faxes" receivedFaxesCount(active_status: String = "active", keywords: String = null): Int "Fetch recent food items" recentFoods(food_type: String = null, keywords: String = null, user_id: String = null): [Food!] "Query a single recurring appointment" recurringAppointment(id: ID!): RecurringAppointment "Fetch recurring forms collection" recurringForms(connectable_id: String = null, connectable_type: String = "UserGroup"): [RecurringForm!] "Fetch a recurring payment by id" recurringPayment(id: ID): RecurringPayment "Fetch active recurring_payments" recurringPayments(active_status: String = "active", user_id: ID): [RecurringPayment!] "Fetch Referral by ID" referral(id: ID): Referral "Get referring physician based on id" referringPhysician(has_fax_number: Boolean = false, id: ID, user_id: String): ReferringPhysician "all referring physicians based on current user" referringPhysicians(has_fax_number: Boolean = false, keywords: String = null, order_by: ReferringPhysicianOrderKeys = NAME_ASC, offset: Int = 0, page_size: Int = 10, should_paginate: Boolean = false, after: Cursor): [ReferringPhysician!] "Number of referring physicians" referringPhysiciansCount: Int "fetch a requested form completion by id" requestedFormCompletion(id: ID, track_opened_event: Boolean = false): RequestedFormCompletion "Fetch requested form completions collection" requestedFormCompletions(keywords: String = null, status: String = null, user_id: ID = null): [RequestedFormCompletion!] "fetch a requested payment (invoice) by id" requestedPayment(id: ID, invoice_id: String, preview: Boolean = false, uuid: String): RequestedPayment "Fetch paginated Requested Payments collection" requestedPayments(keywords: String = null, preview: Boolean = false, sender_id: ID = null, status_filter: String = null, order_by: RequestedPaymentOrderKeys = CREATED_AT_DESC, offset: Int = 0, page_size: Int = 20, after: Cursor): [RequestedPayment!] "Number of Requested Payments" requestedPaymentsCount(keywords: String = null, sender_id: ID = null, status_filter: String = null): Int "Fetch specific saved filter" savedFilter(id: ID, uuid: ID): SavedFilter "Fetch all saved filters for a user or organization" savedFilters(user_id: ID, organization_id: ID): [SavedFilter!] "Fetch user's scheduled message blasts" scheduledMessageBlasts(org_chat: Boolean = false, client_id: String = null, provider_id: ID = null, provider_ids: [ID] = null): [NoteScheduler!] "Fetch collection of all scheduled packages" scheduledUserPackageSelections(user_id: ID): [ScheduledUserPackageSelection!] "SDK configuration" sdkConfig(version: String): SDKConfig! "Fetch sent direct message via ID" sentDirectMessage(id: ID): SentDirectMessage "Fetch Sent Direct Messages" sentDirectMessages(offset: Int = 0, keywords: String = null, order_by: SentDirectMessageOrderKeys = CREATED_AT_DESC): [SentDirectMessage!] "Fetch number of Sent Direct Messages" sentDirectMessagesCount(offset: Int = 0, keywords: String = null): Int "Fetch sent Fax by ID" sentFax(id: ID!): SentFax "Fetch paginated Sent Faxes collection" sentFaxes(keywords: String = null, order_by: SentFaxOrderKeys = CREATED_AT_DESC, offset: Int = 0, page_size: Int = 20, after: Cursor): [SentFax!] "Number of Sent Faxes" sentFaxesCount(keywords: String = null): Int "Fetch a single notification record by ID." sentNotificationRecord(id: ID!): SentNotificationRecord "Fetch notification list for a specific client or list of clients." sentNotificationRecords(end_date: String, org_level: Boolean, patient_id: ID, provider_id: ID, should_paginate: Boolean = false, start_date: String, status: String, type: String, offset: Int = 0): [SentNotificationRecord!] "Get number of SentNotificationRecord entries" sentNotificationRecordsCount(end_date: String, org_level: Boolean = false, patient_id: ID, provider_id: ID, start_date: String, status: String, type: String): Int "Fetch paginated SentWebhooks collection. SentWebhook records are available for 180 days." sentWebhooks(keywords: String = null, order_by: SentWebhookOrderKeys = CREATED_AT_DESC, sent_after: ISO8601DateTime = null, sent_before: ISO8601DateTime = null, resource_id: ID, resource_type: SentWebhookResourceType, failed: Boolean, offset: Int = 0, page_size: Int = 20, after: Cursor): [SentWebhook!] "Number of SentWebhooks. SentWebhook records are available for 180 days." sentWebhooksCount(keywords: String = null, resource_id: ID, resource_type: SentWebhookResourceType, http_response_status: String): Int "Fetch serving sizes for a food" servingSizes(food_id: String): [ServingSize!] "A HTML string of charting note answers" shareNotePreview(answers: String, form_answer_group_id: String, letterhead: Boolean, pdf_letterhead_template_id: ID = null, include_header_on_every_page: Boolean = false, user_id: String): String "A document or folder that can be shared with users or groups" shareable(id: ID!, shareable_type: ShareableType!): Shareable "Should current user see scheduled chat tab" showScheduledTab: Boolean "Get the signed stream name for a given stream name" signedStreamName(conversation_id: ID, appointment_id: ID, type: SignedStreamName!): String "Fetch user smart phrases" smartPhrases(keywords: String = null, order_by: SmartPhraseOrderKeys = NAME_ASC, user_id: ID, offset: Int = null, should_paginate: Boolean = true, page_size: Int = 15, after: Cursor): [SmartPhrase!] "Get size of user smart phrases that matches the keyword" smartPhrasesCount(keywords: String = null): Int "initial cpt codes for a new super bill" startingSuperBillCptCodes(form_answer_group_id: ID = null, form_answer_group_ids: [ID] = null, user_id: ID = null): [CptCodesSuperBill!] "initial icd10 codes for a new super bill" startingSuperBillIcd10s(form_answer_group_id: ID = null, user_id: ID = null): [IcdCodesSuperBill!] "Return providers' state licenses" stateLicenses(provider_id: ID, provider_ids: [ID]): [StateLicense!] "Default Stripe bank account object associated to a practitioner stripe account" stripeBankAccount: StripeBankAccountType "Information about the user's stripe company" stripeCompany: StripeCompanyType "An array containing information about countries that stripe supports" stripeCountries: [StripeCountry!] "An object containing info about a country that stripe supports" stripeCountry(country_code: String): StripeCountry "Fetch all Stripe payment methods for a user" stripeCustomerDetails(user_id: ID): [StripeCustomerDetail!] "All subgoals for a given goal" subGoals(goal_id: ID, user_id: ID, offset: Int = 0): [Goal!] "Number of subgoals" subGoalsCount(goal_id: ID, offset: Int = 0, user_id: ID = null): Int "Get the current users subscription" subscription: SubscriptionInstance "fetch a superbill by id" superBill(id: ID): SuperBill "Fetch paginated super bills collection" superBills(client_id: ID, keywords: String = null, provider_id: ID, order_by: SuperBillOrderKeys = CREATED_AT_DESC, status: String = "all", offset: Int = 0, page_size: Int = 20, after: Cursor): [SuperBill!] "Number of super bills" superBillsCount(client_id: ID, keywords: String = null, provider_id: ID, status: String = "all"): Int "Fetch medication history from the Surescripts history (via Dosespot). Patient consent must be confirmed via the API before calling." surescriptsReportedMedicationHistory(patient_id: ID, start_date: ISO8601DateTime = null, end_date: ISO8601DateTime = null, page_number: Int = 1): [Prescription!] @deprecated(reason: "Use API version 2025-11-30 or later to return MedicationHistoryType connection") "A collection of tags related to current patient/provider/organization" tags(applied_to_providers: Boolean, ids: [ID], order_by: TagOrderKeys = NAME_ASC, user_id: String): [Tag!] "Number of tags" tagsCount(applied_to_providers: Boolean, ids: [ID], user_id: String): Int "A paginated collection of tags related to current patient/provider/organization" tagsPaginated(applied_to_providers: Boolean, ids: [ID], order_by: TagOrderKeys = NAME_ASC, user_id: String, after: String, before: String, first: Int, last: Int): TagPaginationConnection task(id: ID): Task "All tasks assigned to a provider or client" tasks(assigned_to_user: Boolean = null, assignees: [ID] = null, client_id: String, completed_status: String, created_by_self: Boolean = null, keywords: String, show_hidden: Boolean = true, smart: Boolean = null, type: String, order_by: TaskOrderKeys, offset: Int, per_page: Int = 10, withoutPagination: Boolean = false, after: Cursor): [Task!] "All tasks assigned to a provider or client" tasksCount(assigned_to_user: Boolean = null, assignees: [ID] = null, client_id: String, completed_status: String, created_by_self: Boolean = null, keywords: String, show_hidden: Boolean, smart: Boolean = null, type: String): Int "Fetch a taxonomy code by ID" taxonomyCode(id: ID): TaxonomyCode "Assignable NUCC taxonomy codes" taxonomyCodes(keywords: String, after: String, before: String, first: Int, last: Int): TaxonomyCodePaginationConnection timesForRange(appt_loc_id: String, appt_type_id: String, endDate: String, length: String, startDate: String): [String] @deprecated(reason: "use availableSlotsForRange.") "fetch transactions for the current user" transactions(payout_id: String, user_id: String): [TransactionType!] "fetch transfers for the current user" transfers(limit: Int, payout_account_id: ID, order_by: TransferOrderKeys = CREATED_AT_DESC, starting_after: String): [TransferType!] "Fetch an array of treatment plans and recommended products from Fullscript given a user id" treatmentPlans(user_id: String): [FullscriptTreatmentPlanType!] "Get the users completed onboarding items, that are not part of the users current flow" unassociatedCompletedOnboardingItems(user_id: ID): [CompletedOnboardingItem!] "Get the listed values of feature flags for an explicit organization/provider context (unauth-friendly)" unauthFeatureFlags(flag_names: [FeatureFlagNameEnum!]!, provider_id: ID, organization_id: ID): [FeatureFlag!] "fetch ungrouped course memberhips belonging to a a specific course" ungroupedCourseMemberships(course_id: ID, course_status: String, offset: Int = 0): [CourseMembership!] "count of ungrouped course memberhips for a specific course" ungroupedCourseMembershipsCount(course_id: ID, course_status: String): Int "Fetch a user by ID" user(clear_notifs: Boolean = true, id: ID, or_current_user: Boolean = false): User "fetch a user group by id" userGroup(id: ID): UserGroup "Fetch paginated user groups collection" userGroups(keywords: String = null, check_group_level_actions: Boolean = false, order_by: UserGroupOrderKeys = NAME_ASC, offset: Int = 0, should_paginate: Boolean = false, page_size: Int = 10, after: Cursor): [UserGroup!] "Number of user groups" userGroupsCount(keywords: String = null, check_group_level_actions: Boolean = false): Int "Fetch collection of all purchased packages" userPackageSelections(offering_id: ID, user_id: ID, offset: Int = 0, page_size: Int = 20, after: Cursor): [UserPackageSelection!] userPackageSelectionsCount(offering_id: ID, offset: Int = 0, user_id: ID): Int "Fetch paginated patients collection (use organizationMembers query for providers)" users(active_status: String = null, conversation_id: ID, convo_patients_only: Boolean = false, expect_conversation_id: Boolean = false, from_superadmin: Boolean = false, group_id: String = null, has_cc_on_file: Boolean, id: ID, ids: [ID], keywords: String = null, limited_to_provider: Boolean = false, provider_id: String = null, show_all_by_default: Boolean = true, order_by: UserOrderKeys = LAST_NAME_ASC, tag_ids: [ID] = [], with_feature_toggles: Boolean = false, include_suborg_patients: Boolean = true, offset: Int = 0, page_size: Int = 10, should_paginate: Boolean = true, after: Cursor): [User!] "Number of users" usersCount(active_status: String = null, conversation_id: ID, convo_patients_only: Boolean = false, expect_conversation_id: Boolean = false, group_id: String = null, has_cc_on_file: Boolean, keywords: String = null, limited_to_provider: Boolean = false, include_suborg_patients: Boolean = true, provider_id: String = null, show_all_by_default: Boolean = true, tag_ids: [ID] = []): Int "Check if a coupon is valid, and return the new price (considered public)" validateCoupon(coupon_code: String, offering_id: ID, provider_id: ID, requested_payment_id: ID): ValidateOfferingCoupon "Check if a reset password token is valid" validateResetPasswordToken(token: String = null): Boolean "Check if a signup token is valid" validateSignupToken(token: String = null): Boolean "Fetch static Visualize dashboard by type" visualizeDashboard(dashboard_type: String!): VisualizeDashboardType waterIntakeEntry(created_at: String, entry_id: ID): Entry "Fetch possible Webhook event types" webhookEventTypes: [String!] "Fetch paginated Webhooks collection" webhooks(keywords: String = null, order_by: WebhookOrderKeys = CREATED_AT_DESC, offset: Int = 0, page_size: Int = 20, after: Cursor): [Webhook!] "Number of Webhooks" webhooksCount(keywords: String = null): Int "Whitelabel setting to use" whitelabelSetting(branded_url: String): WhitelabelSetting "Fetch Write Off by ID" writeOff(id: ID!): WriteOff "Generate a JWT to be used in the client-side Zoom SDK. This is just available on production, and requires your account to be approved by Healthie. The JWT is valid for 1 day." zoomSdkJwt(mn: String, role: String): String } "receipt line item" type ReceiptLineItem { "Date of service (as a date)" created_at: String! "description of line item" description: String "The unique identifier of the line item" id: ID! "previous price" previous_price: String "price of line item" price: String "id of super bill" super_bill_id: ID "updated at" updated_at: String! } "A Received Direct Message" type ReceivedDirectMessage { "The number of attachments for the received direct message" attachments_count: Int "The XML data contained in the attach CDA file" cda_xml: String "The received date of the direct message" created_at: String "Array of direct message attachments" direct_message_attachments: [DirectMessageAttachment!] "When true, the message has an attached CDA" has_cda: Boolean "The unique identifier of the fax" id: ID! "The listed recipient" listed_recipient: String "The listed sender" listed_sender: String "The message body of the direct message" message_body: String "The patient associated with the direct message. Will be nil if the direct message is not associated" patient: User "The subject" subject: String } "A Received Fax" type ReceivedFax { "The archived status of the fax" archived: Boolean! "Any user added comments on the fax" comments: String "The received date of the fax" created_at: String! "Pagination cursor" cursor: Cursor! "The number of the sender of the fax" from_number: String "The unique identifier of the fax" id: ID! "Returns the referral provider name if fax number is found" referring_provider_name: String "Whether the received fax has been viewed by the current user" viewed_by_current_user: Boolean } "A Care Plan Recommendation" type Recommendation { "The category of the recommendation" care_plan_recommendation_category: CarePlanRecommendationCategory "The unique identifier of the recommendation" id: ID! "Recommendation text" recommendation_body: String "The type of recommendation (1)Activity, (2)Nutrition, (3)Supplement, (4)Other" recommendation_type: String "Sanitized recommendation_body" sanitized_body: String } "A Recurring Appointment" type RecurringAppointment { "All appointments for recurring appointment" appointments(after: String, before: String, first: Int, last: Int, order_by: AppointmentOrderKeys = DATE_ASC): AppointmentPaginationConnection "The unique identifier of the recurring appointment" id: ID! "True when every appointment in the series has been created. Used by the web app to gate series-level edits during background creation." is_series_creation_complete: Boolean! "Auto-register clients for all appointments in series" join_all: Boolean! "The ID of the previous recurring appointment if this was split from another" previous_recurring_appointment_id: ID "Interval between each appointment in the series" repeat_interval: String "Count of the appointment recurrences" repeat_times: String } "Each data point has a time range and the days that are in that time range" type RecurringDaysData { "The days that are in the time range" day_ranges: [DayRangeType!] "The unique identifier of the recurring days data" id: ID! } "A Recurring Form" type RecurringForm { "Associated custom module form" custom_module_form: CustomModuleForm "The ID of the form itself" form_id: String "The type of form" form_type: String! "Whether the user or group is connected to the recurring form" has_connected_recipient(connectable_id: ID, connectable_type: String): Boolean "The unique identifier of the recurring form" id: ID! "The interval of recurrence. Can be: '23:12' / 'Monday, Tuesday' / '31st'" interval: String "The type of recurrence('Daily'(1) / 'Weekly'(2) / 'Monthly'(3))" interval_type: String "Whether the recurrence is active or not" is_active: Boolean! "The day when recurrence ends" recurrence_end_at: String "Get user_group assigned to the recurring form" userGroups: [UserGroup!] "The ID of the provider who set up recurrence" user_id: String "Get patients assigned to the recurring form" users: [User!] "The identifiers of associated users and groups: ['1', '2', 'group-5', 'group-13']" users_and_groups: [String]! } "Recurring Payment" type RecurringPayment { "The amount of recurring payment" amount_paid: String "The amount to be paid for the next payment" amount_to_pay: String "The ID of the appointment associated with this recurring payment" appointment_id: ID "The frequency the payment should be made" billing_frequency: String "The number of billing items" billing_items_count: String "The date on which the recurring payment is canceled" canceled_at: String "The provider who canceled the recurring payment" canceled_by: User "The date on which the recurring payment is created" created_at: String! "Includes the next payment date, returns true if next payment date is set and payments remaining is greater than zero" has_next_payment_date: Boolean "Whether or not this recurring payment has scheduled billing item" has_scheduled_billing_item: Boolean "The unique identifier of the recurring payment" id: ID! "If the recurring payment has been canceled" is_canceled: Boolean! "Whether or not the recurring payments has been paused" is_paused: Boolean! "The last billing item for this recurring payment" last_billing_item: BillingItem "The date of the next payment" next_payment_date: String "The next payment date if the recurring payment is restarted" next_restart_payment_date: String "The ID of the coupon" offering_coupon_id: ID "The offering ID" offering_id: ID "The name of the offering associated with recurring payment" offering_name: String "The original price" original_price: String "The date on which the recurring payment is paused" paused_at: String "The provider who paused the recurring payment" paused_by: User "Count remaining payments or returns Until Canceled" payments_remaining: String "The ID of the receiver" recipient_id: ID "The number of times the payment should repeat" repeat_tiems: String @deprecated(reason: "Use `repeat_times` instead") "The number of times the payment should repeat" repeat_times: String "The ID oft the sender" sender_id: ID "The date payments should begin" start_at: String "The updated at date" updated_at: String } "A referral" type Referral { "created at" created_at: String! "The unique identifier of the referral" id: ID! "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String "The reason the client was referred to the physician" referral_reason: String "The referring physician" referring_physician: ReferringPhysician "id of the referring physician" referring_physician_id: ID "updated at" updated_at: String! "The referred client" user: User "id of the referred client" user_id: ID } "The referral information for a CMS1500 claim" type ReferralInfo { "The state the auto accident occurred in" auto_accident_state: String "The date of current illness, injury, or pregnancy" case_date: String "The qualifier for case_date" case_qualifier: String "The associated CMS1500" cms1500: Cms1500 @deprecated(reason: "You are no longer able to get the cms1500 from the referral info") "The id of the associated CMS1500" cms1500_id: String "Options that the condition can be related to" condition_related_to: [String] "The end of the hospitalization period" hospitalization_end: String "The start of the hospitalization period" hospitalization_start: String "The unique identifier of the referral info" id: ID "This field identifies additional date information about the patient's condition or treatment." other_associated_date: String "The qualifier for other_associated_date" other_associated_qualifier: String "The prior authorization number" prior_auth_number: String "The first name of the referring provider" ref_provider_first: String "The last name of the referring provider" ref_provider_last: String "The middle name of the referring provider" ref_provider_middle: String "The NPI of the referring provider" ref_provider_npi: String "The other id of the referring provider" ref_provider_other_id: String "The other id qualifier of the referring provider" ref_provider_other_id_qual: String "The qualifications of the referring provider" ref_provider_qual: String "The date of the referral" referral_date: String "The associated referring physician" referring_physician: ReferringPhysician "The id of associated referring physician" referring_physician_id: ID "The end of the unable to work period" unable_to_work_end: String "The start of the unable to work period" unable_to_work_start: String } "a referring physician" type ReferringPhysician { accepts_insurance: Boolean "Business Name of physician" business_name: String "created at" created_at: String! "Pagination cursor" cursor: Cursor! "email of physician" email: String "fax number of physician" fax_number: String "first name of physician" first_name: String "full name of physician" full_name: String "The unique identifier of the physician" id: ID! "last name of physician" last_name: String "The associated location" location: Location "location id" location_id: ID "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String "Dietitian's notes" notes: String "npi of physician" npi: String "Saved Other ID associated with this provider" other_id: String "Qualifier for Other ID" other_id_qualifier: String "phone number of physician" phone_number: String "The user who entered the referring physician" provider: User! "Associated users" referrals: [Referral!] "Associated users count" referrals_count: Int "Physician's speciality" speciality: String "updated at" updated_at: String! "Physician's website" website: String } "Autogenerated return type of RefetchChangeHealthLabOrder." type RefetchChangeHealthLabOrderPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "A refunding item of a related billing item" type RefundItem { "The ID of the billing_item" billing_item_id: String "The currency" currency: String "The unique identifier of the refund" id: ID! "The refund amount" refund_amount: String "The refund date" refund_date: String "The status of refunding" status: String } "A Related Object" type RelatedObject { "A combined string to use for labels" full_name: String "The Healthie unique identifier" id: ID! } "A reminder object" type Reminder { "The unique identifier of the reminder" id: ID! "Interval of a reminder ex. daily" interval_type: String! "Value of the reminder interval ex. monday" interval_value: String "True if reminder is active" is_enabled: Boolean! } "The selected date range for specific report" type ReportsDateFilterSelection { "The selected date range for appointments" appointments: String "The selected date range for authorizations" authorization: String "The selected date range for bank transfers" bank_transfers: String "The selected date range for client activities" client_activity: String "The selected date range for client blood sugar metrics" client_blood_sugar_metrics: String "The selected date range for client credits" client_credits: String "The selected date range for clients list" client_list: String "The selected date range for client metrics" client_metrics: String "The selected date range for client statuses" client_status: String "The selected date range for cms 1500s" cms_1500s: String "The unique identifier of the selection" id: ID! "The selected date range for payments" payments: String "The selected date range for superbills" superbills: String } "Autogenerated return type of RequestIntegration." type RequestIntegrationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "A request, from a provider to a client, to fill out a form" type RequestedFormCompletion { "The form to fill out" custom_module_form: CustomModuleForm "The ID of the form to fill out" custom_module_form_id: String "The relevant date to show, if the form is completed it shows the completed at date, if there is an associated incomplete form it shows when that was started, otherwise shows when the request was created" date_to_show: String "The filled form that completes the request" form_answer_group: FormAnswerGroup "The id of the filled form that completes the request" form_answer_group_id: String "The unique identifier of the form" id: ID! "type of form requested" item_type: String! "A serialized JSON string of metadata. Maximum character limit of 128,000. Only accessible by staff and providers" metadata: String "The recipient (client)" recipient: User "The ID of the recipient (client)" recipient_id: String "Recurring Form related to the request" recurring_form: RecurringForm "The sender (provider)" sender: User "The ID of the sender (provider)" sender_id: String "The status of the request" status: String } "The status of the requested form" type RequestedFormStatusType { "Used to return something after request if the job has been triggered" status: String } "A Requested Payer for the Invoice" type RequestedPayer { "The address of the requested payer" address: String "The email of the requested payer" email: String "The unique identifier of the requested payer" id: ID! "The name of the requested payer" name: String } "A request, from a provider to a client, to make a payment" type RequestedPayment { "The appointment associated with this requested payment" appointment: Appointment "The ID of the appointment associated with this requested payment" appointment_id: String "The balance due on this invoice (based on payments and write-offs)" balance_due: Float "The id of the filled form that completes the request" billing_item_id: String "The payments that completes the request" billing_items(only_successful: Boolean = true): [BillingItem!]! "The ID of the CMS1500 to pay for" cms1500_id: String "Line items from the CMS1500 claim for invoice display. Only present when invoice_type is cms1500." cms1500_line_items: [InvoiceCms1500LineItem!]! "The CMS1500 service date" cms1500_service_date: String "The time the requested payment record was created" created_at: ISO8601DateTime! "The currency of the requested payment (invoice)" currency: String "Pagination cursor" cursor: Cursor! "The relevant date to show" date_to_show: String "Balance to pay" debt: Int @deprecated(reason: "use debt_decimal instead") "The debt, including decimals" debt_decimal: Float "The details of the invoice (based off of associated item)" details: String "The datetime that the share email was last sent, nil if never" email_sent_at: String "The unique identifier of the payment" id: ID! "The generated invoice ID" invoice_id: String "The type of invoice" invoice_type: String "True if requested payment was manually paid" is_manually_paid: Boolean "True if the invoice is still in preview mode" is_preview: Boolean! "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String "Extra details on the invoice" notes: String "The offering to purchase" offering: Offering "The ID of the offering to buy" offering_id: String "The price of the offering at the time of invoice creation" offering_price_at_invoice_creation: String "The requested payer. This will return null if the requested payer exists as a client in Healthie" other_requested_payer: RequestedPayer "The datetime that the invoice was paid" paid_at: String "Percent from total price which has been paid (if status == Partial)" paid_percent: Int "price of payment requested" price: String "The recipient (client)" recipient: User "The ID of the recipient (client)" recipient_id: String "Individual responsible for payment. If user_id, the user exists in Healthie, otherwise the individual doesn't have a Healthie account." requested_payer: RequestedPayer "The ID of the requested payer" requested_payer_id: String "The template used to create this requested payment" requested_payment_template: RequestedPaymentTemplate "The sender (provider)" sender: User "The ID of the sender (provider)" sender_id: String "The service date" service_date: String "The service date without time" service_day: ISO8601Date "The services provided" services_provided: String "The status of the request" status: String "The time the requested payment record was last updated" updated_at: ISO8601DateTime! "User Package Selection connected to this requested payment" user_package_selection: UserPackageSelection "The total amount written off" write_off_amount: Float "The write-offs associated with this requested payment" write_offs: [WriteOff!] } "Requested payment template" type RequestedPaymentTemplate { "Whether the template is active or not" active_template: Boolean! "The unique identifier of the template" id: ID! "The name of the template" name: String "The requested payment of the template" requested_payment: RequestedPayment } "Autogenerated return type of ResetMfa." type ResetMfaPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of ResumeCourseGroup." type ResumeCourseGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The resumed course group" courseGroup: CourseGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of ResumeCourseMembership." type ResumeCourseMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseMembership: CourseMembership "The list of errors occurred during the mutation" messages: [FieldError] } "A room at a location" type Room { "Unique ID for this room" id: ID! "When true, there can only be one appointment at a time in the room" limit_to_one: Boolean! "Name of the room" name: String } "Configuration for the SDK" type SDKConfig { "Stripe's publishable key" stripe_publishable_key: String! } "A set of filter options saved for quick loading in the calendar" type SavedFilter { "JSON-formatted options to use for setting filter" filter_data: JSON! "Unique ID for this filter" id: ID! "Name of the filter" name: String! "The organization_id that has access to the filter" organization_id: String "The user that created the filter" user_id: String! "The unique UUID/string of the filter, used for sharing" uuid: String! } "Billing items that are scheduled and will have a user package selection associated with them" type ScheduledUserPackageSelection { "The unique identifier of the room" id: ID! "Related offering" offering: Offering "Related recurring_payment" recurring_payment: RecurringPayment "Related user" user: User } "Autogenerated return type of SendSpeakToTrainerNotification." type SendSpeakToTrainerNotificationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "A Sent Direct Message" type SentDirectMessage { "Array of attachments" attachments: [Document!] "The number of attachments for the sent direct message" attachments_count: Int "The sent date of the direct message" created_at: String "When true, the message has an attached binary document" has_binary_attachment: Boolean "When true, the message has an attached CDA" has_cda: Boolean "The unique identifier of the fax" id: ID! "The body of the direct message" message_body: String "The outbound recipient" outbound_recipient: String "ID of the related patient" patient_id: String "ID of the related sender" sender_id: String "The status" status: String "The subject of the direct message" subject: String } "A Sent Fax" type SentFax { "The creation date of the fax" created_at: String! "Pagination cursor" cursor: Cursor! "Where the fax was sent" destination_number: String "The unique identifier of the fax" id: ID! "The ids of the chart notes sent with the fax" parsed_form_answer_group_ids: [ID!] "The patient that the fax is in regards to" patient: User "False if no document ids or form answer group ids (fax existed before the addition of document ids column)" resendable: Boolean "The sender of the fax" sender: User "The status of the fax" status: String "The display string of the fax status" status_display_string: String "The updated date of the sent fax" updated_at: String } "A Sent Notification" type SentNotificationRecord { "The enumerated values: [:sms, :push, :email]" category: String! "The time when the record was created" created_at: String! "The enumerated values: [:sent, :delivered, :bounced]" delivery_status: String! "The unique identifier of the record" id: ID! "Description of notification context. (Ex: 'Follow-up Session on Nov 16 at 1:00 PM EST with Joe Smith')" notification_description: String "Examples: 'appointment_reminder', 'folder_shared', 'reminder_to_work_on_a_goal'" notification_type: String "The type categorizing notification_type into subgroups. Accepted values: [appointments, billing, chat_messages, accounting, documents, forms, goals, journals, packages, programs]" representation_type: String "The ID of the user this notification was sent to" user_id: ID } "The record of a sent webhook" type SentWebhook { "The datetime that the webhook was sent" created_at: String! "Pagination cursor" cursor: Cursor! "The type of webhook" event_type: String "Whether the webhook is enabled or not" http_response_status: String "The unique identifier of the webhook" id: ID! "The id of the resource the sent webhook related to" resource_id: ID "The type of resource the sent webhook related to" resource_id_type: String "The URL that the webhook was sent to" url: String "The configured webhook thst was sent" webhook_id: ID } "A serving size object" type ServingSize { "The number of servings" amount: Float "The calories of serving size" calories: Float "Whether or not this serving size was imported from the USDA database" fdc_import: Boolean! "The food id of the food this serving size belongs to" food_id: String "The id of the food portion this serving size belongs to" food_portion_id: ID "The unique identifier of the serving size" id: ID! "The macro & micro nutrients of this serving size" macro_micro_nutrients: [FoodNutrient!] "The macro nutrients of this serving size (Calories, Carbohydrate, Protein, Fat)" macro_nutrients: [FoodNutrient!] "percentage of 100g. For example if modifier is 2.5 then this serving size is 250g" modifier: Float "The nutrients of this serving size" nutrients(food_search: Boolean): [FoodNutrient!] "The type of serving (i.e grams, scoop, spoonful)" unit: String } "Autogenerated return type of SetCustomModuleFormScribeInstructions." type SetCustomModuleFormScribeInstructionsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The CustomModuleForm whose Scribe instructions were updated." customModuleForm: CustomModuleForm "The list of errors occurred during the mutation" messages: [FieldError] } "Structured representation of a `sex` form_answer answer" type SexAnswer { "The selected sex as an enum member, or null when the stored answer matches no member" sex_code: Sex "The selected sex as its display label, or null when the stored answer matches no member" value: String } "A Shapa Connection" type ShapaConnection { "The unique identifier of the connection" id: ID! "The last time Shapa was synced" last_sync_date: String } "Autogenerated return type of Sign." type SignPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup form_answer_group_signing: FormAnswerGroupSigning "The list of errors occurred during the mutation" messages: [FieldError] } "Structured representation of a single-select (radio, horizontal_radio, dropdown) form_answer answer" type SingleSelectAnswer { "The selected option label; expected to match one of the question's configured options" value: String } "A smart phrase object" type SmartPhrase { "The time when the smart phrase was created" created_at: String! "Pagination cursor" cursor: Cursor! "The unique identifier of the smart phrase" id: ID! "Custom metadata for the smart phrase" metadata: JSON "The name of the smart phrase" name: String "The content of the smart phrase" phrase: String "The time when the smart phrase was last updated" updated_at: ISO8601DateTime "The smart phrase owner" user: User } "Smoking Status object" type SmokingStatus { "The unique identifier of the status" id: ID! "The smoking status code" smoking_status_code: String "The end date of the status" status_end_datetime: String "The start date of the status" status_start_datetime: String "The id of the user the status belongs to" user_id: ID } "Warning about SMS template length and multi-message costs" type SmsTemplateWarning { "Estimated character length after template variable expansion" estimated_length: Int! "Estimated number of SMS messages that will be sent" estimated_message_count: Int! "Warning message to display to the user" message: String! } "Snomed terms" type SnomedTerm { "id for snomed term" concept_id: String "snomed term name" term: String } "Specialty" type Specialty { "The unique identifier of the specialty" id: ID! "The name of the specialty" specialty: String! "The name of the specialty category" specialty_category: String! } "Information on an SsoConnection" type SsoConnection { "Whether or not to allow Just-In-Time provisioning" allow_jit_provisioning: Boolean "The type of user this SSO is for (either patient or staff)" for_user_type: String "The unique identifier of the SSO connection" id: ID! "The label to display on the sign in button" label: String "The URL to take the user to to sign in via SSO" sign_in_url: String "The URL to take the user to to sign out via SSO" sign_out_url: String } "A state license object" type StateLicense { "The full name of the state" full_state_name: String "The unique identifier of the state license" id: ID! "The abbreviation of the state" state: String } "A Stripe bank account" type StripeBankAccountType { "The name of the account holder" account_holder_name: String "The type of the account holder (Individual or Company)" account_holder_type: String "The last 4 digits of the bank account number" accounts_number_last_4: String "The city of the business address" city: String "The country of the business address" country: String "The currency the bank account is in" currency: String "The date of birth of the company's business representative" dob: String "The ID of the bank account object (generated by Stripe)" id: String "If the holder has verified government issued id" id_image_provided: Boolean "The first line of the business address" line1: String "The second line of the business address" line2: String "The last 4 digits of the routing number" routing_number_last_4: String "If the holder has a verified social security number" ssn_last_4_provided: Boolean "The state of the business address" state: String "If the holder has a verified business tax ID" tax_id_provided: Boolean "The zip code of the business address" zip: String } "A Stripe company address object" type StripeCompanyAddressType { "The city or town of the address." city: String "The two-letter country code of the address." country: String "The first line of the address." line1: String "The second line of the address." line2: String "The postal code of the address." postal_code: String "The state or province of the address." state: String } "A Stripe company" type StripeCompanyType { "The company address" address: StripeCompanyAddressType "Whether the company directors have been provided" directors_provided: Boolean "Whether the company executives have been provided" executives_provided: Boolean "The legal name of the company" name: String "Whether the company owners have been provided" owners_provided: Boolean "The company phone number" phone: String "Whether the company tax ID has been provided" tax_id_provided: Boolean "The verification status of the company" verification: String } "A Stripe country" type StripeCountry { "The accepted currencies for this country" accepted_currencies: [String] "The country code" country_code: String "The currency of the country" currency: String "A custom field 1" field1: String "A custom field 2" field2: String "The name of the country" name: String } "Details of the client's credit card" type StripeCustomerDetail { "The name of the bank the bank account is with (nil for 'Card' source types)" bank_type: String "The brand of the card" card_type: String "The type of card indicated by the user. Defaults to personal, Options are 'hsa', 'fsa', and 'personal'" card_type_label: String "Stripe card country" country: String "The date this payment method was created/added" created_at: ISO8601DateTime "Pagination cursor" cursor: Cursor! "The expiration date of the card" expiration: String "Whether the card is expiring next month" expiring_next_month: Boolean "The unique identifier of the customer detail object" id: ID! "The last 4 digits of the credit card" last_four: String "The status of the payment method" source_status: String "The type of payment method (either 'Card' or 'Bank Account')" source_type: String "The ID of the client (in Stripe)" stripe_id: String "The client associated with stripe account(in Healthie)" user: User "The ID of the client (in Healthie)" user_id: String "Stripe card address zip" zip: String } "An invoice from stripe as object" type StripeInvoice { "The list of add-ons applied to the invoice." add_ons: [StripePlan!] "The amount of the invoice, as a positive or negative integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or -100 to credit $1.00). The value is multiplied by the quantity to get the full amount. If the total is zero, this field will be absent." applied_balance: StripePlan "The base amount of the invoice, not including any discounts, in cents." base_plan: StripePlan "The list of credits applied to the invoice." credits: [StripePlan!] "The discount applied to the invoice." discount: Discount "The unique identifier of the invoice" id: String! "The end of the period the invoice covers." period_end: String "The start of the period the invoice covers." period_start: String "The total amount of the invoice, including all discounts and add-ons." total: String } "A discount from stripe as object" type StripePlan { "The amount in cents to be charged on the interval specified" amount: String "The annual cost of the plan" annual_cost: String "The description of the plan" description: String "The unique identifier of the plan" id: String! "The interval when the plan is charged" interval: String } "URLs to manage a Stripe subscription" type StripeSubscriptionUrl { "URL to checkout for Core Monthly plan" core_monthly_checkout: String! "URL to checkout for Core Yearly plan" core_yearly_checkout: String! "Client secret for embedded Stripe checkout" embedded_checkout_client_secret(plan_lookup_key: String!, promotion_code: String): String! "URL to checkout for Essential Monthly plan" essential_monthly_checkout: String! "URL to checkout for Essential Yearly plan" essential_yearly_checkout: String! "URL to checkout for Group Monthly plan" group_monthly_checkout: String! "URL to checkout for Group Plus Monthly plan" group_plus_monthly_checkout: String! "URL to checkout for Group Yearly plan" group_yearly_checkout: String! "URL to manage a Stripe subscription" manage_subscription: String! "URL to checkout for Plus Monthly plan" plus_monthly_checkout: String! "URL to checkout for Plus Yearly plan" plus_yearly_checkout: String! "URL to checkout for Starter Monthly plan" starter_monthly_checkout: String! "URL to view a Stripe subscription invoice" subscription_invoice: String! "URL to update a Stripe subscription" update_subscription: String! } "Autogenerated return type of SubmitSecondaryClaim." type SubmitSecondaryClaimPayload { "The submitted secondary claims with updated status" claims: [Claim] "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] "Success message confirming submission to ClaimMD" success_message: String } "Subscriptions for events tracking" type Subscription { "Track changes in conversations" conversationChangedSubscription(id: ID): Conversation "Track new members of conversations" conversationMembershipAddedSubscription(notesType: String): ConversationMembership "Track new updates to members of conversations" conversationMembershipUpdatedSubscription(notesType: String): ConversationMembership "Track modifications of form answer groups" formAnswerGroupModifiedSubscription(id: ID): FormAnswerGroup "Track added notes" noteAddedSubscription(conversationId: String): Note "Track user updates" userUpdatedSubscription: UserNotificationsCount } "Subscription access information" type SubscriptionAccess { current_period_end_at: ISO8601DateTime id: ID! on_trial: Boolean show_paywall: Boolean! status: SubscriptionStatus! stripe_subscription: StripePlan subscription: SubscriptionInstance trial_days_left: Int trial_end_at: ISO8601DateTime user: User } "a subscription object" type SubscriptionInstance { "When a customer cancels, or is set to cancel, this will be a datetime of when access will cease" access_will_stop_at: String "Amount difference if switching to annual/monthly" amount_saved_if_plan_switched: Int "Amount savings from monthly to annual" amount_savings_on_base_plan: String "Total cost of subscription for the year" annual_total: String "Expiration of credit card on Stripe" card_expiration: String "Returns true if card is expired" card_expired: Boolean "Type of credit card on Stripe (Mastercard, Visa, Amex, etc.)" card_type: String "Number of clients under the user that owns the subscription" client_count: Int "Cost per month of annual plan" cost_of_annual_base_plan: String "Credit balance on Stripe customer" credit_balance: Float "Shows how many days are left in the users trial" days_left_in_trial: Int "Discounts currently active on Stripe account" discounts: [Discount!] "Array of discounts applied in Stripe (most possible is 2)" discounts_if_switched: [Discount!] "Returns true if the subscription includes an enterprise plan" has_enterprise_or_skipped_paywall: Boolean "Returns true if there is already a scheduled subscription change on this account" has_scheduled_change: Boolean "The unique identifier of the subscription" id: ID! "The interval of the subscription" interval: String "Example of next invoice if switching plan" invoice_if_switched: StripeInvoice "Returns true if the user is trialing" is_trialing: Boolean "Last four digits of credit card on Stripe" last_four: String "Last attempted invoice in Stripe" last_invoice: StripeInvoice "When the user is scheduled to be locked out due to non-payment" locked_out_at: String "Total cost of subscription for the month" month_total: String @deprecated(reason: "This field is no longer supported and always returns null. Use monthly_cost_of_base_plan instead.") "Cost per month of annual plan" monthly_cost_of_annual_base_plan: String "Cost per month for base plan" monthly_cost_of_base_plan: String "Returns true if the subscription includes a group plan" paid_for_group: Boolean "The number of providers that the subscription covers" paid_for_providers: String "The number of support staff that the subscription covers" paid_for_support: String "Percent difference if switching to annual/monthly" percent_change_if_plan_switched: Int "Percent savings from monthly to annual" percent_savings_on_base_plan: Int "Array of line items applied to Stripe subscription other than base plan (i.e fax line, extra providers, office ally etc.)" plan_add_ons: [StripePlan!] "The ID of the plan in Healthie" plan_id: String "Name of the plan in Stripe" plan_name: String "Returns true if the user is set to cancel" set_to_cancel: Boolean "Remaining balance on stripe customer" stripe_balance: String "The ID of the customer in Stripe" stripe_id: String "Stripe Subscription plan name" stripe_plan: String "The ID of the subscription in Stripe" stripe_subscription_id: String "URLs to manage a Stripe subscription" stripe_subscription_url: StripeSubscriptionUrl "When the trial ends" trial_end_at: ISO8601DateTime "Upcoming invoice in Stripe" upcoming_invoice: StripeInvoice "Owner of this subscription" user: User "The ID of the user who owns the subscription" user_id: String } "SuperBill" type SuperBill { "address" address: String "amount of super bill" amount_paid: String "amount due after amount paid is subtracted from total fee" balance_due: String "Returns cpt codes names list comma separated" cpt_code_names: String "CPT codes in use for this super bill" cpt_codes_super_bills: [CptCodesSuperBill!] "date super bill was created" created_at: String! "Pagination cursor" cursor: Cursor! "date superbill was deleted" deleted_at: String "id of dietitian" dietitian_id: ID "ICD codes in use for this super bill" icd_codes_super_bills: [IcdCodesSuperBill!] "The unique identifier of the bill" id: ID! "license number" license_num: String "location" location: Location "location id" location_id: ID "npi number" npi: String "patient of this superbill" patient: User "dob of patient" patient_dob: String "id of patient" patient_id: ID "location" patient_location: Location "patient location id" patient_location_id: ID "name of patient" patient_name: String "phone number of patient" patient_phone: String "place of service" place_of_service: PlaceOfService "place of service id" place_of_service_id: ID "city" prov_city: String "email" prov_email: String "address line one" prov_line1: String "address line one" prov_line2: String "phone" prov_phone: String "state" prov_state: String "zip" prov_zip: String "provider" provider: User "name of provider" provider_name: String "receipt line items of this super bill" receipt_line_items: [ReceiptLineItem!] "name of referrer" referrer_name: String "npi of referrer" referrer_npi: String "Date of service (as a date)" service_date: String "status" status: String "tax id" tax_id: String "total fee for superbill" total_fee: String "date super bill was updated" updated_at: String! } "A Symptom Option" type SymptomOption { "Custom Symptoms use numeric IDs. Standard symptoms just use the symptom name" id: ID! "The symptom name" name: String! "The symptom value" value: Int! } "A custom tag that can be applied on a user" type Tag { "The number of active users who have the tag" active_users_count: Int "The name of the user who created the tag" added_by: String "The number of archived users who have the tag" archived_users_count: Int "The time when the tag was created" created_at: String! "The unique identifier of the tag" id: ID! "A human-readable name of the tag" name: String! "The number of org members who have the tag" org_members_count: Int "The number of patients this tag is applied to" patients_tagged_count: Int "The number of providers this tag is applied to" providers_tagged_count: Int "The array of tagged users" tagged_users(offset: Int, should_paginate: Boolean = false): [User!] "The last time the tag was updated" updated_at: String! "The user who created the tag" user: User } "An edge in a connection." type TagEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: Tag } "The connection type for Tag." type TagPaginationConnection { "A list of edges." edges: [TagEdge] "A list of nodes." nodes: [Tag] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "Tasks for providers to create, complete, and optionally assign to client profiles" type Task { "The providers and staff who are assigned to this task" assignees(order_by: UserOrderKeys = LAST_NAME_ASC, after: String, before: String, first: Int, last: Int): UserConnection "The client (patient) associated with this task" client: User "The identifier of the client (patient) associated with this task" client_id: ID "Fetch paginated comments collection" comments(order_by: InternalCommentsOrderKeys = CREATED_AT_ASC, after: String, before: String, first: Int, last: Int): InternalCommentPaginationConnection! "If true, user has marked task complete" complete: Boolean "Date and time this task was completed" completed_at: String "User (provider or staff member) who completed this task" completed_by: User "User ID of the user (provider or staff member) who completed this task" completed_by_id: ID "Details describing this task" content: String "Date and time this task was created" created_at: String! "ID of an auto generator" created_by_generator_id: String "The identifier of the user (provider or staff member) who created this task" created_by_id: ID "The user (provider or staff member) who created this task" creator: User "Pagination cursor" cursor: Cursor! "Date and time this task was is due to be complete" due_date: String "If true, hide completed task from top nav bar" hidden: Boolean! "The unique identifier of the task" id: ID! "A serialized JSON string of metadata. Maximum character limit of 2,000." metadata: JSON "Get associated chat message with a task" note: Note "Get relative path to view the note (chat message) associated with the task." note_path: String "Order in which tasks are displayed (ascending)" position: Int "Level of urgency for this task(0 = standard priority, 1 = high priority)" priority: Int! "ID of additional relation" ref_source: String "Reminder object for a given goal" reminder: Reminder "If true, the assigned user (provider or staff member) has viewed this task in top navbar" seen: Boolean! "Indicates this was automatically created via smart task" smart: Boolean! "The category of smart task" smart_category: String "What generated this smart task" smart_source: SmartSource "The last date and time that the task was updated" updated_at: ISO8601DateTime "The first user (provider or staff member) assigned to complete the task" user: User "The ID of the first user (provider or staff member) assigned to this task" user_id: ID } "A NUCC Health Care Provider Taxonomy code used to classify a provider specialty" type TaxonomyCode { "Whether the code is currently assignable" active: Boolean! "The 10-character NUCC taxonomy code" code: String! "A human-readable label combining the code and its name/classification" display_label: String! "The unique identifier of the taxonomy code" id: ID! } "An edge in a connection." type TaxonomyCodeEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: TaxonomyCode } "The connection type for TaxonomyCode." type TaxonomyCodePaginationConnection { "A list of edges." edges: [TaxonomyCodeEdge] "A list of nodes." nodes: [TaxonomyCode] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "A transaction" type TransactionType { "The currency of the transaction" currency: String "The amount for the transaction after fees" displayed_amount: String "Charge ID associated to transaction. Can be matched with billing_item.stripe_charge_id" source_name: String } "A transcript (in VTT format) of an appointment and associated metadata" type Transcript { "The raw VTT content of the transcript" content: String "A short-lived URL to download the vtt file" expiring_url: String "The unique identifier of the transcript" id: String "The status of the transcript" status: TranscriptStatusEnum "The datetime that the transcript ended" transcript_end: ISO8601DateTime "The approximate datetime that the transcript started" transcript_start: ISO8601DateTime "The type of transcript" transcript_type: TranscriptTypeEnum } "A transfer" type TransferType { "The amount for the transfer" amount: String "The currency of the transfer" currency: String "The amount to display (formatted and with currency symbol)" displayed_amount: String "The expected to happen date to display" displayed_expected_to_happen: String "The initiation date to display" displayed_initiated: String "The date that the transfer is expected to complete" expected_to_happen: String "Total of all fees deducted from all transactions" fees: String "Stripe ID for this transfer" id: String! "The initiation time of the transfer" initiated: String "The status for the transfer" status: String "Number of transactions" transactions_count: Int "The type of transfer" type: String } "UniqueDeviceIdentifier object" type UniqueDeviceIdentifier { "The assigning authority for the device code" assigning_authority: String "The device code" device_code: String "The display name for the device code" display_name: String "The unique identifier of the identifier" id: ID! "The scoping entity for the device code" scoping_entity: String "The UDI code for the device" udi_code: String } "Autogenerated return type of Unlock." type UnlockPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateAlertTemplate." type UpdateAlertTemplatePayload { "The updated alert template" alert_template: AlertTemplate "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateAppointmentFormAnswerGroupConnection." type UpdateAppointmentFormAnswerGroupConnectionPayload { "The appointment now linked to the form answer group." appointment: Appointment "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The form answer group whose linked appointment was updated." form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateAutomation." type UpdateAutomationPayload { "The updated automation" automation: Automation "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateCalorieLevel." type UpdateCalorieLevelPayload { assessment: HealthAssessment "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateCareAlert." type UpdateCareAlertPayload { "The updated care alert" care_alert: CareAlert "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateDocumentDraft." type UpdateDocumentDraftPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") document_draft: DocumentDraft "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateGeneratedSummary." type UpdateGeneratedSummaryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The generated summary" generated_summary: GeneratedSummary "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateInternalComment." type UpdateInternalCommentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") internal_comment: InternalComment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateMacronutrientSplit." type UpdateMacronutrientSplitPayload { assessment: HealthAssessment "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateOrganizationConfiguration." type UpdateOrganizationConfigurationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization_configuration: OrganizationConfigurationType } "Autogenerated return type of UpdateSecondaryClaim." type UpdateSecondaryClaimPayload { "The updated claim with COB data" claim: Claim "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of UpdateUiConfiguration." type UpdateUiConfigurationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization } "An user entry, returns basic user information" type User { "Access Token (for iCal)" access_token: String "(Only Valid For new Sign-ins/Ups after 2024-12-01) When true, indicates the user has accessed their own Healthie account." accessed_account: Boolean "The status of whether the user is active or not (if false, patient is archived)" active: Boolean! "Active care plan for the user" active_care_plan: CarePlan "Active group care plan for the user" active_group_care_plan: CarePlan "All active patients associated with this user." active_patients(course_id: ID, keywords: String, include_suborg_patients: Boolean = true, offset: Int = 0, should_paginate: Boolean = false): [User!]! "A number of all active patients associated with this user." active_patients_count(course_id: ID, keywords: String, include_suborg_patients: Boolean = true): Int "A collection of tags applied on the specific user" active_tags: [Tag!] "Additional tabs to display within the provider's view of the client profile" additional_client_profile_items: [CustomSidebarOverride!]! "Additional links to display within gear menu in patient's header" additional_header_dropdown_items: [CustomSidebarOverride!]! "additional phone number for user" additional_phone_number: String "Additional links to display within patient's quick profile" additional_quick_profile_items: [CustomSidebarOverride!]! "additional unique record identifier for user" additional_record_identifier: String "Additional links to display on patient sidebar" additional_sidebar_items: [CustomSidebarOverride!]! "Appointment prices associated with this user" advance_appointment_prices: [AdvanceAppointmentPrice!] "The user's lead dyno affiliate info" affiliate: Affiliate @deprecated(reason: "NO LONGER USED") "The age of the user (in years)" age: String "All Verification fields left for the provider to fill out" all_verification_fields: [String] "Allergies, Sensitivities, Intolerances, and Preferences reported by client" allergy_sensitivities(category: String, is_current: Boolean = false, unreconciled_from_ccda_ingest: Boolean = false): [AllergySensitivity!] "Allow the user to send messages in community chat" allow_community_chat(all_patients: Boolean = false): Boolean "Allow the user to send direct messages in chat" allow_direct_chat(all_patients: Boolean = false): Boolean "All announcements associated with this user. For a dietitian it returns all announcements created including those created in organization if applicable. For a patient it returns announcements generated by his/her dietitian." announcements(exclude_dismissed: Boolean): [Announcement!]! "Anticipated number of providers in the next 6 months, from the personalization questionnaire." anticipated_number_of_providers: String "If the user has incomplete onboarding steps" any_incomplete_onboarding_steps: Boolean "If the user has incomplete requested form completions" any_incomplete_requested_form_completions: Boolean "If the user has courses shared with them" any_shared_courses: Boolean "If the user has docs shared with them" any_shared_documents: Boolean "If the user has courses shared with them" any_shared_incomplete_courses: Boolean "Whether the user has docs shared with them that they have not viewed" any_unviewed_documents: Boolean "API keys associated with this user" api_keys(keywords: String = null, order_by: ApiKeyOrderKeys = CREATED_AT_DESC, after: String, before: String, first: Int, last: Int): ApiKeyPaginationConnection! "AppleHealth for the user" apple_health: AppleHealth "Appointment Locations for the user" appointment_locations: [AppointmentLocation!] "Appointment Settings for the user" appointment_setting: AppointmentSetting "All Appointment Type Credits for this user" appointment_type_credits(appointment_type_id: ID): [AppointmentTypeCredit!]! "All available appointment types for the provider." appointment_types(appointment_type_ids: String, require_client_bookable: Boolean): [AppointmentType!]! "Appointments for the user" appointments: [Appointment!] "Datetime of archival. This field will only be populated with archived changes made after Aug 7, 2023" archived_at: String "If true, user has seen popup explaining how to assign providers and clients to tasks" assign_tasks_seen: Boolean "Tasks assigned by the user to other users" assigned_tasks(limit: Int, show_hidden: Boolean = false): [Task!] "When false, the user is opted out of the automatic charge feature." auto_charge_enabled: Boolean! "All available contact types for the provider." available_contact_types: String "The link to the avatar image (nil if no image has been uploaded)" avatar_url: String "The status of the user's bank account" bank_account_verified_status: String "If user still has verification steps for stripe, returns deadline timestamp" bank_verification_deadline: String "All Billing Items for this user" billing_items: [BillingItem!]! "If a user has seen the message blast alert" blast_seen: Boolean "Displays bmi percentile for growth charts" bmi_percentile: String "Displays standard by which bmi percentile is calculated" bmi_percentile_standard: String "The brand that the user made" brand(is_for_editing: Boolean = false): Brand "The URL of the brand's alternative logo" brand_alt_logo_url: String "The URL of the brand logo" brand_logo_url: String "The Brand Name Of the User" brand_name: String "The name of the Brand" branded_name: String "Broken synced calendar" broken_synced_cal: ExternalCalendar "HTML String to display on top of the calendar" calendar_text: String "Calendar timezone" calendar_timezone: String "Call references made for a patient's insurances" call_references: [CallReference!] "If true, has Zus credential" can_access_zus: Boolean "Allow the user to add clients" can_add_clients: Boolean "If the provider can add members" can_add_members: Boolean "If true this user to archive clients" can_archive_clients: Boolean "Allow this user to charge clients" can_charge_clients: Boolean "Allow the user to Check Eligibility" can_check_eligibility: Boolean "If true, the user can delete charting notes" can_delete_charting_notes: Boolean "If true this user to delete faxes" can_delete_faxes: Boolean "If true, the user to edit Appointment Types" can_edit_appointment_types: Boolean "If true, the user can edit brand" can_edit_brand: Boolean "If true, the user can edit client credit" can_edit_credit: Boolean "If true, the user can edit org documents" can_edit_docs: Boolean "If the provider can edit forms" can_edit_forms: Boolean "If the provider can edit members" can_edit_members: Boolean "If true, the user to edit org calendar" can_edit_org_calendar: Boolean "If true, the user can edit packages" can_edit_packages: Boolean "If true, the user can add, edit and delete products" can_edit_products: Boolean "If true, the user can add or remove clients within programs" can_edit_program_clients: Boolean "If true, the user can edit programs" can_edit_programs: Boolean "Allow the user to edit account settings" can_edit_settings: Boolean "If the provider organization can have suborgs" can_have_suborgs: Boolean "If the user can add suborgs" can_insert_suborgs: Boolean can_link_labs_to_chart_notes: Boolean @deprecated(reason: "Use `OrganizationType.can_link_labs_to_chart_notes` instead") "If true, the user can lock other providers charting notes" can_lock_others_charting_notes: Boolean "If true, the user can lock their own charting notes" can_lock_own_charting_notes: Boolean "If the provider can mark tasks that are assigned to other org members as completed" can_mark_assigned_tasks_to_other_org_members_as_completed: Boolean "If true, the user can merge clients" can_merge_clients: Boolean "If true, can order new lab using labs widget" can_order_labs: Boolean "Allow this user to schedule appointments (Linked accounts)" can_schedule_appointments: Boolean "If true, user can see Audit Logs UI for masked in account" can_see_audit_log_ui: Boolean "If true, user can see products tab in client profile and see fullscript box on homepage if not linked to fullscript" can_see_fullscript_tab: Boolean "Show insurance info for a client" can_see_insurance_authorization: Boolean "When true, the user should see option to use erx dosespot" can_see_option_to_use_erx_dosespot: Boolean "If true, can view transfer tab in billing page" can_see_transfers: Boolean "If true, the user can sign other providers charting notes" can_sign_others_charting_notes: Boolean "If true, the user can sign their own charting notes" can_sign_own_charting_notes: Boolean "If `true`, the user can unlock charting notes. Always `true` for org owners and providers w/o an org" can_unlock_charting_notes: Boolean "True if the user can use AI Scribe (org has AI Scribe AND the membership has can_autogenerate_charting_notes_from_zoom_calls)" can_use_ai_scribe: Boolean "If true, can access to labs widget" can_view_labs: Boolean "If True, the user will be able to add addendums for an other org member locked form answer groups" can_write_org_addendums: Boolean "If true, the user cannot access org settings" cannot_access_org_member_settings: Boolean "If True, the user will not be able to lock form answer groups" cannot_lock_form_answer_groups: Boolean @deprecated(reason: "Use can_lock_own_charting_notes instead") "Fetch paginated stripe customer accounts with associated errors or soon to expire credit cards" card_issues_count: Int "A JSON object containing validation errors for the patient's CDA file" cda_validation_errors_json: String "The Patient's CDA" cda_xml(end_date: String, start_date: String): String "Hash for Chameleon" chameleon_hash: String "When true, user will be able to check insurance eligibility via Change Healthcare" change_healthcare_insurance_eligibility_connected: Boolean @deprecated(reason: "ChangeHealth integration has been discontinued.") "Clearinghouse/RCM destinations that the user can submit to" claim_destination_options: [ClaimDestinationIntegration!] "Clearstep Connection for the user. If the Shapa integration is enabled, then the Clearstep integration should automatically appear as enabled" clearstep_connection: ShapaConnection "Authorizations allowing access to this user" client_restriction_authorizations: [ClientRestrictionAuthorization!] "Info about how a user was acquired" client_source: ClientSource "Completed Tasks of organization if user has permission, or user if not" completed_tasks(limit: Int, show_hidden: Boolean = false): [Task!] "Whether the user has accepted the lab order waiver" consented_to_labs: Boolean "List of consents required" consents_required: [String!] "course membership scoped by specific course" course_membership_via_course: CourseMembership "All course memberships for this user" course_memberships: [CourseMembership!] "All course memberships for this user" course_membrships: [CourseMembership!]! @deprecated(reason: "This field has a typo. use User.course_memberships instead") "The date this user created an account" created_at: String "The credit balance of the user" credit_balance: String "The most recent generated summary. Null if no summary has been generated" current_summary: GeneratedSummary "Pagination cursor" cursor: Cursor! "All custom custom emails associated with this user." custom_custom_emails: [CustomEmail!] "Custom Metric of the user" custom_metrics: [CustomMetric!]! "The default billing type for this patient" default_billing_type: DefaultBillingType "The default currency for the user" default_currency: String "When set for a client, the provider's Dosespot iFrame will launch into this clinic. When null, the Dosespot iframe will launch into the provider's default clinic. This will error unless the provider is connected to that clinic in Dosespot. Only used for patients." default_dosespot_clinic_id: ID "Default eligibility check service to use. Nil if none available or if user is a patient" default_eligibility_check_service: EligibilityCheckService "Default external videochat URL for scheduling with this user" default_external_video_url: String "The id of the users default onboarding flow" default_onboarding_flow: OnboardingFlow "The id of the users default onboarding flow" default_onboarding_flow_id: String "Patient's default pharmacy. Only applicable to dosespot users" default_pharmacy: Pharmacy "Default stripe payment card" default_stripe_customer_detail_id: ID "Check that user has no video or audio devices (or both)" devices_unavailability: Boolean "Dexcom Connection for the user" dexcom_connection: DexcomConnection "diagnoses for the user" diagnoses(unreconciled_from_ccda_ingest: Boolean = false): [Diagnosis!] "Dietitian of this user" dietitian: User "The Dietitian ID of the Client" dietitian_id: String "Dismisses a small advertisement about the ability to sync calendars" dimissed_calendar_prompt: Boolean @deprecated(reason: "Use `dismissed_calendar_prompt` instead") "Dismisses a small advertisement about the ability to sync calendars" dismissed_calendar_prompt: Boolean "Dismisses a notice warn about charting note addendum" dismissed_charting_note_addendum_warning: Boolean "If true, do not show fullscript box in provider homepage" dismissed_fullscript: Boolean "Dismisses the warning while insurance eligibility checking should not be shown" dismissed_insurance_eligibility_warning: Boolean "Dismisses the warning while locking a charting note should not be shown" dismissed_lock_charting_note_warning: Boolean @deprecated(reason: "Not used") "If true, do not show fullscript box in provider homepage" dismissed_products_tab: Boolean "The Brand that controls the look of the website for the user" displayed_brand: Brand "date of birth of user" dob: String "An ID used for document, course, and conversation sharing" doc_share_id: String "Number of notifications from Dosespot (e-prescriptions)" dosespot_notification_count: Int "Dosespot assigned ID for this patient. nil if the patient is not connected to Dosespot" dosespot_patient_id: String "When true, user has an eligibility checking service connected" eligibility_checking_connected: Boolean "The email of this user" email: String "The E-Rx clinic currently assigned to this patient, if any." erx_clinic: ErxClinic "The erx dosespot role" erx_dosespot_role: String "Amount of money waiting to be paid out, as a float" estimated_future_payouts: Float "Patient cards that have expired (requires can_see_billing for org level patients)" expired_client_cards_count: Int "Patient cards that will expire by next recurring payment (requires can_see_billing for org level patients)" expiring_client_cards_count: Int "Family history conditions for user" family_history_conditions: [FamilyHistoryCondition!] "Fax line request data" fax_line_request: FaxLineRequest "Fax number belonging to the user" fax_number: String "Feature Toggle of the user" feature_toggle: FeatureToggle "Date of the first client entry" first_client_entry_date: String "The first (preferred) name of this user" first_name: String "The first name and last initial of the user" first_name_last_initial: String "Fitbit for the user" fitbit: Fitbit "The number of food entries the user has" food_entries_count: String "All filled out forms for this user" form_answer_groups: [FormAnswerGroup!] "Formatted string of money waiting to be paid out, including currency symbol" formatted_estimated_future_payouts: String "The full legal name of this user" full_legal_name: String "The full legal name of this user with preferred name in parentheses. e.g 'Jonathan (Jon) Jones'" full_legal_name_with_preferred: String "The full name of the user" full_name: String "Fullscript for the user" fullscript: fullscript "Practitioner id for the user's Fullscript account" fullscript_practitioner_id: String "gender of user" gender: String "Gender identity of user (typically nil unless gender field is 'Other')" gender_identity: String "User gender identity code" gender_identity_code: String "id of generated reports folder" generated_reports_folder_id: String "The Number of goals the user has" goals_count: String "The Google Calendar Account for this user. Must be an admin or authenticated as the user to access" google_calendar: ExternalCalendar "Google Fit for the user" google_fit: GoogleFit "The name of the patients user group" group_name: String "When true, the user can see client portal setting in notification contact form" has_access_to_client_portal_setting_in_notification_contact: Boolean "When true, the user can access CMS 1500 content in the CMS 1500 tab" has_access_to_cms_1500s_content: Boolean "When true, the user can see insurance billing automation features" has_access_to_insurance_billing_automation: Boolean "When true, the user can see the connect button to sign up on dosespot on the settings integrations section" has_access_to_sign_up_on_dosespot: Boolean "When true, the user can see the zus megazap component" has_access_to_zus_megazap_component: Boolean @deprecated(reason: "Megazap is now enabled by default, so this is always true") "Deprecated: always false." has_ach: Boolean @deprecated(reason: "Client ACH via this feature is no longer supported. This field is always false.") "True if the user's org has AI Scribe enabled" has_ai_scribe: Boolean "True if the user's org has AI Summaries enabled" has_ai_summaries: Boolean "If true, user has at least one entry type to track" has_any_entry_types: Boolean "If the user's organization has API access" has_api_access: Boolean "If true, the user has access to download the mobile app" has_available_mobile_app: Boolean "(Considered public) If true, the user has bookable appts" has_bookable_appts: Boolean "(Considered public) If true, the user has bookable packages" has_bookable_packages: Boolean "Whether the user has CCDA feature available" has_ccda: Boolean "True if the user has change health connection" has_change_health: Boolean "If true, the user has completed their intake forms" has_completed_intake_forms: Boolean "If courses exist for an organization or provider" has_courses: Boolean "If true, the user has created a password" has_created_password: Boolean "Allow the user to change the color of their calendar" has_custom_color_schemes: Boolean "Check if user has any custom food item" has_custom_food: Boolean "Check if user has any created meals" has_custom_meals: Boolean "When true, the user can set scheduling priority levels for providers" has_custom_scheduling_prioritization: Boolean "When true, the user can have custom text for SMS reminders for specific appointment types" has_custom_text_reminders: Boolean "If the user is marked as a developer and can modify webhooks and api keys." has_developer_access: Boolean "If true, user is a provider with a dosespot account linked" has_dosespot: Boolean "If true, user meets prerequisites to order e-labs. Only supports Vital." has_e_labs_access: Boolean "If True, the user has enterprise plan" has_enterprise_plan: Boolean "If True, the user has expanded vbc charting fields" has_expanded_vbc_charting_fields: Boolean "True if the user can add external videochat URLs" has_external_videochat_urls: Boolean "TRUE if the patient has not finished form requests or incomplete onboarding items" has_forms_to_complete: Boolean "If true, the user has connected their Fullscript account to Healthie" has_fullscript: Boolean "If true, the user have available appointment slots in future" has_future_availabilities(offering_ids: [ID]): Boolean "True if the user has access to goal title links" has_goal_title_links: Boolean "Can the user receive inbound faxes?" has_inbound_faxing: Boolean "Allow this user to access increased branding" has_increased_branding: Boolean "Insurance Pay checks to see if there IS an insurance policy for the client" has_insurance_pay: Boolean "If true, patient's most recent demographic information(phone, dob, location, gender, name) contains a special character that may not be accepted by our integration partners" has_invalid_characters: Boolean "If true, patient's most recent demographic information(phone, dob, location, gender, name) could not be updated in dosespot because information is invalid" has_invalid_dosespot_info: Boolean "True if the user has any lab orders" has_lab_orders: Boolean "Whether users have a lab order from lab_testing_api" has_lab_testing_api_orders: Boolean "If true, user is a provider with a living plate linked" has_living_plate: Boolean "When true, the user can have a custom email sent out when an appointment is marked as no-show" has_marked_as_no_show_email: Boolean "When true, the user can have a custom email sent out when an appointment is marked as rescheduled" has_marked_as_rescheduled_email: Boolean "True if user is able to see conversations of all organization members" has_org_chat_access: Boolean "Check to see if the user has any other active org members" has_other_org_members: Boolean "When true, the user has their own appointment setting" has_own_appointment_setting: Boolean "When true, the user has their own custom emails" has_own_custom_emails: Boolean "When true, the provider can control settings around allow rescheduling past appointments." has_past_rescheduling_settings: Boolean "Whether or not this user has plus plan and above" has_plus_or_above_plan: Boolean "True if the user has PP features" has_practice_plus: Boolean "Has had payment in the last 30 days" has_recent_payments: Boolean "True if the user has rupa connection" has_rupa_health: Boolean "Self Pay checks to see if there is NOT an insurance policy for the client" has_self_pay: Boolean "If true, user has shared appointment settings with at least one member in org" has_shared_appt_setting_with_org: Boolean "If the provider controls settings around enforcing state licensing restrictions for appointments" has_state_licensing_restrictions: Boolean "If true, suborganization owner has stripe account from the parent organization owner" has_stripe_id_from_parent_org: Boolean "Whether the user has a synced calendar" has_synced_cal: Boolean "When true, the user can set appointment settings for specific appointment types" has_type_specific_appointment_settings: Boolean "Check to see if the user has any user groups" has_user_groups: Boolean "Check to see if the user can switch to another user" has_user_switch_options: Boolean "True if the user is allowed to use Zoom" has_zoom_access: Boolean "Heads Up Health SSO link for user; always returns nil if Heads Up Health add-on is not enabled" heads_up_health_sso_link: String "height of user" height: Float "Displays height percentile for growth charts" height_percentile: String "Displays standard by which height percentile is calculated" height_percentile_standard: String "String of height including units" height_str: String "Hash for Help Scout" helpscout_hash: String "True if user is not able to edit BAC metric entries" hide_bac_entry_actions: Boolean "ID of the human" human_id: ID "The unique identifier of the user" id: ID! "A collection of immunizations for this client" immunizations: [Immunization!] "Implantable device users for the user" implantable_devices_users: [ImplantableDeviceUser!] "True if User organization with multiple providers" in_multiple_providers_org: Boolean "If a user is in an org" in_org(known_to_be_in_org: Boolean = false): Boolean @deprecated(reason: "As of Jan 2025, this is always true as users are always in an organization") "Incomplete Tasks of organization if user has permissions, or user if not" incomplete_tasks(limit: Int, show_hidden: Boolean = false): [Task!] "Insurance Authorization for this user" insurance_authorization: InsuranceAuthorizationType "Hash for intercom" intercom_hash: String @deprecated(reason: "NO LONGER USED") "The required but invalid or missing fields required for ordering e-labs; empty string if all fields are present/valid. Only supports Vital." invalid_e_labs_fields: String "The invite code for the provider" invite_code: String "Get filter string for user invoices" invoices_filter: String "Check if the user is an active provider in an organization" is_active_provider: Boolean "True if chat autoresponding is active" is_chat_autoresponding: Boolean "boolean for if the user has ever logged in to Healthie as a provider" is_first_time_provider: Boolean "Whether the user's organization has insurance billing enabled" is_insurance_billing_enabled: Boolean "If true, the user is in an organization" is_org: Boolean "True if the user an organization admin" is_org_admin: Boolean "If true, the user is in an organization with more than one user" is_org_with_multiple_users: Boolean "the status of whether the user is the owner of their org or not" is_owner: Boolean "the status of whether the user is a patient or not" is_patient(already_known_value: Boolean): Boolean "Whether a user is a super admin" is_super_admin: Boolean "Whether the user is trialing" is_trialing: String "If the user aware they switched providers on specific login (can only do for current user)" knows_about_provider: Boolean "The client-side Kustomer API Key. (Only applies to specific custom whitelabels)" kustomer_api_key: String @deprecated(reason: "NO LONGER USED") "last date user was active through web or mobile" last_active: String "last date the user was active" last_activity: String "String of the last date the user was active" last_activity_string: String "The User's last active appointment object" last_app: Appointment "the last payment made by client" last_billing_item: BillingItem "id of last conversation" last_conversation_id: String "The most recent mobile health data snapshot for this user" last_mobile_health_data_snapshot: MobileHealthDataSnapshot "The last name of this user" last_name: String "last date the user signed in" last_sign_in_at: String "Last time allergy/sensitivity was updated" last_updated_allergy(category: String): AllergySensitivity "The last weighing date of the user" last_weighing_date: String "Link to most recent roadmap article on helpscout" latest_article_link: String "Last product roadmap article number" latest_article_number: Int "The legal first name of this user" legal_name: String "license number of user" license_num: String "Graphs to show in line graph form" line_graph_metric_categories: [String] "A collections of users who are in relationship with this client" linked_relatives: [NotificationContact!] "Link automatically signs user into Living plate dashboard without entering login credentials" living_plate_magic_link: String "The address of this user" location: Location "All available locations for the client." locations: [Location!] "Fetch count of medications for a given patient" medications_count(active: Boolean, patient_id: ID): Int "A serialized JSON string of metadata. Maximum character limit of 128,000." metadata: String "The number of metric entries the user has" metric_entries_count: String "The number of mirror entries the user has" mirror_entries_count: String "Mobile health data integrations for the user" mobile_health_integrations: [MobileHealthDataIntegration!] "The amount of money the user owes. If the user is a provider this will return 0" money_owed: String "Most important features from personalization questionnaire" most_important_features: [String!] "All tasks assigned to user" my_tasks(limit: Int, show_hidden: Boolean = false, order_by: TaskOrderKeys): [Task!] "The full name of the user" name: String "The User's next upcoming active appointment object" next_app: Appointment "The User's next upcoming active appointment date (method)" next_appointment: String @deprecated(reason: "use next_appt_date instead") "The Users next upcoming active appointment date (field)" next_appt_date: String "The next onboarding item that the user has to fill" next_onboarding_step: OnboardingItem "Recurring payment with next upcoming payment date" next_recurring_payment: RecurringPayment "The next step preventing the user from moving forward. nil if user has completed all steps" next_required_step: String "If True, the user has non paid plan" non_paid: Boolean "notification contacts for the user" notification_contacts: [NotificationContact!] "Notification Settings for the user" notification_setting: NotificationSetting "NPI of the user" npi: String "Number of entries for the client" num_entries: String "All offering_coupons associated with this provider." offering_coupons: [OfferingCoupon!] "All available offerings for the provider." offerings: [Offering!]! "Office Ally SFTP account associated with this user" officeally_sftp_account: OfficeallySftpAccount "User onc gender identity" onc_gender_identity: String "The number of open payments with balance due > 0" open_balance_due_count: Int "The number open payments for the user" open_payments_count: Int "Returns name of the org if exists, otherwise returns full name" org_name_or_self_name: String "The user's organization" organization: Organization "The contact email for this users organization" organization_email: String "The user's organization ID" organization_id: ID "The organization membership of the user" organization_membership: OrganizationMembership "Single Other ID number for the user" other_id_number(cms1500_id: ID, id: ID, is_last_cms1500: Boolean): OtherIdNumber "All other id numbers for this user" other_id_numbers: [OtherIdNumber!] "Other organization members." other_org_members(only_active: Boolean): [User!]! "Other organization members for sharing" other_org_members_for_sharing: [User!]! "The IDs of other care team members for the client" other_provider_ids: [ID] "The other care team members for the client" other_providers: [User!] "The Outlook Calendar Account for this user. Must be an admin or authenticated as the user to access" outlook: ExternalCalendar "Status paid for fax" paid_for_fax_status: String "boolean for If a user is a part of the journify organization" part_of_journify: Boolean @deprecated(reason: "NO LONGER USED.") "When true, the user is a patient and has auto submit cms1500 enabled" patient_has_cms1500_auto_submission_enabled: Boolean "All patients associated with this user." patients(client_ids: [ID], only_active: Boolean): [User!]! "The number of all active patients associated with this user." patients_count(only_primary: Boolean): Int "the number of notifications belonging to a patient" patients_notification_count(excluded_types: String): Int "All patients with a credit card on file associated with this user." patients_with_cc: [User!]! "When true, the user will never be prompted to change their timezone" permanently_disable_tz_prompt: Boolean "The phone number of the user" phone_number: String "Place of service for this user" place_of_service: PlaceOfService "All policies associated with this user. Can be filtered to return only active policies." policies(active: Boolean): [Policy!] "All policies associated with this user" policiesOrderAscending: [Policy!] "Preferred language based on language code" preferred_language: String "User preferred language code" preferred_language_code: String "Fetch count of prescriptions for a given patient pulled from Dosespot" prescriptions_count(patient_id: ID, status: String): Int "Displays administrator account as other user account" pretend_to_be: String "Whether name editing is disabled for this patient by their provider org" prevent_client_name_edit: Boolean "The primary ethnicity value based on ethnicity code" primary_ethnicity: String "User primary ethnicity code" primary_ethnicity_code: String "The primary insurance policy for the user" primary_insurance_policy: Policy "User primary race" primary_race: String "User primary race code" primary_race_code: String "The provider's primary NUCC taxonomy (specialty) code" primary_taxonomy_code: TaxonomyCode "Problems for the user" problems(unreconciled_from_ccda_ingest: Boolean = false): [Problem] "Profession from personalization questionnaire" profession: String "Professions of the user" professions: [Profession!] "Pronouns that the client identifies with" pronouns: String "Provider appointment locations" provider_appointment_locations: [ProviderAppointmentLocation!] "The biography information for the provider" provider_bio: ProviderBio "When true, the user is a provider and has auto submit cms1500 enabled" provider_has_cms1500_auto_submission_enabled: Boolean "Restriction authorizations owned by user" provider_restriction_authorizations: [ClientRestrictionAuthorization!] "All providers associated with the client" providers(can_be_scheduled_with: Boolean): [User!] "Meal Plans from Living Plate" purchased_meal_plans: [MealPlan!] "qualifications of the user" qualifications: String "quicks notes for a given user" quick_notes: String "All reactivation custom emails associated with this user." reactivation_emails: [CustomEmail!] "unique record identifier for user" record_identifier: String "referrals for the user" referrals: [Referral!] "An array of referring physicians associated to all referrals associated with a client" referring_physicians: [ReferringPhysician!] "NPI of the referring provider" referring_provider_id: String "Name of the referring provider" referring_provider_name: String "NPI of the referring provider" referring_provider_npi: String "The date range filter selections for each report" reports_date_filter_selection: ReportsDateFilterSelection "The number of forms that have been requested for the user" requested_form_count: Int "If true, the user must complete their intake forms before accessing chat or joining platform-hosted video calls" require_intake_for_communication: Boolean! "If true, the user is a patient with required fields to create dosespot patient. If false, then either the provider does not have a linked dosespot account, or the patient has all required fields." required_dosespot_fields: String "User subscription has been inactive and needs to be reactivated before allowing access" requires_reactivation: Boolean "User subscription has been inactive for 91+ days and should receive 7 day trial upon reactivation" requires_shortened_trial: Boolean "If true, patients with sensitive information can only be accessed by creating a restriction authorization" restricted: Boolean "Patient ID on the rupa health" rupa_patient_id: String "Providers with higher priority will be chosen first when availability is generated for self-scheduling. Defaults to 0" scheduling_priority: String "The secondary ethnicity value based on ethnicity code" secondary_ethnicity: String "User secondary ethnicity code" secondary_ethnicity_code: String "User secondary race" secondary_race: String "User secondary race code" secondary_race_code: String "True if user is up to date with all product roadmap articles" seen_last_article: Boolean "A link that takes a user to set their password. This will return null if the user has set a password, or the authenticated user is not an admin" set_password_link: String "Sex of the user (Stated on ID card for insurance purposes)" sex: String "Sexual orientation of the user" sexual_orientation: String "The sexual orientation code of the user, corresponds to sexual orientation" sexual_orientation_code: String "The sexual orientation value if other" sexual_orientation_other: String "Shapa Connection for the user" shapa_connection: ShapaConnection "An ID that includes the shard the user is on. Matches ID unless user is on a custom shard" shard_aware_id: ID! "Show appointments tab on the sidebar" show_appointments_tab: Boolean """ Show "Billing Dropdown" on patient sidebar """ show_billing_dropdown_item: Boolean "Show billing tab on the sidebar" show_billing_tab: Boolean "Show brand link in the header" show_brand_tab: Boolean "Allow this user to view care plan (Linked accounts)" show_care_plan_area: Boolean "Show chat tab on the sidebar" show_chat_tab: Boolean "If to show the client credits in the UI" show_client_appointment_credits: Boolean "Show Cms1500s tab on the sidebar" show_cms1500s_tab: Boolean "Show the option to view the dashboard" show_dashboard: Boolean "Show documents tab on the sidebar" show_documents_tab: Boolean "Show education tab on the sidebar" show_education_tab: Boolean "Display DOB next to the name of the client" show_expanded_label: Boolean "Show forms tab on the sidebar" show_forms_tab: Boolean "Allow this user to view goals (Linked accounts)" show_goals_area: Boolean "If true, user will be able to view Grow settings page" show_grow: Boolean """ Show "Integrations" option in gear menu """ show_integrations_dropdown_item: Boolean "Allow this user to view journal entries (Linked accounts)" show_journal_entries_area: Boolean "Show the organization tab on sidebar" show_org_tab: Boolean "Show packages tab on the sidebar" show_packages_tab: Boolean """ Show "Update Payment Methods" option in gear menu """ show_payment_methods_dropdown_item: Boolean "Show payments tab on the sidebar" show_payments_tab: Boolean "Show received fax tab on the sidebar" show_received_fax_tab: Boolean "Show reports tab on the sidebar" show_reports_tab: Boolean "Show scheduled tab on the chat page" show_scheduled_chat_tab: Boolean "Show sent fax tab on the sidebar" show_sent_fax_tab: Boolean "Show subscription link in the settings dropdown" show_subscription_link: Boolean "If a user has seen the message blast alert" show_superbill_org_select: Boolean "Show Superbill tab on the sidebar" show_superbills_tab: Boolean "The total number of sidebar notifications to be displayed for the user" sidebar_notification_count: Int "If true, the user has completed signup" signup_completed(token: String = null): Boolean "True if the user skipped adding a bank account" skipped_bank_account: Boolean "The status of whether the user has a real email or not" skipped_email: Boolean "Specialties of the user" specialties: [Specialty!] "The SSN of the user" ssn: String "Returns a user state licenses" state_licenses: [StateLicense!] "Stripe Info of the client" stripe_customer_detail: StripeCustomerDetail "Stripe credit cards of the client" stripe_customer_details: [StripeCustomerDetail!] "The stripe id of the user (Used to look up bank account details for provider)" stripe_id: String "ID of account representative in Stripe. Nil if not staff/provider" stripe_person_id: String "Returns the subscription for this user. Nil if not staff/provider" subscription: SubscriptionInstance "Paywall information for the user" subscription_access: SubscriptionAccess "Address to use on super bills" super_bill_address: String "Providers location to use on super bills" super_bill_location: Location "Patient location to use on super bills" super_bill_patient_location: Location "Provider's phone number to use on super bills" super_bill_phone_number: String "When true, hide the Stripe bank verification banner for this user" suppress_bank_verification_banner: Boolean "Other users this account can switch to" switchable_users: [User!] "Number of other users this account can switch to" switchable_users_count: Int "Number of tasks" tasks_count(only_created_by_others: Boolean = false, show_hidden: Boolean = false, type: String): Int "tax id of user" tax_id: String "The user's timezone" timezone: String "Access token used to access an ICS feed of this users appointment. Nil if user if not a provider. Must be an admin or authenticated as the user to access" token: String "Total active packages credits" total_active_packages_with_credits: Int "Total clients with appointment credits greater than 0" total_clients_with_appt_type_credits: Int "Total count of the user lab orders objects" total_lab_orders: Int "The authenticated human if an account is masked" true_human_id: String "UI settings for the user (JSON). Internal Healthie Use Only" ui: JSON "The number unconfirmed appointments for the user" unconfirmed_appointment_count(unconfirmed_by_clients: Boolean = false): Int "The number of unseen conversations for the user" unread_convo_count: Int "The number of unread notifications for the user (web only)" unread_notifications_count: Int "The number of unscheduled lab orders" unscheduled_lab_orders_count: Int "The number of unseen appointment notifications" unseen_appt_notification_count: Int "The number of unseen comment notifications" unseen_comment_notification_count: Int "The number of unseen document notifications" unseen_document_notification_count: Int "The number of unseen entry notifications" unseen_entry_notification_count: Int "The number of unseen goal notifications" unseen_goal_notification_count: Int "The number of unseen note notifications" unseen_note_notification_count: Int "The number of unseen notifications for the user (mobile only)" unseen_notification_count: Int @deprecated(reason: "use unseen_notifications_count_mobile") "The number of unseen notifications for the user (web only)" unseen_notifications_count: Int "The number of unseen notifications for the user (this field only used by mobile) [identical to :unseen_notification_count]" unseen_notifications_count_mobile: Int "The number of unseen payment notifications" unseen_payment_notification_count: Int "Number of unseen bounced notification records" unseen_sent_notification_records_count: Int "All active upcoming appointments of the user" upcoming_appointments: [Appointment!] "All active upcoming payments of the user" upcoming_payments: [RecurringPayment!] "Date user was last updated" updated_at: String "File name of uploaded avatar image" uploaded_avatar_file_name: String "User Group of this user" user_group: UserGroup "The ID of the patient's user group" user_group_id: String "All user groups associated with this provider." user_groups(check_group_level_actions: Boolean, course_id: ID, keywords: String, offset: Int = 0, should_paginate: Boolean = false): [UserGroup!]! "A number of user groups associated with this provider." user_groups_count(check_group_level_actions: Boolean, course_id: ID): Int! "User of who sent this member an invite" user_who_invited_member: User "Verification fields left for the provider to fill out" verification_fields: [String] "The last weight of the user" weight: String "Displays weight percentile for growth charts" weight_percentile: String "Displays standard by which weight percentile is calculated" weight_percentile_standard: String "Withings Connection for the user" withings_connection: WithingsConnection "The number of workout entries the user has" workout_entries_count: String "If user has Zus, returns Zus proxy token" zus_proxy_token: String } "The connection type for User." type UserConnection { "A list of edges." edges: [UserEdge] "A list of nodes." nodes: [User] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "An edge in a connection." type UserEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: User } "A user group, returns basic info about the user group" type UserGroup { "The date the user group was created" created_at: String! "Pagination cursor" cursor: Cursor! "An ID used for document, course, and conversation sharing" doc_share_id: String "The unique identifier of the user group" id: ID! "The invite code" invite_code: String "The name of the user group" name: String "Onboarding Flow of this user group" onboarding_flow: OnboardingFlow "The id of the associated onboarding flow" onboarding_flow_id: String "Recurring Form Names for this user group" recurring_forms: [RecurringForm!] "Recurring Forms Count for this user group" recurring_forms_count: Int "Owner of this user group" user: User "ids of user in group" user_ids: [String] "All patients associated with this user group." users(active_status: String, convo_id: ID, should_sort: Boolean = true): [User!]! "The number of users in the group" users_count: Int "Users in user group with course membership" users_with_membership: [User!] } "An edge in a connection." type UserGroupEdge { "A cursor for use in pagination" cursor: Cursor! "The item at the end of the edge." node: UserGroup } "The connection type for UserGroup." type UserGroupPaginationConnection { "A list of edges." edges: [UserGroupEdge] "A list of nodes." nodes: [UserGroup] "Information to aid in pagination." page_info: PageInfo! "Total count of items." total_count: Int! } "Counts of different types of notifications for a user" type UserNotificationsCount { "The number of unread conversation notifications" conversation_notification_count: Int "The unique identifier of the counter" id: ID "The number of unscheduled lab orders" unscheduled_lab_orders_count: Int } "A user package selection" type UserPackageSelection { "The related billing item" billing_item: BillingItem "The id of the related billing item" billing_item_id: ID "The time when the user package selection was created" created_at: String! "Pagination cursor" cursor: Cursor! "The unique identifier of the user package selection" id: ID! "The amount of the first payment for a package, including promo discounts" initial_price_with_offering_coupon: String "The related offering" offering: Offering "The id of the related offering coupon" offering_coupon_id: ID "The related recurring payment" recurring_payment: RecurringPayment "The related requested payment" requested_payment: RequestedPayment "The id of the related requested payment" requested_payment_id: ID "The related user" user: User } "Information based on if an offering coupon is valid" type ValidateOfferingCoupon { "The reason why the promo code was not successfully applied" fail_reason: String "Discount amount for first payment" first_amount: String "The size of the discount with the promo code applied to the first payment (in case offering has a different first payment amount)" new_first_price: String "The new price with a promo code applied" new_price: String "Indicates number of discount periods" repeat_times: String "Indicates necessary of displaying CC form" still_ask_for_cc: Boolean } "A default video URL" type VideoUrlDefault { "The default URL to use for anyone with the connected appointment setting" default_url: String! "The unique identifier of the url" id: ID! "The ID of the connected user" user_id: ID! "The options for the connected video URL" video_url_options: [VideoUrlOption!] } "A video URL option" type VideoUrlOption { "The unique identifier of the option" id: ID! "The default URL to use for the connected provider" url: String "The ID of the connected provider" url_by_item_id: String } "Info about a visitor to the site" type Visitor { "Message from visitor" about_me: String "Email of the visitor" email: String "First name of visitor" first_name: String "The unique identifier of the visitor" id: ID! "Last name of visitor" last_name: String "Phone number of visitor" phone_number: String } "represents an embeddable static Visualize dashboard" type VisualizeDashboardType { "The IFrame URL for the embeddable static dashboard" url: String } "Autogenerated return type of VoidLinePayment." type VoidLinePaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The voided line payment" line_payment: LinePayment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of VoidLineWriteOff." type VoidLineWriteOffPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The voided write-off" line_write_off: LineWriteOff "The list of errors occurred during the mutation" messages: [FieldError] } "A configured webhook" type Webhook { "Pagination cursor" cursor: Cursor! "The type of webhook" event_type: String "The unique identifier of the webhook" id: ID! "Whether the webhook is enabled or not" is_enabled: Boolean! "Whether the webhook should retry on failure" should_retry: Boolean! "The secret key used to sign the webhook" signature_secret: String "The URL that the webhook will be sent to" url: String "The date and time that the customer was wamed about the webhook failing" warned_at: ISO8601DateTime "The events that the webhook is subscribed to" webhook_events: [WebhookEvent!] } "The events that the webhook is subscribed to" type WebhookEvent { "The date and time that the webhook was created" created_at: ISO8601DateTime! "The type of webhook" event_type: String! "The date and time that the webhook first failed" first_failed_at: ISO8601DateTime "The unique identifier of the webhook" id: ID! "The date and time that the webhook last failed" last_failed_at: ISO8601DateTime "The number of times the webhook has been retried" retry_count: Int! "The date and time that the webhook was last updated" updated_at: ISO8601DateTime! "The webhook that the event is associated with" webhook: Webhook! } "Info for Whitelabeling" type WhitelabelSetting { "Amplitude API Key" amplitude_api_key(branded_url: String): String "URL of whitelabeled Android app" android_app_link: String "The branded URL of the backend (used in certain whitelabel setups)" branded_backend_url: String "Branded email of whitelabel" branded_email: String "Branded favicon url of whitelabel" branded_favicon_url: String "Branded logo url of whitelabel" branded_logo_url: String "Branded name of whitelabel" branded_name: String "URL of whitelabel site" branded_url: String "URL of whitelabeled Food icon" food_icon_url: String "Whether to hide the Apple Calendar integration" hide_apple_calendar: Boolean "The unique identifier of the setting" id: ID! "The number of minutes of allowable inactivity" inactivity_minutes_timeout: String "URL of whitelabeled iOS app" ios_app_link: String "URL of whitelabeled Metric icon" metric_icon_url: String "Mixpanel Project Token" mixpanel_project_token(branded_url: String): String "The namespace that the whitelabel setting is in." namespace: String "The whitelabel's patient SSO connection" patient_sso_connection: SsoConnection "The whitelabel's patient SSO connections" patient_sso_connections: [SsoConnection!] "JSON hash of whitelabel replacement words" replacement_words_json: String "URL of whitelabeled Selfie icon" selfie_icon_url: String "The whitelabel's staff SSO connection" staff_sso_connection: SsoConnection "The whitelabel's staff SSO connections" staff_sso_connections: [SsoConnection!] "URL of whitelabeled Workout icon" workout_icon_url: String } "A Withings Connection" type WithingsConnection { "The unique identifier of the connections" id: ID! "The last time Withings was synced" last_sync_date: String } "An invoice (requested payment) write-off" type WriteOff { "The amount of the write-off" amount: Float! "The unique identifier of the write-off" id: ID! "Non-standard reason for the write-off" other_reason: String "The requested payment associated with this write-off" requested_payment: RequestedPayment! "The type of write-off" write_off_type: WriteOffType! } "Zoom meeting retrieved from Zoom API" type ZoomAppointment { "The total number of minutes attended by the meeting's host and participants" duration: Int "End time of meeting" end_time: String "The unique identifier of the zoom appointment" id: ID "The number of meeting participants" participants_count: Int "Start time of meeting" start_time: String "The meeting's duration, in minutes" total_minutes: Int } "A Zoom cloud recording file with metadata and download URL" type ZoomCloudRecordingFile { "The URL to download the recording file" download_url: String "The size of the recording file in bytes" file_size: Int "The file type of the recording" file_type: ZoomRecordingFileTypeEnum "The unique identifier of the recording file" id: String "The Meeting ID for the Zoom call that was recorded" meeting_id: String "The end time of the recording" recording_end: String "The start time of the recording" recording_start: String "The type of recording" recording_type: ZoomRecordingTypeEnum "The status of the recording file" status: ZoomRecordingStatusEnum } "A co-host entry for a Zoom group appointment, containing a ZAK token for automatic co-host promotion" type ZoomCoHostLink { "Full name of the co-host" full_name: String! "User ID of the co-host" user_id: ID! "ZAK token used to build a co-host join URL" zak_token: String! } "Autogenerated return type of addPharmacy." type addPharmacyPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] pharmacy: Pharmacy } "Autogenerated return type of asyncBulkCreateOrganizationMemberships." type asyncBulkCreateOrganizationMembershipsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The current authenticated user (for client state management)" currentUser: User "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of bulkApplyCarePlanTemplate." type bulkApplyCarePlanTemplatePayload { carePlans: [CarePlan] "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of bulkApply." type bulkApplyPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] tags: [Tag] } "Autogenerated return type of bulkCreateAvailability." type bulkCreateAvailabilityPayload { availabilities: [Availability] "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of bulkCreateEntries." type bulkCreateEntriesPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") entries: [Entry] "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of bulkCreateOrganizationMemberships." type bulkCreateOrganizationMembershipsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The current authenticated user (for client state management)" currentUser: User "The list of errors occurred during the mutation" messages: [FieldError] organizationMembership: OrganizationMembership "The organization memberships enqueued to be created" other_organization_memberships_count: Int } "Autogenerated return type of bulkDeleteTasks." type bulkDeleteTasksPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] tasks: [Task] } "Autogenerated return type of bulkUpdateCardIssues." type bulkUpdateCardIssuesPayload { card_issues: [StripeCustomerDetail] "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of bulkUpdateCarePlanUsers." type bulkUpdateCarePlanUsersPayload { carePlans: [CarePlan] "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of bulkUpdateClients." type bulkUpdateClientsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] users: [User] } "Autogenerated return type of bulkUpdateNotificationRecords." type bulkUpdateNotificationRecordsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of bulkUpdateNotifications." type bulkUpdateNotificationsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") current_user: User "The list of errors occurred during the mutation" messages: [FieldError] notifications: [Notification] } "Autogenerated return type of bulkUpdateTasks." type bulkUpdateTasksPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] tasks: [Task] } "Autogenerated return type of cancelRecurringPayment." type cancelRecurringPaymentPayload { billingItem: BillingItem "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of clearUnreconciledObjects." type clearUnreconciledObjectsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of completeCheckout." type completeCheckoutPayload { appointment: Appointment "An array of all group appointments that were registered for. Used in conjunction with appointment_ids argument." appointments: [Appointment] billingItem: BillingItem "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") formAnswerGroupSaved: Boolean "The list of errors occurred during the mutation" messages: [FieldError] patientEmail: String "Returns true if client booking appointment is newly created and has never logged into their account or booked future appointments" reassignClientProvider: Boolean userPackageSelection: UserPackageSelection widgetCompletedSubheaderHtml: String } "Autogenerated return type of completeCourseDocument." type completeCourseDocumentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "New CompletedCourseItem" completedCourseItem: CompletedCourseItem "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of convertGeneratedFormAnswerGroup." type convertGeneratedFormAnswerGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup generated_form_answer_group: GeneratedFormAnswerGroupType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of copyCourse." type copyCoursePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") course: Course "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of copyCustomModuleForm." type copyCustomModuleFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModuleForm: CustomModuleForm "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of copyCustomModule." type copyCustomModulePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModule: CustomModule "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of copyOffering." type copyOfferingPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] offering: Offering } "Autogenerated return type of createAcceptedInsurancePlan." type createAcceptedInsurancePlanPayload { accepted_insurance_plans: [AcceptedInsurancePlan] appointment_setting: AppointmentSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAddendum." type createAddendumPayload { addendum: ChartingNoteAddendumType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAllergySensitivity." type createAllergySensitivityPayload { allergy_sensitivity: AllergySensitivity "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") duplicate_allergy: AllergySensitivity "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAnnouncement." type createAnnouncementPayload { announcement: Announcement "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createApiKey." type createApiKeyPayload { api_key: String api_key_object: ApiKey "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAppleHealth." type createAppleHealthPayload { apple_health: AppleHealth "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAppointmentFormAnswerGroupConnection." type createAppointmentFormAnswerGroupConnectionPayload { appointment: Appointment "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAppointment." type createAppointmentPayload { appointment: Appointment "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAppointmentRequest." type createAppointmentRequestPayload { appointmentRequest: AppointmentRequestType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAppointmentSetting." type createAppointmentSettingPayload { appointmentSetting: AppointmentSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAppointmentTypeCptCode." type createAppointmentTypeCptCodePayload { appointment_type_cpt_code: AppointmentTypeCptCodeType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAppointmentType." type createAppointmentTypePayload { appointmentType: AppointmentType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] "Warning about SMS template length and multi-message costs. Returns null for short templates (≤480 characters after variable expansion) or when the split_long_sms_messages feature flag is disabled. Returns a warning object with message, estimated_message_count, and estimated_length when the template will be sent as multiple SMS messages." sms_template_warning: SmsTemplateWarning } "Autogenerated return type of createAutoTaskGenerator." type createAutoTaskGeneratorPayload { auto_task_generator: AutoTaskGenerator "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAutomatedInsuranceBillingSetting." type createAutomatedInsuranceBillingSettingPayload { automated_insurance_billing_setting: AutomatedInsuranceBillingSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createAvailability." type createAvailabilityPayload { availability: Availability "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createBillingItem." type createBillingItemPayload { billingItem: BillingItem "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] stripeError: String } "Autogenerated return type of createBrand." type createBrandPayload { brand: Brand "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCarePlan." type createCarePlanPayload { carePlan: CarePlan "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCarePlanRecommendationCategory." type createCarePlanRecommendationCategoryPayload { care_plan_recommendation_category: CarePlanRecommendationCategory "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization } "Autogenerated return type of createChatSetting." type createChatSettingPayload { chatSetting: ChatSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createClient." type createClientPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of createClientRestrictionAuthorization." type createClientRestrictionAuthorizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") client_restriction_authorization: ClientRestrictionAuthorization "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCms1500." type createCms1500Payload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cms1500: Cms1500 "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCognitiveStatus." type createCognitiveStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cognitive_status: CognitiveStatus "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createComment." type createCommentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") comment: Comment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCompletedCourseItem." type createCompletedCourseItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") completedCourseItem: CompletedCourseItem "The list of errors occurred during the mutation" messages: [FieldError] redirect_url: String } "Autogenerated return type of createCompletedOnboardingItem." type createCompletedOnboardingItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") completed_onboarding_item: CompletedOnboardingItem "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createContact." type createContactPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] visitor: Visitor } "Autogenerated return type of createConversation." type createConversationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") conversation: Conversation "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCourseBenefit." type createCourseBenefitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseBenefit: CourseBenefit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCourseItem." type createCourseItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseItem: CourseItem "The list of errors occurred during the mutation" messages: [FieldError] redirect_url: String } "Autogenerated return type of createCourse." type createCoursePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") course: Course "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCustomEmail." type createCustomEmailPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customEmail: CustomEmail "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCustomFood." type createCustomFoodPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customFood: Food "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCustomModuleForm." type createCustomModuleFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModuleForm: CustomModuleForm "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createCustomModule." type createCustomModulePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModule: CustomModule "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createDocument." type createDocumentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") currentUser: User document: Document "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createDosespotClinician." type createDosespotClinicianPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") dosespot_user: DoseSpot "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createDraft." type createDraftPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") draft: Draft "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createDsiComment." type createDsiCommentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") dsi_comment: DsiComment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createEbook." type createEbookPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] visitor: Visitor } "Autogenerated return type of createEntry." type createEntryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") entry: Entry "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createEpisodeOfCare." type createEpisodeOfCarePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") episode_of_care: EpisodeOfCare "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createExternalCalendar." type createExternalCalendarPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") external_calendar: ExternalCalendar "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFamilyHistory." type createFamilyHistoryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") duplicate_family_history_condition: FamilyHistoryCondition family_history_condition: FamilyHistoryCondition "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFaxAcctInfo." type createFaxAcctInfoPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of createFaxLineRequest." type createFaxLineRequestPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") faxLineRequest: FaxLineRequest "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFeatureToggle." type createFeatureTogglePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") feature_toggle: FeatureToggle "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFitbit." type createFitbitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") fitbit: Fitbit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFolder." type createFolderPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") folder: Folder "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFormAnswerFileAttachment." type createFormAnswerFileAttachmentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The file attachment record" file_attachment: FileAttachment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFormAnswerFileAttachmentUploadUrl." type createFormAnswerFileAttachmentUploadUrlPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "Headers to include in the upload request." headers: [HttpHeader!] "The list of errors occurred during the mutation" messages: [FieldError] "The ID of the upload. This is needed after the upload is complete, when creating the form answer file attachment." upload_id: ID "The direct upload URL" upload_url: String } "Autogenerated return type of createFormAnswerGroup." type createFormAnswerGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFormAnswerGroupSigning." type createFormAnswerGroupSigningPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") formAnswerGroupSigning: FormAnswerGroupSigning "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFullscriptPractitioner." type createFullscriptPractitionerPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "Fullscript Practitioner" fullscript_practitioner: FullscriptPractitionerType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createFunctionalStatus." type createFunctionalStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") functional_status: FunctionalStatus "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createGoalHistory." type createGoalHistoryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") goalHistory: GoalHistory "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createGoal." type createGoalPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") goal: Goal "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createGoogleFit." type createGoogleFitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") google_fit: GoogleFit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createGroup." type createGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user_group: UserGroup } "Autogenerated return type of createHealthConcern." type createHealthConcernPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") health_concern: HealthConcern "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createImmunization." type createImmunizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") immunization: Immunization "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createImplantableDeviceUser." type createImplantableDeviceUserPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") implantable_device_user: ImplantableDeviceUser "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createImportDataRequest." type createImportDataRequestPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") importDataRequest: ImportDataRequest "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createInsuranceAuthorization." type createInsuranceAuthorizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") insuranceAuthorization: InsuranceAuthorizationType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createInsurancePayment." type createInsurancePaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") insurance_payment: InsurancePayment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createInsurancePlan." type createInsurancePlanPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") insurance_plan: InsurancePlan "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createLabOrder." type createLabOrderPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") currentUserNotificationsCount: UserNotificationsCount lab_order: LabOrder "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createLocation." type createLocationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") location: Location "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createMeal." type createMealPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") meal: Meal "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createMedication." type createMedicationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") medication: MedicationType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createMessageBlast." type createMessageBlastPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") message: String "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createNote." type createNotePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] note: Note } "Autogenerated return type of createNotificationContact." type createNotificationContactPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] notificationContact: NotificationContact } "Autogenerated return type of createOfferingCoupon." type createOfferingCouponPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] offeringCoupon: OfferingCoupon } "Autogenerated return type of createOffering." type createOfferingPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] offering: Offering } "Autogenerated return type of createOfficeallySftpAccount." type createOfficeallySftpAccountPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] officeally_sftp_account: OfficeallySftpAccount } "Autogenerated return type of createOnboardingFlow." type createOnboardingFlowPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] onboardingFlow: OnboardingFlow } "Autogenerated return type of createOnboardingItem." type createOnboardingItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] onboardingItem: OnboardingItem } "Autogenerated return type of createOrAddToWaterIntakeEntry." type createOrAddToWaterIntakeEntryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") entry: Entry "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createOrganizationCptCode." type createOrganizationCptCodePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization_cpt_code: OrganizationCptCodeType } "Autogenerated return type of createOrganizationMembership." type createOrganizationMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The current authenticated user (for client state management)" currentUser: User "The list of errors occurred during the mutation" messages: [FieldError] organizationMembership: OrganizationMembership } "Autogenerated return type of createOrganization." type createOrganizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The current authenticated user (for client state management)" currentUser: User "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization } "Autogenerated return type of createPartner." type createPartnerPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] visitor: Visitor } "Autogenerated return type of createPaymentIntent." type createPaymentIntentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") intentClientSecret: String "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createPdfLetterheadTemplate." type createPdfLetterheadTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization pdf_letterhead_template: PdfLetterheadTemplate } "Autogenerated return type of createPermissionTemplate." type createPermissionTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] newPermissionTemplate: PermissionTemplateType } "Autogenerated return type of createPersonalizationQuestionnaire." type createPersonalizationQuestionnairePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] was_saved: Boolean } "Autogenerated return type of createPreferredMedicalCode." type createPreferredMedicalCodePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] preferred_medical_codes: [PreferredMedicalCode] } "Autogenerated return type of createProcedure." type createProcedurePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] procedure: Procedure } "Autogenerated return type of createProduct." type createProductPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] product: Product } "Autogenerated return type of createProviderAcceptedInsurancePlans." type createProviderAcceptedInsurancePlansPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] provider_accepted_insurance_plans: [ProviderAcceptedInsurancePlanType!] } "Autogenerated return type of createProviderCptCodes." type createProviderCptCodesPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createRecommendation." type createRecommendationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] recommendation: Recommendation } "Autogenerated return type of createReferral." type createReferralPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] referral: Referral } "Autogenerated return type of createReferringPhysician." type createReferringPhysicianPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") duplicated_physician: ReferringPhysician "The list of errors occurred during the mutation" messages: [FieldError] referring_physician: ReferringPhysician } "Autogenerated return type of createRequestedForm." type createRequestedFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] requestedFormCompletion: RequestedFormCompletion requestedFormCompletionStatus: RequestedFormStatusType } "Autogenerated return type of createRequestedPayment." type createRequestedPaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] requestedPayment: RequestedPayment } "Autogenerated return type of createRupaOrder." type createRupaOrderPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] rupa_order_url: String } "Autogenerated return type of createSavedFilter." type createSavedFilterPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] savedFilter: SavedFilter } "Autogenerated return type of createSentDirectMessage." type createSentDirectMessagePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] sent_direct_message: SentDirectMessage } "Autogenerated return type of createSentFax." type createSentFaxPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] sent_fax: SentFax } "Autogenerated return type of createSetupIntent." type createSetupIntentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") intentClientSecret: String "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of createSmartPhrase." type createSmartPhrasePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] smartPhrase: SmartPhrase } "Autogenerated return type of createSmokingStatus." type createSmokingStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] smokingStatus: SmokingStatus } "Autogenerated return type of createStripeCustomerDetail." type createStripeCustomerDetailPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] stripeError: String stripe_customer_detail: StripeCustomerDetail } "Autogenerated return type of createSubscription." type createSubscriptionPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] subscription: SubscriptionInstance } "Autogenerated return type of createSuperBill." type createSuperBillPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] superBill: SuperBill } "Autogenerated return type of createTag." type createTagPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] tag: Tag } "Autogenerated return type of createTask." type createTaskPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] task: Task } "Autogenerated return type of createUniqueDeviceIdentifier." type createUniqueDeviceIdentifierPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] unique_device_identifier: UniqueDeviceIdentifier } "Autogenerated return type of createVisitor." type createVisitorPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] visitor: Visitor } "Autogenerated return type of createWebhook." type createWebhookPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] webhook: Webhook } "Autogenerated return type of createWriteOff." type createWriteOffPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] writeOff: WriteOff } "Autogenerated return type of deleteAcceptedInsurancePlan." type deleteAcceptedInsurancePlanPayload { accepted_insurance_plan: AcceptedInsurancePlan appointment_setting: AppointmentSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAllergySensitivity." type deleteAllergySensitivityPayload { allergy_sensitivity: AllergySensitivity "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteApiKey." type deleteApiKeyPayload { api_key: ApiKey "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAppleHealth." type deleteAppleHealthPayload { apple_health: AppleHealth "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAppointmentFormAnswerGroupConnection." type deleteAppointmentFormAnswerGroupConnectionPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAppointment." type deleteAppointmentPayload { appointment: Appointment "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAppointmentRequest." type deleteAppointmentRequestPayload { appointmentRequest: AppointmentRequestType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAppointmentTypeCptCode." type deleteAppointmentTypeCptCodePayload { appointment_type_cpt_code: AppointmentTypeCptCodeType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAppointmentType." type deleteAppointmentTypePayload { appointmentType: AppointmentType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAutoTaskGenerator." type deleteAutoTaskGeneratorPayload { auto_task_generator: AutoTaskGenerator "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteAvailability." type deleteAvailabilityPayload { availability: Availability "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteBillingItem." type deleteBillingItemPayload { billingItem: BillingItem "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCarePlanConnection." type deleteCarePlanConnectionPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") connection: CarePlanConnection "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCarePlan." type deleteCarePlanPayload { carePlan: CarePlan "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCarePlanRecommendationCategory." type deleteCarePlanRecommendationCategoryPayload { care_plan_recommendation_category: CarePlanRecommendationCategory "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization } "Autogenerated return type of deleteClientRestrictionAuthorization." type deleteClientRestrictionAuthorizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") client_restriction_authorization: ClientRestrictionAuthorization "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCms1500." type deleteCms1500Payload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cms1500: Cms1500 "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCognitiveStatus." type deleteCognitiveStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cognitive_status: CognitiveStatus "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteComment." type deleteCommentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") comment: Comment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteConversationMembership." type deleteConversationMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") conversationMembership: ConversationMembership "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCourseBenefit." type deleteCourseBenefitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseBenefit: CourseBenefit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCourseGroup." type deleteCourseGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseGroup: CourseGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCourseItem." type deleteCourseItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseItem: CourseItem "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCourseMembership." type deleteCourseMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseMembership: CourseMembership "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCourse." type deleteCoursePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") course: Course "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCustomEmail." type deleteCustomEmailPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customEmail: CustomEmail "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCustomFood." type deleteCustomFoodPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customFood: Food "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCustomModuleForm." type deleteCustomModuleFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModuleForm: CustomModuleForm "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteCustomModule." type deleteCustomModulePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModule: CustomModule "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteDexcomConnection." type deleteDexcomConnectionPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") dexcom_connection: DexcomConnection "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteDocument." type deleteDocumentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") document: Document "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteEntry." type deleteEntryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") entry: Entry "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteEpisodeOfCare." type deleteEpisodeOfCarePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") episode_of_care: EpisodeOfCare "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteExternalCalendar." type deleteExternalCalendarPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") external_calendar: ExternalCalendar "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteFamilyHistory." type deleteFamilyHistoryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") family_history_condition: FamilyHistoryCondition "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteFitbit." type deleteFitbitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") fitbit: Fitbit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteFolder." type deleteFolderPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") folder: Folder "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteFormAnswerFileAttachment." type deleteFormAnswerFileAttachmentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The file attachment that was deleted" file_attachment: FileAttachment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteFormAnswerGroup." type deleteFormAnswerGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteFormAnswerGroupSigning." type deleteFormAnswerGroupSigningPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") formAnswerGroupSigning: FormAnswerGroupSigning "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteFunctionalStatus." type deleteFunctionalStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") functional_status: FunctionalStatus "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteGoalHistory." type deleteGoalHistoryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") goal_history: GoalHistory "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteGoal." type deleteGoalPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") goal: Goal "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteGoogleFit." type deleteGoogleFitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") google_fit: GoogleFit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteHealthConcern." type deleteHealthConcernPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") health_concern: HealthConcern "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteImplantableDeviceUser." type deleteImplantableDeviceUserPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") implantable_device_user: ImplantableDeviceUser "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteInsuranceAuthorization." type deleteInsuranceAuthorizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") insuranceAuthorization: InsuranceAuthorizationType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteInsurancePlan." type deleteInsurancePlanPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") insurance_plan: InsurancePlan "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteLocation." type deleteLocationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") location: Location "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteManualInsurancePayment." type deleteManualInsurancePaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The deleted insurance payment" insurance_payment: InsurancePayment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteMeal." type deleteMealPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") meal: Meal "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of deleteNote." type deleteNotePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] note: Note } "Autogenerated return type of deleteNotificationContact." type deleteNotificationContactPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] notificationContact: NotificationContact } "Autogenerated return type of deleteOfferingCoupon." type deleteOfferingCouponPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] offeringCoupon: OfferingCoupon } "Autogenerated return type of deleteOffering." type deleteOfferingPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] offering: Offering } "Autogenerated return type of deleteOnboardingFlow." type deleteOnboardingFlowPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] onboardingFlow: OnboardingFlow } "Autogenerated return type of deleteOnboardingItem." type deleteOnboardingItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] onboardingItem: OnboardingItem } "Autogenerated return type of deleteOrganizationCptCode." type deleteOrganizationCptCodePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization_cpt_code: OrganizationCptCodeType } "Autogenerated return type of deleteOrganizationInfo." type deleteOrganizationInfoPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organizationInfo: OrganizationInfo } "Autogenerated return type of deleteOrganizationMembership." type deleteOrganizationMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organizationMembership: OrganizationMembership } "Autogenerated return type of deletePermissionTemplate." type deletePermissionTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] permission_template: PermissionTemplateType } "Autogenerated return type of deletePreferredMedicalCode." type deletePreferredMedicalCodePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] preferred_medical_codes: [PreferredMedicalCode] } "Autogenerated return type of deleteProcedure." type deleteProcedurePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] procedure: Procedure } "Autogenerated return type of deleteProduct." type deleteProductPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] product: Product } "Autogenerated return type of deleteProviderAcceptedInsurancePlan." type deleteProviderAcceptedInsurancePlanPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] providerAcceptedInsurancePlan: ProviderAcceptedInsurancePlanType } "Autogenerated return type of deleteProviderCptCode." type deleteProviderCptCodePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] provider_cpt_code: ProviderCptCodeType } "Autogenerated return type of deleteReceivedFax." type deleteReceivedFaxPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] receivedFax: ReceivedFax } "Autogenerated return type of deleteRecommendation." type deleteRecommendationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] recommendation: Recommendation } "Autogenerated return type of deleteReferral." type deleteReferralPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] referral: Referral } "Autogenerated return type of deleteReferringPhysician." type deleteReferringPhysicianPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] referringPhysician: ReferringPhysician } "Autogenerated return type of deleteRequestedForm." type deleteRequestedFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] requestedFormCompletion: RequestedFormCompletion } "Autogenerated return type of deleteRequestedPayment." type deleteRequestedPaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] requested_payment: RequestedPayment } "Autogenerated return type of deleteSavedFilter." type deleteSavedFilterPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] savedFilter: SavedFilter } "Autogenerated return type of deleteShapaConnection." type deleteShapaConnectionPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] shapa_connection: ShapaConnection } "Autogenerated return type of deleteSmartPhrase." type deleteSmartPhrasePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] smartPhrase: SmartPhrase } "Autogenerated return type of deleteSmokingStatus." type deleteSmokingStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] smokingStatus: SmokingStatus } "Autogenerated return type of deleteStripeCustomerDetail." type deleteStripeCustomerDetailPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] stripe_customer_detail: StripeCustomerDetail } "Autogenerated return type of deleteSuperBill." type deleteSuperBillPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] superBill: SuperBill } "Autogenerated return type of deleteTag." type deleteTagPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] "Indicates if the tag is being removed asynchronously in a background job" removing_async: Boolean tag: Tag } "Autogenerated return type of deleteTask." type deleteTaskPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] task: Task } "Autogenerated return type of deleteUniqueDeviceIdentifier." type deleteUniqueDeviceIdentifierPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] unique_device_identifier: UniqueDeviceIdentifier } "Autogenerated return type of deleteUserGroup." type deleteUserGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user_group: UserGroup } "Autogenerated return type of deleteWebhook." type deleteWebhookPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] webhook: Webhook } "Autogenerated return type of deleteWithingsConnection." type deleteWithingsConnectionPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] withings_connection: WithingsConnection } "Autogenerated return type of deleteWriteOff." type deleteWriteOffPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] write_off: WriteOff } "Autogenerated return type of deleteZoomRecordingFile." type deleteZoomRecordingFilePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success: Boolean zoom_recording_file: ZoomCloudRecordingFile } "Autogenerated return type of destroyAnnouncement." type destroyAnnouncementPayload { announcement: Announcement "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of destroyFaxAcctInfo." type destroyFaxAcctInfoPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of destroyMedication." type destroyMedicationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") medication: MedicationType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of destroyPdfLetterheadTemplate." type destroyPdfLetterheadTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization pdf_letterhead_template: PdfLetterheadTemplate } "Autogenerated return type of destroyRecurringForm." type destroyRecurringFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] recurringForm: RecurringForm } "Autogenerated return type of dismissAllAnnouncements." type dismissAllAnnouncementsPayload { announcements: [Announcement] "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of dismissAnnouncement." type dismissAnnouncementPayload { announcement: Announcement "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of editAvailability." type editAvailabilityPayload { availability: Availability "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of expireWebhookSignature." type expireWebhookSignaturePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] webhook: Webhook } "Autogenerated return type of exportClientEhi." type exportClientEhiPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] "The banner message shown when successful." success_string: String } "Autogenerated return type of exportToTemplate." type exportToTemplatePayload { carePlan: CarePlan "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "A fullscript Sync" type fullscript { "The unique identifier of the fullscript" id: ID! } "Autogenerated return type of generateChartingPdf." type generateChartingPdfPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of ingestMedicationsFromSurescripts." type ingestMedicationsFromSurescriptsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of linkEncounterToEpisodeOfCare." type linkEncounterToEpisodeOfCarePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] results: [LinkUnlinkEncounterToEpisodeOfCare!] } "Autogenerated return type of logMedicationHistoryConsent." type logMedicationHistoryConsentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") consented_at: ISO8601DateTime "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of mergeClients." type mergeClientsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of parseCcdaDocument." type parseCcdaDocumentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") current_provider_has_access: Boolean is_new_patient: Boolean "The list of errors occurred during the mutation" messages: [FieldError] user: User xml_file_name: String } "Autogenerated return type of rejectGeneratedFormAnswerGroup." type rejectGeneratedFormAnswerGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") generated_form_answer_group: GeneratedFormAnswerGroupType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of removeAppliedTag." type removeAppliedTagPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] tag: Tag } "Autogenerated return type of removeDraft." type removeDraftPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") draft: Draft "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of removeUserFromGroupCarePlan." type removeUserFromGroupCarePlanPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") groupCarePlanUserConnection: GroupCarePlanUserConnection "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of resendSentFax." type resendSentFaxPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] sent_fax: SentFax } "Autogenerated return type of resetDefaultPdfLetterheadTemplate." type resetDefaultPdfLetterheadTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization } "Autogenerated return type of resetPassword." type resetPasswordPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of resyncRupaLabOrders." type resyncRupaLabOrdersPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success: Boolean } "Autogenerated return type of revokeToken." type revokeTokenPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of runEligibilityCheckMutation." type runEligibilityCheckMutationPayload { "The result of the ChangeHealth eligibility check." claim_eligibility_check: ClaimEligibilityCheck @deprecated(reason: "ChangeHealth integration has been discontinued.") "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The result of the eligibility check." eligibility_check: EligibilityCheck "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of sendCarePlanEmail." type sendCarePlanEmailPayload { carePlan: CarePlan "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of sendTestWebhook." type sendTestWebhookPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] sent: Boolean! } "Autogenerated return type of setDefaultPdfLetterheadTemplate." type setDefaultPdfLetterheadTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization pdf_letterhead_template: PdfLetterheadTemplate } "Autogenerated return type of shareAnswersAsDocument." type shareAnswersAsDocumentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") document: Document "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of shareCourse." type shareCoursePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") course: Course "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of shareCustomModuleForm." type shareCustomModuleFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModuleForm: CustomModuleForm "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of signIn." type signInPayload { "API Key created" api_key: String "Blocked by 2fa status" blocked_by_2fa: Boolean "2fa challenge type" blocked_by_2fa_type: MfaType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] "Token returned for authorization" token: String "User info" user: User } "Autogenerated return type of signUp." type signUpPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") initialMessage: String "The list of errors occurred during the mutation" messages: [FieldError] nextRequiredStep: String token: String user: User whitelabelSetting: WhitelabelSetting } "Autogenerated return type of toggleCarePlanStatusForSpecificUser." type toggleCarePlanStatusForSpecificUserPayload { carePlan: CarePlan "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of unlinkEncounterToEpisodeOfCare." type unlinkEncounterToEpisodeOfCarePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] results: [LinkUnlinkEncounterToEpisodeOfCare!] } "Autogenerated return type of unsubscribeFromNotification." type unsubscribeFromNotificationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] notificationSettingUpdated: Boolean } "Autogenerated return type of updateAddendum." type updateAddendumPayload { addendum: ChartingNoteAddendumType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAllergySensitivity." type updateAllergySensitivityPayload { allergy_sensitivity: AllergySensitivity "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") duplicate_allergy: AllergySensitivity "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAnnouncement." type updateAnnouncementPayload { announcement: Announcement "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAppleHealth." type updateAppleHealthPayload { apple_health: AppleHealth "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAppointmentInclusion." type updateAppointmentInclusionPayload { appointment_inclusion: AppointmentInclusionType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAppointment." type updateAppointmentPayload { appointment: Appointment "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAppointmentRequest." type updateAppointmentRequestPayload { appointmentRequest: AppointmentRequestType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAppointmentSetting." type updateAppointmentSettingPayload { appointmentSetting: AppointmentSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAppointmentTypeCptCode." type updateAppointmentTypeCptCodePayload { appointment_type_cpt_code: AppointmentTypeCptCodeType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAppointmentType." type updateAppointmentTypePayload { appointmentType: AppointmentType "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] "Warning about SMS template length and multi-message costs. Returns null for short templates (≤480 characters after variable expansion) or when the split_long_sms_messages feature flag is disabled. Returns a warning object with message, estimated_message_count, and estimated_length when the template will be sent as multiple SMS messages." sms_template_warning: SmsTemplateWarning } "Autogenerated return type of updateAutoTaskGenerator." type updateAutoTaskGeneratorPayload { auto_task_generator: AutoTaskGenerator "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateAutomatedInsuranceBillingSetting." type updateAutomatedInsuranceBillingSettingPayload { automated_insurance_billing_setting: AutomatedInsuranceBillingSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateBillingItem." type updateBillingItemPayload { billingItem: BillingItem "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateBrand." type updateBrandPayload { brand: Brand "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateByTemplate." type updateByTemplatePayload { care_plan: CarePlanConnection "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCalendarViewSetting." type updateCalendarViewSettingPayload { calendar_view_setting: CalendarViewSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCarePlan." type updateCarePlanPayload { carePlan: CarePlan "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCarePlanRecommendationCategory." type updateCarePlanRecommendationCategoryPayload { care_plan_recommendation_category: CarePlanRecommendationCategory "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization } "Autogenerated return type of updateChangeHealthAccount." type updateChangeHealthAccountPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of updateChargeBack." type updateChargeBackPayload { charge_back: ChargeBack "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateChatSetting." type updateChatSettingPayload { chatSetting: ChatSetting "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateClient." type updateClientPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of updateCms1500." type updateCms1500Payload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cms1500: Cms1500 "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCognitiveStatus." type updateCognitiveStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cognitive_status: CognitiveStatus "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateConversationMembership." type updateConversationMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") conversation_membership: ConversationMembership "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateConversation." type updateConversationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") conversation: Conversation "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCourseGroup." type updateCourseGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseGroup: CourseGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCourseItem." type updateCourseItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseItem: CourseItem "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCourseMembership." type updateCourseMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") courseMembership: CourseMembership "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCourse." type updateCoursePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") course: Course "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCustomEmail." type updateCustomEmailPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customEmail: CustomEmail "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCustomFood." type updateCustomFoodPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customFood: Food "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCustomModuleForm." type updateCustomModuleFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModuleForm: CustomModuleForm "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateCustomModule." type updateCustomModulePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") customModule: CustomModule "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateDocument." type updateDocumentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") document: Document "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateDsiComment." type updateDsiCommentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") dsi_comment: DsiComment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateEntry." type updateEntryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") entry: Entry "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateEpisodeOfCare." type updateEpisodeOfCarePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") episode_of_care: EpisodeOfCare "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateExternalCalendar." type updateExternalCalendarPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") external_calendar: ExternalCalendar "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateFamilyHistory." type updateFamilyHistoryPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") duplicate_family_history_condition: FamilyHistoryCondition family_history_condition: FamilyHistoryCondition "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateFaxAcctInfo." type updateFaxAcctInfoPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of updateFeatureToggle." type updateFeatureTogglePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") feature_toggle: FeatureToggle "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateFitbit." type updateFitbitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") fitbit: Fitbit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateFolder." type updateFolderPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") folder: Folder "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateFormAnswerGroup." type updateFormAnswerGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") form_answer_group: FormAnswerGroup "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateFunctionalStatus." type updateFunctionalStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") functional_status: FunctionalStatus "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateGeneratedFormAnswerGroupFeedback." type updateGeneratedFormAnswerGroupFeedbackPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") generated_form_answer_group: GeneratedFormAnswerGroupType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateGoal." type updateGoalPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") goal: Goal "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateGoogleFit." type updateGoogleFitPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") google_fit: GoogleFit "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateGroupCarePlan." type updateGroupCarePlanPayload { carePlan: CarePlan "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateHealthConcern." type updateHealthConcernPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") health_concern: HealthConcern "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateHuman." type updateHumanPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") human: Human "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateImmunization." type updateImmunizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") immunization: Immunization "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateImplantableDeviceUser." type updateImplantableDeviceUserPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") implantable_device_user: ImplantableDeviceUser "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateInsuranceAuthorization." type updateInsuranceAuthorizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") insuranceAuthorization: InsuranceAuthorizationType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateInsurancePaymentDepositStatus." type updateInsurancePaymentDepositStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The updated insurance payment" insurance_payment: InsurancePayment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateInsurancePlan." type updateInsurancePlanPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") insurance_plan: InsurancePlan "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateLabOrder." type updateLabOrderPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") currentUserNotificationsCount: UserNotificationsCount lab_order: LabOrder "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateLocation." type updateLocationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") location: Location "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateManualInsurancePayment." type updateManualInsurancePaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The updated insurance payment" insurance_payment: InsurancePayment "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateMeal." type updateMealPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") meal: Meal "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateMedication." type updateMedicationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") medication: MedicationType "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateNote." type updateNotePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] note: Note } "Autogenerated return type of updateNoteScheduler." type updateNoteSchedulerPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] noteScheduler: NoteScheduler } "Autogenerated return type of updateNotificationContact." type updateNotificationContactPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] notificationContact: NotificationContact } "Autogenerated return type of updateNotification." type updateNotificationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") currentUser: User "The list of errors occurred during the mutation" messages: [FieldError] notification: Notification } "Autogenerated return type of updateNotificationSetting." type updateNotificationSettingPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] notificationSetting: NotificationSetting } "Autogenerated return type of updateOffering." type updateOfferingPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] offering: Offering } "Autogenerated return type of updateOfficeallySftpAccount." type updateOfficeallySftpAccountPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] officeally_sftp_account: OfficeallySftpAccount } "Autogenerated return type of updateOnboardingFlow." type updateOnboardingFlowPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] onboardingFlow: OnboardingFlow } "Autogenerated return type of updateOnboardingItem." type updateOnboardingItemPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] onboardingItem: OnboardingItem } "Autogenerated return type of updateOrganizationCptCode." type updateOrganizationCptCodePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization_cpt_code: OrganizationCptCodeType } "Autogenerated return type of updateOrganizationMember." type updateOrganizationMemberPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of updateOrganizationMembership." type updateOrganizationMembershipPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organizationMembership: OrganizationMembership } "Autogenerated return type of updateOrganization." type updateOrganizationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization updated_organization_info: OrganizationInfo } "Autogenerated return type of updatePdfLetterheadTemplate." type updatePdfLetterheadTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] organization: Organization pdf_letterhead_template: PdfLetterheadTemplate } "Autogenerated return type of updatePermissionTemplate." type updatePermissionTemplatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] permissionTemplate: PermissionTemplateType } "Autogenerated return type of updatePolicyMutation." type updatePolicyMutationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] policy: Policy } "Autogenerated return type of updateProcedure." type updateProcedurePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] procedure: Procedure } "Autogenerated return type of updateProduct." type updateProductPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] product: Product } "Autogenerated return type of updateProviderCptCodes." type updateProviderCptCodesPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateReceivedDirectMessage." type updateReceivedDirectMessagePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] received_direct_message: ReceivedDirectMessage } "Autogenerated return type of updateReceivedFax." type updateReceivedFaxPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] receivedFax: ReceivedFax } "Autogenerated return type of updateRecommendation." type updateRecommendationPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] recommendation: Recommendation } "Autogenerated return type of updateRecurringForm." type updateRecurringFormPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] recurringForm: RecurringForm } "Autogenerated return type of updateReferral." type updateReferralPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] referral: Referral } "Autogenerated return type of updateReferringPhysician." type updateReferringPhysicianPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] referring_physician: ReferringPhysician } "Autogenerated return type of updateRequestedPayment." type updateRequestedPaymentPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] requested_payment: RequestedPayment } "Autogenerated return type of updateSavedFilter." type updateSavedFilterPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] savedFilter: SavedFilter } "Autogenerated return type of updateSmartPhrase." type updateSmartPhrasePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] smartPhrase: SmartPhrase } "Autogenerated return type of updateSmokingStatus." type updateSmokingStatusPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] smokingStatus: SmokingStatus } "Autogenerated return type of updateState." type updateStatePayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") course: Course "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateStripeCustomerDetail." type updateStripeCustomerDetailPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] stripe_customer_detail: StripeCustomerDetail } "Autogenerated return type of updateStripeVerificationDetails." type updateStripeVerificationDetailsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of updateSubscription." type updateSubscriptionPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") currentUser: User "The list of errors occurred during the mutation" messages: [FieldError] subscription: SubscriptionInstance } "Autogenerated return type of updateSuperBill." type updateSuperBillPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] superBill: SuperBill } "Autogenerated return type of updateTag." type updateTagPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] tag: Tag } "Autogenerated return type of updateTask." type updateTaskPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] task: Task } "Autogenerated return type of updateUniqueDeviceIdentifier." type updateUniqueDeviceIdentifierPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] unique_device_identifier: UniqueDeviceIdentifier } "Autogenerated return type of updateUserAppointmentPricing." type updateUserAppointmentPricingPayload { advance_appointment_prices: [AdvanceAppointmentPrice] "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] } "Autogenerated return type of updateUserGroup." type updateUserGroupPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user_group: UserGroup } "Autogenerated return type of updateUser." type updateUserPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Autogenerated return type of updateWebhook." type updateWebhookPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] webhook: Webhook } "Autogenerated return type of updateWriteOff." type updateWriteOffPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] writeOff: WriteOff } "Autogenerated return type of uploadBatchToCandidHealth." type uploadBatchToCandidHealthPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cms1500s: [Cms1500] "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of uploadBatchToChangeHealth." type uploadBatchToChangeHealthPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cms1500s: [Cms1500] "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of uploadBatchToOfficeally." type uploadBatchToOfficeallyPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cms1500s: [Cms1500] "The list of errors occurred during the mutation" messages: [FieldError] success_string: String } "Autogenerated return type of uploadToIntegrations." type uploadToIntegrationsPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") cms1500s: [Cms1500] "The list of errors occurred during the mutation" messages: [FieldError] success_message: String } "Autogenerated return type of validateVerificationToken." type validateVerificationTokenPayload { "DO NOT USE" clientMutationId: String @deprecated(reason: "DO NOT USE") "The list of errors occurred during the mutation" messages: [FieldError] user: User } "Pagination cursor" scalar Cursor "A valid hex color code (e.g. #FF0000 or #F00 or #FF000000)" scalar HexColor "An ISO 8601-encoded date" scalar ISO8601Date "An ISO 8601-encoded datetime" scalar ISO8601DateTime "An ISO 8601-encoded duration" scalar ISO8601Duration "Represents untyped JSON" scalar JSON "Base class for scalars" scalar UUID scalar Upload "The type-specific detail of an automation step" union AutomationStepDetail = AutomationAction | AutomationConditionGroup | AutomationDelay | AutomationQuery "CustomEmail related_object union" union CustomEmailRelatedObject = AppointmentType | Course | Offering "Structured representation of a FormAnswer's answer" union FormAnswerStructuredAnswer = BMIAnswer | DiagnosisListAnswer | GenderAnswer | LocationAnswer | NumericAnswer | PlainTextAnswer | SexAnswer | SingleSelectAnswer "Union type representing either a Prescription or Medication" union PrescriptionMedication = MedicationType | Prescription "The related record associated with a form answer group audit event, which varies depending on the action that occurred." union RelatedObjectUnion = ChartingNoteAddendumType | FormAnswerGroupSigning "Union type representing either a Document or Folder" union Shareable = Document | Folder