OBJECT

Query

The query root of this schema. See available queries.

link GraphQL Schema definition

  • type Query {
  • # Search results for allergies, allergens, and reactions
  • #
  • # Arguments
  • # category: accepts drug, environmental, food, pet, and reaction
  • allergySuggestions(category: String): [String]
  • # Fetch an announcement
  • #
  • # Arguments
  • # id: [Not documented]
  • announcement(id: ID): Announcement
  • # Fetch an array of announcements for a provider
  • #
  • # Arguments
  • # offset: [Not documented]
  • # should_paginate: [Not documented]
  • # exclude_dismissed: If true, only show announcements that client
  • # has not dismissed
  • announcements(
  • offset: Int,
  • should_paginate: Boolean,
  • exclude_dismissed: Boolean
  • ): [Announcement]
  • # Number of announcements for a provider
  • #
  • # Arguments
  • # exclude_dismissed: If true, only show announcements that client
  • # has not dismissed
  • announcementsCount(exclude_dismissed: Boolean): Int
  • # 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.
  • appointment(id: ID, include_deleted: Boolean): Appointment
  • # Return protential booking issues for an appointment, date, time, repeats,
  • # attendees, and provider.
  • #
  • # Arguments
  • # attendee_ids: [Not documented]
  • # provider_id: [Not documented]
  • # appointment_type_id: [Not documented]
  • # date: [Not documented]
  • # time: [Not documented]
  • # is_repeating: [Not documented]
  • # repeat_interval: [Not documented]
  • # repeat_times: [Not documented]
  • appointmentBookingWarnings(
  • attendee_ids: [ID],
  • provider_id: ID,
  • appointment_type_id: ID,
  • date: String,
  • time: String,
  • is_repeating: Boolean,
  • repeat_interval: String,
  • repeat_times: String
  • ): [AppointmentBookingWarning]
  • # returns metadata about appointments for provider dashboard
  • #
  • # Arguments
  • # org_level: [Not documented]
  • # only_to_current_date: [Not documented]
  • appointmentFrequencyData(
  • org_level: Boolean,
  • only_to_current_date: Boolean
  • ): [AppointmentDataType]
  • # fetch an appointment location by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • appointmentLocation(id: ID): AppointmentLocation
  • # get appointment locations that the current user can use. (considered public)
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # resource: [Not documented]
  • # location_ids: [Not documented]
  • # provider_id: [Not documented]
  • # 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]
  • # org_level: [Not documented]
  • # provider_ids: [Not documented]
  • appointmentLocations(
  • keywords: String,
  • resource: String,
  • location_ids: String,
  • provider_id: ID,
  • appointment_date: String,
  • appointment_type_id: ID,
  • ids: [Int],
  • org_level: Boolean,
  • provider_ids: [ID]
  • ): [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]
  • appointmentNumberPerDayOfMonth(
  • date: String,
  • include_blockers: Boolean
  • ): String
  • # fetch a Appointment Setting by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • # provider_id: [Not documented]
  • appointmentSetting(id: ID, provider_id: ID): AppointmentSetting
  • # fetch an appointment type by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • appointmentType(id: ID): AppointmentType
  • # Fetch credit history for the specific appointment type
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # appointment_type_id: [Not documented]
  • appointmentTypeCreditChanges(
  • user_id: ID,
  • appointment_type_id: ID
  • ): [AppointmentCreditChange]
  • # Fetch paginated Appointment Type collection (considered public)
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # show_group: [Not documented]
  • # provider_id: [Not documented]
  • # should_paginate: [Not documented]
  • # clients_can_book: [Not documented]
  • # org_level: [Not documented]
  • # offering_id: [Not documented]
  • # appointment_type_ids: JSONified array of ids to include
  • # page_size: [Not documented]
  • # with_deleted_appt_types: [Not documented]
  • appointmentTypes(
  • offset: Int,
  • keywords: String,
  • show_group: Boolean,
  • provider_id: String,
  • should_paginate: Boolean,
  • clients_can_book: Boolean,
  • org_level: Boolean,
  • offering_id: String,
  • appointment_type_ids: String,
  • page_size: Int,
  • with_deleted_appt_types: Boolean
  • ): [AppointmentType]
  • # Number of appointment types (considered public)
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # show_group: [Not documented]
  • # provider_id: [Not documented]
  • # clients_can_book: [Not documented]
  • # org_level: [Not documented]
  • # offering_id: [Not documented]
  • # appointment_type_ids: JSONified array of ids to include
  • # with_deleted_appt_types: [Not documented]
  • appointmentTypesCount(
  • keywords: String,
  • show_group: Boolean,
  • provider_id: String,
  • clients_can_book: Boolean,
  • org_level: Boolean,
  • offering_id: String,
  • appointment_type_ids: String,
  • with_deleted_appt_types: Boolean
  • ): Int
  • # Fetch paginated appointment collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # page_size: The number of appointments to return at one time
  • # (when should_paginate is true). Maximum of 500
  • # keywords: [Not documented]
  • # startDate: [Not documented]
  • # endDate: [Not documented]
  • # specificDay: [Not documented]
  • # currentWeek: [Not documented]
  • # user_id: [Not documented]
  • # filter: Options are 'future', 'past', 'ended', 'didnt-occur'
  • # should_paginate: [Not documented]
  • # colorSchemeId: [Not documented]
  • # provider_id: [Not documented]
  • # provider_ids: [Not documented]
  • # is_org: When true, returns appointments for all providers in
  • # the org
  • # is_active: [Not documented]
  • # is_upcoming: [Not documented]
  • # is_confirmed: [Not documented]
  • # unconfirmed: [Not documented]
  • # include_blockers: [Not documented]
  • # with_others: [Not documented]
  • # show_appointments: [Not documented]
  • # with_all_statuses: [Not documented]
  • # without_status: [Not documented]
  • # sort_by: Allowed options are date_desc, date_asc,
  • # created_at_desc, created_at_asc, updated_at_desc, and updated_at_asc
  • # filter_by_location_id: [Not documented]
  • # filter_by_appointment_status: [Not documented]
  • # filter_by_appointment_type_id: [Not
  • # documented]
  • # filter_by_appointment_type_ids: Returns appointments of the
  • # specified appointment types. Overrides filter_by_appointment_type_id
  • # filter_by_appointment_location_ids: Returns appointments of the
  • # specified appointment locations. Overrides filter_by_location_id
  • # filter_synced_appointments: When true, no pulled-in synced
  • # appointments will be included
  • # filter_by_provider_confirmed: [Not documented]
  • # filter_by_client_confirmed: [Not documented]
  • # 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
  • # is_with_clients: [Not documented]
  • # include_suborganizations: include all providers in the
  • # organization and sub-organizations
  • appointments(
  • offset: Int,
  • page_size: Int,
  • keywords: String,
  • startDate: String,
  • endDate: String,
  • specificDay: String,
  • currentWeek: Boolean,
  • user_id: ID,
  • filter: String,
  • should_paginate: Boolean,
  • colorSchemeId: String,
  • provider_id: ID,
  • provider_ids: [ID],
  • is_org: Boolean,
  • is_active: Boolean,
  • is_upcoming: Boolean,
  • is_confirmed: Boolean,
  • unconfirmed: Boolean,
  • include_blockers: Boolean,
  • with_others: Boolean,
  • show_appointments: Boolean,
  • with_all_statuses: Boolean,
  • without_status: Boolean,
  • sort_by: String,
  • filter_by_location_id: ID,
  • filter_by_appointment_status: String,
  • filter_by_appointment_type_id: ID,
  • filter_by_appointment_type_ids: [ID],
  • filter_by_appointment_location_ids: [ID],
  • filter_synced_appointments: Boolean,
  • filter_by_provider_confirmed: Boolean,
  • filter_by_client_confirmed: Boolean,
  • filter_by_chart_note_written: Boolean,
  • is_with_clients: Boolean,
  • include_suborganizations: Boolean
  • ): [Appointment]
  • # Number of Appointments
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # startDate: [Not documented]
  • # endDate: [Not documented]
  • # specificDay: [Not documented]
  • # currentWeek: [Not documented]
  • # user_id: [Not documented]
  • # filter: [Not documented]
  • # provider_id: [Not documented]
  • # is_org: [Not documented]
  • # is_active: [Not documented]
  • # is_upcoming: [Not documented]
  • # is_confirmed: [Not documented]
  • # unconfirmed: [Not documented]
  • # with_others: [Not documented]
  • # show_appointments: [Not documented]
  • # with_all_statuses: [Not documented]
  • # without_status: [Not documented]
  • # include_blockers: [Not documented]
  • # is_with_clients: [Not documented]
  • # 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_by_appointment_status: [Not documented]
  • # filter_by_appointment_type_id: [Not
  • # documented]
  • # filter_by_appointment_type_ids: Returns appointments of the
  • # specified appointment types. Overrides filter_by_appointment_type_id
  • # filter_by_appointment_location_ids: Returns appointments of the
  • # specified appointment locations. Overrides filter_by_location_id
  • # include_suborganizations: include all providers in the
  • # organization and sub-organizations
  • appointmentsCount(
  • keywords: String,
  • startDate: String,
  • endDate: String,
  • specificDay: String,
  • currentWeek: Boolean,
  • user_id: ID,
  • filter: String,
  • provider_id: ID,
  • is_org: Boolean,
  • is_active: Boolean,
  • is_upcoming: Boolean,
  • is_confirmed: Boolean,
  • unconfirmed: Boolean,
  • with_others: Boolean,
  • show_appointments: Boolean,
  • with_all_statuses: Boolean,
  • without_status: Boolean,
  • include_blockers: Boolean,
  • is_with_clients: Boolean,
  • filter_by_chart_note_written: Boolean,
  • filter_by_location_id: ID,
  • filter_by_appointment_status: String,
  • filter_by_appointment_type_id: ID,
  • filter_by_appointment_type_ids: [ID],
  • filter_by_appointment_location_ids: [ID],
  • include_suborganizations: Boolean
  • ): Int
  • # Data summary for appointment reports
  • #
  • # Arguments
  • # range_start: [Not documented]
  • # range_end: [Not documented]
  • # range_type: [Not documented]
  • # provider_ids: [Not documented]
  • appointmentsSummary(
  • range_start: String,
  • range_end: String,
  • range_type: String,
  • provider_ids: [ID]
  • ): AppointmentSummaryData
  • # Fetch availabilities for range
  • #
  • # Arguments
  • # startDate: [Not documented]
  • # endDate: [Not documented]
  • # includeRepeating: [Not documented]
  • # is_repeating: [Not documented]
  • # one_time: [Not documented]
  • # user_id: [Not documented]
  • # appointment_location_id: [Not documented]
  • # appointment_type_id: [Not documented]
  • # contact_type_id: [Not documented]
  • # provider_id: [Not documented]
  • # availability_provider_id: ID of the provider to show
  • # availabilities for, supercedes provider id and is_org
  • # provider_ids: [Not documented]
  • # is_org: [Not documented]
  • # show_availability: [Not documented]
  • # 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
  • # 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
  • availabilities(
  • startDate: String,
  • endDate: String,
  • includeRepeating: Boolean,
  • is_repeating: Boolean,
  • one_time: Boolean,
  • user_id: String,
  • appointment_location_id: String,
  • appointment_type_id: String,
  • contact_type_id: String,
  • provider_id: ID,
  • availability_provider_id: ID,
  • provider_ids: [ID],
  • is_org: Boolean,
  • show_availability: Boolean,
  • start_date_padding: Int,
  • end_date_padding: Int
  • ): [Availability]
  • # number of availabilities
  • #
  • # Arguments
  • # startDate: [Not documented]
  • # endDate: [Not documented]
  • # appointment_location_id: [Not documented]
  • # appointment_type_id: [Not documented]
  • # provider_id: [Not documented]
  • # is_org: [Not documented]
  • availabilitiesCount(
  • startDate: String,
  • endDate: String,
  • appointment_location_id: String,
  • appointment_type_id: String,
  • provider_id: ID,
  • is_org: Boolean
  • ): Int
  • # Fetch availability
  • #
  • # Arguments
  • # id: [Not documented]
  • availability(id: ID): Availability
  • # Fetch available item types (for use in onboarding items)
  • #
  • # Arguments
  • # onboarding_flow_id: [Not documented]
  • availableItemTypes(onboarding_flow_id: String): String
  • # get open appointment times for a range
  • #
  • # Arguments
  • # start_date: [Not documented]
  • # end_date: [Not documented]
  • # start_date_boundary: When passed in, slots before this will not
  • # be returned. YYYY-MM-DD format
  • # end_date_boundary: When passed in, slots after this will not be
  • # returned. Inclusive. YYYY-MM-DD format
  • # provider_ids: [Not documented]
  • # provider_id: [Not documented]
  • # org_level: [Not documented]
  • # appt_loc_id: [Not documented]
  • # appt_type_id: [Not documented]
  • # appointment_type_ids: An array of group appointment type IDs
  • # can be passed in. When passed in, will return availability for multiple group
  • # appointment types. Overrides appt_type_id.
  • # contact_type: [Not documented]
  • # length: [Not documented]
  • # outside_factors: [Not documented]
  • # timezone: [Not documented]
  • # clients_can_join_waitlist: [Not documented]
  • # 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
  • availableSlotsForRange(
  • start_date: String,
  • end_date: String,
  • start_date_boundary: String,
  • end_date_boundary: String,
  • provider_ids: [String],
  • provider_id: String,
  • org_level: Boolean,
  • appt_loc_id: String,
  • appt_type_id: String,
  • appointment_type_ids: [ID],
  • contact_type: String,
  • length: String,
  • outside_factors: Boolean,
  • timezone: String,
  • clients_can_join_waitlist: Boolean,
  • appointment_to_reschedule_id: ID
  • ): [PotentialAppointmentSlot]
  • # Get the Cms1500 Policies object for a given claim and client
  • #
  • # Arguments
  • # patient_id: [Not documented]
  • # cms1500_id: [Not documented]
  • # rendering_provider_id: [Not documented]
  • # base_date: [Not documented]
  • # form_answer_group_id: [Not documented]
  • baseCms1500ForUser(
  • patient_id: ID,
  • cms1500_id: String,
  • rendering_provider_id: String,
  • base_date: String,
  • form_answer_group_id: ID
  • ): Cms1500
  • # Get basic info about User from signup token
  • #
  • # Arguments
  • # token: [Not documented]
  • basicUserInfoFromToken(token: String): User
  • # DEPRECATED: All ICD Codes that are allowed to be used in healthecare claims
  • billableIcdCodes: [IcdCode]
  • # fetch a billing item by id
  • #
  • # Arguments
  • # id: [Not documented]
  • billingItem(id: ID): BillingItem
  • # Fetch paginated billing items collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # state: [Not documented]
  • # user_id: [Not documented]
  • # provider_id: [Not documented]
  • # client_id: [Not documented]
  • # offerings_only: [Not documented]
  • billingItems(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • state: String,
  • user_id: ID,
  • provider_id: ID,
  • client_id: ID,
  • offerings_only: Boolean
  • ): [BillingItem]
  • # Number of billing items
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # state: [Not documented]
  • # client_id: [Not documented]
  • billingItemsCount(keywords: String, state: String, client_id: ID): Int
  • # fetch a Brand by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • # provider_id: [Not documented]
  • # locationString: [Not documented]
  • # custom_sign_in_path: [Not documented]
  • brand(
  • id: ID,
  • provider_id: ID,
  • locationString: String,
  • custom_sign_in_path: String
  • ): Brand
  • # fetch a Brand by custom sign in path (considered public)
  • #
  • # Arguments
  • # custom_sign_in_path: [Not documented]
  • brandFromCustomSignInPath(
  • custom_sign_in_path: String
  • ): Brand
  • # get info used on authentication pages for either a dietitian or partner
  • #
  • # Arguments
  • # dietitian_id: [Not documented]
  • # partner_name: [Not documented]
  • # code: [Not documented]
  • # invite_code: [Not documented]
  • brandInfo(
  • dietitian_id: String,
  • partner_name: String,
  • code: String,
  • invite_code: String
  • ): BrandInfo
  • # Fetch a calendar view settings for current user
  • calendarViewSetting: CalendarViewSetting
  • # Fetch an array of campaigns for a provider
  • #
  • # Arguments
  • # offset: [Not documented]
  • campaigns(offset: Int): [Campaign]
  • # Number of campaigns for a provider
  • campaignsCount: Int
  • # Check if the user has access to the package buy limit feature
  • #
  • # Arguments
  • # token: [Not documented]
  • canCapOfferingPurchases(token: String): Boolean
  • # Fetch paginated stripe customer accounts with associated errors or soon to
  • # expire credit cards
  • #
  • # Arguments
  • # offset: [Not documented]
  • # sort_by: [Not documented]
  • cardIssues(offset: Int, sort_by: String): [StripeCustomerDetail]
  • # Fetch paginated stripe customer accounts with associated errors or soon to
  • # expire credit cards
  • cardIssuesCount: Int
  • # fetch a single care plan
  • #
  • # Arguments
  • # id: [Not documented]
  • # is_managing_templates: Deprecated. Does nothing
  • carePlan(id: ID, is_managing_templates: Boolean): CarePlan
  • # Fetch paginated care plan collection
  • #
  • # Arguments
  • # patient_id: [Not documented]
  • # offset: [Not documented]
  • # sort_by: [Not documented]
  • # templates_only: [Not documented]
  • # template_search_keywords: [Not documented]
  • carePlans(
  • patient_id: ID,
  • offset: Int,
  • sort_by: String,
  • templates_only: Boolean,
  • template_search_keywords: String
  • ): [CarePlan]
  • # Number of care plans
  • #
  • # Arguments
  • # patient_id: [Not documented]
  • carePlansCount(patient_id: ID): Int
  • # Number of care plans templates
  • carePlansTemplatesCount: Int
  • # fetch a chargeback by the Healthie ID or the Stripe Dispute ID.
  • #
  • # Arguments
  • # id: [Not documented]
  • # stripe_dispute_id: [Not documented]
  • chargeBack(id: ID, stripe_dispute_id: ID): ChargeBack
  • # All items to include in the charting list
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # date: [Not documented]
  • # name: [Not documented]
  • # form_answer_group_id: [Not documented]
  • # filler_id: [Not documented]
  • # custom_module_form_id: [Not documented]
  • # document_id: [Not documented]
  • # keywords: [Not documented]
  • # include_docs: [Not documented]
  • chartingItems(
  • user_id: String,
  • date: String,
  • name: String,
  • form_answer_group_id: String,
  • filler_id: String,
  • custom_module_form_id: ID,
  • document_id: ID,
  • keywords: String,
  • include_docs: Boolean
  • ): [ChartingItemType]
  • # All items to include in the charting list
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # date: [Not documented]
  • # name: [Not documented]
  • # form_answer_group_id: [Not documented]
  • # filler_id: [Not documented]
  • # custom_module_form_id: [Not documented]
  • # document_id: [Not documented]
  • chartingItemsCount(
  • user_id: String,
  • date: String,
  • name: String,
  • form_answer_group_id: String,
  • filler_id: String,
  • custom_module_form_id: ID,
  • document_id: ID
  • ): Int
  • # fetch a Chat Setting
  • #
  • # Arguments
  • # id: [Not documented]
  • chatSetting(id: 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
  • closeToCurrentVideoChats(user_id: String): [Appointment]
  • # fetch a cms1500 by id
  • #
  • # Arguments
  • # id: [Not documented]
  • cms1500(id: ID): Cms1500
  • # Fetch paginated Cms1500s collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # status: [Not documented]
  • # client_id: [Not documented]
  • # provider_id: [Not documented]
  • # should_paginate: [Not documented]
  • cms1500s(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • status: String,
  • client_id: ID,
  • provider_id: ID,
  • should_paginate: Boolean
  • ): [Cms1500]
  • # Number of Cms1500s
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # client_id: [Not documented]
  • # status: [Not documented]
  • # provider_id: [Not documented]
  • cms1500sCount(
  • keywords: String,
  • client_id: ID,
  • status: String,
  • provider_id: ID
  • ): Int
  • # Color Code Options for a given category
  • #
  • # Arguments
  • # color_code_by: [Not documented]
  • # appointment_setting_id: [Not documented]
  • colorCodeOptions(
  • color_code_by: String,
  • appointment_setting_id: String
  • ): [ColorCodeOption]
  • # Fetch comment
  • #
  • # Arguments
  • # id: [Not documented]
  • comment(id: ID): Comment
  • # Fetch comments collection
  • #
  • # Arguments
  • # 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]
  • comments(
  • entry_id: ID,
  • entry_ids: [ID],
  • offset: Int,
  • page_size: Int,
  • should_paginate: 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
  • commentsCount(entry_id: ID, entry_ids: [ID]): Int
  • # fetch a completedCourseItem by course_item_id and user_id
  • #
  • # Arguments
  • # course_item_id: [Not documented]
  • # user_id: [Not documented]
  • completedCourseItem(course_item_id: ID, user_id: ID): CompletedCourseItem
  • # All Contact Types For Current User
  • contactTypes: [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)
  • conversation(id: ID, provider_id: ID): Conversation
  • # fetch a conversation membership by id and owner
  • #
  • # Arguments
  • # id: [Not documented]
  • conversationMembership(id: ID): ConversationMembership
  • # fetch a conversationmembership by id and invitees
  • #
  • # Arguments
  • # id: [Not documented]
  • conversationMembershipInvitees(id: ID): [ConversationMembership]
  • # Fetch paginated conversationmemberships collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # client_id: [Not documented]
  • # active_status: [Not documented]
  • # read_status: [Not documented]
  • # conversation_type: [Not documented]
  • # notes_type: [Not documented]
  • # provider_id: ID of the provider to get conversation for (if
  • # nil, will return current users)
  • conversationMemberships(
  • offset: Int,
  • keywords: String,
  • client_id: String,
  • active_status: String,
  • read_status: String,
  • conversation_type: String,
  • notes_type: String,
  • provider_id: ID
  • ): [ConversationMembership]
  • # Number of conversationmembership
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # active_status: [Not documented]
  • # client_id: [Not documented]
  • # read_status: [Not documented]
  • # conversation_type: [Not documented]
  • # notes_type: [Not documented]
  • # provider_id: ID of the provider to get conversation for (if
  • # nil, will return current users)
  • conversationMembershipsCount(
  • keywords: String,
  • active_status: String,
  • client_id: String,
  • read_status: String,
  • conversation_type: String,
  • notes_type: String,
  • provider_id: ID
  • ): 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
  • conversations(user_id: ID): [Conversation]
  • # Number of conversation
  • #
  • # Arguments
  • # keywords: [Not documented]
  • conversationsCount(keywords: String): Int
  • # fetch a course by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • # course_id: [Not documented]
  • course(id: ID, course_id: ID): Course
  • # fetch clients belonging to a course by course_id
  • #
  • # Arguments
  • # course_id: [Not documented]
  • # course_status: [Not documented]
  • # offset: [Not documented]
  • courseClients(course_id: ID, course_status: String, offset: Int): [CourseMembership]
  • # total number of clients for a specific course
  • #
  • # Arguments
  • # course_id: [Not documented]
  • # course_status: [Not documented]
  • courseClientsCount(course_id: ID, course_status: String): Int
  • # Course group memberships for the course
  • #
  • # Arguments
  • # course_id: [Not documented]
  • # course_group_id: [Not documented]
  • # course_status: [Not documented]
  • # offset: [Not documented]
  • courseGroupClients(
  • course_id: ID,
  • course_group_id: String,
  • course_status: String,
  • offset: Int
  • ): [User]
  • # Total clients in course group memberships
  • #
  • # Arguments
  • # course_status: [Not documented]
  • # course_id: [Not documented]
  • # course_group_id: [Not documented]
  • courseGroupClientsCount(
  • course_status: String,
  • course_id: ID,
  • course_group_id: String
  • ): Int
  • # fetch a courseitem by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • # course_membership_id: [Not documented]
  • courseItem(id: ID, course_membership_id: ID): CourseItem
  • # get all custom custom emails for a current user
  • courseItemCustomEmails: [CustomEmail]
  • # get all documents for current user
  • courseItemDocuments: [Document]
  • # get all custom module forms for a current user
  • courseItemForms: [CustomModuleForm]
  • # Course items info for the course membership
  • #
  • # Arguments
  • # client_id: [Not documented]
  • # course_id: [Not documented]
  • # include_emails: [Not documented]
  • # find_for_provider: [Not documented]
  • courseItems(
  • client_id: ID,
  • course_id: ID,
  • include_emails: Boolean,
  • find_for_provider: Boolean
  • ): [CourseItem]
  • # fetch a courseMembership by id
  • #
  • # Arguments
  • # course_id: [Not documented]
  • # user_id: [Not documented]
  • # id: [Not documented]
  • # course_membership_id: [Not documented]
  • # user_group_id: [Not documented]
  • # course_item_id: [Not documented]
  • courseMembership(
  • course_id: ID,
  • user_id: ID,
  • id: ID,
  • course_membership_id: ID,
  • user_group_id: ID,
  • course_item_id: ID
  • ): CourseMembership
  • # Fetch paginated course membership collection
  • #
  • # Arguments
  • # client_id: [Not documented]
  • # offset: [Not documented]
  • # fetch_all: [Not documented]
  • courseMemberships(client_id: ID, offset: Int, fetch_all: Boolean): [CourseMembership]
  • # Number of course memberships
  • #
  • # Arguments
  • # client_id: [Not documented]
  • courseMembershipsCount(client_id: ID): Int
  • # Fetch paginated course collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # course_type: [Not documented]
  • # should_paginate: [Not documented]
  • # only_available: [Not documented]
  • courses(
  • offset: Int,
  • keywords: String,
  • course_type: String,
  • should_paginate: Boolean,
  • only_available: Boolean
  • ): [Course]
  • # Number of course
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # course_type: [Not documented]
  • coursesCount(keywords: String, course_type: String): Int
  • # All CPT Codes
  • #
  • # Arguments
  • # for_superbill: [Not documented]
  • cptCodes(for_superbill: Boolean): [CptCode]
  • # fetch the current user.
  • currentUser: User
  • # fetch the current users notifications count.
  • currentUserNotificationsCount: UserNotificationsCount
  • # get current video chats for a user.
  • #
  • # Arguments
  • # user_id: User to get current video chats for (if left blank,
  • # defaults to current user)
  • # only_current: [Not documented]
  • currentVideoChats(user_id: String, only_current: Boolean): [Appointment]
  • # A HTML string containing mailer template for certain email type
  • #
  • # Arguments
  • # id: [Not documented]
  • # course_id: [Not documented]
  • # email_type: [Not documented]
  • # greeting: [Not documented]
  • # message_body: [Not documented]
  • # subject: [Not documented]
  • # preview_email_type: [Not documented]
  • # reactivation_wait_days: [Not documented]
  • # find_record: [Not documented]
  • # email_body_only: [Not documented]
  • customEmailPreview(
  • id: String,
  • course_id: String,
  • email_type: String,
  • greeting: String,
  • message_body: String,
  • subject: String,
  • preview_email_type: String,
  • reactivation_wait_days: String,
  • find_record: Boolean,
  • email_body_only: Boolean
  • ): String
  • # Fetch paginated custom emails collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # email_type: [Not documented]
  • # provider_id: [Not documented]
  • customEmails(offset: Int, email_type: String, provider_id: ID): [CustomEmail]
  • # Number of custom emails
  • #
  • # Arguments
  • # email_type: [Not documented]
  • customEmailsCount(email_type: String): Int
  • # fetch a custom module form by id (templates are considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • # default: [Not documented]
  • # charting: [Not documented]
  • customModuleForm(id: ID, default: Boolean, charting: Boolean): CustomModuleForm
  • # All form templates for the current user
  • #
  • # Arguments
  • # include_default_templates: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # category: [Not documented]
  • # offset: [Not documented]
  • # should_paginate: [Not documented]
  • # active_status: [Not documented]
  • customModuleForms(
  • include_default_templates: Boolean,
  • keywords: String,
  • sort_by: String,
  • category: String,
  • offset: Int,
  • should_paginate: Boolean,
  • active_status: Boolean
  • ): [CustomModuleForm]
  • # Fetch paginated count for provider custom module forms
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # include_default_templates: [Not documented]
  • # sort_by: [Not documented]
  • # category: [Not documented]
  • # active_status: [Not documented]
  • customModuleFormsCount(
  • keywords: String,
  • include_default_templates: Boolean,
  • sort_by: String,
  • category: String,
  • active_status: Boolean
  • ): Int
  • # get open appointment times for a range
  • #
  • # Arguments
  • # date_from_month: [Not documented]
  • # start_date_boundary: When passed in, slots before this will not
  • # be returned. YYYY-MM-DD format
  • # end_date_boundary: When passed in, slots after this will not be
  • # returned. Inclusive. YYYY-MM-DD format
  • # provider_ids: [Not documented]
  • # provider_id: [Not documented]
  • # org_level: [Not documented]
  • # appt_loc_id: [Not documented]
  • # appt_type_id: [Not documented]
  • # contact_type: [Not documented]
  • # length: [Not documented]
  • # outside_factors: [Not documented]
  • # timezone: [Not documented]
  • # clients_can_join_waitlist: [Not documented]
  • # 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
  • daysAvailableForRange(
  • date_from_month: String,
  • start_date_boundary: String,
  • end_date_boundary: String,
  • provider_ids: [String],
  • provider_id: String,
  • org_level: Boolean,
  • appt_loc_id: String,
  • appt_type_id: String,
  • contact_type: String,
  • length: String,
  • outside_factors: Boolean,
  • timezone: String,
  • clients_can_join_waitlist: Boolean,
  • appointment_to_reschedule_id: ID
  • ): [String]
  • # fetch a document by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # course_id: [Not documented]
  • # custom_module_id: [Not documented]
  • # care_plan_id: [Not documented]
  • document(id: ID, course_id: ID, custom_module_id: ID, care_plan_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
  • # offset: [Not documented]
  • # document_id: [Not documented]
  • # per_page: The number of document views to return per page.
  • # Maximum 500
  • documentViewings(offset: Int, document_id: ID, per_page: Int): [DocumentViewing]
  • # Number of instances for a document viewings for a specific document
  • #
  • # Arguments
  • # document_id: [Not documented]
  • documentViewingsCount(document_id: ID): Int
  • # Fetch paginated documents collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # folder_id: [Not documented]
  • # file_types: (DEPRECATED)
  • # file_type: [Not documented]
  • # sort_by: [Not documented]
  • # private_user_id: [Not documented]
  • # viewable_user_id: [Not documented]
  • # consolidated_user_id: [Not documented]
  • # filter: [Not documented]
  • # should_paginate: [Not documented]
  • # for_template_use: [Not documented]
  • # provider_id: [Not documented]
  • documents(
  • offset: Int,
  • keywords: String,
  • folder_id: String,
  • file_types: [String],
  • file_type: String,
  • sort_by: String,
  • private_user_id: String,
  • viewable_user_id: String,
  • consolidated_user_id: String,
  • filter: String,
  • should_paginate: Boolean,
  • for_template_use: Boolean,
  • provider_id: ID
  • ): [Document]
  • # Number of documents
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # folder_id: [Not documented]
  • # file_types: [Not documented]
  • # file_type: [Not documented]
  • # private_user_id: [Not documented]
  • # viewable_user_id: [Not documented]
  • # consolidated_user_id: [Not documented]
  • # filter: [Not documented]
  • # provider_id: [Not documented]
  • documentsCount(
  • keywords: String,
  • folder_id: String,
  • file_types: [String],
  • file_type: String,
  • private_user_id: String,
  • viewable_user_id: String,
  • consolidated_user_id: String,
  • filter: String,
  • provider_id: ID
  • ): Int
  • # 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]
  • dosespot_ui_link(patient_id: ID): String
  • # draft by conversation_membership id
  • #
  • # Arguments
  • # conversation_membership_id: [Not documented]
  • draft(conversation_membership_id: ID): Draft
  • # Fetch a link from Fullscript to create a treatment plan for a given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • dynamicLink(user_id: String): String
  • # fetch embed steps based off of params
  • #
  • # Arguments
  • # locationString: [Not documented]
  • # is_for_web: [Not documented]
  • embedWidgetSteps(locationString: String, is_for_web: Boolean): [EmbedWidgetStepType]
  • # Fetch paginated entries collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # type: The type of entry (e.g MetricEntry) to return
  • # keywords: [Not documented]
  • # entry_id: [Not documented]
  • # category: The category of entry (e.g Weight or Blood Pressure)
  • # to return
  • # client_id: [Not documented]
  • # is_org: When true, returns entries for all client in the
  • # organization
  • # 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
  • # start_range: This field takes in a date (e.g 2020-11-28), and
  • # returns entries starting at the beginning of that day
  • # group_id: [Not documented]
  • # sort_by: Options are [created_at::desc,created_at::asc,
  • # metric_stat::desc, metric_stat::asc]
  • # 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
  • # 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
  • # summary_view: [Not documented]
  • entries(
  • offset: Int,
  • type: String,
  • keywords: String,
  • entry_id: String,
  • category: String,
  • client_id: String,
  • is_org: Boolean,
  • end_range: String,
  • start_range: String,
  • group_id: String,
  • sort_by: String,
  • end_datetime_range: String,
  • start_datetime_range: String,
  • summary_view: Boolean
  • ): [Entry]
  • # Number of entries
  • #
  • # Arguments
  • # type: [Not documented]
  • # group_id: [Not documented]
  • # client_id: [Not documented]
  • # is_org: When true, returns entries for all client in the
  • # organization
  • # keywords: [Not documented]
  • # category: [Not documented]
  • # 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
  • # start_range: This field takes in a date (e.g 2020-11-28), and
  • # returns entries starting at the beginning of that day
  • # 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
  • # 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
  • # 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
  • entriesCount(
  • type: String,
  • group_id: String,
  • client_id: String,
  • is_org: Boolean,
  • keywords: String,
  • category: String,
  • end_range: String,
  • start_range: String,
  • end_datetime_range: String,
  • start_datetime_range: String,
  • maximum_count: Int
  • ): Int
  • # fetch an entry by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # type: [Not documented]
  • # client_id: [Not documented]
  • entry(id: ID, type: String, client_id: ID): Entry
  • # fetch a featureToggle by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # user_id: [Not documented]
  • featureToggle(id: ID, user_id: ID): FeatureToggle
  • # fetch a featureToggle by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # user_id: [Not documented]
  • # user_group_id: [Not documented]
  • # care_plan_id: [Not documented]
  • featureToggleForEditing(
  • id: ID,
  • user_id: ID,
  • user_group_id: ID,
  • care_plan_id: ID
  • ): FeatureToggle
  • # fetch a folder by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # custom_module_id: [Not documented]
  • folder(id: String, custom_module_id: ID): Folder
  • # Fetch paginated folders collection
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # folder_id: [Not documented]
  • # sort_by: [Not documented]
  • # private_user_id: [Not documented]
  • # viewable_user_id: [Not documented]
  • # consolidated_user_id: [Not documented]
  • # filter: [Not documented]
  • # should_paginate: [Not documented]
  • # folder_to_move_id: [Not documented]
  • # document_to_move_id: [Not documented]
  • # provider_id: [Not documented]
  • # for_template_use: [Not documented]
  • # client_id: [Not documented]
  • folders(
  • keywords: String,
  • folder_id: String,
  • sort_by: String,
  • private_user_id: String,
  • viewable_user_id: String,
  • consolidated_user_id: String,
  • filter: String,
  • should_paginate: Boolean,
  • folder_to_move_id: ID,
  • document_to_move_id: ID,
  • provider_id: ID,
  • for_template_use: Boolean,
  • client_id: String
  • ): [Folder]
  • # Number of folders
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # folder_id: [Not documented]
  • # private_user_id: [Not documented]
  • # viewable_user_id: [Not documented]
  • # consolidated_user_id: [Not documented]
  • # filter: [Not documented]
  • # provider_id: [Not documented]
  • foldersCount(
  • keywords: String,
  • folder_id: String,
  • private_user_id: String,
  • viewable_user_id: String,
  • consolidated_user_id: String,
  • filter: String,
  • provider_id: ID
  • ): Int
  • # Fetch food items
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # offset: [Not documented]
  • # food_type: [Not documented]
  • # user_id: [Not documented]
  • # exclude_recent: [Not documented]
  • foodSearch(
  • keywords: String,
  • offset: Int,
  • food_type: String,
  • user_id: String,
  • exclude_recent: Boolean
  • ): [Food]
  • # Get size of food items that matches the keyword
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # food_type: [Not documented]
  • # user_id: [Not documented]
  • # exclude_recent: [Not documented]
  • foodSearchCount(
  • keywords: String,
  • food_type: String,
  • user_id: String,
  • exclude_recent: Boolean
  • ): Int
  • # Fetch a form answer group by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # for_superbills: [Not documented]
  • # ids: [Not documented]
  • formAnswerGroup(id: ID, for_superbills: Boolean, ids: [ID]): FormAnswerGroup
  • # All filled forms for a given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # date: [Not documented]
  • # name: [Not documented]
  • # form_answer_group_id: [Not documented]
  • # filler_id: [Not documented]
  • # custom_module_form_id: [Not documented]
  • formAnswerGroups(
  • user_id: String,
  • date: String,
  • name: String,
  • form_answer_group_id: String,
  • filler_id: String,
  • custom_module_form_id: ID
  • ): [FormAnswerGroup]
  • # All filled forms for a given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # date: [Not documented]
  • # name: [Not documented]
  • # form_answer_group_id: [Not documented]
  • # filler_id: [Not documented]
  • formAnswerGroupsCount(
  • user_id: String,
  • date: String,
  • name: String,
  • form_answer_group_id: String,
  • filler_id: String
  • ): Int
  • # Fetch available forms to request
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • formTypesToRequest(keywords: String, sort_by: String): [FormTypesToRequest]
  • # Fullscript practitioners that share the same clinic id as organization owner
  • fullscriptPractitionerTypes: [FullscriptPractitionerTypeType]
  • # Fullscript practitioners that share the same clinic id as organization owner
  • fullscriptPractitioners: [FullscriptPractitionerType]
  • # fetch a goal by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # program_goal: [Not documented]
  • # client_id: [Not documented]
  • # last_client_goal: [Not documented]
  • goal(id: ID, program_goal: Boolean, client_id: ID, last_client_goal: Boolean): Goal
  • # All completed goals for a given set of users
  • #
  • # Arguments
  • # offset: [Not documented]
  • # user_id: [Not documented]
  • # category: [Not documented]
  • # unique: [Not documented]
  • # should_paginate: [Not documented]
  • # include_subgoals: [Not documented]
  • goalHistories(
  • offset: Int,
  • user_id: ID,
  • category: String,
  • unique: Boolean,
  • should_paginate: Boolean,
  • include_subgoals: Boolean
  • ): [GoalHistory]
  • # All completed goals for a given set of users
  • #
  • # Arguments
  • # offset: [Not documented]
  • # user_id: [Not documented]
  • # category: [Not documented]
  • # unique: [Not documented]
  • # include_subgoals: [Not documented]
  • goalHistoriesCount(
  • offset: Int,
  • user_id: ID,
  • category: String,
  • unique: Boolean,
  • include_subgoals: Boolean
  • ): Int
  • # Fetch goal history
  • #
  • # Arguments
  • # id: [Not documented]
  • goalHistory(id: ID): GoalHistory
  • # A goal's instances
  • #
  • # Arguments
  • # offset: [Not documented]
  • # goal_id: [Not documented]
  • # keywords: [Not documented]
  • # start_range: [Not documented]
  • # end_range: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # per_page: [Not documented]
  • goalInstances(
  • offset: Int,
  • goal_id: ID,
  • keywords: String,
  • start_range: String,
  • end_range: String,
  • status_filter: String,
  • per_page: Int
  • ): [GoalInstance]
  • # Number of instances for a goal
  • #
  • # Arguments
  • # offset: [Not documented]
  • # goal_id: [Not documented]
  • # keywords: [Not documented]
  • # start_range: [Not documented]
  • # end_range: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # per_page: [Not documented]
  • goalInstancesCount(
  • offset: Int,
  • goal_id: ID,
  • keywords: String,
  • start_range: String,
  • end_range: String,
  • status_filter: String,
  • per_page: Int
  • ): Int
  • # Goal templates for given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # keywords: [Not documented]
  • # offset: DEPRECATED
  • # category: Can be 'personal', 'organizational', or 'default'
  • goalTemplates(
  • user_id: ID,
  • keywords: String,
  • offset: Int,
  • category: String
  • ): [GoalTemplate]
  • # Number of Goal templates for given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # keywords: [Not documented]
  • goalTemplatesCount(user_id: ID, keywords: String): Int
  • # All goals, either for a given user or for all of the providers clients
  • #
  • # Arguments
  • # offset: [Not documented]
  • # user_id: [Not documented]
  • # category: [Not documented]
  • # sort_by: [Not documented]
  • # rel_goal_id: [Not documented]
  • # keywords: [Not documented]
  • # start_range: [Not documented]
  • # end_range: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # frequency_filter: Can be daily, weekly, or one_time
  • # per_page: [Not documented]
  • goals(
  • offset: Int,
  • user_id: ID,
  • category: String,
  • sort_by: String,
  • rel_goal_id: String,
  • keywords: String,
  • start_range: String,
  • end_range: String,
  • status_filter: String,
  • frequency_filter: String,
  • per_page: Int
  • ): [Goal]
  • # Number of goal
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # offset: [Not documented]
  • # category: [Not documented]
  • # rel_goal_id: [Not documented]
  • # sort_by: [Not documented]
  • # keywords: [Not documented]
  • # start_range: [Not documented]
  • # end_range: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # frequency_filter: Can be daily, weekly, or one_time
  • goalsCount(
  • user_id: ID,
  • offset: Int,
  • category: String,
  • rel_goal_id: String,
  • sort_by: String,
  • keywords: String,
  • start_range: String,
  • end_range: String,
  • status_filter: String,
  • frequency_filter: String
  • ): Int
  • # All goals data
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # offset: [Not documented]
  • # per_page: [Not documented]
  • # category: Search over goals' repeat property
  • # keywords: Search over goals' names and descriptions
  • # end_range: [Not documented]
  • # rel_goal_id: the goal ID
  • # start_range: [Not documented]
  • # sort_by: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # frequency_filter: Can be daily, weekly, or one_time
  • goalsData(
  • user_id: ID,
  • offset: Int,
  • per_page: Int,
  • category: String,
  • keywords: String,
  • end_range: String,
  • rel_goal_id: String,
  • start_range: String,
  • sort_by: String,
  • status_filter: String,
  • frequency_filter: String
  • ): GoalDataType
  • # Overall completion percentage of goals
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # offset: [Not documented]
  • # category: [Not documented]
  • # rel_goal_id: [Not documented]
  • # sort_by: [Not documented]
  • # keywords: [Not documented]
  • # start_range: [Not documented]
  • # end_range: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # frequency_filter: Can be daily, weekly, or one_time
  • goalsOverallCompletionRate(
  • user_id: ID,
  • offset: Int,
  • category: String,
  • rel_goal_id: String,
  • sort_by: String,
  • keywords: String,
  • start_range: String,
  • end_range: String,
  • status_filter: String,
  • frequency_filter: String
  • ): Int @deprecated( reason: "Use goalsOverallCompletionRateInfo instead" )
  • # Overall completion percentage of goals
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # offset: [Not documented]
  • # category: [Not documented]
  • # rel_goal_id: (DEPRECATED) Use goal_id instead as it is the
  • # correct type(types.ID)
  • # goal_id: [Not documented]
  • # sort_by: [Not documented]
  • # keywords: [Not documented]
  • # start_range: [Not documented]
  • # end_range: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # frequency_filter: Can be daily, weekly, or one_time
  • goalsOverallCompletionRateInfo(
  • user_id: ID,
  • offset: Int,
  • category: String,
  • rel_goal_id: String,
  • goal_id: ID,
  • sort_by: String,
  • keywords: String,
  • start_range: String,
  • end_range: String,
  • status_filter: String,
  • frequency_filter: String
  • ): GoalOverallCompletionRateInfo
  • # Overall completion percentage of goals
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # offset: [Not documented]
  • # category: [Not documented]
  • # rel_goal_id: (DEPRECATED) Use goal_id instead as it is the
  • # correct type(types.ID)
  • # goal_id: [Not documented]
  • # sort_by: [Not documented]
  • # keywords: [Not documented]
  • # start_range: [Not documented]
  • # end_range: [Not documented]
  • # status_filter: Can be complete or not_complete
  • # frequency_filter: Can be daily, weekly, or one_time
  • goalsStreakCount(
  • user_id: ID,
  • offset: Int,
  • category: String,
  • rel_goal_id: String,
  • goal_id: ID,
  • sort_by: String,
  • keywords: String,
  • start_range: String,
  • end_range: String,
  • status_filter: String,
  • frequency_filter: String
  • ): Int
  • # When true, the user can set up question conditions in the form builder
  • hasConditionalQuestionEditing: Boolean
  • # When true, the user can add sublabels to questions in the form builder
  • hasSubLabels: Boolean
  • # Fetch a single health assessment
  • #
  • # Arguments
  • # email: [Not documented]
  • # user_id: [Not documented]
  • # device_type: [Not documented]
  • # device_token: [Not documented]
  • # run_id: [Not documented]
  • healthAssessment(
  • email: String,
  • user_id: ID,
  • device_type: String,
  • device_token: String,
  • run_id: ID
  • ): HealthAssessment
  • # Fetch Health Assessments
  • #
  • # Arguments
  • # email: [Not documented]
  • # user_id: [Not documented]
  • # device_type: [Not documented]
  • # device_token: [Not documented]
  • # run_id: [Not documented]
  • healthAssessments(
  • email: String,
  • user_id: ID,
  • device_type: String,
  • device_token: String,
  • run_id: ID
  • ): [HealthAssessment]
  • # Fetch ICD Code by ID
  • #
  • # Arguments
  • # id: [Not documented]
  • icdCode(id: ID): IcdCode
  • # All ICD Codes
  • #
  • # Arguments
  • # is_favorited: The favorited status of the ICD Code
  • # is_billable: [Not documented]
  • # offset: [Not documented]
  • # should_paginate: Whether results are paginated, highly
  • # recommended for use
  • # keywords: [Not documented]
  • icdCodes(
  • is_favorited: Boolean,
  • is_billable: Boolean,
  • offset: Int,
  • should_paginate: Boolean,
  • keywords: String
  • ): [IcdCode]
  • # Count of all ICD Codes
  • #
  • # Arguments
  • # is_favorited: The favorited status of the ICD Code
  • # is_billable: [Not documented]
  • # keywords: [Not documented]
  • icdCodesCount(
  • is_favorited: Boolean,
  • is_billable: Boolean,
  • keywords: String
  • ): Int
  • # fetch import data request by user_id
  • #
  • # Arguments
  • # user_id: [Not documented]
  • importDataRequest(user_id: ID): ImportDataRequest
  • # A new CMS1500 form with some objects already prefilled
  • #
  • # Arguments
  • # provider_id: [Not documented]
  • # form_answer_group_id: [Not documented]
  • # patient_id: [Not documented]
  • initialCms1500(
  • provider_id: String,
  • form_answer_group_id: ID,
  • patient_id: ID
  • ): Cms1500
  • # Initial form answers for a given user and template
  • #
  • # Arguments
  • # custom_module_form_id: [Not documented]
  • # user_id: [Not documented]
  • # incomplete_form_id: [Not documented]
  • initialFormAnswers(
  • custom_module_form_id: ID,
  • user_id: ID,
  • incomplete_form_id: ID
  • ): [FormAnswer]
  • # appointment types related to offering
  • #
  • # Arguments
  • # offering_id: [Not documented]
  • initializedOfferingIncludes(offering_id: ID): [OfferingInclude]
  • # Insurance Authorization belonging to a client
  • #
  • # Arguments
  • # client_id: Client to get insurance authorization for
  • # id: id of insurance authorization
  • insuranceAuthorization(client_id: ID, id: ID): InsuranceAuthorizationType
  • # Get all potential insurance plans
  • #
  • # Arguments
  • # ids: Array of plan ids
  • # keywords: Search keywords
  • # is_accepted: The accepted status of the insurance plan
  • # sort_by: [Not documented]
  • # offset: [Not documented]
  • # should_paginate: [Not documented]
  • insurancePlans(
  • ids: String,
  • keywords: String,
  • is_accepted: Boolean,
  • sort_by: String,
  • offset: Int,
  • should_paginate: Boolean
  • ): [InsurancePlan]
  • # Get all potential insurance plans
  • #
  • # Arguments
  • # ids: Array of plan ids
  • # keywords: Search keywords
  • # is_accepted: The accepted status of the insurance plan
  • insurancePlansCount(
  • ids: String,
  • keywords: String,
  • is_accepted: Boolean
  • ): Int
  • # Fetch intake flow
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • intakeFlow(user_id: ID, keywords: String, sort_by: String): IntakeFlowType
  • # Fetch list of available integrations
  • #
  • # Arguments
  • # category: [Not documented]
  • integrationsList(category: String): [IntegrationCategoryType]
  • # Initial date of service for a new form answer group
  • #
  • # Arguments
  • # appointment_id: [Not documented]
  • # user_id: [Not documented]
  • intitialServiceDate(appointment_id: ID, user_id: ID): String
  • # get the base price for the invoice based off the associated item
  • #
  • # Arguments
  • # offering_id: [Not documented]
  • # cms1500_id: [Not documented]
  • invoiceBasePrice(offering_id: ID, cms1500_id: ID): String
  • # Arguments
  • # keywords: [Not documented]
  • invoiceTemplates(keywords: String): [RequestedPaymentTemplate]
  • # Fetch all lab options (considered public)
  • labOptions: [LabOption]
  • # Fetch onboarding flows collection
  • #
  • # Arguments
  • # id: [Not documented]
  • labOrder(id: ID): LabOrder
  • # Fetch onboarding flows collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # should_paginate: [Not documented]
  • labOrders(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • should_paginate: Boolean
  • ): [LabOrder]
  • # Number of onboarding flows
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • labOrdersCount(offset: Int, keywords: String, sort_by: 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)
  • lastCM(active_status: String, provider_id: ID): ConversationMembership
  • # The 6 most recently active clients
  • #
  • # Arguments
  • # limit: [Not documented]
  • lastClientActivities(limit: Int): [User]
  • # has loadMoreNotes been called
  • loadMoreNotesCalled: Boolean
  • # fetch a location by id
  • #
  • # Arguments
  • # id: [Not documented]
  • location(id: ID): Location
  • # Get location resources
  • #
  • # Arguments
  • # location_ids: [Not documented]
  • locationResources(location_ids: String): [LocationResourceType]
  • # Get locations for a given user (or current user)
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # has_name: Pass in true to get service facilities for CMS 1500
  • locations(user_id: String, has_name: Boolean): [Location]
  • # Fetch user meals
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # offset: [Not documented]
  • # user_id: [Not documented]
  • mealSearch(keywords: String, offset: Int, user_id: String): [Meal]
  • # Get size of user meals that matches the keyword
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # user_id: [Not documented]
  • mealSearchCount(keywords: String, user_id: String): Int
  • # Meal plan options from user Living Plate account. Nil if no Living Plate account
  • # associated
  • meal_plan_options: [MealPlan]
  • # Fetch an array of medications options queried from Dosespot API
  • #
  • # Arguments
  • # keywords: [Not documented]
  • medication_options(keywords: String): [MedicationOptionType]
  • # Fetch an array of medications for a given patient
  • #
  • # Arguments
  • # patient_id: [Not documented]
  • # active: [Not documented]
  • medications(patient_id: ID, active: Boolean): [MedicationType]
  • # Fetch count of medications for a given patient
  • #
  • # Arguments
  • # patient_id: [Not documented]
  • # active: [Not documented]
  • medications_count(patient_id: ID, active: Boolean): Int
  • # Fetch data for the metric graphs for a given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # category: [Not documented]
  • # multiplier: [Not documented]
  • # start_date: Start of the date range, must be sent in with an
  • # end date.
  • # 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
  • metricGraphData(
  • user_id: String,
  • category: String,
  • multiplier: String,
  • start_date: String,
  • end_date: String,
  • entry_type: String,
  • has_third_party_source: Boolean
  • ): MetricGraphDataType
  • # Fetch data for the metric graphs for a given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # start_date: Start of the date range, must be sent in with an
  • # end date.
  • # 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
  • metricGraphsData(
  • user_id: String,
  • start_date: String,
  • end_date: String,
  • has_third_party_source: Boolean
  • ): [MetricGraphDataType!]
  • # Arguments
  • # lab_option_ids: [Not documented]
  • # state: [Not documented]
  • minimumOfferingPrice(lab_option_ids: [ID], state: String): String
  • # returns metadata about montly payments
  • #
  • # Arguments
  • # org_level: [Not documented]
  • # gross: [Not documented]
  • monthlyBillingItemsData(
  • org_level: Boolean,
  • gross: Boolean
  • ): [MonthlyBillingItemsDataType]
  • # Fetch data for multi line metric graphs for a given user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # category: [Not documented]
  • # start_date: Start of the date range, must be sent in with an
  • # end date.
  • # end_date: End of the date range, must be sent in with a start
  • # date.
  • # entry_type: [Not documented]
  • # food_graph_type: [Not documented]
  • # sub_category: [Not documented]
  • multiLineMetricGraphData(
  • user_id: String,
  • category: String,
  • start_date: String,
  • end_date: String,
  • entry_type: String,
  • food_graph_type: String,
  • sub_category: String
  • ): MultiLineMetricGraphDataType
  • # String containing info for the user about the client upgrade price
  • #
  • # Arguments
  • # new_client_num: [Not documented]
  • newClientPriceString(new_client_num: Int): String
  • # String containing info for the user about the org upgrade price
  • #
  • # Arguments
  • # new_provder_num: [Not documented]
  • newOrganizationPriceString(new_provder_num: 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]
  • newOrganizationSupportPriceString(
  • new_support_num: Int
  • ): [String]
  • # Fetch closest appointment
  • nextAppointment: Appointment
  • # get open appointment times for a range
  • #
  • # Arguments
  • # provider_ids: [Not documented]
  • # provider_id: [Not documented]
  • # start_date_boundary: When passed in, slots before this will not
  • # be returned. YYYY-MM-DD format
  • # end_date_boundary: When passed in, slots after this will not be
  • # returned. Inclusive. YYYY-MM-DD format
  • # org_level: [Not documented]
  • # appt_type_id: [Not documented]
  • # length: [Not documented]
  • # 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]
  • # timezone: [Not documented]
  • # contact_type: [Not documented]
  • # outside_factors: [Not documented]
  • nextAvailableSlot(
  • provider_ids: [String],
  • provider_id: String,
  • start_date_boundary: String,
  • end_date_boundary: String,
  • org_level: Boolean,
  • appt_type_id: String,
  • length: String,
  • appointment_to_reschedule_id: ID,
  • appt_loc_id: String,
  • timezone: String,
  • contact_type: String,
  • outside_factors: Boolean
  • ): String
  • # fetch a courseitem by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • nextCourseItem(id: ID): CourseItem
  • # fetch a note by id
  • #
  • # Arguments
  • # id: [Not documented]
  • note(id: ID): Note
  • # get the viewed status of a note
  • #
  • # Arguments
  • # id: [Not documented]
  • noteViewedStatus(id: ID): Boolean
  • # Fetch note scheduler by id
  • #
  • # Arguments
  • # id: [Not documented]
  • note_scheduler(id: ID): NoteScheduler
  • # Fetch paginated note collection for given conversation
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # conversation_id: [Not documented]
  • # since_note_id: [Not documented]
  • # sort_by: [Not documented]
  • # scheduled_notes: [Not documented]
  • # provider_id: [Not documented]
  • notes(
  • offset: Int,
  • keywords: String,
  • conversation_id: ID,
  • since_note_id: ID,
  • sort_by: String,
  • scheduled_notes: Boolean,
  • provider_id: ID
  • ): [Note]
  • # Number of notes
  • #
  • # Arguments
  • # conversation_id: [Not documented]
  • # keywords: [Not documented]
  • # scheduled_notes: [Not documented]
  • # provider_id: [Not documented]
  • notesCount(
  • conversation_id: ID,
  • keywords: String,
  • scheduled_notes: Boolean,
  • provider_id: ID
  • ): Int
  • # get count of notifications for a given user (or for the current user)
  • #
  • # Arguments
  • # other_party_id: [Not documented]
  • # types: [Not documented]
  • # categories: (DEPRECATED) This argument is not used, and does
  • # not do anything.
  • # seen_status: [Not documented]
  • # read_status: [Not documented]
  • # page_size: (DEPRECATED) This argument is not used, and does not
  • # do anything.
  • notificationCount(
  • other_party_id: String,
  • types: [String],
  • categories: [String],
  • seen_status: Boolean,
  • read_status: Boolean,
  • page_size: Int
  • ): Int
  • # fetch a Notification Setting by id
  • #
  • # Arguments
  • # id: [Not documented]
  • notificationSetting(id: ID): NotificationSetting
  • # get notifications for a given user (or for the current user)
  • #
  • # Arguments
  • # other_party_id: [Not documented]
  • # types: [Not documented]
  • # seen_status: [Not documented]
  • # read_status: [Not documented]
  • # offset: [Not documented]
  • # sort_by: Options are created_at_asc and created_at_desc.
  • # Defaults to created_at_desc
  • # page_size: [Not documented]
  • notifications(
  • other_party_id: String,
  • types: [String],
  • seen_status: Boolean,
  • read_status: Boolean,
  • offset: Int,
  • sort_by: String,
  • page_size: Int
  • ): [Notification]
  • # fetch an offering by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • offering(id: ID): Offering
  • # Fetch paginated list of users associated with an offering
  • #
  • # Arguments
  • # offset: [Not documented]
  • # offering_id: [Not documented]
  • offeringBillingItems(offset: Int, offering_id: ID): [BillingItem]
  • # Number of users associated with an offering
  • #
  • # Arguments
  • # offering_id: [Not documented]
  • offeringBillingItemsCount(offering_id: ID): Int
  • # Fetch paginated coupon offerings collection
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # user_id: [Not documented]
  • # offset: [Not documented]
  • # from_package_details: [Not documented]
  • offeringCoupons(
  • keywords: String,
  • sort_by: String,
  • user_id: ID,
  • offset: Int,
  • from_package_details: Boolean
  • ): [OfferingCoupon]
  • # Number of offering coupons
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # from_package_details: [Not documented]
  • offeringCouponsCount(
  • keywords: String,
  • from_package_details: Boolean
  • ): 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
  • offeringGroupVisibilities(provider_id: ID): [OfferingGroupVisibility]
  • # All OfferingImage that have no user_id
  • offeringImages: [OfferingImage]
  • # Fetch paginated offerings collection (considered public)
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # provider_id: [Not documented]
  • # offering_id: [Not documented]
  • # only_client_visible: [Not documented]
  • # should_paginate: [Not documented]
  • # offering_ids: [Not documented]
  • # status: [Not documented]
  • # client_visibility: [Not documented]
  • # offering_user_group_id: [Not documented]
  • # show_only_visible: [Not documented]
  • offerings(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • provider_id: ID,
  • offering_id: ID,
  • only_client_visible: Boolean,
  • should_paginate: Boolean,
  • offering_ids: [ID],
  • status: String,
  • client_visibility: String,
  • offering_user_group_id: ID,
  • show_only_visible: Boolean
  • ): [Offering]
  • # Number of offerings (considered public)
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # provider_id: [Not documented]
  • # offering_id: [Not documented]
  • # only_client_visible: [Not documented]
  • # should_paginate: [Not documented]
  • # offering_ids: [Not documented]
  • # status: [Not documented]
  • # client_visibility: [Not documented]
  • # offering_user_group_id: [Not documented]
  • offeringsCount(
  • keywords: String,
  • provider_id: ID,
  • offering_id: ID,
  • only_client_visible: Boolean,
  • should_paginate: Boolean,
  • offering_ids: [ID],
  • status: String,
  • client_visibility: String,
  • offering_user_group_id: ID
  • ): Int
  • # returns metadata about offerings purchased
  • #
  • # Arguments
  • # org_level: [Not documented]
  • offeringsData(org_level: Boolean): [OfferingsDataType]
  • # fetch the current users officeally sftp connection
  • officeallySftpAccount: OfficeallySftpAccount
  • # fetch an onboarding flow by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # user_id: [Not documented]
  • onboardingFlow(id: ID, user_id: ID): OnboardingFlow
  • # Fetch onboarding flows collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # should_paginate: [Not documented]
  • onboardingFlows(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • should_paginate: Boolean
  • ): [OnboardingFlow]
  • # Number of onboarding flows
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • onboardingFlowsCount(
  • offset: Int,
  • keywords: String,
  • sort_by: String
  • ): Int
  • # fetch an onboarding item by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • onboardingItem(id: ID): OnboardingItem
  • # fetch an organization by id, by provider id, or by the current_user, demographic
  • # org info is (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • # provider_id: [Not documented]
  • # provider_ids: [Not documented]
  • # for_client: [Not documented]
  • # email: [Not documented]
  • organization(
  • id: ID,
  • provider_id: ID,
  • provider_ids: [ID],
  • for_client: Boolean,
  • email: String
  • ): Organization
  • # fetch organization info by id
  • #
  • # Arguments
  • # id: [Not documented]
  • organizationInfo(id: ID): OrganizationInfo
  • # fetch members of organization
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • organizationMembers(
  • offset: Int,
  • keywords: String,
  • sort_by: String
  • ): [User]
  • # org members count
  • #
  • # Arguments
  • # keywords: [Not documented]
  • organizationMembersCount(keywords: String): Int
  • # Get the organization membership info of the current user, basic org member info
  • # is (considered public)
  • #
  • # Arguments
  • # user_id: [Not documented]
  • organizationMembership(user_id: ID): OrganizationMembership
  • # Get the organization memberships
  • #
  • # Arguments
  • # id: [Not documented]
  • # sort_by: [Not documented]
  • organizationMemberships(id: String, sort_by: String): [OrganizationMembership]
  • # fetch an Other Id Number by id
  • #
  • # Arguments
  • # id: [Not documented]
  • otherIdNumber(id: ID): OtherIdNumber
  • # returns true if the there are more transfers to load
  • #
  • # Arguments
  • # limit: [Not documented]
  • # starting_after: [Not documented]
  • paginate_transfers(limit: Int, starting_after: String): Boolean
  • # Fetch an array of pharmacies given search parameters
  • #
  • # Arguments
  • # name: keywords for name of pharmacy, requires at least 3
  • # characters
  • # city: requires at least 3 characters
  • # state: two letter abbreviation (i.e ny, ca, md)
  • # zip: requires at least 3 numeric characters
  • # address: requires at least 3 characters
  • # phone_or_fax: [Not documented]
  • # specialties: Array of pharmacy types. accepted values: EPCS,
  • # TwentyFourHourPharmacy, LongTermCarePharmacy, MailOrder, SpecialtyPharmacy,
  • # Retail
  • # ncpdp_id: [Not documented]
  • pharmacies(
  • name: String,
  • city: String,
  • state: String,
  • zip: String,
  • address: String,
  • phone_or_fax: String,
  • specialties: [String],
  • ncpdp_id: String
  • ): [Pharmacy]
  • # fetch all place of services
  • placeOfServices: [PlaceOfService]
  • # fetch a Plan by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • plan(id: ID): Plan
  • # fetch a policy by id
  • #
  • # Arguments
  • # id: [Not documented]
  • policy(id: ID): Policy
  • # Fetch collection of preferred CPT/ICD codes
  • #
  • # Arguments
  • # code_type: [Not documented]
  • preferred_medical_codes(code_type: String): [PreferredMedicalCode]
  • # Fetch an array of prescriptions for a given patient pulled from Dosespot
  • #
  • # Arguments
  • # patient_id: [Not documented]
  • # status: [Not documented]
  • prescriptions(patient_id: ID, status: String): [Prescription]
  • # fetch a courseitem by id (considered public)
  • #
  • # Arguments
  • # id: [Not documented]
  • prevCourseItem(id: ID): CourseItem
  • # Fetch paginated product collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # should_paginate: [Not documented]
  • products(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • should_paginate: Boolean
  • ): [Product]
  • # Number of products
  • #
  • # Arguments
  • # keywords: [Not documented]
  • productsCount(keywords: String): Int
  • # fetch a provider by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # super_bill_id: [Not documented]
  • # client_id: [Not documented]
  • # organization_info_id: Change provider tax id based off the
  • # specified organization info
  • provider(id: ID, super_bill_id: ID, client_id: ID, organization_info_id: ID): User
  • # Fetch generic custom modules for use in the form builder
  • #
  • # Arguments
  • # category: [Not documented]
  • questionBankModules(category: String): [CustomModule]
  • # Fetch receipt_line_items collection by super_bill_id
  • #
  • # Arguments
  • # super_bill_id: [Not documented]
  • receiptLineItems(super_bill_id: ID): [ReceiptLineItem]
  • # Fetch paginated Received Faxes collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # active_status: [Not documented]
  • receivedFaxes(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • active_status: String
  • ): [ReceivedFax]
  • # Number of Received Faxes
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # active_status: [Not documented]
  • receivedFaxesCount(keywords: String, active_status: String): Int
  • # Fetch recent food items
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # user_id: [Not documented]
  • # food_type: [Not documented]
  • recentFoods(keywords: String, user_id: String, food_type: String): [Food]
  • # Fetch recurring forms collection
  • #
  • # Arguments
  • # connectable_id: [Not documented]
  • # connectable_type: [Not documented]
  • recurringForms(connectable_id: String, connectable_type: String): [RecurringForm]
  • # Fetch active recurring_payments
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # active_status: [Not documented]
  • recurringPayments(user_id: ID, active_status: String): [RecurringPayment]
  • # Get referring physician based on id
  • #
  • # Arguments
  • # id: [Not documented]
  • # user_id: [Not documented]
  • # has_fax_number: [Not documented]
  • referringPhysician(
  • id: ID,
  • user_id: String,
  • has_fax_number: Boolean
  • ): ReferringPhysician
  • # all referring physicians based on current user
  • #
  • # Arguments
  • # sort_by: [Not documented]
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # should_paginate: [Not documented]
  • # has_fax_number: [Not documented]
  • referringPhysicians(
  • sort_by: String,
  • offset: Int,
  • keywords: String,
  • should_paginate: Boolean,
  • has_fax_number: Boolean
  • ): [ReferringPhysician]
  • # Number of referring physicians
  • referringPhysiciansCount: Int
  • # fetch a requested form completion by id
  • #
  • # Arguments
  • # id: [Not documented]
  • requestedFormCompletion(id: ID): RequestedFormCompletion
  • # Fetch requested form completions collection
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # status: [Not documented]
  • # keywords: [Not documented]
  • requestedFormCompletions(
  • user_id: ID,
  • status: String,
  • keywords: String
  • ): [RequestedFormCompletion]
  • # fetch a requested payment (invoice) by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # invoice_id: [Not documented]
  • # uuid: [Not documented]
  • # preview: [Not documented]
  • requestedPayment(
  • id: ID,
  • invoice_id: String,
  • uuid: String,
  • preview: Boolean
  • ): RequestedPayment
  • # Fetch paginated Requested Payments collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # only_unpaid: [Not documented]
  • # sender_id: [Not documented]
  • # status_filter: Can be paid, partial or unpaid
  • # preview: [Not documented]
  • requestedPayments(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • only_unpaid: Boolean,
  • sender_id: ID,
  • status_filter: String,
  • preview: Boolean
  • ): [RequestedPayment]
  • # Number of Requested Payments
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # only_unpaid: [Not documented]
  • # sender_id: [Not documented]
  • # status_filter: Can be paid or unpaid
  • requestedPaymentsCount(
  • keywords: String,
  • only_unpaid: Boolean,
  • sender_id: ID,
  • status_filter: String
  • ): Int
  • # Fetch user's scheduled message blasts
  • #
  • # Arguments
  • # provider_id: ID of the provider to get conversation for (if
  • # nil, will return current users)
  • scheduledMessageBlasts(provider_id: ID): [NoteScheduler]
  • # Fetch collection of all scheduled packages
  • #
  • # Arguments
  • # offset: [Not documented]
  • # user_id: ID of the user to load the list of given packages
  • # offering_id: ID of the offering to filter the list
  • scheduledUserPackageSelections(
  • offset: Int,
  • user_id: ID,
  • offering_id: ID
  • ): [ScheduledUserPackageSelection]
  • # Fetch paginated Sent Faxes collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • sentFaxes(offset: Int, keywords: String, sort_by: String): [SentFax]
  • # Number of Sent Faxes
  • #
  • # Arguments
  • # keywords: [Not documented]
  • sentFaxesCount(keywords: String): Int
  • # Fetch notification list for a specific client or list of clients.
  • #
  • # Arguments
  • # offset: [Not documented]
  • # should_paginate: Must be true if provider_id is passed in.
  • # 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
  • # org_level: Used in conjunction with provider_id. When true,
  • # returns sent notification records for all patients in the organization
  • # type: [Not documented]
  • # status: [Not documented]
  • # start_date: [Not documented]
  • # end_date: [Not documented]
  • sentNotificationRecords(
  • offset: Int,
  • should_paginate: Boolean,
  • patient_id: ID,
  • provider_id: ID,
  • org_level: Boolean,
  • type: String,
  • status: String,
  • start_date: String,
  • end_date: String
  • ): [SentNotificationRecord]
  • # Get number of SentNotificationRecord entries
  • #
  • # Arguments
  • # 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
  • # org_level: Used in conjunction with provider_id. When true,
  • # returns sent notification records for all patients in the organization
  • # type: [Not documented]
  • # status: [Not documented]
  • # start_date: [Not documented]
  • # end_date: [Not documented]
  • sentNotificationRecordsCount(
  • patient_id: ID,
  • provider_id: ID,
  • org_level: Boolean,
  • type: String,
  • status: String,
  • start_date: String,
  • end_date: String
  • ): Int
  • # Fetch serving sizes for a food
  • #
  • # Arguments
  • # food_id: [Not documented]
  • servingSizes(food_id: String): [ServingSize]
  • # A HTML string of charting note answers
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # form_answer_group_id: [Not documented]
  • # answers: [Not documented]
  • # letterhead: [Not documented]
  • shareNotePreview(
  • user_id: String,
  • form_answer_group_id: String,
  • answers: String,
  • letterhead: Boolean
  • ): String
  • # Should current user see scheduled chat tab
  • showScheduledTab: Boolean
  • # Fetch user smart phrases
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # offset: [Not documented]
  • # should_paginate: [Not documented]
  • smartPhrases(keywords: String, offset: Int, should_paginate: Boolean): [SmartPhrase]
  • # Get size of user smart phrases that matches the keyword
  • #
  • # Arguments
  • # keywords: [Not documented]
  • smartPhrasesCount(keywords: String): Int
  • # initial cpt codes for a new super bill
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # form_answer_group_ids: [Not documented]
  • # form_answer_group_id: [Not documented]
  • startingSuperBillCptCodes(
  • user_id: ID,
  • form_answer_group_ids: [ID],
  • form_answer_group_id: ID
  • ): [CptCodesSuperBill]
  • # initial icd10 codes for a new super bill
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # form_answer_group_id: [Not documented]
  • startingSuperBillIcd10s(
  • user_id: ID,
  • form_answer_group_id: ID
  • ): [IcdCodesSuperBill]
  • # Default Stripe bank account object associated to a practitioner stripe account
  • stripeBankAccount: StripeBankAccountType
  • # An array containing infoformation about countries that stripe supports
  • stripeCountries: [StripeCountry]
  • # An object containing info about a country that stripe supports
  • #
  • # Arguments
  • # country_code: [Not documented]
  • stripeCountry(country_code: String): StripeCountry
  • # Fetch all stripe payment cards for user
  • #
  • # Arguments
  • # user_id: [Not documented]
  • stripeCustomerDetails(user_id: ID): [StripeCustomerDetail]
  • # All subgoals for a given goal
  • #
  • # Arguments
  • # offset: [Not documented]
  • # user_id: [Not documented]
  • # goal_id: [Not documented]
  • subGoals(offset: Int, user_id: ID, goal_id: ID): [Goal]
  • # Number of subgoals
  • #
  • # Arguments
  • # user_id: [Not documented]
  • # goal_id: [Not documented]
  • # offset: [Not documented]
  • subGoalsCount(user_id: ID, goal_id: ID, offset: Int): Int
  • # Get the current users subscription
  • subscription: SubscriptionInstance
  • # fetch a superbill by id
  • #
  • # Arguments
  • # id: [Not documented]
  • superBill(id: ID): SuperBill
  • # Fetch paginated super bills collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # provider_id: [Not documented]
  • # client_id: [Not documented]
  • # status: status to filter superbills, default all
  • superBills(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • provider_id: ID,
  • client_id: ID,
  • status: String
  • ): [SuperBill]
  • # Number of super bills
  • #
  • # Arguments
  • # keywords: [Not documented]
  • # client_id: [Not documented]
  • # provider_id: [Not documented]
  • # status: status to filter superbills, default all
  • superBillsCount(
  • keywords: String,
  • client_id: ID,
  • provider_id: ID,
  • status: String
  • ): Int
  • # A collection of tags related to current patient/provider/organization
  • tags: [Tag]
  • # All tasks assigned to a provider or client
  • #
  • # Arguments
  • # client_id: [Not documented]
  • # offset: [Not documented]
  • # withoutPagination: [Not documented]
  • # per_page: [Not documented]
  • # type: [Not documented]
  • # completed_status: [Not documented]
  • # sort_by: _ (i.e completed_asc,
  • # assignee_desc)
  • # keywords: [Not documented]
  • # show_hidden: [Not documented]
  • # created_by_self: Nil -> does nothing, false -> tasks created by
  • # others, true -> tasks created by current user
  • tasks(
  • client_id: String,
  • offset: Int,
  • withoutPagination: Boolean,
  • per_page: Int,
  • type: String,
  • completed_status: String,
  • sort_by: String,
  • keywords: String,
  • show_hidden: Boolean,
  • created_by_self: Boolean
  • ): [Task]
  • # All tasks assigned to a provider or client
  • #
  • # Arguments
  • # show_hidden: [Not documented]
  • # completed_status: [Not documented]
  • # keywords: [Not documented]
  • # type: [Not documented]
  • # created_by_self: Nil -> does nothing, false -> tasks created by
  • # others, true -> tasks created by current user
  • tasksCount(
  • show_hidden: Boolean,
  • completed_status: String,
  • keywords: String,
  • type: String,
  • created_by_self: Boolean
  • ): Int
  • # get open appointment times for a range
  • #
  • # Arguments
  • # startDate: [Not documented]
  • # endDate: [Not documented]
  • # length: [Not documented]
  • # appt_loc_id: [Not documented]
  • # appt_type_id: [Not documented]
  • timesForRange(
  • startDate: String,
  • endDate: String,
  • length: String,
  • appt_loc_id: String,
  • appt_type_id: String
  • ): [String]
  • # fetch transactions for the current user
  • #
  • # Arguments
  • # payout_id: [Not documented]
  • # user_id: [Not documented]
  • transactions(payout_id: String, user_id: String): [TransactionType!]
  • # fetch transfers for the current user
  • #
  • # Arguments
  • # starting_after: [Not documented]
  • # limit: [Not documented]
  • # sort_by: [Not documented]
  • transfers(starting_after: String, limit: Int, sort_by: String): [TransferType!]
  • # Fetch an array of treatment plans and recommended products from Fullscript given
  • # a user id
  • #
  • # Arguments
  • # user_id: [Not documented]
  • treatmentPlans(user_id: 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
  • unassociatedCompletedOnboardingItems(
  • user_id: ID
  • ): [CompletedOnboardingItem]
  • # fetch a user by id
  • #
  • # Arguments
  • # id: [Not documented]
  • # email: [Not documented]
  • # clear_notifs: [Not documented]
  • # from_superadmin: [Not documented]
  • # or_current_user: [Not documented]
  • user(
  • id: ID,
  • email: String,
  • clear_notifs: Boolean,
  • from_superadmin: Boolean,
  • or_current_user: Boolean
  • ): User
  • # fetch a user group by id
  • #
  • # Arguments
  • # id: [Not documented]
  • userGroup(id: ID): UserGroup
  • # Fetch paginated user groups collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # keywords: [Not documented]
  • # sort_by: [Not documented]
  • # should_paginate: [Not documented]
  • userGroups(
  • offset: Int,
  • keywords: String,
  • sort_by: String,
  • should_paginate: Boolean
  • ): [UserGroup]
  • # Number of user groups
  • #
  • # Arguments
  • # keywords: [Not documented]
  • userGroupsCount(keywords: String): Int
  • # Fetch collection of all purchased packages
  • #
  • # Arguments
  • # offset: [Not documented]
  • # user_id: ID of the user to load the list of given packages
  • # offering_id: ID of the offering to filter the list
  • userPackageSelections(
  • offset: Int,
  • user_id: ID,
  • offering_id: ID
  • ): [UserPackageSelection]
  • # Arguments
  • # offset: [Not documented]
  • # user_id: ID of the user to load the list of given packages
  • # offering_id: ID of the offering to filter the list
  • userPackageSelectionsCount(
  • offset: Int,
  • user_id: ID,
  • offering_id: ID
  • ): Int
  • # Fetch paginated users collection
  • #
  • # Arguments
  • # offset: [Not documented]
  • # group_id: [Not documented]
  • # keywords: [Not documented]
  • # expect_conversation_id: When this is true, but conversation_id
  • # is nil, we return no users
  • # sort_by: Options are email,
  • #
  • # first_name_asc,
  • #
  • # first_name_desc,
  • #
  • # last_name_asc,
  • #
  • # last_name_desc,
  • #
  • # created_at_desc,
  • #
  • # created_at_asc,
  • #
  • # updated_at_desc,
  • #
  • # updated_at_asc,
  • #
  • # group_name_asc,
  • #
  • # group_name_desc,
  • #
  • # provider_name_asc,
  • #
  • # provider_name_desc,
  • #
  • # next_appt_asc,
  • #
  • # next_appt_desc. Defaults to last_name_desc
  • # active_status: Possible options: [active, archived]
  • # show_all_by_default: [Not documented]
  • # should_paginate: [Not documented]
  • # provider_id: [Not documented]
  • # conversation_id: [Not documented]
  • # limited_to_provider: [Not documented]
  • # email: [Not documented]
  • # id: [Not documented]
  • # ids: [Not documented]
  • # from_superadmin: [Not documented]
  • # with_feature_toggles: [Not documented]
  • # has_cc_on_file: When true, only clients with credit cards will
  • # be returned. Passing false does nothing
  • users(
  • offset: Int,
  • group_id: String,
  • keywords: String,
  • expect_conversation_id: Boolean,
  • sort_by: String,
  • active_status: String,
  • show_all_by_default: Boolean,
  • should_paginate: Boolean,
  • provider_id: String,
  • conversation_id: ID,
  • limited_to_provider: Boolean,
  • email: String,
  • id: ID,
  • ids: [ID],
  • from_superadmin: Boolean,
  • with_feature_toggles: Boolean,
  • has_cc_on_file: Boolean
  • ): [User]
  • # Number of users
  • #
  • # Arguments
  • # group_id: [Not documented]
  • # keywords: [Not documented]
  • # active_status: [Not documented]
  • # provider_id: [Not documented]
  • # conversation_id: [Not documented]
  • # expect_conversation_id: When this is true, but conversation_id
  • # is nil, we return no users
  • # limited_to_provider: [Not documented]
  • # has_cc_on_file: When true, only clients with credit cards will
  • # be returned. Passing false does nothing
  • usersCount(
  • group_id: String,
  • keywords: String,
  • active_status: String,
  • provider_id: String,
  • conversation_id: ID,
  • expect_conversation_id: Boolean,
  • limited_to_provider: Boolean,
  • has_cc_on_file: Boolean
  • ): Int
  • # Check if a coupon is valid, and return the new price (considered public)
  • #
  • # Arguments
  • # coupon_code: [Not documented]
  • # provider_id: [Not documented]
  • # offering_id: [Not documented]
  • # requested_payment_id: [Not documented]
  • validateCoupon(
  • coupon_code: String,
  • provider_id: ID,
  • offering_id: ID,
  • requested_payment_id: ID
  • ): ValidateOfferingCoupon
  • # Check if a reset passwrd token is valid
  • #
  • # Arguments
  • # token: [Not documented]
  • validateResetPasswordToken(token: String): Boolean
  • # Check if a signup token is valid
  • #
  • # Arguments
  • # token: [Not documented]
  • validateSignupToken(token: String): Boolean
  • # Arguments
  • # entry_id: Entry to query daily intake total if present.
  • # created_at: Date entry was posted
  • waterIntakeEntry(entry_id: ID, created_at: String): Entry
  • # Whitelabel setting to use
  • #
  • # Arguments
  • # branded_url: [Not documented]
  • whitelabelSetting(branded_url: 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.
  • zoomSdkJwt: String
  • }

link Require by

This element is not required by anyone