OBJECT
Query
The query root of this schema. See available queries.
link GraphQL Schema definition
- type Query {
- # Fetch advance appointment prices
- #
- # Arguments
- # appointment_type_id: [Not documented]
- # user_id: [Not documented]
- (
- ID, :
- ID :
- ): [AdvanceAppointmentPrice!]
- # Search results for allergies, allergens, and reactions
- #
- # Arguments
- # category: accepts drug, environmental, food, pet, and reaction
- String): [String] ( :
- # Fetch an announcement
- #
- # Arguments
- # id: [Not documented]
- ID): Announcement ( :
- # Fetch an array of announcements for a provider
- #
- # Arguments
- # after: Cursor to fetch results after
- # exclude_dismissed: If true, only show announcements that client
- # has not dismissed
- # keywords: Search announcements by name, title and description
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # page_size: [Not documented]
- (
- Cursor, :
- Boolean, :
- String, :
- Int, :
- Boolean, :
- Int :
- ): [Announcement!]
- # Number of announcements for a provider
- #
- # Arguments
- # exclude_dismissed: If true, only show announcements that client
- # has not dismissed
- # keywords: Search announcements by name, title and description
- (
- Boolean, :
- String :
- ): Int
- # Fetch paginated API Keys collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # keywords: [Not documented]
- # offset: [Not documented]
- # page_size: [Not documented]
- # order_by: [Not documented]
- (
- Cursor, :
- String, :
- Int, :
- Int, :
- ApiKeyOrderKeys :
- ): [ApiKey!]
- # Number of API Keys
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # An applied tag to a user
- #
- # Arguments
- # id: [Not documented]
- ID): AppliedTag ( :
- # Applied tags to a users
- #
- # Arguments
- # id: [Not documented]
- # tag_id: The tag ID
- ID, : ID): [AppliedTag!] ( :
- # fetch an appointment by id, group appointments are (considered public)
- #
- # Arguments
- # id: [Not documented]
- # include_deleted: When true, deleted appointments can be
- # retrieved via this query.
- ID, : Boolean): Appointment ( :
- # Return potential booking issues for an appointment, date, time, repeats,
- # attendees, and provider.
- #
- # Arguments
- # appointment_type_id: [Not documented]
- # attendee_ids: [Not documented]
- # date: [Not documented]
- # is_repeating: [Not documented]
- # provider_id: [Not documented]
- # repeat_interval: [Not documented]
- # repeat_times: [Not documented]
- # recurring_appt_id: [Not documented]
- # time: [Not documented]
- (
- ID, :
- ID], : [
- String, :
- Boolean, :
- ID, :
- String, :
- String, :
- String, :
- String :
- ): [AppointmentBookingWarning!]
- # returns metadata about appointments for provider dashboard
- #
- # Arguments
- # only_to_current_date: [Not documented]
- # org_level: [Not documented]
- (
- Boolean, :
- Boolean :
- ): [AppointmentDataType!]
- # fetch an appointment by id, group appointments are (considered public)
- #
- # Arguments
- # id: [Not documented]
- # uuid: When external reschedule/cancellation is allowed, the
- # UUID can be used to allow the holder to retrieve and update/cancel their
- # inclusion in an appointment.
- ID, : ID): AppointmentInclusionType ( :
- # fetch an appointment location by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): AppointmentLocation ( :
- # get appointment locations that the current user can use. (considered public)
- #
- # Arguments
- # appointment_date: Pass in datetime of the appointment to limit
- # the locations based on room availability
- # appointment_type_id: Pass in id of the appointment type to
- # limit the locations based on room availability
- # ids: [Not documented]
- # keywords: [Not documented]
- # location_ids: [Not documented]
- # org_level: [Not documented]
- # provider_id: [Not documented]
- # provider_ids: [Not documented]
- # resource: [Not documented]
- (
- String, :
- ID, :
- Int], : [
- String, :
- String, :
- Boolean, :
- ID, :
- ID], : [
- String :
- ): [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.
- #
- # Arguments
- # date: [Not documented]
- # include_blockers: [Not documented]
- (
- String, :
- Boolean :
- ): String
- # fetch a Appointment Setting by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- # provider_id: [Not documented]
- ID, : ID): AppointmentSetting ( :
- # fetch an appointment type by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): AppointmentType ( :
- # Fetch credit history for the specific appointment type
- #
- # Arguments
- # appointment_type_id: [Not documented]
- # user_id: [Not documented]
- (
- ID, :
- ID :
- ): [AppointmentCreditChange!]
- # Fetch paginated Appointment Type collection (considered public)
- #
- # Arguments
- # after: Cursor to fetch results after
- # appointment_type_ids: JSONified array of ids to include
- # clients_can_book: [Not documented]
- # embed_or_sharing_link: [Not documented]
- # keywords: [Not documented]
- # offering_id: [Not documented]
- # offset: [Not documented]
- # org_level: [Not documented]
- # page_size: [Not documented]
- # provider_id: [Not documented]
- # should_paginate: [Not documented]
- # show_group: [Not documented]
- # with_deleted_appt_types: [Not documented]
- # order_by: [Not documented]
- (
- Cursor, :
- String, :
- Boolean, :
- Boolean, :
- String, :
- String, :
- Int, :
- Boolean, :
- Int, :
- String, :
- Boolean, :
- Boolean, :
- Boolean, :
- AppointmentTypeOrderKeys :
- ): [AppointmentType!]
- # Number of appointment types (considered public)
- #
- # Arguments
- # appointment_type_ids: JSONified array of ids to include
- # clients_can_book: [Not documented]
- # embed_or_sharing_link: [Not documented]
- # keywords: [Not documented]
- # offering_id: [Not documented]
- # org_level: [Not documented]
- # provider_id: [Not documented]
- # show_group: [Not documented]
- # with_deleted_appt_types: [Not documented]
- (
- String, :
- Boolean, :
- Boolean, :
- String, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- Boolean :
- ): Int
- # Fetch paginated appointment collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # colorSchemeId: [Not documented]
- # currentWeek: [Not documented]
- # endDate: [Not documented]
- # exclude_appointments_with_invoice: when true, all appointments
- # with invoices will be excluded
- # filter: Options are 'future', 'past', 'ended', 'didnt-occur'
- # filter_by_appointment_location_ids: Returns appointments of the
- # specified appointment locations. Overrides filter_by_location_id
- # filter_by_appointment_status: [Not documented]
- # filter_by_appointment_type_id: [Not
- # documented]
- # filter_by_appointment_type_ids: Returns appointments of the
- # specified appointment Overrides filter_by_appointment_type_id
- # filter_by_chart_note_written: When true, only appointments
- # without an associated chart note will be returned. When false, only appointments
- # with an associated chart note will be return. If nil, has no effect
- # filter_by_client_confirmed: [Not documented]
- # filter_by_location_id: [Not documented]
- # filter_by_provider_confirmed: [Not documented]
- # filter_synced_appointments: When true, no pulled-in synced
- # appointments will be included
- # filter_by_invoices: When true, only appointments up to the next
- # future scheduled appointment will be included
- # include_blockers: [Not documented]
- # include_nil_blockers: When true, returns blocking appointments
- # with no appointment type/location/status
- # include_suborganizations: include all providers in the
- # organization and sub-organizations
- # is_active: [Not documented]
- # is_confirmed: [Not documented]
- # is_org: When true, returns appointments for all providers in
- # the org
- # is_upcoming: [Not documented]
- # is_with_clients: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # page_size: The number of appointments to return at one time
- # (when should_paginate is true). Maximum of 500
- # provider_id: [Not documented]
- # provider_ids: [Not documented]
- # should_paginate: [Not documented]
- # show_appointments: [Not documented]
- # order_by: [Not documented]
- # specificDay: [Not documented]
- # startDate: [Not documented]
- # unconfirmed: [Not documented]
- # user_id: [Not documented]
- # with_all_statuses: [Not documented]
- # with_others: [Not documented]
- # without_status: [Not documented]
- # attendee_ids: Returns appointments for the specified
- # attendee_ids
- (
- Cursor, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- String, :
- ID], : [
- String, :
- ID, :
- ID], : [
- Boolean, :
- Boolean, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- String, :
- Int, :
- Int, :
- ID, :
- ID], : [
- Boolean, :
- Boolean, :
- AppointmentOrderKeys, :
- String, :
- String, :
- Boolean, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- ID] : [
- ): [Appointment!]
- # Number of Appointments
- #
- # Arguments
- # currentWeek: [Not documented]
- # endDate: [Not documented]
- # exclude_appointments_with_invoice: when true, all appointments
- # with invoices will be excluded
- # filter: [Not documented]
- # filter_by_appointment_location_ids: Returns appointments of the
- # specified appointment locations. Overrides filter_by_location_id
- # filter_by_appointment_status: [Not documented]
- # filter_by_appointment_type_id: [Not
- # documented]
- # filter_by_appointment_type_ids: Returns appointments of the
- # specified appointment Overrides filter_by_appointment_type_id
- # filter_by_chart_note_written: When true, only appointments with
- # an associated chart note will be returned. When false, only appointments without
- # an associated chart note will be return. If nil, has no effect
- # filter_by_location_id: [Not documented]
- # filter_synced_appointments: When true, no pulled-in synced
- # appointments will be included
- # filter_by_invoices: When true, only appointments up to the next
- # future scheduled appointment will be included
- # include_blockers: [Not documented]
- # include_nil_blockers: When true, returns blocking appointments
- # with no appointment type/location/status
- # include_suborganizations: include all providers in the
- # organization and sub-organizations
- # is_active: [Not documented]
- # is_confirmed: [Not documented]
- # is_org: [Not documented]
- # is_upcoming: [Not documented]
- # is_with_clients: [Not documented]
- # keywords: [Not documented]
- # provider_id: [Not documented]
- # provider_ids: This will filter the appointments by the array of
- # provider_ids used here. NOTE: must have is_org set to true for this to argument
- # to be respected.
- # show_appointments: [Not documented]
- # specificDay: [Not documented]
- # startDate: [Not documented]
- # unconfirmed: [Not documented]
- # user_id: [Not documented]
- # with_all_statuses: [Not documented]
- # with_others: [Not documented]
- # without_status: [Not documented]
- # only_healthie_appointments: When true, returns only healthie
- # appointments and excluding external appointments
- (
- Boolean, :
- String, :
- Boolean, :
- String, :
- ID], : [
- String, :
- ID, :
- ID], : [
- Boolean, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- String, :
- ID, :
- ID], : [
- Boolean, :
- String, :
- String, :
- Boolean, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean :
- ): Int
- # Data summary for appointment reports
- #
- # Arguments
- # provider_ids: [Not documented]
- # range_end: [Not documented]
- # range_start: [Not documented]
- # range_type: [Not documented]
- # require_cache_threshold: When provided, the query will require
- # data to be loaded from cache if the appointment count is over the provided
- # number. If data is not in the cache, it will return without data, and load the
- # data in the cache in the background.
- (
- ID], : [
- String, :
- String, :
- String, :
- Int :
- ): AppointmentSummaryData
- # fetch auto task generators belonging to a specific user
- #
- # Arguments
- # user_id: [Not documented]
- String): [AutoTaskGenerator!] ( :
- # Fetch availabilities for range
- #
- # Arguments
- # appointment_location_id: [Not documented]
- # appointment_type_id: [Not documented]
- # availability_provider_id: ID of the provider to show
- # availabilities for, supercedes provider id and is_org
- # contact_type_id: [Not documented]
- # endDate: the end date of availability (datetime string)
- # end_date_padding: Amount of hours after the endDate to pull
- # availabilities in for. This is helpful when using this query with some calendar
- # display libraries
- # includeRepeating: [Not documented]
- # is_org: [Not documented]
- # is_repeating: [Not documented]
- # one_time: [Not documented]
- # provider_id: [Not documented]
- # provider_ids: [Not documented]
- # show_availability: [Not documented]
- # startDate: the start date of availability (datetime string)
- # start_date_padding: Amount of hours before the startDate to
- # pull availabilities in for. This is helpful when using this query with some
- # calendar display libraries
- # user_id: [Not documented]
- (
- String, :
- String, :
- ID, :
- String, :
- String, :
- Int, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- ID, :
- ID], : [
- Boolean, :
- String, :
- Int, :
- String :
- ): [Availability!]
- # number of availabilities
- #
- # Arguments
- # appointment_location_id: [Not documented]
- # appointment_type_id: [Not documented]
- # endDate: [Not documented]
- # is_org: [Not documented]
- # provider_id: [Not documented]
- # startDate: [Not documented]
- (
- String, :
- String, :
- String, :
- Boolean, :
- ID, :
- String :
- ): Int
- # Fetch availability
- #
- # Arguments
- # id: [Not documented]
- ID): Availability ( :
- # (Limited availability, subject to breaking changes). JSONified Hash with summary
- # of availability.
- #
- # Arguments
- # date: Date (in YYYY-MM-DD) to retrieve availability summary for
- String): String ( :
- # Fetch available item types (for use in onboarding items)
- #
- # Arguments
- # onboarding_flow_id: [Not documented]
- String): String ( :
- # Get open appointment times for a date range. Returns array of dates sorted in
- # ascending order
- #
- # Arguments
- # appointment_to_reschedule_id: (optional) The ID of the
- # appointment that will be rescheduled. Only needed if you want to use
- # appointment-specific rescheduling restrictions
- # appointment_type_ids: An array of group appointment type IDs
- # can be passed in. When passed in, will return availability for multiple group
- # appointment Overrides appt_type_id.
- # appt_loc_id: [Not documented]
- # appt_type_id: [Not documented]
- # clients_can_join_waitlist: [Not documented]
- # contact_type: [Not documented]
- # end_date: [Not documented]
- # end_date_boundary: When passed in, slots after this will not be
- # returned. Inclusive. YYYY-MM-DD format
- # length: [Not documented]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- # make_unique: When false, multiple slots for the same time (for
- # different providers) will be returned.
- # org_level: [Not documented]
- # outside_factors: [Not documented]
- # provider_id: Required
- # provider_ids: [Not documented]
- # start_date: [Not documented]
- # start_date_boundary: When passed in, slots before this will not
- # be returned. YYYY-MM-DD format
- # timezone: [Not documented]
- (
- ID, :
- ID], : [
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- Boolean, :
- Boolean, :
- String, :
- String], : [
- String, :
- String, :
- String :
- ): [PotentialAppointmentSlot!]
- # Get the Cms1500 Policies object for a given claim and client
- #
- # Arguments
- # base_date: [Not documented]
- # cms1500_id: [Not documented]
- # form_answer_group_id: [Not documented]
- # only_active_policies: [Not documented]
- # patient_id: [Not documented]
- # rendering_provider_id: [Not documented]
- (
- String, :
- String, :
- ID, :
- Boolean, :
- ID, :
- String :
- ): Cms1500
- # Get basic info about User from signup token
- #
- # Arguments
- # token: [Not documented]
- String): User ( :
- # DEPRECATED: All ICD Codes that are allowed to be used in healthecare claims
- IcdCode!] : [
- # fetch a billing item by id
- #
- # Arguments
- # id: [Not documented]
- ID): BillingItem ( :
- # Fetch paginated billing items collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # client_id: [Not documented]
- # created_at_end: YYYY-MM-DD format
- # created_at_start: YYYY-MM-DD format
- # keywords: [Not documented]
- # offerings_only: [Not documented]
- # offset: [Not documented]
- # page_size: The number of billing items to return (Max 100)
- # provider_id: [Not documented]
- # order_by: [Not documented]
- # state: (DEPRECATED) Use 'status' field instead with type -
- # [String]
- # status: [Not documented]
- # user_id: [Not documented]
- (
- Cursor, :
- ID, :
- String, :
- String, :
- String, :
- Boolean, :
- Int, :
- Int, :
- ID, :
- BillingItemOrderKeys, :
- String, :
- String], : [
- ID :
- ): [BillingItem!]
- # Number of billing items
- #
- # Arguments
- # client_id: [Not documented]
- # keywords: [Not documented]
- # state: (DEPRECATED) Use 'status' field instead with type -
- # [String]
- # status: [Not documented]
- # provider_id: [Not documented]
- # created_at_start: YYYY-MM-DD format
- # created_at_end: YYYY-MM-DD format
- (
- ID, :
- String, :
- String, :
- String], : [
- ID, :
- String, :
- String :
- ): Int
- # fetch a Brand by id (considered public)
- #
- # Arguments
- # custom_sign_in_path: [Not documented]
- # id: [Not documented]
- # locationString: [Not documented]
- # provider_id: [Not documented]
- (
- String, :
- ID, :
- String, :
- ID :
- ): Brand
- # fetch a Brand by custom sign in path (considered public)
- #
- # Arguments
- # custom_sign_in_path: [Not documented]
- (
- String :
- ): Brand
- # get info used on authentication pages for either a dietitian or partner
- #
- # Arguments
- # code: [Not documented]
- # dietitian_id: [Not documented]
- # invite_code: [Not documented]
- # partner_name: [Not documented]
- (
- String, :
- String, :
- String, :
- String :
- ): BrandInfo
- # Fetch a calendar view settings for current user
- CalendarViewSetting :
- # Fetch an array of campaigns for a provider
- #
- # Arguments
- # offset: [Not documented]
- Int): [Campaign!] ( :
- # Number of campaigns for a provider
- Int :
- # Check if the user has access to the package buy limit feature
- #
- # Arguments
- # token: [Not documented]
- String): Boolean ( :
- # fetch the current users candidhealth connection
- CandidHealthConnection :
- # Fetch paginated stripe customer accounts with associated errors or soon to
- # expire credit cards
- #
- # Arguments
- # offset: [Not documented]
- # order_by: [Not documented]
- Int, : StripeCustomerDetailOrderKeys): [StripeCustomerDetail!] ( :
- # Fetch paginated stripe customer accounts with associated errors or soon to
- # expire credit cards
- Int :
- # fetch a single care plan
- #
- # Arguments
- # id: [Not documented]
- # is_managing_templates: Deprecated. Does nothing
- ID, : Boolean): CarePlan ( :
- # Fetch paginated care plan collection
- #
- # Arguments
- # offset: [Not documented]
- # patient_id: [Not documented]
- # order_by: [Not documented]
- # template_search_keywords: [Not documented]
- # templates_only: [Not documented]
- (
- Int, :
- ID, :
- CarePlanOrderKeys, :
- String, :
- Boolean :
- ): [CarePlan!]
- # Number of care plans
- #
- # Arguments
- # patient_id: [Not documented]
- ID): Int ( :
- # Number of care plans templates
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # fetch the current users Change Health connection
- ChangeClaimSubmitter :
- # fetch a chargeback by the Healthie ID or the Stripe Dispute ID.
- #
- # Arguments
- # id: [Not documented]
- # stripe_dispute_id: [Not documented]
- ID, : ID): ChargeBack ( :
- # fetch all charge backs for a user or organization
- #
- # Arguments
- # show_all_for_org: If user has access to all billing for their
- # organization, this will return all chargebacks for the organization
- # offset: [Not documented]
- # per_page: [Not documented]
- # order_by: [Not documented]
- (
- Boolean, :
- Int, :
- Int, :
- ChargeBackOrderKeys :
- ): [ChargeBack!]
- # fetch count of all charge backs
- #
- # Arguments
- # show_all_for_org: If user has access to all billing for their
- # organization, this will return the count of all chargebacks for the organization
- Boolean): Int ( :
- # All items to include in the charting list
- #
- # Arguments
- # custom_module_form_id: [Not documented]
- # date: [Not documented]
- # document_id: [Not documented]
- # filler_id: [Not documented]
- # form_answer_group_id: [Not documented]
- # include_docs: [Not documented]
- # keywords: [Not documented]
- # name: [Not documented]
- # user_id: [Not documented]
- # start_date: Filter charting items between date range. The
- # `date` argument supersedes this filter. If an end date is present and no start
- # date is, the start date will default to today.
- # end_date: Filter charting items between date range. The `date`
- # argument supersedes this filter. If an start date is present and no end date is,
- # the end date will default to today.
- (
- ID, :
- String, :
- ID, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- String :
- ): [ChartingItemType!]
- # All items to include in the charting list
- #
- # Arguments
- # custom_module_form_id: [Not documented]
- # date: [Not documented]
- # document_id: [Not documented]
- # filler_id: [Not documented]
- # form_answer_group_id: [Not documented]
- # include_docs: [Not documented]
- # keywords: [Not documented]
- # name: [Not documented]
- # user_id: [Not documented]
- # start_date: Filter charting items between date range. The
- # `date` argument supersedes this filter. If an end date is present and no start
- # date is, the start date will default to today.
- # end_date: Filter charting items between date range. The `date`
- # argument supersedes this filter. If an start date is present and no end date is,
- # the end date will default to today.
- (
- ID, :
- String, :
- ID, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- String :
- ): Int
- # Fetch a charting note addendum by id
- #
- # Arguments
- # id: [Not documented]
- ID): ChartingNoteAddendumType ( :
- # fetch a Chat Setting
- #
- # Arguments
- # id: [Not documented]
- ID): ChatSetting ( :
- # get current video chats for a user.
- #
- # Arguments
- # user_id: User to get video chats that are starting in the next
- # 10 minutes
- String): [Appointment!] ( :
- # Fetch a CMS1500 by ID
- #
- # Arguments
- # id: [Not documented]
- ID): Cms1500 ( :
- # Fetch paginated Cms1500s collection
- #
- # Arguments
- # client_id: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # provider_id: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- # status: [Not documented]
- (
- ID, :
- String, :
- Int, :
- ID, :
- Boolean, :
- Cms1500OrderKeys, :
- String :
- ): [Cms1500!]
- # Number of Cms1500s
- #
- # Arguments
- # client_id: [Not documented]
- # keywords: [Not documented]
- # provider_id: [Not documented]
- # status: [Not documented]
- (
- ID, :
- String, :
- ID, :
- String :
- ): Int
- # Color Code Options for a given category
- #
- # Arguments
- # appointment_setting_id: [Not documented]
- # color_code_by: [Not documented]
- (
- String, :
- String :
- ): [ColorCodeOption!]
- # Fetch comment
- #
- # Arguments
- # id: [Not documented]
- ID): Comment ( :
- # Fetch comments collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # entry_id: [Not documented]
- # entry_ids: An array of entry IDs to grab comments for.
- # Overrides entry_id if passed in
- # offset: [Not documented]
- # page_size: If should paginate is true, the number of results to
- # return on a page. Max 1000
- # should_paginate: [Not documented]
- (
- Cursor, :
- ID, :
- ID], : [
- Int, :
- Int, :
- Boolean :
- ): [Comment!]
- # number of comments
- #
- # Arguments
- # entry_id: [Not documented]
- # entry_ids: An array of entry IDs to grab comments for.
- # Overrides entry_id if passed in
- ID, : [ID]): Int ( :
- # fetch a completedCourseItem by course_item_id and user_id
- #
- # Arguments
- # course_item_id: [Not documented]
- # user_id: [Not documented]
- ID, : ID): CompletedCourseItem ( :
- # Get the completed onboarding item by ID
- #
- # Arguments
- # id: The ID of the completed onboarding item
- ID!): CompletedOnboardingItem ( :
- # All Contact Types For Current User
- String!] : [
- # fetch a conversation by id
- #
- # Arguments
- # id: [Not documented]
- # provider_id: (DEPRECATED - NO LONGER NEEDED) ID of the provider
- # to get conversation for (if nil, will return current users)
- ID, : ID): Conversation ( :
- # fetch a conversation membership by id
- #
- # Arguments
- # id: The id of the conversation, will return the membership
- # object for the conversation owner
- # conversation_membership_id: The id of the conversation
- # membership, must have access to the conversation to use
- (
- ID, :
- ID :
- ): ConversationMembership
- # fetch a conversationmembership by id and invitees
- #
- # Arguments
- # id: [Not documented]
- ID): [ConversationMembership!] ( :
- # Fetch paginated conversationmemberships collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # active_status: [Not documented]
- # client_id: [Not documented]
- # conversation_type: [Not documented]
- # keywords: [Not documented]
- # notes_type: [Not documented]
- # offset: [Not documented]
- # page_size: [Not documented]
- # only_include_shared_memberships: If true with client_id, only
- # returns client messages that are shared with the provider
- # org_chat: If TRUE: fetch organization members conversations
- # provider_id: ID of the provider to get conversation for (if
- # nil, will return current users)
- # provider_ids: Used to filter org chat conversations by provider
- # ids
- # read_status: [Not documented]
- # order_by: [Not documented]
- (
- Cursor, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Int, :
- Int, :
- Boolean, :
- Boolean, :
- ID, :
- ID], : [
- String, :
- ConversationMembershipOrderKeys :
- ): [ConversationMembership!]
- # Number of conversationmembership
- #
- # Arguments
- # active_status: [Not documented]
- # client_id: [Not documented]
- # conversation_type: [Not documented]
- # keywords: [Not documented]
- # only_include_shared_memberships: If true with client_id, only
- # returns client messages that are shared with the provider
- # notes_type: [Not documented]
- # org_chat: If TRUE: count organization members conversations
- # provider_id: ID of the provider to get conversation for (if
- # nil, will return current users)
- # provider_ids: Used to filter org chat conversations by provider
- # ids
- # read_status: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- ID, :
- ID], : [
- String :
- ): Int
- # Fetch current user's conversations. It is normally better to use the
- # conversationMemberships query.
- #
- # Arguments
- # user_id: Get conversations between the current user and a given
- # user
- ID): [Conversation!] ( :
- # Number of conversation
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # fetch a course by id (considered public)
- #
- # Arguments
- # course_id: [Not documented]
- # id: [Not documented]
- ID, : ID): Course ( :
- # fetch clients belonging to a course by course_id
- #
- # Arguments
- # course_id: [Not documented]
- # course_status: [Not documented]
- # offset: [Not documented]
- ID, : String, : Int): [CourseMembership!] ( :
- # total number of clients for a specific course
- #
- # Arguments
- # course_id: [Not documented]
- # course_status: [Not documented]
- ID, : String): Int ( :
- # Get course completion info for users and user_groups
- #
- # Arguments
- # course_id: [Not documented]
- ID): CourseCompletionInfoType ( :
- # Course group memberships for the course
- #
- # Arguments
- # course_group_id: [Not documented]
- # course_id: [Not documented]
- # course_status: [Not documented]
- # offset: [Not documented]
- (
- String, :
- ID, :
- String, :
- Int :
- ): [User!]
- # Total clients in course group memberships
- #
- # Arguments
- # course_group_id: [Not documented]
- # course_id: [Not documented]
- # course_status: [Not documented]
- (
- String, :
- ID, :
- String :
- ): Int
- # fetch a courseitem by id (considered public)
- #
- # Arguments
- # course_membership_id: [Not documented]
- # id: [Not documented]
- ID, : ID): CourseItem ( :
- # get all custom custom emails for a current user
- CustomEmail!] : [
- # get all documents for current user
- Document!] : [
- # get all custom module forms for a current user
- CustomModuleForm!] : [
- # Course items info for the course membership
- #
- # Arguments
- # client_id: [Not documented]
- # course_id: [Not documented]
- # find_for_provider: [Not documented]
- # include_emails: [Not documented]
- (
- ID, :
- ID, :
- Boolean, :
- Boolean :
- ): [CourseItem!]
- # fetch a courseMembership by id
- #
- # Arguments
- # course_id: [Not documented]
- # course_item_id: [Not documented]
- # course_membership_id: [Not documented]
- # id: [Not documented]
- # user_group_id: [Not documented]
- # user_id: [Not documented]
- (
- ID, :
- ID, :
- ID, :
- ID, :
- ID, :
- ID :
- ): CourseMembership
- # Fetch paginated course membership collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # client_id: [Not documented]
- # fetch_all: [Not documented]
- # offset: [Not documented]
- # page_size: [Not documented]
- (
- Cursor, :
- ID, :
- Boolean, :
- Int, :
- Int :
- ): [CourseMembership!]
- # Number of course memberships
- #
- # Arguments
- # client_id: [Not documented]
- ID): Int ( :
- # Fetch paginated course collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # active: [Not documented]
- # course_type: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # only_available: [Not documented]
- # page_size: [Not documented]
- # should_paginate: [Not documented]
- (
- Cursor, :
- Boolean, :
- String, :
- String, :
- Int, :
- Boolean, :
- Int, :
- Boolean :
- ): [Course!]
- # Number of course
- #
- # Arguments
- # active: [Not documented]
- # course_type: [Not documented]
- # keywords: [Not documented]
- Boolean, : String, : String): Int ( :
- # All CPT Codes
- #
- # Arguments
- # after: Cursor to fetch results after
- # for_superbill: [Not documented]
- # is_favorited: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # page_size: [Not documented]
- # should_paginate: [Not documented]
- (
- Cursor, :
- Boolean, :
- Boolean, :
- String, :
- Int, :
- Int, :
- Boolean :
- ): [CptCode!]
- # CPT Codes count
- #
- # Arguments
- # is_favorited: [Not documented]
- Boolean): Int ( :
- # fetch the current user.
- User :
- # fetch the current users notifications count.
- UserNotificationsCount :
- # get current video chats for a user.
- #
- # Arguments
- # only_current: [Not documented]
- # user_id: User to get current video chats for (if left blank,
- # defaults to current user)
- Boolean, : String): [Appointment!] ( :
- # Custom Email object
- #
- # Arguments
- # id: [Not documented]
- ID): CustomEmail ( :
- # A HTML string containing mailer template for certain email type
- #
- # Arguments
- # course_id: [Not documented]
- # email_body_only: [Not documented]
- # email_type: [Not documented]
- # find_record: [Not documented]
- # greeting: [Not documented]
- # id: [Not documented]
- # message_body: [Not documented]
- # preview_email_type: [Not documented]
- # reactivation_wait_days: [Not documented]
- # subject: [Not documented]
- (
- String, :
- Boolean, :
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String :
- ): String
- # Fetch paginated custom emails collection
- #
- # Arguments
- # after: Cursor to fetch results after
- # email_type: [Not documented]
- # offset: [Not documented]
- # provider_id: [Not documented]
- (
- Cursor, :
- String, :
- Int, :
- ID :
- ): [CustomEmail!]
- # Number of custom emails
- #
- # Arguments
- # email_type: [Not documented]
- String): Int ( :
- # fetch a custom module form by id (templates are considered public)
- #
- # Arguments
- # charting: [Not documented]
- # default: [Not documented]
- # id: [Not documented]
- Boolean, : Boolean, : ID): CustomModuleForm ( :
- # All form templates for the current user
- #
- # Arguments
- # active_status: [Not documented]
- # category: [Not documented]
- # include_default_templates: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- (
- Boolean, :
- String, :
- Boolean, :
- String, :
- Int, :
- Boolean, :
- CustomModuleFormOrderKeys :
- ): [CustomModuleForm!]
- # Fetch paginated count for provider custom module forms
- #
- # Arguments
- # active_status: [Not documented]
- # category: [Not documented]
- # include_default_templates: [Not documented]
- # keywords: [Not documented]
- (
- Boolean, :
- String, :
- Boolean, :
- String :
- ): Int
- # get open appointment times for a range
- #
- # Arguments
- # appointment_to_reschedule_id: (optional) The ID of the
- # appointment that will be rescheduled. Only needed if you want to use
- # appointment-specific rescheduling restrictions
- # appt_loc_id: [Not documented]
- # appt_type_id: [Not documented]
- # clients_can_join_waitlist: [Not documented]
- # contact_type: [Not documented]
- # date_from_month: [Not documented]
- # end_date: When passed in, supercedes date_from_month. Must be
- # passed in along with start_date
- # end_date_boundary: When passed in, slots after this will not be
- # returned. Inclusive. YYYY-MM-DD format
- # length: [Not documented]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- # org_level: Required True if querying multiple providers
- # outside_factors: [Not documented]
- # provider_id: Required
- # provider_ids: [Not documented]
- # start_date: When passed in, supercedes date_from_month. Must be
- # passed in along with end_date
- # start_date_boundary: When passed in, slots before this will not
- # be returned. YYYY-MM-DD format
- # timezone: [Not documented]
- (
- ID, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- Boolean, :
- String, :
- String], : [
- String, :
- String, :
- String :
- ): [String]
- # fetch a document by id
- #
- # Arguments
- # care_plan_id: [Not documented]
- # course_id: [Not documented]
- # course_item_id: [Not documented]
- # custom_module_id: [Not documented]
- # id: [Not documented]
- (
- ID, :
- 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
- #
- # Arguments
- # after: Cursor to fetch results after
- # document_id: [Not documented]
- # offset: [Not documented]
- # per_page: The number of document views to return per page.
- # Maximum 500
- (
- Cursor, :
- ID, :
- Int, :
- Int :
- ): [DocumentViewing!]
- # Number of instances for a document viewings for a specific document
- #
- # Arguments
- # document_id: [Not documented]
- ID): Int ( :
- # Fetch paginated documents collection
- #
- # Arguments
- # consolidated_user_id: [Not documented]
- # file_type: [Not documented]
- # file_types: (DEPRECATED)
- # filter: [Not documented]
- # folder_id: [Not documented]
- # for_template_use: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # private_user_id: [Not documented]
- # provider_id: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- # viewable_user_id: [Not documented]
- (
- String, :
- String, :
- String], : [
- String, :
- String, :
- Boolean, :
- String, :
- Int, :
- String, :
- ID, :
- Boolean, :
- DocumentOrderKeys, :
- String :
- ): [Document!]
- # Number of documents
- #
- # Arguments
- # consolidated_user_id: [Not documented]
- # file_type: [Not documented]
- # file_types: (DEPRECATED)
- # filter: [Not documented]
- # folder_id: [Not documented]
- # keywords: [Not documented]
- # private_user_id: [Not documented]
- # provider_id: [Not documented]
- # viewable_user_id: [Not documented]
- (
- String, :
- String, :
- String], : [
- String, :
- String, :
- String, :
- String, :
- ID, :
- String :
- ): Int
- # Fetch User Info on DoseSpot Object
- #
- # Arguments
- # user_id: [Not documented]
- 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)
- #
- # Arguments
- # patient_id: [Not documented]
- ID): String ( :
- # draft by conversation_membership id
- #
- # Arguments
- # conversation_membership_id: [Not documented]
- ID): Draft ( :
- # Fetch a link from Fullscript to create a treatment plan for a given user
- #
- # Arguments
- # user_id: [Not documented]
- String): String ( :
- # fetch embed steps based off of params
- #
- # Arguments
- # is_for_web: [Not documented]
- # locationString: [Not documented]
- Boolean, : String): [EmbedWidgetStepType!] ( :
- # Fetch paginated entries collection
- #
- # Arguments
- # category: The category of entry (e.g Weight or Blood Pressure)
- # to return
- # client_id: [Not documented]
- # end_datetime_range: This field takes in a datetime string, and
- # returns entries before that datetime. Must be sent in with a
- # start_datetime_range
- # end_range: This field takes in a date (e.g 2020-11-29), and
- # returns entries before the beginning of that day. Must be sent in with a
- # start_range
- # entry_id: [Not documented]
- # group_id: [Not documented]
- # is_org: When true, returns entries for all client in the
- # organization
- # keywords: [Not documented]
- # offset: [Not documented]
- # page_size: If should paginate is true, the number of results to
- # return on a page. Max 500
- # order_by: [Not documented]
- # start_datetime_range: This field takes in a datetime string,
- # and returns entries after that datetime. Must be sent in with a
- # end_datetime_range
- # start_range: This field takes in a date (e.g 2020-11-28), and
- # returns entries starting at the beginning of that day
- # summary_view: [Not documented]
- # type: The type of entry (e.g MetricEntry) to return
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- Int, :
- Int, :
- EntryOrderKeys, :
- String, :
- String, :
- Boolean, :
- String :
- ): [Entry!]
- # Number of entries
- #
- # Arguments
- # category: [Not documented]
- # client_id: [Not documented]
- # end_datetime_range: This field takes in a datetime string, and
- # returns entries before that datetime. Must be sent in with a
- # start_datetime_range
- # end_range: This field takes in a date (e.g 2020-11-29), and
- # returns entries before the beginning of that day. Must be sent in with a
- # start_range
- # group_id: [Not documented]
- # is_org: When true, returns entries for all client in the
- # organization
- # keywords: [Not documented]
- # maximum_count: When passed in, the count query will never
- # return a higher number than this. This can significantly speed up performance if
- # you are just want users to scroll through recent entries
- # start_datetime_range: This field takes in a datetime string,
- # and returns entries after that datetime. Must be sent in with a
- # end_datetime_range
- # start_range: This field takes in a date (e.g 2020-11-28), and
- # returns entries starting at the beginning of that day
- # type: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- Int, :
- String, :
- String, :
- String :
- ): Int
- # fetch an entry by id
- #
- # Arguments
- # client_id: [Not documented]
- # id: [Not documented]
- # type: [Not documented]
- ID, : ID, : String): Entry ( :
- # fetch a featureToggle by id
- #
- # Arguments
- # id: [Not documented]
- # user_id: [Not documented]
- ID, : ID): FeatureToggle ( :
- # fetch a featureToggle by id
- #
- # Arguments
- # care_plan_id: [Not documented]
- # id: [Not documented]
- # user_group_id: [Not documented]
- # user_id: [Not documented]
- (
- ID, :
- ID, :
- ID, :
- ID :
- ): FeatureToggle
- # fetch a folder by id
- #
- # Arguments
- # custom_module_id: [Not documented]
- # id: [Not documented]
- ID, : String): Folder ( :
- # Fetch paginated folders collection
- #
- # Arguments
- # client_id: [Not documented]
- # consolidated_user_id: [Not documented]
- # document_to_move_id: [Not documented]
- # filter: [Not documented]
- # folder_id: [Not documented]
- # folder_to_move_id: [Not documented]
- # for_template_use: [Not documented]
- # keywords: [Not documented]
- # private_user_id: [Not documented]
- # provider_id: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- # viewable_user_id: [Not documented]
- (
- String, :
- String, :
- ID, :
- String, :
- String, :
- ID, :
- Boolean, :
- String, :
- String, :
- ID, :
- Boolean, :
- FolderOrderKeys, :
- String :
- ): [Folder!]
- # Number of folders
- #
- # Arguments
- # consolidated_user_id: [Not documented]
- # filter: [Not documented]
- # folder_id: [Not documented]
- # keywords: [Not documented]
- # private_user_id: [Not documented]
- # provider_id: [Not documented]
- # viewable_user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- ID, :
- String :
- ): Int
- # Fetch food items
- #
- # Arguments
- # after: Cursor to fetch results after
- # exclude_recent: [Not documented]
- # food_type: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # page_size: [Not documented]
- # upc: [Not documented]
- # user_id: [Not documented]
- (
- Cursor, :
- Boolean, :
- String, :
- String, :
- Int, :
- Int, :
- String, :
- String :
- ): [Food!]
- # Get size of food items that matches the keyword
- #
- # Arguments
- # exclude_recent: [Not documented]
- # food_type: [Not documented]
- # keywords: [Not documented]
- # upc: [Not documented]
- # user_id: [Not documented]
- (
- Boolean, :
- String, :
- String, :
- String, :
- String :
- ): Int
- # Fetch a form answer group by id
- #
- # Arguments
- # for_superbills: [Not documented]
- # external_id: [Not documented]
- # id: [Not documented]
- # ids: [Not documented]
- # track_opened_event: If TRUE, create form history 'opened' event
- (
- Boolean, :
- String, :
- ID, :
- ID], : [
- Boolean :
- ): FormAnswerGroup
- # All filled forms for a given set of arguments
- #
- # Arguments
- # custom_module_form_id: [Not documented]
- # date: [Not documented]
- # filler_id: [Not documented]
- # form_answer_group_id: [Not documented]
- # ids: Accepts an array of FormAnswerGroup ids
- # include_group_notes: [Not documented]
- # name: [Not documented]
- # user_id: [Not documented]
- # should_paginate: [Not documented]
- # offset: [Not documented]
- # page_size: [Not documented]
- # order_by: [Not documented]
- (
- ID, :
- String, :
- String, :
- String, :
- ID], : [
- Boolean, :
- String, :
- String, :
- Boolean, :
- Int, :
- Int, :
- FormAnswerGroupOrderKeys :
- ): [FormAnswerGroup!]
- # The number of filled forms for a given set of a arguments
- #
- # Arguments
- # date: [Not documented]
- # filler_id: [Not documented]
- # form_answer_group_id: [Not documented]
- # ids: Accepts an array of FormAnswerGroup ids
- # name: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- ID], : [
- String, :
- String :
- ): Int
- # Form histories owned by a patient and related to a sourceable form
- # (RequsetedFormCompletion / OnboardingItem)
- #
- # Arguments
- # patient_id: The patient ID who owns the form
- # sourceable_id: Source object ID
- # sourceable_type: Source object type
- # offset: [Not documented]
- (
- ID, :
- ID, :
- FormHistorySourceable, :
- Int :
- ): [FormHistory!]!
- # Total count of form histories owned by a patient and related to a sourceable
- # form (RequsetedFormCompletion / OnboardingItem)
- #
- # Arguments
- # patient_id: The patient ID who owns the form
- # sourceable_id: Source object ID
- # sourceable_type: Source object type
- (
- ID, :
- ID, :
- FormHistorySourceable :
- ): Int!
- # Fetch available forms to request
- #
- # Arguments
- # keywords: [Not documented]
- String): [FormTypesToRequest!] ( :
- # Fullscript practitioners that share the same clinic id as organization owner
- FullscriptPractitionerTypeType!] : [
- # Fullscript practitioners that share the same clinic id as organization owner
- FullscriptPractitionerType!] : [
- # fetch a goal by id
- #
- # Arguments
- # client_id: [Not documented]
- # date: [Not documented]
- # get_client_goal: [Not documented]
- # id: [Not documented]
- # last_client_goal: Deprecated, at some point this argument
- # stopped being used. Keeping it around in order to make sure nothing breaks
- # backwards
- # patient_goal_module: [Not documented]
- # program_goal: [Not documented]
- (
- ID, :
- String, :
- Boolean, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean :
- ): Goal
- # All completed goals for a given set of users
- #
- # Arguments
- # category: [Not documented]
- # include_subgoals: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # unique: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- Boolean, :
- Int, :
- Boolean, :
- Boolean, :
- ID :
- ): [GoalHistory!]
- # All completed goals for a given set of users
- #
- # Arguments
- # category: [Not documented]
- # include_subgoals: [Not documented]
- # offset: [Not documented]
- # unique: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- Boolean, :
- Int, :
- Boolean, :
- ID :
- ): Int
- # Fetch goal history
- #
- # Arguments
- # id: [Not documented]
- ID): GoalHistory ( :
- # A goal's instances
- #
- # Arguments
- # end_range: [Not documented]
- # goal_id: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # per_page: [Not documented]
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- (
- String, :
- ID, :
- String, :
- Int, :
- Int, :
- String, :
- String :
- ): [GoalInstance!]
- # Number of instances for a goal
- #
- # Arguments
- # end_range: [Not documented]
- # goal_id: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # per_page: [Not documented]
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- (
- String, :
- ID, :
- String, :
- Int, :
- Int, :
- String, :
- String :
- ): Int
- # Goal templates for given user
- #
- # Arguments
- # category: Can be 'personal', 'organizational', or 'default'
- # keywords: [Not documented]
- # offset: DEPRECATED
- # user_id: [Not documented]
- (
- String, :
- String, :
- Int, :
- ID :
- ): [GoalTemplate!]
- # Number of Goal templates for given user
- #
- # Arguments
- # keywords: [Not documented]
- # user_id: [Not documented]
- String, : ID): Int ( :
- # All goals, either for a given user or for all of the providers clients
- #
- # Arguments
- # category: [Not documented]
- # end_range: [Not documented]
- # frequency_filter: Can be daily, weekly, or one_time
- # keywords: [Not documented]
- # offset: [Not documented]
- # per_page: [Not documented]
- # rel_goal_id: [Not documented]
- # order_by: [Not documented]
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- Int, :
- Int, :
- String, :
- GoalOrderKeys, :
- String, :
- String, :
- ID :
- ): [Goal!]
- # Number of goal
- #
- # Arguments
- # category: [Not documented]
- # end_range: [Not documented]
- # frequency_filter: Can be daily, weekly, or one_time
- # keywords: [Not documented]
- # offset: [Not documented]
- # rel_goal_id: [Not documented]
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- Int, :
- String, :
- String, :
- String, :
- ID :
- ): Int
- # All goals data
- #
- # Arguments
- # category: Search over goals' repeat property
- # end_range: [Not documented]
- # frequency_filter: Can be daily, weekly, or one_time
- # keywords: Search over goals' names and descriptions
- # offset: [Not documented]
- # per_page: [Not documented]
- # rel_goal_id: the goal ID
- # order_by: [Not documented]
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- Int, :
- Int, :
- String, :
- GoalOrderKeys, :
- String, :
- String, :
- ID :
- ): GoalDataType
- # Overall completion percentage of goals
- #
- # Arguments
- # category: [Not documented]
- # end_range: [Not documented]
- # frequency_filter: Can be daily, weekly, or one_time
- # keywords: [Not documented]
- # offset: [Not documented]
- # rel_goal_id: [Not documented]
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- Int, :
- String, :
- String, :
- String, :
- ID :
- ): Int @deprecated( reason: "Use goalsOverallCompletionRateInfo instead" )
- # Overall completion percentage of goals
- #
- # Arguments
- # category: [Not documented]
- # end_range: [Not documented]
- # frequency_filter: Can be daily, weekly, or one_time
- # goal_id: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # rel_goal_id: (DEPRECATED) Use goal_id instead as it is the
- # correct ID
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- ID, :
- String, :
- Int, :
- String, :
- String, :
- String, :
- ID :
- ): GoalOverallCompletionRateInfo
- # Overall completion percentage of goals
- #
- # Arguments
- # category: [Not documented]
- # end_range: [Not documented]
- # frequency_filter: Can be daily, weekly, or one_time
- # goal_id: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # rel_goal_id: (DEPRECATED) Use goal_id instead as it is the
- # correct ID
- # start_range: [Not documented]
- # status_filter: Can be complete or not_complete
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- ID, :
- String, :
- Int, :
- String, :
- String, :
- String, :
- ID :
- ): Int
- # When true, the user can set up question conditions in the form builder
- Boolean :
- # When true, the user can add sublabels to questions in the form builder
- Boolean :
- # Fetch a single health assessment
- #
- # Arguments
- # device_token: [Not documented]
- # device_type: [Not documented]
- # email: [Not documented]
- # run_id: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- ID, :
- ID :
- ): HealthAssessment
- # Fetch Health Assessments
- #
- # Arguments
- # device_token: [Not documented]
- # device_type: [Not documented]
- # email: [Not documented]
- # run_id: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- ID, :
- ID :
- ): [HealthAssessment!]
- # Fetch ICD Code by ID
- #
- # Arguments
- # id: [Not documented]
- ID): IcdCode ( :
- # All ICD Codes
- #
- # Arguments
- # is_billable: [Not documented]
- # is_favorited: The favorited status of the ICD Code
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: Whether results are paginated, highly
- # recommended for use
- # order_by: [Not documented]
- (
- Boolean, :
- Boolean, :
- String, :
- Int, :
- Boolean, :
- IcdCodeOrderKeys :
- ): [IcdCode!]
- # Count of all ICD Codes
- #
- # Arguments
- # is_billable: [Not documented]
- # is_favorited: The favorited status of the ICD Code
- # keywords: [Not documented]
- (
- Boolean, :
- Boolean, :
- String :
- ): Int
- # fetch import data request by user_id
- #
- # Arguments
- # user_id: [Not documented]
- ID): ImportDataRequest ( :
- # A new CMS1500 form with some objects already prefilled
- #
- # Arguments
- # form_answer_group_id: [Not documented]
- # patient_id: [Not documented]
- # provider_id: [Not documented]
- (
- ID, :
- ID, :
- String :
- ): Cms1500
- # Initial form answers for a given user and template
- #
- # Arguments
- # custom_module_form_id: [Not documented]
- # incomplete_form_id: [Not documented]
- # user_id: [Not documented]
- (
- ID, :
- ID, :
- ID :
- ): [FormAnswer!]
- # appointment types related to offering
- #
- # Arguments
- # offering_id: [Not documented]
- ID): [OfferingInclude!] ( :
- # Insurance Authorization belonging to a client
- #
- # Arguments
- # client_id: Client to get insurance authorization for
- # id: id of insurance authorization
- ID, : ID): InsuranceAuthorizationType ( :
- # Get all potential insurance plans
- #
- # Arguments
- # ids: Array of plan ids
- # is_accepted: The accepted status of the insurance plan
- # is_custom: Get custom insurance plans
- # keywords: Search keywords
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- (
- String, :
- Boolean, :
- Boolean, :
- String, :
- Int, :
- Boolean, :
- InsurancePlanOrderKeys :
- ): [InsurancePlan!]
- # Get all potential insurance plans
- #
- # Arguments
- # ids: Array of plan ids
- # is_accepted: The accepted status of the insurance plan
- # is_custom: Get custom insurance plans
- # keywords: Search keywords
- (
- String, :
- Boolean, :
- Boolean, :
- String :
- ): Int
- # Fetch intake flow
- #
- # Arguments
- # keywords: [Not documented]
- # order_by: [Not documented]
- # user_id: [Not documented]
- # statuses: Filter records by list of statuses
- # form_types: Filter records by list of form types
- (
- String, :
- IntakeFlowOrderKeys, :
- ID, :
- FormStatus], : [
- FormType] : [
- ): IntakeFlowType
- # Fetch list of available integrations
- #
- # Arguments
- # category: [Not documented]
- String): [IntegrationCategoryType!] ( :
- # Initial date of service for a new form answer group
- #
- # Arguments
- # appointment_id: [Not documented]
- # user_id: [Not documented]
- ID, : ID): String ( :
- # get the base price for the invoice based off the associated item
- #
- # Arguments
- # cms1500_id: [Not documented]
- # offering_id: [Not documented]
- ID, : ID): String ( :
- # Arguments
- # keywords: [Not documented]
- String): [RequestedPaymentTemplate!] ( :
- # Get options for lab filters
- LabFiltersDataType :
- # Fetch all lab options (considered public)
- LabOption!] : [
- # Fetch onboarding flows collection
- #
- # Arguments
- # id: [Not documented]
- ID): LabOrder ( :
- # Fetch lab orders collection
- #
- # Arguments
- # client_filter: [Not documented]
- # client_id: [Not documented]
- # keywords: [Not documented]
- # lab_filter: [Not documented]
- # offset: [Not documented]
- # provider_filter: [Not documented]
- # recent_orders: [Not documented]
- # order_by: [Not documented]
- # status_filter: [Not documented]
- (
- String, :
- ID, :
- String, :
- String, :
- Int, :
- String, :
- Boolean, :
- LabOrderOrderKeys, :
- String :
- ): [LabOrder!]
- # Number of lab orders related to the current user
- #
- # Arguments
- # client_filter: [Not documented]
- # keywords: [Not documented]
- # lab_filter: [Not documented]
- # provider_filter: [Not documented]
- # status_filter: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- String :
- ): Int
- # Fetch most recent conversationMembership
- #
- # Arguments
- # active_status: [Not documented]
- # provider_id: ID of the provider to get conversation for (if
- # nil, will return current users)
- String, : ID): ConversationMembership ( :
- # The 6 most recently active clients
- #
- # Arguments
- # limit: [Not documented]
- Int): [User!] ( :
- # has loadMoreNotes been called
- Boolean :
- # fetch a location by id
- #
- # Arguments
- # id: [Not documented]
- ID): Location ( :
- # Get location resources
- #
- # Arguments
- # location_ids: [Not documented]
- String): [LocationResourceType!] ( :
- # Get locations for a given user (or current user)
- #
- # Arguments
- # has_name: Pass in true to get service facilities for CMS 1500
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # user_id: [Not documented]
- (
- Boolean, :
- String, :
- Int, :
- Boolean, :
- String :
- ): [Location!]
- # A count of available locations for the current user
- #
- # Arguments
- # has_name: [Not documented]
- # keywords: [Not documented]
- Boolean, : String): Int ( :
- # Fetch user meals
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # user_id: [Not documented]
- String, : Int, : String): [Meal!] ( :
- # Get size of user meals that matches the keyword
- #
- # Arguments
- # keywords: [Not documented]
- # user_id: [Not documented]
- String, : String): Int ( :
- # Meal plan options from user Living Plate account. Nil if no Living Plate account
- # associated
- MealPlan!] : [
- # Fetch an array of medications options queried from Dosespot API
- #
- # Arguments
- # keywords: [Not documented]
- String): [MedicationOptionType!] ( :
- # Fetch an array of medications for a given patient
- #
- # Arguments
- # active: [Not documented]
- # patient_id: [Not documented]
- Boolean, : ID): [MedicationType!] ( :
- # Fetch count of medications for a given patient
- #
- # Arguments
- # active: [Not documented]
- # patient_id: [Not documented]
- Boolean, : ID): Int ( :
- # Fetch data for the metric graphs for a given user
- #
- # Arguments
- # category: [Not documented]
- # end_date: End of the date range, must be sent in with a start
- # date.
- # entry_type: [Not documented]
- # has_third_party_source: When false, returns no third-party
- # data. When true, returns only third-party data. If not passed in, will return
- # all data
- # multiplier: [Not documented]
- # start_date: Start of the date range, must be sent in with an
- # end date.
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- String :
- ): MetricGraphDataType
- # Fetch data for the metric graphs for a given user
- #
- # Arguments
- # end_date: End of the date range, must be sent in with a start
- # date.
- # has_third_party_source: When false, returns no third-party
- # data. When true, returns only third-party data. If not passed in, will return
- # all data
- # start_date: Start of the date range, must be sent in with an
- # end date.
- # user_id: [Not documented]
- (
- String, :
- Boolean, :
- String, :
- String :
- ): [MetricGraphDataType!]!
- # Arguments
- # lab_option_ids: [Not documented]
- # state: [Not documented]
- ID], : String): String ( : [
- # returns metadata about montly payments
- #
- # Arguments
- # gross: [Not documented]
- # org_level: [Not documented]
- (
- Boolean, :
- Boolean :
- ): [MonthlyBillingItemsDataType!]
- # Fetch data for multi line metric graphs for a given user
- #
- # Arguments
- # category: [Not documented]
- # end_date: End of the date range, must be sent in with a start
- # date.
- # entry_type: [Not documented]
- # food_graph_type: [Not documented]
- # start_date: Start of the date range, must be sent in with an
- # end date.
- # sub_category: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String :
- ): MultiLineMetricGraphDataType
- # String containing info for the user about the client upgrade price
- #
- # Arguments
- # new_client_num: [Not documented]
- Int): String ( :
- # String containing info for the user about the org upgrade price
- #
- # Arguments
- # new_provder_num: [Not documented]
- Int): String ( :
- # String containing info for the user about the org upgrade price when adding a
- # new support user
- #
- # Arguments
- # new_support_num: [Not documented]
- (
- Int :
- ): [String]
- # Fetch closest appointment
- Appointment :
- # get open appointment times for a range
- #
- # Arguments
- # appointment_to_reschedule_id: (optional) The ID of the
- # appointment that will be rescheduled. Only needed if you want to use
- # appointment-specific rescheduling restrictions
- # appt_loc_id: [Not documented]
- # appt_type_id: [Not documented]
- # contact_type: [Not documented]
- # end_date_boundary: When passed in, slots after this will not be
- # returned. Inclusive. YYYY-MM-DD format
- # length: [Not documented]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- # org_level: [Not documented]
- # outside_factors: [Not documented]
- # provider_id: Required
- # provider_ids: [Not documented]
- # start_date_boundary: When passed in, slots before this will not
- # be returned. YYYY-MM-DD format
- # timezone: [Not documented]
- (
- ID, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- Boolean, :
- String, :
- String], : [
- String, :
- String :
- ): String
- # fetch a courseitem by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): CourseItem ( :
- # fetch a note by id
- #
- # Arguments
- # id: [Not documented]
- ID): Note ( :
- # get the viewed status of a note
- #
- # Arguments
- # id: [Not documented]
- ID): Boolean ( :
- # Fetch note scheduler by id
- #
- # Arguments
- # id: [Not documented]
- ID): NoteScheduler ( :
- # Fetch paginated note collection for given conversation
- #
- # Arguments
- # conversation_id: [Not documented]
- # ids: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # org_chat: If TRUE: get base user as a conversation owner
- # provider_id: [Not documented]
- # scheduled_notes: [Not documented]
- # since_note_id: [Not documented]
- # order_by: [Not documented]
- # with_tasks: If TRUE: get notes with tasks
- (
- ID, :
- ID], : [
- String, :
- Int, :
- Boolean, :
- ID, :
- Boolean, :
- ID, :
- NoteOrderKeys, :
- Boolean :
- ): [Note!]
- # Number of notes
- #
- # Arguments
- # conversation_id: [Not documented]
- # keywords: [Not documented]
- # org_chat: If TRUE: get base user as a conversation owner
- # provider_id: [Not documented]
- # scheduled_notes: [Not documented]
- (
- ID, :
- String, :
- Boolean, :
- ID, :
- Boolean :
- ): Int
- # get count of notifications for a given user (or for the current user)
- #
- # Arguments
- # categories: (DEPRECATED) This argument is not used, and does
- # not do anything.
- # other_party_id: [Not documented]
- # page_size: (DEPRECATED) This argument is not used, and does not
- # do anything.
- # read_status: [Not documented]
- # seen_status: [Not documented]
- # types: [Not documented]
- (
- String], : [
- String, :
- Int, :
- Boolean, :
- Boolean, :
- String] : [
- ): Int
- # fetch a Notification Setting by id
- #
- # Arguments
- # id: [Not documented]
- ID): NotificationSetting ( :
- # get notifications for a given user (or for the current user)
- #
- # Arguments
- # offset: [Not documented]
- # other_party_id: [Not documented]
- # page_size: [Not documented]
- # read_status: [Not documented]
- # seen_status: [Not documented]
- # order_by: [Not documented]
- # types: [Not documented]
- (
- Int, :
- String, :
- Int, :
- Boolean, :
- Boolean, :
- NotificationOrderKeys, :
- String] : [
- ): [Notification!]
- # fetch an offering by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): Offering ( :
- # Fetch paginated list of users associated with an offering
- #
- # Arguments
- # offering_id: [Not documented]
- # offset: [Not documented]
- ID, : Int): [BillingItem!] ( :
- # Number of users associated with an offering
- #
- # Arguments
- # offering_id: [Not documented]
- ID): Int ( :
- # Fetch paginated coupon offerings collection
- #
- # Arguments
- # from_package_details: [Not documented]
- # keywords: [Not documented]
- # offering_id: [Not documented]
- # offset: [Not documented]
- # order_by: [Not documented]
- # user_id: [Not documented]
- (
- Boolean, :
- String, :
- ID, :
- Int, :
- OfferingCouponOrderKeys, :
- ID :
- ): [OfferingCoupon!]
- # Number of offering coupons
- #
- # Arguments
- # from_package_details: [Not documented]
- # keywords: [Not documented]
- # offering_id: [Not documented]
- (
- Boolean, :
- String, :
- ID :
- ): Int
- # get all user groups relating to offerings
- #
- # Arguments
- # provider_id: the provider ID we want to use to fetch all user
- # groups relating to offerings
- ID): [OfferingGroupVisibility!] ( :
- # All OfferingImage that have no user_id
- OfferingImage!] : [
- # Fetch paginated offerings collection (considered public)
- #
- # Arguments
- # client_visibility: [Not documented]
- # keywords: [Not documented]
- # offering_id: [Not documented]
- # offering_ids: [Not documented]
- # offering_user_group_id: [Not documented]
- # offset: [Not documented]
- # only_client_visible: [Not documented]
- # page_size: The number of packages to return at one time (when
- # should_paginate is true)
- # provider_id: [Not documented]
- # should_paginate: [Not documented]
- # show_only_visible: [Not documented]
- # order_by: [Not documented]
- # status: [Not documented]
- (
- String, :
- String, :
- ID, :
- ID], : [
- ID, :
- Int, :
- Boolean, :
- Int, :
- ID, :
- Boolean, :
- Boolean, :
- OfferingOrderKeys, :
- String :
- ): [Offering!]
- # Number of offerings (considered public)
- #
- # Arguments
- # client_visibility: [Not documented]
- # keywords: [Not documented]
- # offering_id: [Not documented]
- # offering_ids: [Not documented]
- # offering_user_group_id: [Not documented]
- # only_client_visible: [Not documented]
- # provider_id: [Not documented]
- # should_paginate: [Not documented]
- # status: [Not documented]
- (
- String, :
- String, :
- ID, :
- ID], : [
- ID, :
- Boolean, :
- ID, :
- Boolean, :
- String :
- ): Int
- # returns metadata about offerings purchased
- #
- # Arguments
- # org_level: [Not documented]
- Boolean): [OfferingsDataType!] ( :
- # fetch the current users officeally sftp connection
- OfficeallySftpAccount :
- # Fetch an onboarding flow by id or uuid
- #
- # Arguments
- # id: [Not documented]
- # user_id: [Not documented]
- # uuid: Fetch onboarding flow by unique identifier. Considered
- # public
- ID, : ID, : String): OnboardingFlow ( :
- # Fetch onboarding flows collection
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- (
- String, :
- Int, :
- Boolean, :
- OnboardingFlowOrderKeys :
- ): [OnboardingFlow!]
- # Number of onboarding flows
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- String, : Int): Int ( :
- # fetch an onboarding item by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- # user_id: Patient ID who owns the form
- # track_opened_event: If TRUE, create form history 'opened' event
- ID, : ID, : Boolean): OnboardingItem ( :
- # Returns all cpt codes associated with org providers
- #
- # Arguments
- # org_id: [Not documented]
- ID): [ProviderCptCodeType!] ( :
- # fetch an organization by id, by provider id, or by the current_user, demographic
- # org info is (considered public)
- #
- # Arguments
- # email: [Not documented]
- # for_client: [Not documented]
- # id: [Not documented]
- # provider_id: [Not documented]
- # provider_ids: [Not documented]
- # state_licenses: [Not documented]
- (
- String, :
- Boolean, :
- ID, :
- ID, :
- ID], : [
- String] : [
- ): Organization
- # Fetch organization info by id
- #
- # Arguments
- # id: [Not documented]
- ID): OrganizationInfo ( :
- # fetch members of organization
- #
- # Arguments
- # conversation_id: [Not documented]
- # keywords: [Not documented]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- # offset: [Not documented]
- # page_size: The number of organization members to return (Max
- # 100)
- # order_by: [Not documented]
- (
- ID, :
- String, :
- String, :
- Int, :
- Int, :
- UserOrderKeys :
- ): [User!]
- # org members count
- #
- # Arguments
- # conversation_id: [Not documented]
- # keywords: [Not documented]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- (
- ID, :
- String, :
- String :
- ): Int
- # Get the organization membership info of the current user, basic org member info
- # is (considered public)
- #
- # Arguments
- # user_id: The id of a user
- # id: The id of an organization membership
- ID, : ID): OrganizationMembership ( :
- # Get the organization memberships
- #
- # Arguments
- # id: [Not documented]
- # order_by: [Not documented]
- # user_ids: [Not documented]
- (
- String, :
- OrganizationMembershipOrderKeys, :
- ID] : [
- ): [OrganizationMembership!]
- # fetch an Other Id Number by id
- #
- # Arguments
- # id: [Not documented]
- ID): OtherIdNumber ( :
- # A collection of Other ID's and its Qualifiers for given user
- #
- # Arguments
- # user_id: [Not documented]
- ID): [OtherIdNumber!] ( :
- # returns true if the there are more transfers to load
- #
- # Arguments
- # limit: [Not documented]
- # starting_after: [Not documented]
- Int, : String): Boolean ( :
- # Fetch permission template
- #
- # Arguments
- # id: [Not documented]
- ID): PermissionTemplateType ( :
- # Get Permission Templates
- #
- # Arguments
- # offset: [Not documented]
- Int): [PermissionTemplateType!] ( :
- # Number of permission templates
- Int :
- # Fetch a pharmacy given dosespot pharmacy id
- #
- # Arguments
- # id: id assigned by dosespot
- String): Pharmacy ( :
- # Fetch an array of pharmacies given search parameters
- #
- # Arguments
- # address: requires at least 3 characters
- # city: requires at least 3 characters
- # name: keywords for name of pharmacy, requires at least 3
- # characters
- # ncpdp_id: [Not documented]
- # phone_or_fax: [Not documented]
- # specialties: Array of pharmacy accepted values: EPCS,
- # TwentyFourHourPharmacy, LongTermCarePharmacy, MailOrder, SpecialtyPharmacy,
- # Retail
- # state: two letter abbreviation (i.e ny, ca, md)
- # zip: requires at least 3 numeric characters
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String], : [
- String, :
- String :
- ): [Pharmacy!]
- # fetch all place of services
- PlaceOfService!] : [
- # fetch a Plan by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): Plan ( :
- # fetch a policy by id
- #
- # Arguments
- # id: [Not documented]
- ID): Policy ( :
- # Fetch collection of preferred CPT/ICD codes
- #
- # Arguments
- # code_type: [Not documented]
- String): [PreferredMedicalCode!] ( :
- # Fetch a prescriptions for a given patient and prescription id pulled from
- # Dosespot
- #
- # Arguments
- # patient_id: [Not documented]
- # prescription_id: [Not documented]
- ID, : String): Prescription ( :
- # Fetch an array of prescriptions for a given patient pulled from Dosespot
- #
- # Arguments
- # patient_id: [Not documented]
- # status: [Not documented]
- ID, : String): [Prescription!] ( :
- # fetch a courseitem by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): CourseItem ( :
- # Fetch paginated product collection
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- (
- String, :
- Int, :
- Boolean, :
- ProductOrderKeys :
- ): [Product!]
- # Number of products
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # fetch a provider by id
- #
- # Arguments
- # client_id: [Not documented]
- # id: [Not documented]
- # organization_info_id: Change provider tax id based off the
- # specified organization info
- # super_bill_id: [Not documented]
- ID, : ID, : ID, : ID): User ( :
- # get provider appointment locations.
- #
- # Arguments
- # provider_id: [Not documented]
- ID): [AppointmentLocation!] ( :
- # Returns all cpt codes associated with this provider
- #
- # Arguments
- # provider_id: [Not documented]
- ID): [ProviderCptCodeType!] ( :
- # Fetch generic custom modules for use in the form builder
- #
- # Arguments
- # category: [Not documented]
- String): [CustomModule!] ( :
- # Fetch receipt_line_items collection by super_bill_id
- #
- # Arguments
- # super_bill_id: [Not documented]
- ID): [ReceiptLineItem!] ( :
- # Fetch received direct message via ID
- #
- # Arguments
- # id: [Not documented]
- ID): ReceivedDirectMessage ( :
- # Fetch Received Direct Meessages
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # order_by: [Not documented]
- (
- Int, :
- String, :
- ReceivedDirectMessageOrderKeys :
- ): [ReceivedDirectMessage!]
- # Fetch number of Received Direct Meessages
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- (
- Int, :
- String :
- ): Int
- # Fetch Received Fax by ID
- #
- # Arguments
- # id: The ID of the Received Fax
- ID): ReceivedFax ( :
- # Fetch paginated Received Faxes collection
- #
- # Arguments
- # active_status: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # order_by: [Not documented]
- (
- String, :
- String, :
- Int, :
- ReceivedFaxOrderKeys :
- ): [ReceivedFax!]
- # Number of Received Faxes
- #
- # Arguments
- # active_status: [Not documented]
- # keywords: [Not documented]
- String, : String): Int ( :
- # Fetch recent food items
- #
- # Arguments
- # food_type: [Not documented]
- # keywords: [Not documented]
- # user_id: [Not documented]
- String, : String, : String): [Food!] ( :
- # Fetch recurring forms collection
- #
- # Arguments
- # connectable_id: [Not documented]
- # connectable_type: [Not documented]
- String, : String): [RecurringForm!] ( :
- # Fetch a recurring payment by id
- #
- # Arguments
- # id: [Not documented]
- ID): RecurringPayment ( :
- # Fetch active recurring_payments
- #
- # Arguments
- # active_status: [Not documented]
- # user_id: [Not documented]
- String, : ID): [RecurringPayment!] ( :
- # Fetch Referral by ID
- #
- # Arguments
- # id: The ID of the Referral
- ID): Referral ( :
- # Get referring physician based on id
- #
- # Arguments
- # has_fax_number: [Not documented]
- # id: [Not documented]
- # user_id: The id of the patient the referring physician is
- # associated with
- (
- Boolean, :
- ID, :
- String :
- ): ReferringPhysician
- # all referring physicians based on current user
- #
- # Arguments
- # has_fax_number: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- (
- Boolean, :
- String, :
- Int, :
- Boolean, :
- ReferringPhysicianOrderKeys :
- ): [ReferringPhysician!]
- # Number of referring physicians
- Int :
- # fetch a requested form completion by id
- #
- # Arguments
- # id: [Not documented]
- # track_opened_event: If TRUE, create form history 'opened' event
- (
- ID, :
- Boolean :
- ): RequestedFormCompletion
- # Fetch requested form completions collection
- #
- # Arguments
- # keywords: [Not documented]
- # status: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- String, :
- ID :
- ): [RequestedFormCompletion!]
- # fetch a requested payment (invoice) by id
- #
- # Arguments
- # id: [Not documented]
- # invoice_id: [Not documented]
- # preview: [Not documented]
- # uuid: [Not documented]
- (
- ID, :
- String, :
- Boolean, :
- String :
- ): RequestedPayment
- # Fetch paginated Requested Payments collection
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # only_unpaid: (DEPRECATED) Use status_filter instead
- # preview: [Not documented]
- # sender_id: will return all requested payments with this ID as
- # the sender or recipient
- # order_by: [Not documented]
- # status_filter: Can be paid, partial or unpaid
- (
- String, :
- Int, :
- Boolean, :
- Boolean, :
- ID, :
- RequestedPaymentOrderKeys, :
- String :
- ): [RequestedPayment!]
- # Number of Requested Payments
- #
- # Arguments
- # keywords: [Not documented]
- # only_unpaid: (DEPRECATED) Use status_filter instead
- # sender_id: [Not documented]
- # status_filter: Can be paid, partial or unpaid
- (
- String, :
- Boolean, :
- ID, :
- String :
- ): Int
- # Fetch user's scheduled message blasts
- #
- # Arguments
- # org_chat: If True - returns organization membership scheduled
- # message blasts
- # client_id: Only include relevant scheduled message blasts for
- # client
- # provider_id: ID of the provider to get conversation for (if
- # nil, will return current users)
- # provider_ids: Used to filter org chat conversations by provider
- # ids
- (
- Boolean, :
- String, :
- ID, :
- ID] : [
- ): [NoteScheduler!]
- # Fetch collection of all scheduled packages
- #
- # Arguments
- # user_id: ID of the user to load the list of given packages
- ID): [ScheduledUserPackageSelection!] ( :
- # SDK configuration
- #
- # Arguments
- # version: SDK version to obtain the configuration for
- String): SDKConfig! ( :
- # Fetch sent direct message via ID
- #
- # Arguments
- # id: [Not documented]
- ID): SentDirectMessage ( :
- # Fetch number of Sent Direct Messages
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # order_by: [Not documented]
- (
- Int, :
- String, :
- SentDirectMessageOrderKeys :
- ): [SentDirectMessage!]
- # Fetch number of Sent Direct Meessages
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- Int, : String): Int ( :
- # Fetch paginated Sent Faxes collection
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # order_by: [Not documented]
- String, : Int, : SentFaxOrderKeys): [SentFax!] ( :
- # Number of Sent Faxes
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # Fetch notification list for a specific client or list of clients.
- #
- # Arguments
- # end_date: [Not documented]
- # offset: [Not documented]
- # org_level: Used in conjunction with provider_id. When true,
- # returns sent notification records for all patients in the organization
- # patient_id: The ID of the patient to return sent notification
- # records for.
- # provider_id: When passed in, returns sent notification records
- # for the given provider's patients. Overrides patient_id. Current user must be an
- # admin to use this param
- # should_paginate: Must be true if provider_id is passed in.
- # start_date: [Not documented]
- # status: [Not documented]
- # type: [Not documented]
- (
- String, :
- Int, :
- Boolean, :
- ID, :
- ID, :
- Boolean, :
- String, :
- String, :
- String :
- ): [SentNotificationRecord!]
- # Get number of SentNotificationRecord entries
- #
- # Arguments
- # end_date: [Not documented]
- # org_level: Used in conjunction with provider_id. When true,
- # returns sent notification records for all patients in the organization
- # patient_id: The ID of the patient to return sent notification
- # records for.
- # provider_id: When passed in, returns sent notification records
- # for the given provider's patients. Overrides patient_id. Current user must be an
- # admin to use this param
- # start_date: [Not documented]
- # status: [Not documented]
- # type: [Not documented]
- (
- String, :
- Boolean, :
- ID, :
- ID, :
- String, :
- String, :
- String :
- ): Int
- # Fetch paginated Webhooks collection
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # order_by: [Not documented]
- (
- String, :
- Int, :
- SentWebhookOrderKeys :
- ): [SentWebhook!]
- # Number of Webhooks
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # Fetch serving sizes for a food
- #
- # Arguments
- # food_id: [Not documented]
- String): [ServingSize!] ( :
- # A HTML string of charting note answers
- #
- # Arguments
- # answers: [Not documented]
- # form_answer_group_id: [Not documented]
- # letterhead: [Not documented]
- # user_id: [Not documented]
- (
- String, :
- String, :
- Boolean, :
- String :
- ): String
- # Should current user see scheduled chat tab
- Boolean :
- # Fetch user smart phrases
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- String, : Int, : Boolean): [SmartPhrase!] ( :
- # Get size of user smart phrases that matches the keyword
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # initial cpt codes for a new super bill
- #
- # Arguments
- # form_answer_group_id: [Not documented]
- # form_answer_group_ids: [Not documented]
- # user_id: [Not documented]
- (
- ID, :
- ID], : [
- ID :
- ): [CptCodesSuperBill!]
- # initial icd10 codes for a new super bill
- #
- # Arguments
- # form_answer_group_id: [Not documented]
- # user_id: [Not documented]
- (
- ID, :
- ID :
- ): [IcdCodesSuperBill!]
- # Return providers' state licenses
- #
- # Arguments
- # provider_id: [Not documented]
- # provider_ids: [Not documented]
- ID, : [ID]): [StateLicense!] ( :
- # Default Stripe bank account object associated to a practitioner stripe account
- StripeBankAccountType :
- # Information about the user's stripe company
- StripeCompanyType :
- # An array containing infoformation about countries that stripe supports
- StripeCountry!] : [
- # An object containing info about a country that stripe supports
- #
- # Arguments
- # country_code: [Not documented]
- String): StripeCountry ( :
- # Fetch all stripe payment cards for user
- #
- # Arguments
- # user_id: [Not documented]
- ID): [StripeCustomerDetail!] ( :
- # All subgoals for a given goal
- #
- # Arguments
- # goal_id: [Not documented]
- # offset: [Not documented]
- # user_id: [Not documented]
- ID, : Int, : ID): [Goal!] ( :
- # Number of subgoals
- #
- # Arguments
- # goal_id: [Not documented]
- # offset: [Not documented]
- # user_id: [Not documented]
- ID, : Int, : ID): Int ( :
- # Get the current users subscription
- SubscriptionInstance :
- # fetch a superbill by id
- #
- # Arguments
- # id: [Not documented]
- ID): SuperBill ( :
- # Fetch paginated super bills collection
- #
- # Arguments
- # client_id: [Not documented]
- # keywords: [Not documented]
- # offset: [Not documented]
- # provider_id: [Not documented]
- # order_by: [Not documented]
- # status: status to filter superbills, default all
- (
- ID, :
- String, :
- Int, :
- ID, :
- SuperBillOrderKeys, :
- String :
- ): [SuperBill!]
- # Number of super bills
- #
- # Arguments
- # client_id: [Not documented]
- # keywords: [Not documented]
- # provider_id: [Not documented]
- # status: status to filter superbills, default all
- (
- ID, :
- String, :
- ID, :
- String :
- ): Int
- # Endpoint for Support Dashboard Queries
- SupportDashboardType :
- # A collection of tags related to current patient/provider/organization
- #
- # Arguments
- # applied_to_providers: When true, only returns tags applied to
- # providers in the organization
- # ids: [Not documented]
- # order_by: [Not documented]
- # user_id: [Not documented]
- (
- Boolean, :
- ID], : [
- TagOrderKeys, :
- String :
- ): [Tag!]
- # Number of tags
- #
- # Arguments
- # applied_to_providers: When true, only returns tags applied to
- # providers in the organization
- # ids: [Not documented]
- # user_id: [Not documented]
- Boolean, : [ID], : String): Int ( :
- # Arguments
- # id: [Not documented]
- ID): Task ( :
- # All tasks assigned to a provider or client
- #
- # Arguments
- # client_id: [Not documented]
- # completed_status: [Not documented]
- # created_by_self: Nil -> does nothing, false -> tasks created by
- # others, true -> tasks created by current user
- # keywords: [Not documented]
- # offset: [Not documented]
- # per_page: [Not documented]
- # show_hidden: [Not documented]
- # order_by: [Not documented]
- # type: [Not documented]
- # withoutPagination: [Not documented]
- (
- String, :
- String, :
- Boolean, :
- String, :
- Int, :
- Int, :
- Boolean, :
- TaskOrderKeys, :
- String, :
- Boolean :
- ): [Task!]
- # All tasks assigned to a provider or client
- #
- # Arguments
- # completed_status: [Not documented]
- # created_by_self: Nil -> does nothing, false -> tasks created by
- # others, true -> tasks created by current user
- # keywords: [Not documented]
- # show_hidden: [Not documented]
- # type: [Not documented]
- (
- String, :
- Boolean, :
- String, :
- Boolean, :
- String :
- ): Int
- # fetch transactions for the current user
- #
- # Arguments
- # payout_id: [Not documented]
- # user_id: [Not documented]
- String, : String): [TransactionType!] ( :
- # fetch transfers for the current user
- #
- # Arguments
- # limit: [Not documented]
- # order_by: [Not documented]
- # starting_after: [Not documented]
- Int, : TransferOrderKeys, : String): [TransferType!] ( :
- # Fetch an array of treatment plans and recommended products from Fullscript given
- # a user id
- #
- # Arguments
- # user_id: [Not documented]
- String): [FullscriptTreatmentPlanType!] ( :
- # Get the users completed onboarding items, that are not part of the users current
- # flow
- #
- # Arguments
- # user_id: User to get unassociated onboarding items
- (
- ID :
- ): [CompletedOnboardingItem!]
- # fetch ungrouped course memberhips belonging to a a specific course
- #
- # Arguments
- # course_id: [Not documented]
- # course_status: [Not documented]
- # offset: [Not documented]
- (
- ID, :
- String, :
- Int :
- ): [CourseMembership!]
- # count of ungrouped course memberhips for a specific course
- #
- # Arguments
- # course_id: [Not documented]
- # course_status: [Not documented]
- (
- ID, :
- String :
- ): Int
- # fetch a user by id
- #
- # Arguments
- # clear_notifs: [Not documented]
- # id: [Not documented]
- # or_current_user: [Not documented]
- Boolean, : ID, : Boolean): User ( :
- # fetch a user group by id
- #
- # Arguments
- # id: [Not documented]
- ID): UserGroup ( :
- # Fetch paginated user groups collection
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # order_by: [Not documented]
- # check_group_level_actions: checks the allow_group_level_actions
- # permission on org membership
- (
- String, :
- Int, :
- Boolean, :
- UserGroupOrderKeys, :
- Boolean :
- ): [UserGroup!]
- # Number of user groups
- #
- # Arguments
- # keywords: [Not documented]
- # check_group_level_actions: checks the allow_group_level_actions
- # permission on org membership
- (
- String, :
- Boolean :
- ): Int
- # Fetch collection of all purchased packages
- #
- # Arguments
- # after: Cursor to fetch results after
- # offering_id: ID of the offering to filter the list
- # offset: [Not documented]
- # page_size: [Not documented]
- # user_id: ID of the user to load the list of given packages
- (
- Cursor, :
- ID, :
- Int, :
- Int, :
- ID :
- ): [UserPackageSelection!]
- # Arguments
- # offering_id: ID of the offering to filter the list
- # offset: [Not documented]
- # user_id: ID of the user to load the list of given packages
- (
- ID, :
- Int, :
- ID :
- ): Int
- # Fetch paginated patients collection (use organizationMembers query for
- # providers)
- #
- # Arguments
- # active_status: Possible options: [active, archived]
- # conversation_id: [Not documented]
- # convo_patients_only: [Not documented]
- # expect_conversation_id: When this is true, but conversation_id
- # is nil, we return no users
- # from_superadmin: [Not documented]
- # group_id: [Not documented]
- # has_cc_on_file: When true, only clients with credit cards will
- # be returned. Passing false does nothing
- # id: [Not documented]
- # ids: [Not documented]
- # keywords: [Not documented]
- # limited_to_provider: [Not documented]
- # offset: [Not documented]
- # page_size: The number of users to return (Max 100)
- # provider_id: [Not documented]
- # should_paginate: [Not documented]
- # show_all_by_default: [Not documented]
- # order_by: [Not documented]
- # tag_ids: [Not documented]
- # with_feature_toggles: [Not documented]
- (
- String, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- String, :
- Boolean, :
- ID, :
- ID], : [
- String, :
- Boolean, :
- Int, :
- Int, :
- String, :
- Boolean, :
- Boolean, :
- UserOrderKeys, :
- ID], : [
- Boolean :
- ): [User!]
- # Number of users
- #
- # Arguments
- # active_status: [Not documented]
- # conversation_id: [Not documented]
- # convo_patients_only: [Not documented]
- # expect_conversation_id: When this is true, but conversation_id
- # is nil, we return no users
- # group_id: [Not documented]
- # has_cc_on_file: When true, only clients with credit cards will
- # be returned. Passing false does nothing
- # keywords: [Not documented]
- # limited_to_provider: [Not documented]
- # provider_id: [Not documented]
- # tag_ids: [Not documented]
- (
- String, :
- ID, :
- Boolean, :
- Boolean, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- String, :
- ID] : [
- ): Int
- # Check if a coupon is valid, and return the new price (considered public)
- #
- # Arguments
- # coupon_code: [Not documented]
- # offering_id: [Not documented]
- # provider_id: [Not documented]
- # requested_payment_id: [Not documented]
- (
- String, :
- ID, :
- ID, :
- ID :
- ): ValidateOfferingCoupon
- # Check if a reset passwrd token is valid
- #
- # Arguments
- # token: [Not documented]
- String): Boolean ( :
- # Check if a signup token is valid
- #
- # Arguments
- # token: [Not documented]
- String): Boolean ( :
- # Arguments
- # created_at: Date entry was posted
- # entry_id: Entry to query daily intake total if present.
- String, : ID): Entry ( :
- # Fetch possible Webhook event types
- String!] : [
- # Fetch paginated Webhooks collection
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # order_by: [Not documented]
- String, : Int, : WebhookOrderKeys): [Webhook!] ( :
- # Number of Webhooks
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # Whitelabel setting to use
- #
- # Arguments
- # branded_url: [Not documented]
- String): WhitelabelSetting ( :
- # 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.
- #
- # Arguments
- # mn: The Zoom meeting or webinar number
- # role: The user role. 0 to specify participant, 1 to specify
- # host
- String, : String): String ( :
- }
link Require by
This element is not required by anyone