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
- String): [String] ( :
- # Fetch an announcement
- #
- # Arguments
- # id: [Not documented]
- 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
- # keywords: Search announcements by name, title and description
- (
- Int, :
- Boolean, :
- Boolean, :
- String :
- ): [Announcement]
- # Number of announcements for a provider
- #
- # Arguments
- # keywords: Search announcements by name, title and description
- # exclude_dismissed: If true, only show announcements that client
- # has not dismissed
- (
- String, :
- 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.
- ID, : 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]
- (
- ID], : [
- ID, :
- ID, :
- String, :
- String, :
- Boolean, :
- String, :
- String :
- ): [AppointmentBookingWarning]
- # returns metadata about appointments for provider dashboard
- #
- # Arguments
- # org_level: [Not documented]
- # only_to_current_date: [Not documented]
- (
- Boolean, :
- Boolean :
- ): [AppointmentDataType]
- # fetch an appointment by id, group appointments are (considered public)
- #
- # Arguments
- # id: [Not documented]
- # uuid: When external reschedule/cancellation is allowed, the
- # UUID can be used to allow the holder to retrieve and update/cancel their
- # inclusion in an appointment.
- ID, : ID): AppointmentInclusionType ( :
- # fetch an appointment location by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): AppointmentLocation ( :
- # get appointment locations that the current user can use. (considered public)
- #
- # Arguments
- # 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]
- (
- String, :
- String, :
- String, :
- ID, :
- String, :
- ID, :
- Int], : [
- Boolean, :
- 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]
- (
- String, :
- Boolean :
- ): String
- # fetch a Appointment Setting by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- # provider_id: [Not documented]
- ID, : ID): AppointmentSetting ( :
- # fetch an appointment type by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): AppointmentType ( :
- # Fetch credit history for the specific appointment type
- #
- # Arguments
- # user_id: [Not documented]
- # appointment_type_id: [Not documented]
- (
- 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]
- (
- Int, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- Boolean, :
- Boolean, :
- String, :
- String, :
- Int, :
- 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]
- (
- String, :
- Boolean, :
- String, :
- Boolean, :
- Boolean, :
- String, :
- String, :
- 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
- # without an associated chart note will be returned. When false, only appointments
- # with an associated chart note will be return. If nil, has no effect
- # is_with_clients: [Not documented]
- # include_suborganizations: include all providers in the
- # organization and sub-organizations
- (
- Int, :
- Int, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- ID, :
- String, :
- Boolean, :
- String, :
- ID, :
- ID], : [
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- String, :
- ID, :
- String, :
- ID, :
- ID], : [
- ID], : [
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- 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
- (
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- ID, :
- String, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- ID, :
- String, :
- ID, :
- ID], : [
- ID], : [
- Boolean :
- ): Int
- # Data summary for appointment reports
- #
- # Arguments
- # range_start: [Not documented]
- # range_end: [Not documented]
- # range_type: [Not documented]
- # provider_ids: [Not documented]
- (
- String, :
- String, :
- String, :
- 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
- (
- String, :
- String, :
- Boolean, :
- Boolean, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- ID, :
- ID, :
- ID], : [
- Boolean, :
- Boolean, :
- Int, :
- 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]
- (
- String, :
- String, :
- String, :
- String, :
- ID, :
- Boolean :
- ): Int
- # Fetch availability
- #
- # Arguments
- # id: [Not documented]
- ID): Availability ( :
- # Fetch available item types (for use in onboarding items)
- #
- # Arguments
- # onboarding_flow_id: [Not documented]
- 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]
- # make_unique: When false, multiple slots for the same time (for
- # different providers) will be returned.
- # 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
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- (
- String, :
- String, :
- String, :
- String, :
- String], : [
- String, :
- Boolean, :
- String, :
- String, :
- ID], : [
- String, :
- String, :
- Boolean, :
- Boolean, :
- String, :
- Boolean, :
- ID, :
- String :
- ): [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]
- (
- ID, :
- String, :
- String, :
- String, :
- ID :
- ): Cms1500
- # Get basic info about User from signup token
- #
- # Arguments
- # token: [Not documented]
- String): User ( :
- # DEPRECATED: All ICD Codes that are allowed to be used in healthecare claims
- IcdCode] : [
- # fetch a billing item by id
- #
- # Arguments
- # id: [Not documented]
- ID): BillingItem ( :
- # Fetch paginated billing items collection
- #
- # Arguments
- # 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]
- (
- Int, :
- String, :
- String, :
- String, :
- ID, :
- ID, :
- ID, :
- Boolean :
- ): [BillingItem]
- # Number of billing items
- #
- # Arguments
- # keywords: [Not documented]
- # state: [Not documented]
- # client_id: [Not documented]
- String, : String, : 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]
- (
- ID, :
- ID, :
- String, :
- String :
- ): Brand
- # fetch a Brand by custom sign in path (considered public)
- #
- # Arguments
- # custom_sign_in_path: [Not documented]
- (
- String :
- ): Brand
- # get info used on authentication pages for either a dietitian or partner
- #
- # Arguments
- # dietitian_id: [Not documented]
- # partner_name: [Not documented]
- # code: [Not documented]
- # invite_code: [Not documented]
- (
- String, :
- String, :
- String, :
- String :
- ): BrandInfo
- # Fetch a calendar view settings for current user
- CalendarViewSetting :
- # Fetch an array of campaigns for a provider
- #
- # Arguments
- # offset: [Not documented]
- Int): [Campaign] ( :
- # Number of campaigns for a provider
- Int :
- # Check if the user has access to the package buy limit feature
- #
- # Arguments
- # token: [Not documented]
- String): Boolean ( :
- # Fetch paginated stripe customer accounts with associated errors or soon to
- # expire credit cards
- #
- # Arguments
- # offset: [Not documented]
- # sort_by: [Not documented]
- Int, : String): [StripeCustomerDetail] ( :
- # Fetch paginated stripe customer accounts with associated errors or soon to
- # expire credit cards
- Int :
- # fetch a single care plan
- #
- # Arguments
- # id: [Not documented]
- # is_managing_templates: Deprecated. Does nothing
- ID, : Boolean): CarePlan ( :
- # Fetch paginated care plan collection
- #
- # Arguments
- # patient_id: [Not documented]
- # offset: [Not documented]
- # sort_by: [Not documented]
- # templates_only: [Not documented]
- # template_search_keywords: [Not documented]
- (
- ID, :
- Int, :
- String, :
- Boolean, :
- String :
- ): [CarePlan]
- # Number of care plans
- #
- # Arguments
- # patient_id: [Not documented]
- ID): Int ( :
- # Number of care plans templates
- Int :
- # fetch a chargeback by the Healthie ID or the Stripe Dispute ID.
- #
- # Arguments
- # id: [Not documented]
- # stripe_dispute_id: [Not documented]
- 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]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- ID, :
- ID, :
- String, :
- 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]
- # keywords: [Not documented]
- # include_docs: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- ID, :
- ID, :
- String, :
- Boolean :
- ): Int
- # fetch a Chat Setting
- #
- # Arguments
- # id: [Not documented]
- ID): ChatSetting ( :
- # get current video chats for a user.
- #
- # Arguments
- # user_id: User to get video chats that are starting in the next
- # 10 minutes
- String): [Appointment] ( :
- # Fetch a CMS1500 by ID
- #
- # Arguments
- # id: [Not documented]
- ID): Cms1500 ( :
- # Fetch paginated Cms1500s collection
- #
- # Arguments
- # 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]
- (
- Int, :
- String, :
- String, :
- String, :
- ID, :
- ID, :
- Boolean :
- ): [Cms1500]
- # Number of Cms1500s
- #
- # Arguments
- # keywords: [Not documented]
- # client_id: [Not documented]
- # status: [Not documented]
- # provider_id: [Not documented]
- (
- String, :
- ID, :
- String, :
- ID :
- ): Int
- # Color Code Options for a given category
- #
- # Arguments
- # color_code_by: [Not documented]
- # appointment_setting_id: [Not documented]
- (
- String, :
- String :
- ): [ColorCodeOption]
- # Fetch comment
- #
- # Arguments
- # id: [Not documented]
- 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]
- (
- ID, :
- ID], : [
- Int, :
- Int, :
- Boolean :
- ): [Comment]
- # number of comments
- #
- # Arguments
- # entry_id: [Not documented]
- # entry_ids: An array of entry IDs to grab comments for.
- # Overrides entry_id if passed in
- ID, : [ID]): Int ( :
- # fetch a completedCourseItem by course_item_id and user_id
- #
- # Arguments
- # course_item_id: [Not documented]
- # user_id: [Not documented]
- ID, : ID): CompletedCourseItem ( :
- # All Contact Types For Current User
- String] : [
- # fetch a conversation by id
- #
- # Arguments
- # id: [Not documented]
- # provider_id: (DEPRECATED - NO LONGER NEEDED) ID of the provider
- # to get conversation for (if nil, will return current users)
- ID, : ID): Conversation ( :
- # fetch a conversation membership by id and owner
- #
- # Arguments
- # id: [Not documented]
- ID): ConversationMembership ( :
- # fetch a conversationmembership by id and invitees
- #
- # Arguments
- # id: [Not documented]
- 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)
- # org_chat: If TRUE: fetch organization members conversations
- # provider_ids: Used to filter org chat conversations by provider
- # ids
- (
- Int, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- ID, :
- Boolean, :
- 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]
- # org_chat: If TRUE: count organization members conversations
- # provider_id: ID of the provider to get conversation for (if
- # nil, will return current users)
- # provider_ids: Used to filter org chat conversations by provider
- # ids
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- 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
- ID): [Conversation] ( :
- # Number of conversation
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # fetch a course by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- # course_id: [Not documented]
- ID, : ID): Course ( :
- # fetch clients belonging to a course by course_id
- #
- # Arguments
- # course_id: [Not documented]
- # course_status: [Not documented]
- # offset: [Not documented]
- ID, : String, : Int): [CourseMembership] ( :
- # total number of clients for a specific course
- #
- # Arguments
- # course_id: [Not documented]
- # course_status: [Not documented]
- ID, : String): Int ( :
- # Get course completion info for users and userg_groups
- #
- # Arguments
- # course_id: [Not documented]
- ID): CourseCompletionInfoType ( :
- # Course group memberships for the course
- #
- # Arguments
- # course_id: [Not documented]
- # course_group_id: [Not documented]
- # course_status: [Not documented]
- # offset: [Not documented]
- (
- ID, :
- String, :
- String, :
- Int :
- ): [User]
- # Total clients in course group memberships
- #
- # Arguments
- # course_status: [Not documented]
- # course_id: [Not documented]
- # course_group_id: [Not documented]
- (
- String, :
- ID, :
- String :
- ): Int
- # fetch a courseitem by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- # course_membership_id: [Not documented]
- ID, : ID): CourseItem ( :
- # get all custom custom emails for a current user
- CustomEmail] : [
- # get all documents for current user
- Document] : [
- # get all custom module forms for a current user
- CustomModuleForm] : [
- # Course items info for the course membership
- #
- # Arguments
- # client_id: [Not documented]
- # course_id: [Not documented]
- # include_emails: [Not documented]
- # find_for_provider: [Not documented]
- (
- ID, :
- ID, :
- Boolean, :
- 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]
- (
- ID, :
- ID, :
- ID, :
- ID, :
- ID, :
- ID :
- ): CourseMembership
- # Fetch paginated course membership collection
- #
- # Arguments
- # client_id: [Not documented]
- # offset: [Not documented]
- # fetch_all: [Not documented]
- # page_size: [Not documented]
- (
- ID, :
- Int, :
- Boolean, :
- Int :
- ): [CourseMembership]
- # Number of course memberships
- #
- # Arguments
- # client_id: [Not documented]
- 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]
- # page_size: [Not documented]
- (
- Int, :
- String, :
- String, :
- Boolean, :
- Boolean, :
- Int :
- ): [Course]
- # Number of course
- #
- # Arguments
- # keywords: [Not documented]
- # course_type: [Not documented]
- String, : String): Int ( :
- # All CPT Codes
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # for_superbill: [Not documented]
- # is_favorited: [Not documented]
- (
- String, :
- Int, :
- Boolean, :
- Boolean, :
- Boolean :
- ): [CptCode]
- # CPT Codes count
- #
- # Arguments
- # is_favorited: [Not documented]
- Boolean): Int ( :
- # fetch the current user.
- User :
- # fetch the current users notifications count.
- UserNotificationsCount :
- # get current video chats for a user.
- #
- # Arguments
- # user_id: User to get current video chats for (if left blank,
- # defaults to current user)
- # only_current: [Not documented]
- String, : 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]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- Boolean :
- ): String
- # Fetch paginated custom emails collection
- #
- # Arguments
- # offset: [Not documented]
- # email_type: [Not documented]
- # provider_id: [Not documented]
- Int, : String, : ID): [CustomEmail] ( :
- # Number of custom emails
- #
- # Arguments
- # email_type: [Not documented]
- String): Int ( :
- # fetch a custom module form by id (templates are considered public)
- #
- # Arguments
- # id: [Not documented]
- # default: [Not documented]
- # charting: [Not documented]
- ID, : Boolean, : 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]
- (
- Boolean, :
- String, :
- String, :
- String, :
- Int, :
- Boolean, :
- 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]
- (
- String, :
- Boolean, :
- String, :
- String, :
- 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
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- (
- String, :
- String, :
- String, :
- String], : [
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- ID, :
- String :
- ): [String]
- # fetch a document by id
- #
- # Arguments
- # id: [Not documented]
- # course_id: [Not documented]
- # custom_module_id: [Not documented]
- # care_plan_id: [Not documented]
- ID, : ID, : ID, : ID): Document ( :
- # Get Document Viewings for a specific document. A 'View' is when a document is
- # downloaded or opened in a new tab
- #
- # Arguments
- # offset: [Not documented]
- # document_id: [Not documented]
- # per_page: The number of document views to return per page.
- # Maximum 500
- Int, : ID, : Int): [DocumentViewing] ( :
- # Number of instances for a document viewings for a specific document
- #
- # Arguments
- # document_id: [Not documented]
- ID): Int ( :
- # Fetch paginated documents collection
- #
- # Arguments
- # 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]
- (
- Int, :
- String, :
- String, :
- String], : [
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- Boolean, :
- 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]
- (
- String, :
- String, :
- String], : [
- String, :
- String, :
- String, :
- String, :
- String, :
- 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]
- ID): String ( :
- # draft by conversation_membership id
- #
- # Arguments
- # conversation_membership_id: [Not documented]
- ID): Draft ( :
- # Fetch a link from Fullscript to create a treatment plan for a given user
- #
- # Arguments
- # user_id: [Not documented]
- String): String ( :
- # fetch embed steps based off of params
- #
- # Arguments
- # locationString: [Not documented]
- # is_for_web: [Not documented]
- String, : 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]
- # page_size: If should paginate is true, the number of results to
- # return on a page. Max 500
- (
- Int, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- Int :
- ): [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
- (
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Int :
- ): Int
- # fetch an entry by id
- #
- # Arguments
- # id: [Not documented]
- # type: [Not documented]
- # client_id: [Not documented]
- ID, : String, : ID): Entry ( :
- # fetch a featureToggle by id
- #
- # Arguments
- # id: [Not documented]
- # user_id: [Not documented]
- 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]
- (
- ID, :
- ID, :
- ID, :
- ID :
- ): FeatureToggle
- # fetch a folder by id
- #
- # Arguments
- # id: [Not documented]
- # custom_module_id: [Not documented]
- String, : 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]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- ID, :
- ID, :
- ID, :
- Boolean, :
- 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]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- ID :
- ): Int
- # Fetch food items
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # food_type: [Not documented]
- # user_id: [Not documented]
- # exclude_recent: [Not documented]
- # upc: [Not documented]
- (
- String, :
- Int, :
- String, :
- String, :
- Boolean, :
- String :
- ): [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]
- # upc: [Not documented]
- (
- String, :
- String, :
- String, :
- Boolean, :
- String :
- ): Int
- # Fetch a form answer group by id
- #
- # Arguments
- # id: [Not documented]
- # for_superbills: [Not documented]
- # ids: [Not documented]
- ID, : Boolean, : [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]
- # ids: Accepts an array of FormAnswerGroup ids
- # include_group_notes: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- ID, :
- ID], : [
- Boolean :
- ): [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]
- # ids: Accepts an array of FormAnswerGroup ids
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- ID] : [
- ): Int
- # Fetch available forms to request
- #
- # Arguments
- # keywords: [Not documented]
- # sort_by: [Not documented]
- String, : String): [FormTypesToRequest] ( :
- # Fullscript practitioners that share the same clinic id as organization owner
- FullscriptPractitionerTypeType] : [
- # Fullscript practitioners that share the same clinic id as organization owner
- FullscriptPractitionerType] : [
- # fetch a goal by id
- #
- # Arguments
- # id: [Not documented]
- # program_goal: [Not documented]
- # client_id: [Not documented]
- # get_client_goal: [Not documented]
- # patient_goal_module: [Not documented]
- # last_client_goal: Deprecated, at some point this argument
- # stopped being used. Keeping it around
- #
- # in order to make sure nothing breaks backwards
- # date: [Not documented]
- (
- ID, :
- Boolean, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- String :
- ): 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]
- (
- Int, :
- ID, :
- String, :
- Boolean, :
- Boolean, :
- 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]
- (
- Int, :
- ID, :
- String, :
- Boolean, :
- Boolean :
- ): Int
- # Fetch goal history
- #
- # Arguments
- # id: [Not documented]
- 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]
- (
- Int, :
- ID, :
- String, :
- String, :
- String, :
- String, :
- 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]
- (
- Int, :
- ID, :
- String, :
- String, :
- String, :
- String, :
- Int :
- ): Int
- # Goal templates for given user
- #
- # Arguments
- # user_id: [Not documented]
- # keywords: [Not documented]
- # offset: DEPRECATED
- # category: Can be 'personal', 'organizational', or 'default'
- (
- ID, :
- String, :
- Int, :
- String :
- ): [GoalTemplate]
- # Number of Goal templates for given user
- #
- # Arguments
- # user_id: [Not documented]
- # keywords: [Not documented]
- ID, : 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]
- (
- Int, :
- ID, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- 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
- (
- ID, :
- Int, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- 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
- (
- ID, :
- Int, :
- Int, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- 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
- (
- ID, :
- Int, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- 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
- (
- ID, :
- Int, :
- String, :
- String, :
- ID, :
- String, :
- String, :
- String, :
- String, :
- String, :
- 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
- (
- ID, :
- Int, :
- String, :
- String, :
- ID, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String :
- ): Int
- # When true, the user can set up question conditions in the form builder
- Boolean :
- # When true, the user can add sublabels to questions in the form builder
- Boolean :
- # Fetch a single health assessment
- #
- # Arguments
- # email: [Not documented]
- # user_id: [Not documented]
- # device_type: [Not documented]
- # device_token: [Not documented]
- # run_id: [Not documented]
- (
- String, :
- ID, :
- String, :
- String, :
- 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]
- (
- String, :
- ID, :
- String, :
- String, :
- ID :
- ): [HealthAssessment]
- # Fetch ICD Code by ID
- #
- # Arguments
- # id: [Not documented]
- 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]
- (
- Boolean, :
- Boolean, :
- Int, :
- Boolean, :
- String :
- ): [IcdCode]
- # Count of all ICD Codes
- #
- # Arguments
- # is_favorited: The favorited status of the ICD Code
- # is_billable: [Not documented]
- # keywords: [Not documented]
- (
- Boolean, :
- Boolean, :
- String :
- ): Int
- # fetch import data request by user_id
- #
- # Arguments
- # user_id: [Not documented]
- ID): ImportDataRequest ( :
- # A new CMS1500 form with some objects already prefilled
- #
- # Arguments
- # provider_id: [Not documented]
- # form_answer_group_id: [Not documented]
- # patient_id: [Not documented]
- (
- String, :
- 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]
- (
- ID, :
- ID, :
- ID :
- ): [FormAnswer]
- # appointment types related to offering
- #
- # Arguments
- # offering_id: [Not documented]
- ID): [OfferingInclude] ( :
- # Insurance Authorization belonging to a client
- #
- # Arguments
- # client_id: Client to get insurance authorization for
- # id: id of insurance authorization
- ID, : ID): InsuranceAuthorizationType ( :
- # Get all potential insurance plans
- #
- # Arguments
- # ids: Array of plan ids
- # keywords: Search keywords
- # is_accepted: The accepted status of the insurance plan
- # sort_by: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- # is_custom: Get custom insurance plans
- (
- String, :
- String, :
- Boolean, :
- String, :
- Int, :
- Boolean, :
- 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
- # is_custom: Get custom insurance plans
- (
- String, :
- String, :
- Boolean, :
- Boolean :
- ): Int
- # Fetch intake flow
- #
- # Arguments
- # user_id: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- ID, : String, : String): IntakeFlowType ( :
- # Fetch list of available integrations
- #
- # Arguments
- # category: [Not documented]
- String): [IntegrationCategoryType] ( :
- # Initial date of service for a new form answer group
- #
- # Arguments
- # appointment_id: [Not documented]
- # user_id: [Not documented]
- ID, : ID): String ( :
- # get the base price for the invoice based off the associated item
- #
- # Arguments
- # offering_id: [Not documented]
- # cms1500_id: [Not documented]
- ID, : ID): String ( :
- # Arguments
- # keywords: [Not documented]
- String): [RequestedPaymentTemplate] ( :
- # Fetch all lab options (considered public)
- LabOption] : [
- # Fetch onboarding flows collection
- #
- # Arguments
- # id: [Not documented]
- ID): LabOrder ( :
- # Fetch lab orders collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- # should_paginate: [Not documented]
- # client_id: [Not documented]
- # recent_orders: [Not documented]
- (
- Int, :
- String, :
- String, :
- Boolean, :
- ID, :
- Boolean :
- ): [LabOrder]
- # Number of onboarding flows
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- Int, : String, : String): Int ( :
- # Fetch most recent conversationMembership
- #
- # Arguments
- # active_status: [Not documented]
- # provider_id: ID of the provider to get conversation for (if
- # nil, will return current users)
- String, : ID): ConversationMembership ( :
- # The 6 most recently active clients
- #
- # Arguments
- # limit: [Not documented]
- Int): [User] ( :
- # has loadMoreNotes been called
- Boolean :
- # fetch a location by id
- #
- # Arguments
- # id: [Not documented]
- ID): Location ( :
- # Get location resources
- #
- # Arguments
- # location_ids: [Not documented]
- String): [LocationResourceType] ( :
- # Get locations for a given user (or current user)
- #
- # Arguments
- # user_id: [Not documented]
- # has_name: Pass in true to get service facilities for CMS 1500
- # should_paginate: [Not documented]
- # offset: [Not documented]
- # keywords: [Not documented]
- (
- String, :
- Boolean, :
- Boolean, :
- Int, :
- String :
- ): [Location]
- # A count of available locations for the current user
- #
- # Arguments
- # has_name: [Not documented]
- # keywords: [Not documented]
- Boolean, : String): Int ( :
- # Fetch user meals
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # user_id: [Not documented]
- String, : Int, : String): [Meal] ( :
- # Get size of user meals that matches the keyword
- #
- # Arguments
- # keywords: [Not documented]
- # user_id: [Not documented]
- String, : String): Int ( :
- # Meal plan options from user Living Plate account. Nil if no Living Plate account
- # associated
- MealPlan] : [
- # Fetch an array of medications options queried from Dosespot API
- #
- # Arguments
- # keywords: [Not documented]
- String): [MedicationOptionType] ( :
- # Fetch an array of medications for a given patient
- #
- # Arguments
- # patient_id: [Not documented]
- # active: [Not documented]
- ID, : Boolean): [MedicationType] ( :
- # Fetch count of medications for a given patient
- #
- # Arguments
- # patient_id: [Not documented]
- # active: [Not documented]
- ID, : 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
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- 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
- (
- String, :
- String, :
- String, :
- Boolean :
- ): [MetricGraphDataType!]
- # Arguments
- # lab_option_ids: [Not documented]
- # state: [Not documented]
- ID], : String): String ( : [
- # returns metadata about montly payments
- #
- # Arguments
- # org_level: [Not documented]
- # gross: [Not documented]
- (
- Boolean, :
- 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]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String :
- ): MultiLineMetricGraphDataType
- # String containing info for the user about the client upgrade price
- #
- # Arguments
- # new_client_num: [Not documented]
- Int): String ( :
- # String containing info for the user about the org upgrade price
- #
- # Arguments
- # new_provder_num: [Not documented]
- Int): String ( :
- # String containing info for the user about the org upgrade price when adding a
- # new support user
- #
- # Arguments
- # new_support_num: [Not documented]
- (
- Int :
- ): [String]
- # Fetch closest appointment
- Appointment :
- # get open appointment times for a range
- #
- # Arguments
- # 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]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- # outside_factors: [Not documented]
- (
- String], : [
- String, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- ID, :
- String, :
- String, :
- String, :
- String, :
- Boolean :
- ): String
- # fetch a courseitem by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): CourseItem ( :
- # fetch a note by id
- #
- # Arguments
- # id: [Not documented]
- ID): Note ( :
- # get the viewed status of a note
- #
- # Arguments
- # id: [Not documented]
- ID): Boolean ( :
- # Fetch note scheduler by id
- #
- # Arguments
- # id: [Not documented]
- ID): NoteScheduler ( :
- # Fetch paginated note collection for given conversation
- #
- # Arguments
- # 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]
- # org_chat: If TRUE: get base user as a conversation owner
- (
- Int, :
- String, :
- ID, :
- ID, :
- String, :
- Boolean, :
- ID, :
- Boolean :
- ): [Note]
- # Number of notes
- #
- # Arguments
- # conversation_id: [Not documented]
- # keywords: [Not documented]
- # scheduled_notes: [Not documented]
- # provider_id: [Not documented]
- # org_chat: If TRUE: get base user as a conversation owner
- (
- ID, :
- String, :
- Boolean, :
- ID, :
- Boolean :
- ): 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.
- (
- String, :
- String], : [
- String], : [
- Boolean, :
- Boolean, :
- Int :
- ): Int
- # fetch a Notification Setting by id
- #
- # Arguments
- # id: [Not documented]
- ID): NotificationSetting ( :
- # get notifications for a given user (or for the current user)
- #
- # Arguments
- # 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]
- (
- String, :
- String], : [
- Boolean, :
- Boolean, :
- Int, :
- String, :
- Int :
- ): [Notification]
- # fetch an offering by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): Offering ( :
- # Fetch paginated list of users associated with an offering
- #
- # Arguments
- # offset: [Not documented]
- # offering_id: [Not documented]
- Int, : ID): [BillingItem] ( :
- # Number of users associated with an offering
- #
- # Arguments
- # offering_id: [Not documented]
- 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]
- # offering_id: [Not documented]
- (
- String, :
- String, :
- ID, :
- Int, :
- Boolean, :
- ID :
- ): [OfferingCoupon]
- # Number of offering coupons
- #
- # Arguments
- # keywords: [Not documented]
- # from_package_details: [Not documented]
- # offering_id: [Not documented]
- (
- String, :
- Boolean, :
- ID :
- ): Int
- # get all user groups relating to offerings
- #
- # Arguments
- # provider_id: the provider ID we want to use to fetch all user
- # groups relating to offerings
- ID): [OfferingGroupVisibility] ( :
- # All OfferingImage that have no user_id
- OfferingImage] : [
- # Fetch paginated offerings collection (considered public)
- #
- # Arguments
- # offset: [Not documented]
- # page_size: The number of packages to return at one time (when
- # should_paginate is true)
- # 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]
- (
- Int, :
- Int, :
- String, :
- String, :
- ID, :
- ID, :
- Boolean, :
- Boolean, :
- ID], : [
- String, :
- String, :
- ID, :
- 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]
- (
- String, :
- ID, :
- ID, :
- Boolean, :
- Boolean, :
- ID], : [
- String, :
- String, :
- ID :
- ): Int
- # returns metadata about offerings purchased
- #
- # Arguments
- # org_level: [Not documented]
- Boolean): [OfferingsDataType] ( :
- # fetch the current users officeally sftp connection
- OfficeallySftpAccount :
- # Fetch an onboarding flow by id or uuid
- #
- # Arguments
- # id: [Not documented]
- # user_id: [Not documented]
- # uuid: Fetch onboarding flow by unique identifier. Considered
- # public
- ID, : ID, : String): OnboardingFlow ( :
- # Fetch onboarding flows collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- # should_paginate: [Not documented]
- (
- Int, :
- String, :
- String, :
- Boolean :
- ): [OnboardingFlow]
- # Number of onboarding flows
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- (
- Int, :
- String, :
- String :
- ): Int
- # fetch an onboarding item by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- 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]
- (
- ID, :
- ID, :
- ID], : [
- Boolean, :
- String :
- ): Organization
- # Fetch organization info by id
- #
- # Arguments
- # id: [Not documented]
- ID): OrganizationInfo ( :
- # fetch members of organization
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- (
- Int, :
- String, :
- String, :
- String :
- ): [User]
- # org members count
- #
- # Arguments
- # keywords: [Not documented]
- # licensed_in_state: Two letter state abbreviation (e.g. "CA",
- # "NY")
- (
- String, :
- String :
- ): Int
- # Get the organization membership info of the current user, basic org member info
- # is (considered public)
- #
- # Arguments
- # user_id: [Not documented]
- ID): OrganizationMembership ( :
- # Get the organization memberships
- #
- # Arguments
- # id: [Not documented]
- # user_ids: [Not documented]
- # sort_by: [Not documented]
- (
- String, :
- ID], : [
- String :
- ): [OrganizationMembership]
- # fetch an Other Id Number by id
- #
- # Arguments
- # id: [Not documented]
- ID): OtherIdNumber ( :
- # A collection of Other ID's and its Qualifiers for given user
- #
- # Arguments
- # user_id: [Not documented]
- ID): [OtherIdNumber] ( :
- # returns true if the there are more transfers to load
- #
- # Arguments
- # limit: [Not documented]
- # starting_after: [Not documented]
- Int, : String): Boolean ( :
- # Fetch a pharmacy given dosespot pharmacy id
- #
- # Arguments
- # id: id assigned by dosespot
- String): Pharmacy ( :
- # 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]
- (
- String, :
- String, :
- String, :
- String, :
- String, :
- String, :
- String], : [
- String :
- ): [Pharmacy]
- # fetch all place of services
- PlaceOfService] : [
- # fetch a Plan by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): Plan ( :
- # fetch a policy by id
- #
- # Arguments
- # id: [Not documented]
- ID): Policy ( :
- # Fetch collection of preferred CPT/ICD codes
- #
- # Arguments
- # code_type: [Not documented]
- String): [PreferredMedicalCode] ( :
- # Fetch a prescriptions for a given patient and prescription id pulled from
- # Dosespot
- #
- # Arguments
- # patient_id: [Not documented]
- # prescription_id: [Not documented]
- ID, : String): Prescription ( :
- # Fetch an array of prescriptions for a given patient pulled from Dosespot
- #
- # Arguments
- # patient_id: [Not documented]
- # status: [Not documented]
- ID, : String): [Prescription] ( :
- # fetch a courseitem by id (considered public)
- #
- # Arguments
- # id: [Not documented]
- ID): CourseItem ( :
- # Fetch paginated product collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- # should_paginate: [Not documented]
- (
- Int, :
- String, :
- String, :
- Boolean :
- ): [Product]
- # Number of products
- #
- # Arguments
- # keywords: [Not documented]
- 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
- ID, : ID, : ID, : ID): User ( :
- # get provider appointment locations.
- #
- # Arguments
- # provider_id: [Not documented]
- ID): [AppointmentLocation] ( :
- # Fetch generic custom modules for use in the form builder
- #
- # Arguments
- # category: [Not documented]
- String): [CustomModule] ( :
- # Fetch receipt_line_items collection by super_bill_id
- #
- # Arguments
- # super_bill_id: [Not documented]
- ID): [ReceiptLineItem] ( :
- # Fetch paginated Received Faxes collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- # active_status: [Not documented]
- (
- Int, :
- String, :
- String, :
- String :
- ): [ReceivedFax]
- # Number of Received Faxes
- #
- # Arguments
- # keywords: [Not documented]
- # active_status: [Not documented]
- String, : String): Int ( :
- # Fetch recent food items
- #
- # Arguments
- # keywords: [Not documented]
- # user_id: [Not documented]
- # food_type: [Not documented]
- String, : String, : String): [Food] ( :
- # Fetch recurring forms collection
- #
- # Arguments
- # connectable_id: [Not documented]
- # connectable_type: [Not documented]
- String, : String): [RecurringForm] ( :
- # Fetch active recurring_payments
- #
- # Arguments
- # user_id: [Not documented]
- # active_status: [Not documented]
- ID, : String): [RecurringPayment] ( :
- # Get referring physician based on id
- #
- # Arguments
- # id: [Not documented]
- # user_id: [Not documented]
- # has_fax_number: [Not documented]
- (
- ID, :
- String, :
- 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]
- (
- String, :
- Int, :
- String, :
- Boolean, :
- Boolean :
- ): [ReferringPhysician]
- # Number of referring physicians
- Int :
- # fetch a requested form completion by id
- #
- # Arguments
- # id: [Not documented]
- ID): RequestedFormCompletion ( :
- # Fetch requested form completions collection
- #
- # Arguments
- # user_id: [Not documented]
- # status: [Not documented]
- # keywords: [Not documented]
- (
- ID, :
- String, :
- String :
- ): [RequestedFormCompletion]
- # fetch a requested payment (invoice) by id
- #
- # Arguments
- # id: [Not documented]
- # invoice_id: [Not documented]
- # uuid: [Not documented]
- # preview: [Not documented]
- (
- ID, :
- String, :
- String, :
- Boolean :
- ): RequestedPayment
- # Fetch paginated Requested Payments collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- # only_unpaid: [Not documented]
- # sender_id: will return all requested payments with this ID as
- # the sender or recipient
- # status_filter: Can be paid, partial or unpaid
- # preview: [Not documented]
- (
- Int, :
- String, :
- String, :
- Boolean, :
- ID, :
- String, :
- 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
- (
- String, :
- Boolean, :
- ID, :
- 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)
- # org_chat: If True - returns organization membership scheduled
- # message blasts
- # provider_ids: Used to filter org chat conversations by provider
- # ids
- (
- ID, :
- Boolean, :
- 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
- (
- Int, :
- ID, :
- ID :
- ): [ScheduledUserPackageSelection]
- # Fetch paginated Sent Faxes collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- Int, : String, : String): [SentFax] ( :
- # Number of Sent Faxes
- #
- # Arguments
- # keywords: [Not documented]
- 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]
- (
- Int, :
- Boolean, :
- ID, :
- ID, :
- Boolean, :
- String, :
- String, :
- String, :
- 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]
- (
- ID, :
- ID, :
- Boolean, :
- String, :
- String, :
- String, :
- String :
- ): Int
- # Fetch paginated Webhooks collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- Int, : String, : String): [Webhook] ( :
- # Number of Webhooks
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # Fetch serving sizes for a food
- #
- # Arguments
- # food_id: [Not documented]
- String): [ServingSize] ( :
- # A HTML string of charting note answers
- #
- # Arguments
- # user_id: [Not documented]
- # form_answer_group_id: [Not documented]
- # answers: [Not documented]
- # letterhead: [Not documented]
- (
- String, :
- String, :
- String, :
- Boolean :
- ): String
- # Should current user see scheduled chat tab
- Boolean :
- # Fetch user smart phrases
- #
- # Arguments
- # keywords: [Not documented]
- # offset: [Not documented]
- # should_paginate: [Not documented]
- String, : Int, : Boolean): [SmartPhrase] ( :
- # Get size of user smart phrases that matches the keyword
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # initial cpt codes for a new super bill
- #
- # Arguments
- # user_id: [Not documented]
- # form_answer_group_ids: [Not documented]
- # form_answer_group_id: [Not documented]
- (
- ID, :
- ID], : [
- ID :
- ): [CptCodesSuperBill]
- # initial icd10 codes for a new super bill
- #
- # Arguments
- # user_id: [Not documented]
- # form_answer_group_id: [Not documented]
- (
- ID, :
- ID :
- ): [IcdCodesSuperBill]
- # Default Stripe bank account object associated to a practitioner stripe account
- StripeBankAccountType :
- # An array containing infoformation about countries that stripe supports
- StripeCountry] : [
- # An object containing info about a country that stripe supports
- #
- # Arguments
- # country_code: [Not documented]
- String): StripeCountry ( :
- # Fetch all stripe payment cards for user
- #
- # Arguments
- # user_id: [Not documented]
- ID): [StripeCustomerDetail] ( :
- # All subgoals for a given goal
- #
- # Arguments
- # offset: [Not documented]
- # user_id: [Not documented]
- # goal_id: [Not documented]
- Int, : ID, : ID): [Goal] ( :
- # Number of subgoals
- #
- # Arguments
- # user_id: [Not documented]
- # goal_id: [Not documented]
- # offset: [Not documented]
- ID, : ID, : Int): Int ( :
- # Get the current users subscription
- SubscriptionInstance :
- # fetch a superbill by id
- #
- # Arguments
- # id: [Not documented]
- 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
- (
- Int, :
- String, :
- String, :
- ID, :
- ID, :
- 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
- (
- String, :
- ID, :
- ID, :
- String :
- ): Int
- # A collection of tags related to current patient/provider/organization
- #
- # Arguments
- # sort_by: [Not documented]
- # ids: [Not documented]
- # user_id: [Not documented]
- # applied_to_providers: When true, only returns tags applied to
- # providers in the organization
- String, : [ID], : String, : Boolean): [Tag] ( :
- # Number of tags
- #
- # Arguments
- # ids: [Not documented]
- # user_id: [Not documented]
- # applied_to_providers: When true, only returns tags applied to
- # providers in the organization
- ID], : String, : Boolean): Int ( : [
- # 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
- (
- String, :
- Int, :
- Boolean, :
- Int, :
- String, :
- String, :
- String, :
- String, :
- Boolean, :
- 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
- (
- Boolean, :
- String, :
- String, :
- String, :
- Boolean :
- ): Int
- # (DEPRECATED - use availableSlotsForRange) 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]
- (
- String, :
- String, :
- String, :
- String, :
- String :
- ): [String]
- # fetch transactions for the current user
- #
- # Arguments
- # payout_id: [Not documented]
- # user_id: [Not documented]
- String, : String): [TransactionType!] ( :
- # fetch transfers for the current user
- #
- # Arguments
- # starting_after: [Not documented]
- # limit: [Not documented]
- # sort_by: [Not documented]
- String, : Int, : String): [TransferType!] ( :
- # Fetch an array of treatment plans and recommended products from Fullscript given
- # a user id
- #
- # Arguments
- # user_id: [Not documented]
- String): [FullscriptTreatmentPlanType] ( :
- # Get the users completed onboarding items, that are not part of the users current
- # flow
- #
- # Arguments
- # user_id: User to get unassociated onboarding items
- (
- ID :
- ): [CompletedOnboardingItem]
- # fetch ungrouped course memberhips belonging to a a specific course
- #
- # Arguments
- # course_id: [Not documented]
- # offset: [Not documented]
- # course_status: [Not documented]
- (
- ID, :
- Int, :
- String :
- ): [CourseMembership]
- # count of ungrouped course memberhips for a specific course
- #
- # Arguments
- # course_id: [Not documented]
- # course_status: [Not documented]
- (
- ID, :
- String :
- ): Int
- # fetch a user by id
- #
- # Arguments
- # id: [Not documented]
- # email: [Not documented]
- # clear_notifs: [Not documented]
- # from_superadmin: [Not documented]
- # or_current_user: [Not documented]
- (
- ID, :
- String, :
- Boolean, :
- Boolean, :
- Boolean :
- ): User
- # fetch a user group by id
- #
- # Arguments
- # id: [Not documented]
- ID): UserGroup ( :
- # Fetch paginated user groups collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- # should_paginate: [Not documented]
- (
- Int, :
- String, :
- String, :
- Boolean :
- ): [UserGroup]
- # Number of user groups
- #
- # Arguments
- # keywords: [Not documented]
- 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
- (
- Int, :
- 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
- (
- Int, :
- 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: DEPRECATED. Does nothing. Pass in the email in the
- # keywords field instead.
- # 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
- # tag_ids: [Not documented]
- (
- Int, :
- String, :
- String, :
- Boolean, :
- String, :
- String, :
- Boolean, :
- Boolean, :
- String, :
- ID, :
- Boolean, :
- String, :
- ID, :
- ID], : [
- Boolean, :
- Boolean, :
- Boolean, :
- ID] : [
- ): [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
- # tag_ids: [Not documented]
- (
- String, :
- String, :
- String, :
- String, :
- ID, :
- Boolean, :
- Boolean, :
- Boolean, :
- ID] : [
- ): 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]
- (
- String, :
- ID, :
- ID, :
- ID :
- ): ValidateOfferingCoupon
- # Check if a reset passwrd token is valid
- #
- # Arguments
- # token: [Not documented]
- String): Boolean ( :
- # Check if a signup token is valid
- #
- # Arguments
- # token: [Not documented]
- String): Boolean ( :
- # Arguments
- # entry_id: Entry to query daily intake total if present.
- # created_at: Date entry was posted
- ID, : String): Entry ( :
- # Fetch possible Webhook event types
- String] : [
- # Fetch paginated Webhooks collection
- #
- # Arguments
- # offset: [Not documented]
- # keywords: [Not documented]
- # sort_by: [Not documented]
- Int, : String, : String): [Webhook] ( :
- # Number of Webhooks
- #
- # Arguments
- # keywords: [Not documented]
- String): Int ( :
- # Whitelabel setting to use
- #
- # Arguments
- # branded_url: [Not documented]
- String): WhitelabelSetting ( :
- # Generate a JWT to be used in the client-side Zoom SDK. This is just available on
- # production, and requires your account to be approved by Healthie. The JWT is
- # valid for 1 day.
- String :
- }
link Require by
This element is not required by anyone