OBJECT
User
An user entry, returns basic user information
link GraphQL Schema definition
- type User {
- # Access Token (for iCal)
- String :
- # The status of whether the user is active or not (if false, patient is archived)
- Boolean :
- # Active care plan for the user
- CarePlan :
- # Active group care plan for the user
- CarePlan :
- # All active patients associated with this user.
- #
- # Arguments
- # course_id: If provided, only returns patients with this course
- ID): [User!]! ( :
- # A collection of tags applied on the specific user
- Tag!] : [
- # Additional links to display within gear menu in patient's header
- CustomSidebarOverride!]! : [
- # additional phone number for user
- String :
- # additional unique record identifier for user
- String :
- # Additional links to display on patient sidebar
- CustomSidebarOverride!]! : [
- # Appointment prices associated with this user
- AdvanceAppointmentPrice!] : [
- # The user's lead dyno affiliate info
- Affiliate :
- # The age of the user (in years)
- String :
- # All Verification fields left for the provider to fill out
- String] : [
- # Allergies, Sensitivities, Intolerances, and Preferences reported by client
- #
- # Arguments
- # category: Only returns allergies with this category
- # is_current: Only return current allergies
- String, : Boolean): [AllergySensitivity!] ( :
- # Allow the user to send messages in community chat
- #
- # Arguments
- # all_patients: Set to true if all sent in users are known to be
- # patients
- Boolean): Boolean ( :
- # Allow the user to send direct messages in chat
- #
- # Arguments
- # all_patients: Set to true if all sent in users are known to be
- # patients
- Boolean): 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.
- #
- # Arguments
- # exclude_dismissed: If true, excludes announcements that patient
- # has dismissed
- Boolean): [Announcement!]! ( :
- # If the user has incomplete onboarding steps
- Boolean :
- # If the user has courses shared with them
- Boolean :
- # If the user has docs shared with them
- Boolean :
- # If the user has courses shared with them
- Boolean :
- # Whether the user has docs shared with them that they have not viewed
- Boolean :
- # AppleHealth for the user
- AppleHealth :
- # Appointment Locations for the user
- AppointmentLocation!] : [
- # Appointment Settings for the user
- AppointmentSetting :
- # All Appointment Type Credits for this user
- #
- # Arguments
- # appointment_type_id: Only returns credits for this appointment
- # type
- ID): [AppointmentTypeCredit!]! ( :
- # All available appointment types for the provider.
- #
- # Arguments
- # appointment_type_ids: Filter types by these ids
- # require_client_bookable: Only return bookable types
- (
- String, :
- Boolean :
- ): [AppointmentType!]!
- # Appointments for the user
- Appointment!] : [
- # If true, user has seen popup explaining how to assign providers and clients to
- # tasks
- Boolean :
- # Tasks assigned by the user to other users
- #
- # Arguments
- # limit: The maximum number of tasks to return
- # show_hidden: If true, return hidden tasks
- Int, : Boolean): [Task!] ( :
- # All available contact types for the provider.
- String :
- # The link to the avatar image (nil if no image has been uploaded)
- String :
- # The status of the user's bank account
- String :
- # If user still has verification steps for stripe, returns deadline timestamp
- String :
- # All Billing Items for this user
- BillingItem!]! : [
- # If a user has seen the message blast alert
- Boolean :
- # Displays bmi percentile for growth charts
- String :
- # Displays standard by which bmi percentile is calculated
- String :
- # The brand that the user made
- #
- # Arguments
- # is_for_editing: If true, return the brand with all fields
- Boolean): Brand ( :
- # The URL of the brand's alternative logo
- String :
- # The URL of the brand logo
- String :
- # The Brand Name Of the User
- String :
- # Broken synced calendar
- ExternalCalendar :
- # HTML String to display on top of the calendar
- String :
- # Calendar timezone
- String :
- # Call references made for a patient's insurances
- CallReference!] : [
- # If true, has Zus credential
- Boolean :
- # Allow the user to add clients
- Boolean :
- # If the provider can add members
- Boolean :
- # If true this user to archive clients
- Boolean :
- # Allow this user to charge clients
- Boolean :
- # If true, the user can delete charting notes
- Boolean :
- # If true this user to delete faxes
- Boolean :
- # If true, the user to edit Appointment Types
- Boolean :
- # If true, the user can edit brand
- Boolean :
- # If true, the user can edit client credit
- Boolean :
- # If true, the user can edit org documents
- Boolean :
- # If the provider can edit forms
- Boolean :
- # If the provider can edit members
- Boolean :
- # If true, the user to edit org calendar
- Boolean :
- # If true, the user can edit packages
- Boolean :
- # If true, the user can add, edit and delete products
- Boolean :
- # If true, the user can add or remove clients within programs
- Boolean :
- # If true, the user can edit programs
- Boolean :
- # Allow the user to edit account settings
- Boolean :
- # If the provider organization can have suborgs
- Boolean :
- # If the user can add suborgs
- Boolean :
- # If true, the user can lock other providers charting notes
- Boolean :
- # If true, the user can lock their own charting notes
- Boolean :
- # If the provider can mark tasks that are assigned to other org members as
- # completed
- Boolean :
- # If true, the user can merge clients
- Boolean :
- # If true, can order new lab using labs widget
- Boolean :
- # Allow this user to schedule appointments (Linked accounts)
- Boolean :
- # If true, user can see products tab in client profile and see fullscript box on
- # homepage if not linked to fullscript
- Boolean :
- # Show insurance info for a client
- Boolean :
- # If true, can view transfer tab in billing page
- Boolean :
- # If true, the user can sign other providers charting notes
- Boolean :
- # If true, the user can sign their own charting notes
- Boolean :
- # If true, can access to labs widget
- Boolean :
- # If True, the user will be able to add addendums for an other org member locked
- # form answer groups
- Boolean :
- # If true, the user cannot access org settings
- Boolean :
- # If True, the user will not be able to 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
- Int :
- # Hash for Chameleon
- String :
- # When true, user will be able to check insurance eligibility via Change
- # Healthcare
- Boolean :
- # Clearstep Connection for the user. If the Shapa integration is enabled, then the
- # Clearstep integration should automatically appear as enabled
- ShapaConnection :
- # Info about how a user was acquired
- ClientSource :
- # Completed Tasks assigned to the user
- #
- # Arguments
- # limit: The maximum number of tasks to return
- # show_hidden: If true, return hidden tasks
- Int, : Boolean): [Task!] ( :
- # Whether the user has accepted the lab order waiver
- Boolean :
- # course membership scoped by specific course
- CourseMembership :
- # All course memberships for this user
- CourseMembership!] : [
- # All course memberships for this user
- CourseMembership!]! @deprecated( reason: "This field has a typo. use User.course_memberships instead" ) : [
- # The date this user created an account
- String :
- # The credit balance of the user
- String :
- # All custom custom emails associated with this user.
- CustomEmail!] : [
- # Custom Metric of the user
- CustomMetric!]! : [
- # The default currency for the user
- String :
- # Default external videochat URL for scheduling with this user
- String :
- # The id of the users default onboarding flow
- OnboardingFlow :
- # The id of the users default onboarding flow
- String :
- # Patient's default pharmacy. Only applicable to dosespot users
- Pharmacy :
- # Default stripe payment card
- ID :
- # Check that user has no video or audio devices (or both)
- Boolean :
- # Dexcom Connection for the user
- DexcomConnection :
- # diagnoses for the user
- Diagnosis!] : [
- # Dietitian of this user
- User :
- # The Dietitian ID of the Client
- String :
- # Dismisses a small advertisement about the ability to sync calendars
- Boolean :
- # Dismisses a notice warn about charting note addendum
- Boolean :
- # If true, do not show fullscript box in provider homepage
- Boolean :
- # Dismisses the warning while locking a charting note should not be shown
- Boolean :
- # If true, do not show fullscript box in provider homepage
- Boolean :
- # The Brand that controls the look of the website for the user
- Brand :
- # date of birth of user
- String :
- # An ID used for document, course, and conversation sharing
- String :
- # Number of notifications from Dosespot (e-prescriptions)
- Int :
- # The email of this user
- String :
- # Amount of money waiting to be paid out, as a float
- Float :
- # Patient cards that have expired (requires can_see_billing for org level
- # patients)
- Int :
- # Patient cards that will expire by next recurring payment (requires
- # can_see_billing for org level patients)
- Int :
- # Fax line request data
- FaxLineRequest :
- # Fax number belonging to the user
- String :
- # Feature Toggle of the user
- FeatureToggle :
- # Date of the first client entry
- String :
- # The first name of this user
- String :
- # The first name and last initial of the user
- String :
- # Fitbit for the user
- Fitbit :
- # The number of food entries the user has
- String :
- # All filled out forms for this user
- FormAnswerGroup!] : [
- # Formatted string of money waiting to be paid out, including currency symbol
- String :
- # The full legal name of this user
- String :
- # The full legal name of this user with preferred name in parentheticals
- # i.e(Jonathan (Wizkid) Jones)
- String :
- # The full name of the user
- String :
- # Fullscript for the user
- fullscript :
- # Practitioner id for the user's Fullscript account
- String :
- # gender of user
- String :
- # Gender identity of user (typically nil unless gender field is 'Other')
- String :
- # User gender identity code
- String :
- # id of generated reports folder
- String :
- # The Number of goals the user has
- String :
- # The Google Calendar Account for this user
- ExternalCalendar :
- # Google Fit for the user
- GoogleFit :
- # The name of the patients user group
- String :
- # When true, the user can see client portal setting in notification contact form
- Boolean :
- # When true, the user can see insurance billing automation features
- Boolean :
- # When true, the user can see the zus megazap component
- Boolean :
- # If true, the user's account can take ACH payments
- Boolean :
- # If true, user has at least one entry type to track
- Boolean :
- # If the user's organization has API access
- Boolean :
- # If true, the user has access to download the mobile app
- Boolean :
- # If true, the user has bookable appts
- Boolean :
- # If true, the user has bookable packages
- Boolean :
- # True if the user has change health connection
- Boolean :
- # If true, the user has complted their intake forms
- Boolean :
- # If courses exist for an organization or provider
- Boolean :
- # If true, the user has created a password
- Boolean :
- # Allow the user to change the color of their calendar
- Boolean :
- # Check if user has any custom food item
- Boolean :
- # Check if user has any created meals
- Boolean :
- # When true, the user can set scheduling priority levels for providers
- Boolean :
- # When true, the user can have custom text for SMS reminders for specific
- # appointment types
- Boolean :
- # If the user is marked as a developer and can modify webhooks and api keys.
- Boolean :
- # If true, user is a provider with a dosespot account linked
- Boolean :
- # True if the user can add external videochat URLs
- Boolean :
- # If true, the user has connected their Fullscript account to Healthie
- Boolean :
- # If true, the user have available appointment slots in future
- #
- # Arguments
- # offering_ids: When passed in, will always make
- # has_future_availabilities return true if the offerings do not have bookable
- # appointment types
- ID]): Boolean ( : [
- # True if the user has access to goal title links
- Boolean :
- # Can the user receive inbound faxes?
- Boolean :
- # Allow this user to access increased branding
- Boolean :
- # If true, patient's most recent demographic information(phone, dob, location,
- # gender, name) could not be updated in dosespot because information is invalid
- Boolean :
- # True if the user has any lab orders
- Boolean :
- # Whether users has a lab order from lab_testing_api
- Boolean :
- # If true, user is a provider with a living plate linked
- Boolean :
- # When true, the user can have a custom email sent out when an appointment is
- # marked as no-show
- Boolean :
- # When true, the user can have a custom email sent out when an appointment is
- # marked as rescheduled
- Boolean :
- # True if user is able to see conversations of all organization members
- Boolean :
- # Check to see if the user has any other active org members
- Boolean :
- # When true, the user has their own appointment setting
- Boolean :
- # When true, the user has their own custom emails
- Boolean :
- # When true, the provider can control settings around allow rescheduling past
- # appointments.
- Boolean :
- # True if the user has PP features
- Boolean :
- # Has had payment in the last 30 days
- Boolean :
- # True if the user has rupa connection
- Boolean :
- # If true, user has shared appointment settings with at least one memember in org
- Boolean :
- # If the provider controls settings around enforcing state licensing restrictions
- # for appointments
- Boolean :
- # If true, suborganization owner has stripe account from the parent organization
- # owner
- Boolean :
- # Whether the user has a synced calendar
- Boolean :
- # When true, the user can set appointment settings for specific appointment types
- Boolean :
- # Check to see if the user has any user groups
- Boolean :
- # Check to see if the user can switch to another user
- Boolean :
- # True if the user is allowed to use Zoom
- Boolean :
- # Heads Up Health SSO link for user; always returns nil if Heads Up Health add-on
- # is not enabled
- String :
- # height of user
- Float :
- # Displays height percentile for growth charts
- String :
- # Displays standard by which height percentile is calculated
- String :
- # String of height including units
- String :
- # Hash for Help Scout
- String :
- # ID of the human
- ID :
- # The unique identifier of the user
- ID! :
- # A collection of immunizations for this client
- Immunization!] : [
- # True if User organization with multiple providers
- Boolean :
- # If a user is in an org
- #
- # Arguments
- # known_to_be_in_org: Some times we already know the user is an
- # an org when we run the query, so we can just return true
- Boolean): Boolean ( :
- # Incomplete Tasks assigned to the user
- #
- # Arguments
- # limit: The maximum number of tasks to return
- # show_hidden: If true, return hidden tasks
- Int, : Boolean): [Task!] ( :
- # Insurance Authorization for this user
- InsuranceAuthorizationType :
- # Hash for intercom
- String :
- # The invite code for the provider
- String :
- # Get filter string for user invoices
- String :
- # Check if the user is an active provider in an organization
- Boolean :
- # True if chat autoresponding is active
- Boolean :
- # boolean for if the user has ever logged in to Healthie as a provider
- Boolean :
- # If true, the user is in an organization
- Boolean :
- # True if the user an organization admin
- Boolean :
- # If true, the user is in an organization with more than one user
- Boolean :
- # the status of whether the user is the owner of their org or not
- Boolean :
- # the status of whether the user is a patient or not
- #
- # Arguments
- # already_known_value: If true, we already know the value and can
- # skip the query
- Boolean): Boolean ( :
- # Whether a user is a super admin
- Boolean :
- # Whether the user is trialing
- String :
- # If the user aware they switched providers on specific login (can only do for
- # current user)
- Boolean :
- # The client-side Kustomer API Key. (Only applies to specific custom whitelabels)
- String :
- # last date user was active through web or mobile
- String :
- # last date the user was active
- String :
- # String of the last date the user was active
- String :
- # The User's last active appointment object
- Appointment :
- # the last payment made by client
- BillingItem :
- # id of last conversation
- String :
- # The last name of this user
- String :
- # last date the user signed in
- String :
- # Last time allergy/sensitivity was updated
- #
- # Arguments
- # category: Category of allergy/sensitivity
- String): AllergySensitivity ( :
- # The last weighing date of the user
- String :
- # Link to most recent roadmap article on helpscout
- String :
- # Last product roadmap article number
- Int :
- # The legal first name of this user
- String :
- # license number of user
- String :
- # Graphs to show in line graph form
- String] : [
- # A collections of users who are in relationship with this client
- NotificationContact!] : [
- # Link automatically signs user into Living plate dashboard without entering login
- # credentials
- String :
- # The address of this user
- Location :
- # All available locations for the client.
- Location!] : [
- # Fetch count of medications for a given patient
- #
- # Arguments
- # active: If true, only return active medications
- # patient_id: The patient ID to fetch medications for
- Boolean, : ID): Int ( :
- # a serialized JSON string of metadata
- String :
- # The number of metric entries the user has
- String :
- # The number of mirror entries the user has
- String :
- # The amount of money the user owes
- String :
- # The full name of the user
- String :
- # The User's next upcoming active appointment object
- Appointment :
- # The User's next upcoming active appointment date (method)
- String @deprecated( reason: "use next_appt_date instead" ) :
- # The Users next upcoming active appointment date (field)
- String :
- # The next onboarding item that the user has to fill
- OnboardingItem :
- # Recurring payment with next upcoming payment date
- RecurringPayment :
- # The next step preventing the user from moving forward. nil if user has completed
- # all steps
- String :
- # notification contacts for the user
- NotificationContact!] : [
- # Notification Settings for the user
- NotificationSetting :
- # NPI of the user
- String :
- # Number of entries for the client
- String :
- # All offering_coupons associated with this provider.
- OfferingCoupon!] : [
- # All available offerings for the provider.
- Offering!]! : [
- # User onc gender identity
- String :
- # The number open payments for the user
- Int :
- # The user of the organization token
- Organization :
- # The organization membership of the user
- OrganizationMembership :
- # Single Other ID number for the user
- #
- # Arguments
- # cms1500_id: CMS1500 ID
- # id: The ID to filter by
- # is_last_cms1500: If true, only return the last CMS1500 ID
- ID, : ID, : Boolean): OtherIdNumber ( :
- # All other id numbers for this user
- OtherIdNumber!] : [
- # Other organization members.
- #
- # Arguments
- # only_active: If true, only return active users
- Boolean): [User!]! ( :
- # The IDs of other care team members for the client
- ID] : [
- # The Outlook Calendar Account for this user
- ExternalCalendar :
- # Status paid for fax
- String :
- # boolean for If a user is a part of the journify organization
- Boolean :
- # All patients associated with this user.
- #
- # Arguments
- # client_ids: The client IDs to filter by
- # only_active: If true, only return active users
- ID], : Boolean): [User!]! ( : [
- # The number of patients belonging to the user
- Int :
- # the number of notifications belonging to a patient
- #
- # Arguments
- # excluded_types: The types of notifications to exclude
- String): Int ( :
- # All patients with a credit card on file associated with this user.
- User!]! : [
- # When true, the user will never be prompted to change their timezone
- Boolean :
- # The phone number of the user
- String :
- # Place of service for this user
- PlaceOfService :
- # All policies associated with this user
- Policy!] : [
- # All policies associated with this user
- Policy!] : [
- # Preferred language based on language code
- String :
- # User preferred language code
- String :
- # Fetch count of prescriptions for a given patient pulled from Dosespot
- #
- # Arguments
- # patient_id: The patient ID to fetch prescriptions for
- # status: The status of the prescriptions to fetch
- ID, : String): Int ( :
- # Displays administrator account as other user account
- String :
- # The primary ethnicity value based on ethnicity code
- String :
- # User primary ethnicity code
- String :
- # User primary race
- String :
- # User primary race code
- String :
- # Professions of the user
- Profession!] : [
- # Pronouns that the client identifies with
- String :
- # Provider appointment locations
- ProviderAppointmentLocation!] : [
- # All providers associated with the client
- #
- # Arguments
- # can_be_scheduled_with: If true, only return providers that can
- # be scheduled
- Boolean): [User!] ( :
- # Meal Plans from Living Plate
- MealPlan!] : [
- # qualifications of the user
- String :
- # quicks notes for a given user
- String :
- # All reactivation custom emails associated with this user.
- CustomEmail!] : [
- # unique record identifier for user
- String :
- # referrals for the user
- Referral!] : [
- # An array of referring physicians associated to all referrals associated with a
- # client
- ReferringPhysician!] : [
- # NPI of the referring provider
- String :
- # Name of the referring provider
- String :
- # NPI of the referring provider
- String :
- # The date range filter selections for each report
- ReportsDateFilterSelection :
- # The number of forms that have been requested for the user
- Int :
- # If true, the user is a patient with required fields to create dosespot patient.
- # If false, then either the provider doesn't have a linked dosespot account, or
- # the patient has all required fields.
- String :
- # User subscription has been inactive and needs to be reactivated before allowing
- # acccess
- Boolean :
- # User subscription has been inactive for 91+ days and should receive 7 day trial
- # upon reactivation
- Boolean :
- # Patient ID on the rupa health
- String :
- # Providers with higher priority will be chosen first when availability is
- # generated for self-scheduling. Defaults to 0
- String :
- # The secondary ethnicity value based on ethnicity code
- String :
- # User secondary ethnicity code
- String :
- # User secondary race
- String :
- # User secondary race code
- String :
- # True if user is up to date with all product roadmap articles
- 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
- String :
- # Sex of the user (Stated on ID card for insurance purposes)
- String :
- # Sexual orientation of the user
- String :
- # The sexual orientation code of the user, corresponds to sexual orientation
- String :
- # Shapa Connection for the user
- ShapaConnection :
- # An ID that includes the shard the user is on. Matches ID unless user is on a
- # custom shard
- ID! :
- # Show appointments tab on the sidebar
- Boolean :
- # Show "Billing Dropdown" on patient sidebar
- Boolean :
- # Show billing tab on the sidebar
- Boolean :
- # Show brand link in the header
- Boolean :
- # Allow this user to view care plan (Linked accounts)
- Boolean :
- # Show chat tab on the sidebar
- Boolean :
- # If to show the client credits in the UI
- Boolean :
- # Show Cms1500s tab on the sidebar
- Boolean :
- # Show the option to view the dashboard
- Boolean :
- # Show documents tab on the sidebar
- Boolean :
- # Show education tab on the sidebar
- Boolean :
- # Display DOB next to the name of the client
- Boolean :
- # Show forms tab on the sidebar
- Boolean :
- # Allow this user to view goals (Linked accounts)
- Boolean :
- # If true, user will be able to view Grow settings page
- Boolean :
- # Show "Integrations" option in gear menu
- Boolean :
- # Allow this user to view journal entries (Linked accounts)
- Boolean :
- # Show the organization tab on sidebar
- Boolean :
- # Show packages tab on the sidebar
- Boolean :
- # Show "Update Payment Methods" option in gear menu
- Boolean :
- # Show payments tab on the sidebar
- Boolean :
- # Show received fax tab on the sidebar
- Boolean :
- # Show scheduled tab on the chat page
- Boolean :
- # Show sent fax tab on the sidebar
- Boolean :
- # Show subscription link in the settings dropdown
- Boolean :
- # If a user has seen the message blast alert
- Boolean :
- # Show Superbill tab on the sidebar
- Boolean :
- # The total number of sidebar notifications to be displayed for the user
- Int :
- # True if the user skipped adding a bank account
- Boolean :
- # The status of whether the user has a real email or not
- Boolean :
- # Specialties of the user
- Specialty!] : [
- # The SSN of the user
- String :
- # Returns a user state licenses
- StateLicense!] : [
- # Stripe Info of the client
- StripeCustomerDetail :
- # Stripe credit cards of the client
- StripeCustomerDetail!] : [
- # The stripe id of the user (Used to look up bank account details for provider)
- String :
- # ID of account representative in Stripe
- String :
- # Returns the subscription for this user
- SubscriptionInstance :
- # Address to use on super bills
- String :
- # Providers location to use on super bills
- Location :
- # Patient location to use on super bills
- Location :
- # Provider's phone number to use on super bills
- String :
- # Other users this account can switch to
- User!] : [
- # Number of other users this account can switch to
- Int :
- # Number of tasks
- #
- # Arguments
- # only_created_by_others: If true, only count tasks created by
- # others
- # show_hidden: If true, count hidden tasks
- # type: Type of task to count
- (
- Boolean, :
- Boolean, :
- String :
- ): Int
- # tax id of user
- String :
- # The user's timezone
- String :
- # Access token
- String :
- # Total active packages credits
- Int :
- # Total clients with appointment credits greater than 0
- Int :
- # Total count of the user lab orders objects
- Int :
- # The authenticated human if an account is masked
- String :
- # The number unconfirmed appointments for the user
- #
- # Arguments
- # unconfirmed_by_clients: If true, include appointments
- # unconfirmed by clients
- (
- Boolean :
- ): Int
- # The number of unseen conversations for the user
- Int :
- # The number of unscheduled lab orders
- Int :
- # The number of unseen appointment notfications
- Int :
- # The number of unseen comment notfications
- Int :
- # The number of unseen document notfications
- Int :
- # The number of unseen entry notfications
- Int :
- # The number of unseen goal notfications
- Int :
- # The number of unseen note notfications
- Int :
- # The number of unseen notifications for the user (mobile only)
- Int @deprecated( reason: "use unseen_notifications_count_mobile" ) :
- # The number of unseen notifications for the user (web only)
- Int :
- # The number of unseen notifications for the user (this field only used by mobile)
- # [identical to :unseen_notification_count]
- Int :
- # The number of unseen payment notfications
- Int :
- # Number of unseen bounced notification records
- Int :
- # All active upcoming appointments of the user
- Appointment!] : [
- # All active upcoming payments of the user
- RecurringPayment!] : [
- # Date user was last updated
- String :
- # File name of uploaded avatar image
- String :
- # User Group of this user
- UserGroup :
- # The ID of the patient's user group
- String :
- # All user groups associated with this provider.
- #
- # Arguments
- # course_id: If provided, only return user groups associated with
- # this course
- ID): [UserGroup!]! ( :
- # User of who sent this member an invite
- User :
- # Verification fields left for the provider to fill out
- String] : [
- # The last weight of the user
- String :
- # Displays weight percentile for growth charts
- String :
- # Displays standard by which weight percentile is calculated
- String :
- # Withings Connection for the user
- WithingsConnection :
- # The number of workout entries the user has
- String :
- # If user has Zus, returns Zus proxy token
- String :
- }
link Require by
- AllergySensitivityAn allergy/sensitivity/preference for a client
- AnnouncementAnnouncements created by providers for client consumption
- AppliedTagA tag applied to a user
- AppointmentAn appointment object containing information about the appointment, including the attendees, date, location, and more.
- AppointmentCreditChangeAn object containing appointment type credit change event
- AppointmentInclusionTypeProvider/Client to Appointment connection
- AppointmentSettingAppointment Setting options that a provider can customize
- AvailabilityAn object containing availability ranges for a provider
- BillingItemBilling
- BrandBrand options that a client can customize
- bulkUpdateClientsPayloadAutogenerated return type of bulkUpdateClients.
- bulkUpdateNotificationsPayloadAutogenerated return type of bulkUpdateNotifications.
- CampaignMarketing campaign (email/sms) sent to clients by provider
- CarePlanA Care Plan
- ChartingNoteAddendumTypeA charting note addendum
- Cms1500A CMS1500 claim
- CommentA comment of an entry
- CompletedOnboardingItemAn object with information about how an onboarding item was completed
- ConversationAn association between conversation holders
- ConversationMembershipConversationMembership entry, returns basic info related to conversation participant
- CourseA Course
- CourseMembershipRelationship between a user and a course
- CreateChangeHealthPatientPayloadAutogenerated return type of CreateChangeHealthPatient.
- createClientPayloadAutogenerated return type of createClient.
- createDocumentPayloadAutogenerated return type of createDocument.
- CustomModuleFormA template for a form, that can then be filled out
- DiagnosisA diagnosis
- DocumentA document file that contains an attachment and information about the attachment
- DocumentViewingInformation about a document being opened
- EntryA post about a client, with different category options
- FeatureToggleAn object containing details about what the client can and can't do
- FolderA folder that contains documents and other folders
- FormAnswerGroupA completed form, with metadata about the completion, and the saved answers
- FormAnswerGroupSigningAn instance representing connection between a charting note(form_answer_group) and a user signing the note
- FormAnswerGroupUserConnectionAn instance representing connection between a group charting note(form_answer_group.appointment.is_group == true) and a user
- generateChartingPdfPayloadAutogenerated return type of generateChartingPdf.
- Goala goal
- GoalHistorya goal history
- GoalTemplatea goal template
- HumanHuman object controls authentication for users
- IndividualClientTypeAn object containing an individual note for certain patient associated with group charting note
- InsurancePlanAn Insurance Plan
- LabFiltersDataTypeOptions for lab filters
- LabOrderLab Order Object
- LabResultLab Result
- LocationA location
- mergeClientsPayloadAutogenerated return type of mergeClients.
- NoteChat message object
- NoteSchedulerScheduled chat notes
- NotificationA notification
- NotificationContactA notification contact
- NotificationSettingAn object containing the users preferences on notification
- OfferingOffering (or Package)
- OfferingCouponOffering Coupon
- OnboardingFlowAn onboarding flow that is comprised of onboarding items
- OnboardingItemAn onboarding item that has something for the client to complete
- OrganizationAn organization, that is an umbrella group for multiple providers
- OrganizationMembershipAn organization membership
- OtherIdNumberAlternative ID numbers for a provider
- PermissionTemplateTypeAn permission templateType
- PolicyA policy
- ProductThe product
- QueryThe query root of this schema. See available queries.
- RecurringFormA Recurring Form
- RecurringPaymentRecurring Payment
- ReferralA referral
- RequestedFormCompletionA request, from a provider to a client, to fill out a form
- RequestedPaymentA request, from a provider to a client, to make a payment
- ScheduledUserPackageSelectionBilling items that are scheduled and will have a user package selection associated with them
- SentFaxA Sent Fax
- signInPayloadAutogenerated return type of signIn.
- signUpPayloadAutogenerated return type of signUp.
- SmartPhraseA smart phrase object
- StripeCustomerDetailDetails of the client's credit card
- SubscriptionInstancea subscription object
- SuperBillSuperBill
- TagA custom tag that can be applied on a user
- TaskTasks for providers to create, complete, and optionally assign to client profiles
- updateClientPayloadAutogenerated return type of updateClient.
- updateNotificationPayloadAutogenerated return type of updateNotification.
- updateOrganizationMemberPayloadAutogenerated return type of updateOrganizationMember.
- updateStripeVerificationDetailsPayloadAutogenerated return type of updateStripeVerificationDetails.
- updateSubscriptionPayloadAutogenerated return type of updateSubscription.
- updateUserPayloadAutogenerated return type of updateUser.
- UserAn user entry, returns basic user information
- UserGroupA user group, returns basic info about the user group
- UserPackageSelectionA user package selection
- validateVerificationTokenPayloadAutogenerated return type of validateVerificationToken.
- VideoChatVideo chat info for subscriptions