Skip to content

Organization

An organization, that is an umbrella group for multiple providers

Fields

active_care_team_members · [User!] · The active potential care team members of the organization
active_members_for_conversation · [User!] · The active users of the organization used for starting new conversations
appointment_locations · [AppointmentLocation!] · Returns organization appointment locations
can_have_suborgs · Boolean · Can have suborgs for this org
cancellation_reasons · [CancellationReason!]! · required · Returns general cancellation reasons
created_at · String! · required · The creation date of the organization
e_labs_settings · ELabsSettings · If enabled for organization, settings for E-Labs
filled_tk_form · FormAnswerGroup · The filled out teaching kitchen form
deprecated No longer supported
id · ID! · required · The unique identifier of the organization
location · Location · The location of the organization
name · String · The name of the organization
npi · String · The NPI of the organization
num_users · String · The number of users in the organization
onboarding_flow_id · String · The ID of the onboarding flow for org providers
only_active_organization_memberships · [OrganizationMembership!] · The active organization memberships of the organization
only_active_providers · [User!] · The active providers of the organization
only_active_providers_count · Int · The number of active providers of the organization
only_active_support · [User!] · The active support users of the organization
only_active_support_count · Int · The number of active support user of the organization
org_roles · [String!] · Potential Organization Roles for this Organization
organization_cpt_codes · [OrganizationCptCodeType!] · Returns organization cpt codes
organization_email · String! · required · The email of organization
organization_info · OrganizationInfo · The first organization info of the organization
organization_infos · [OrganizationInfo!] · The organization infos of the organization
organization_infos_count · Int · The count of organization infos of the organization
organization_memberships · [OrganizationMembership!] · The organization memberships of the organization
organization_memberships_count · Int · The total count of organization memberships on this organization
other_id · String · The other id
other_id_qual · String · The other ID qualifier (what type of ID it is)
owner · User · The owner of the organization
owner_id · ID · The ID of the org owner
owner_subscription · SubscriptionInstance · The owner of the org's subscription
parent_organization · Organization · Parent organization for this org
parent_organization_id · ID · ID of the parent organization
permission_templates · [PermissionTemplateType!] · Permission templates for this org
phone_number · String · The phone number of the organization
providers · [User!] · The providers of the organization
providers_count · Int · The number of providers in the organization
rupa_health_members · [User!] · The number of users in the organization connected their rupa health account
state_licenses · [String!] · Returns organization state licenses
suborganizations · [Organization!] · Suborganizations for this org
tags · [Tag!] · Returns organization tags
tax_id · String · Tax ID of organization
tax_id_type · String · The tax is of the organization
user_groups · [UserGroup!] · User groups that are in the organization
users · [User!] · The users of the organization
zus_builder_id · String · Builder ID for the Zus token

Used By

Definition

"""
An organization, that is an umbrella group for multiple providers
"""
type Organization {
"""
The active potential care team members of the organization
"""
active_care_team_members(
"""
The list of IDs of interested providers
"""
provider_ids: [ID]
"""
Filters the provider list to only include users who have ALL of the specified tags applied. Ignored if org_level is not true
"""
tag_ids: [ID]
"""
An array of provider record identifiers. When passed in, only providers with these matching record identifiers are returned.
"""
record_identifiers: [String]
state_licenses: [String]
): [User!]
"""
The active users of the organization used for starting new conversations
"""
active_members_for_conversation(
exclude_sub_org_members: Boolean = false
keywords: String = null
): [User!]
"""
Returns organization appointment locations
"""
appointment_locations: [AppointmentLocation!]
"""
Can have suborgs for this org
"""
can_have_suborgs: Boolean
"""
Returns general cancellation reasons
"""
cancellation_reasons: [CancellationReason!]!
"""
The creation date of the organization
"""
created_at: String!
"""
If enabled for organization, settings for E-Labs
"""
e_labs_settings: ELabsSettings
"""
The filled out teaching kitchen form
"""
filled_tk_form: FormAnswerGroup @deprecated
"""
The unique identifier of the organization
"""
id: ID!
"""
The location of the organization
"""
location: Location
"""
The name of the organization
"""
name: String
"""
The NPI of the organization
"""
npi: String
"""
The number of users in the organization
"""
num_users: String
"""
The ID of the onboarding flow for org providers
"""
onboarding_flow_id: String
"""
The active organization memberships of the organization
"""
only_active_organization_memberships: [OrganizationMembership!]
"""
The active providers of the organization
"""
only_active_providers(
"""
If false return only active providers of current org
"""
include_suborg_providers: Boolean
"""
Customize IDs of interested providers
"""
provider_ids: [ID]
): [User!]
"""
The number of active providers of the organization
"""
only_active_providers_count(
"""
Customize IDs of interested providers
"""
provider_ids: [ID]
): Int
"""
The active support users of the organization
"""
only_active_support: [User!]
"""
The number of active support user of the organization
"""
only_active_support_count: Int
"""
Potential Organization Roles for this Organization
"""
org_roles: [String!]
"""
Returns organization cpt codes
"""
organization_cpt_codes: [OrganizationCptCodeType!]
"""
The email of organization
"""
organization_email: String!
"""
The first organization info of the organization
"""
organization_info: OrganizationInfo
"""
The organization infos of the organization
"""
organization_infos(
id: ID
keywords: String
offset: Int = 0
should_paginate: Boolean = false
): [OrganizationInfo!]
"""
The count of organization infos of the organization
"""
organization_infos_count: Int
"""
The organization memberships of the organization
"""
organization_memberships(
keywords: String
offset: Int = 0
page_size: Int = 10
should_paginate: Boolean = false
use_filters: Boolean = false
): [OrganizationMembership!]
"""
The total count of organization memberships on this organization
"""
organization_memberships_count(
keywords: String
use_filters: Boolean = false
): Int
"""
The other id
"""
other_id: String
"""
The other ID qualifier (what type of ID it is)
"""
other_id_qual: String
"""
The owner of the organization
"""
owner: User
"""
The ID of the org owner
"""
owner_id: ID
"""
The owner of the org's subscription
"""
owner_subscription: SubscriptionInstance
"""
Parent organization for this org
"""
parent_organization: Organization
"""
ID of the parent organization
"""
parent_organization_id: ID
"""
Permission templates for this org
"""
permission_templates: [PermissionTemplateType!]
"""
The phone number of the organization
"""
phone_number: String
"""
The providers of the organization
"""
providers(
keywords: String
"""
Options are one of [active, archived]
"""
active_status: String
"""
Two letter state abbreviation (e.g. "CA", "NY")
"""
licensed_in_state: String
offset: Int = 0
provider_ids: [ID] = []
should_paginate: Boolean = false
with_private_notes_for_id: String
"""
When passed in, only providers with at least ONE of the passed-in tags will be returned.
"""
with_tag_ids: [ID]
): [User!]
"""
The number of providers in the organization
"""
providers_count: Int
"""
The number of users in the organization connected their rupa health account
"""
rupa_health_members: [User!]
"""
Returns organization state licenses
"""
state_licenses: [String!]
"""
Suborganizations for this org
"""
suborganizations: [Organization!]
"""
Returns organization tags
"""
tags: [Tag!]
"""
Tax ID of organization
"""
tax_id: String
"""
The tax is of the organization
"""
tax_id_type: String
"""
User groups that are in the organization
"""
user_groups: [UserGroup!]
"""
The users of the organization
"""
users(
"""
Options are one of [active, archived]
"""
active_status: String
keywords: String
show_all_by_default: Boolean = false
): [User!]
"""
Builder ID for the Zus token
"""
zus_builder_id: String
}