Healthie API

https://docs.gethealthie.com/
Admin
Healthie's API-first platform allows building, scaling, and embedding modern healthcare experiences...
Tokens:1,256,646
Snippets:12,373
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example Configurations for Insurance Billing Methods

Source: https://docs.gethealthie.com/guides/billing/insurance-auto-billing

Example variables for setting up a $25 copay, 20% coinsurance, and unmet deductible billing. Each example shows the required fields and values.

```json
{
  "variables": {
    "id": "patient_123",
    "policies_attributes": [
      {
        "id": "policy_456",
        "insurance_billing_method": "copay",
        "copay_value": 2500,
        "coinsurance_value": 0
      }
    ]
  }
}
```

```json
{
  "variables": {
    "id": "patient_123",
    "policies_attributes": [
      {
        "id": "policy_456",
        "insurance_billing_method": "coinsurance",
        "copay_value": 0,
        "coinsurance_value": 20
      }
    ]
  }
}
```

```json
{
  "variables": {
    "id": "patient_123",
    "policies_attributes": [
      {
        "id": "policy_456",
        "insurance_billing_method": "unmet_deductible",
        "copay_value": 0,
        "coinsurance_value": 0
      }
    ]
  }
}
```

--------------------------------

### Install dependencies with npm

Source: https://docs.gethealthie.com/guides/websockets-and-subscriptions/setting-up-apollo-client

Install @rails/actioncable and graphql-ruby-client using npm.

```bash
npm install @rails/actioncable graphql-ruby-client
```

--------------------------------

### appointment.recording_started payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the appointment.recording_started event, fired when recording starts for an appointment.

```json
{
  "resource_id": "67890",
  "resource_id_type": "Appointment",
  "event_type": "appointment.recording_started",
  "changed_fields": []
}
```

--------------------------------

### createSetupIntent mutation example

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/createsetupintent

Use this mutation to create a Stripe Setup Intent. The input variable is of type createSetupIntentInput. The response includes intentClientSecret and messages.

```graphql
mutation createSetupIntent($input: createSetupIntentInput) {
  createSetupIntent(input: $input) {
    intentClientSecret
    messages
  }
}
```

--------------------------------

### Install dependencies with yarn

Source: https://docs.gethealthie.com/guides/websockets-and-subscriptions/setting-up-apollo-client

Install @rails/actioncable and graphql-ruby-client using yarn.

```bash
yarn add @rails/actioncable graphql-ruby-client
```

--------------------------------

### courseClientsCount GraphQL query example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/courseclientscount

Example query that takes course_id and course_status as variables and returns the count of clients for that course.

```GraphQL
query courseClientsCount($course_id: ID, $course_status: String) {
  courseClientsCount(course_id: $course_id, course_status: $course_status)
}
```

--------------------------------

### Install @healthie/sdk with npm

Source: https://docs.gethealthie.com/guides/react-sdks

Install the Healthie React SDK using npm. The SDK works with Healthie's GraphQL API only.

```bash
npm install @healthie/sdk
```

--------------------------------

### createSetupIntent

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/createsetupintent

Creates a Stripe Setup Intent for setting up payment methods for future usage without immediately charging.

```APIDOC
## createSetupIntent

### Description
Create a Stripe Setup Intent. Used for setting up payment methods for future usage without immediately charging.

### Arguments
- **input** (`createSetupIntentInput`) - Parameters for createSetupIntent

### Returns
- **createSetupIntentPayload** - The payload returned by the mutation.

### Example
```graphql
mutation createSetupIntent($input: createSetupIntentInput) {
  createSetupIntent(input: $input) {
    intentClientSecret
    messages
  }
}
```
```

--------------------------------

### conversation.created example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Payload for the conversation.created webhook, fired when a new conversation is started via the createConversation mutation.

```json
{
  "resource_id": "13000",
  "resource_id_type": "Conversation",
  "event_type": "conversation.created",
  "changed_fields": []
}
```

--------------------------------

### appointment.transcript_started payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the appointment.transcript_started event, fired when transcript capture starts. No GraphQL mutations trigger this webhook.

```json
{
  "resource_id": "12345678",
  "resource_id_type": "Appointment",
  "event_type": "appointment.transcript_started",
  "changed_fields": []
}
```

--------------------------------

### onboardingFlow query example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/onboardingflow

Example GraphQL query to fetch an onboarding flow by id, user_id, or uuid. The query accepts optional arguments and returns the OnboardingFlow object with the listed fields.

```graphql
query onboardingFlow($id: ID, $user_id: ID, $uuid: String) {
  onboardingFlow(id: $id, user_id: $user_id, uuid: $uuid) {
    created_at
    cursor
    has_forms_after_welcome
    id
    is_multiple_providers
    name
    onboarding_items
    onboarding_items_count
    user
    user_groups
    user_groups_count
    user_groups_name_string
  }
}
```

--------------------------------

### Onboarding Item Object Example

Source: https://docs.gethealthie.com/guides/forms

Shows the structure of an OnboardingItem object with fields id, item_type, display_name, is_skippable, and onboarding_flow.

```json
{
  "id": "1980",
  "item_type": "Insurance Form",
  "display_name": "Insurance Form",
  "is_skippable": true,
  "onboarding_flow": {
    "id": "170"
  }
}
```

--------------------------------

### Example variables for createRecurringAppointment

Source: https://docs.gethealthie.com/guides/scheduling/appointments

JSON variables for the createRecurringAppointment mutation. Creates a series of 8 weekly appointments starting March 15, 2024, with join_all true to auto-register attendees.

```json
{
  "user_id": "123",
  "appointment_type_id": "456",
  "contact_type": "Healthie Video Call",
  "other_party_id": "789",
  "datetime": "2024-03-15T14:00:00Z",
  "recurring_appointment": {
    "repeat_interval": "Weekly",
    "repeat_times": "8",
    "join_all": true
  }
}
```

--------------------------------

### Example Welcome and Ping Messages

Source: https://docs.gethealthie.com/guides/websockets-and-subscriptions/getting-started

After connecting, you receive a welcome message and periodic pings. The welcome message includes a session ID (sid), and the ping includes a timestamp.

```json
{
  "type": "welcome",
  "sid": "0czVwnltbucBy23AanKFJ"
}
```

```json
{
  "type": "ping",
  "message": 1664558222
}
```

--------------------------------

### Fetch onboarding flows collection

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/onboardingflows

Example GraphQL query for the onboardingFlows field. It accepts optional arguments for filtering (keywords, order_by, sort_by), pagination (offset, should_paginate, page_size, after), and returns a list of OnboardingFlow objects with fields like created_at, cursor, has_forms_after_welcome, id, is_multiple_providers, name, onboarding_items, onboarding_items_count, user, user_groups, user_groups_count, and user_groups_name_string.

```graphql
query onboardingFlows(
  $keywords: String
  $order_by: OnboardingFlowOrderKeys
  $sort_by: String
  $offset: Int
  $should_paginate: Boolean
  $page_size: Int
  $after: Cursor
) {
  onboardingFlows(
    keywords: $keywords
    order_by: $order_by
    sort_by: $sort_by
    offset: $offset
    should_paginate: $should_paginate
    page_size: $page_size
    after: $after
  ) {
    created_at
    cursor
    has_forms_after_welcome
    id
    is_multiple_providers
    name
    onboarding_items
    onboarding_items_count
    user
    user_groups
    user_groups_count
    user_groups_name_string
  }
}
```

--------------------------------

### deleteSharings mutation example

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/deletesharings

Example mutation that calls deleteSharings with a DestroySharingsInput variable.

```GraphQL
mutation deleteSharings($input: DestroySharingsInput) {
  deleteSharings(input: $input)
}
```

--------------------------------

### diagnosis.updated example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the diagnosis.updated event, fired when a diagnosis is updated.

```json
{
  "resource_id": "26000",
  "resource_id_type": "Diagnosis",
  "event_type": "diagnosis.updated",
  "changed_fields": ["code"],
  "icd_code_id": "67890",
  "user_id": "22222"
}
```

--------------------------------

### onboardingFlowsCount query example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/onboardingflowscount

Example GraphQL query for onboardingFlowsCount. It takes optional keywords, offset, and sort_by arguments and returns an integer count.

```GraphQL
query onboardingFlowsCount($keywords: String, $offset: Int, $sort_by: String) {
  onboardingFlowsCount(keywords: $keywords, offset: $offset, sort_by: $sort_by)
}
```

--------------------------------

### diagnosis.deleted example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the diagnosis.deleted event, fired when a diagnosis is removed.

```json
{
  "resource_id": "26000",
  "resource_id_type": "Diagnosis",
  "event_type": "diagnosis.deleted",
  "changed_fields": [],
  "icd_code_id": "67890",
  "user_id": "22222"
}
```

--------------------------------

### Example Offering Fields

Source: https://docs.gethealthie.com/guides/billing/packages

Shows the structure of an Offering object with example values for fields like id, name, price, billing_frequency, and offering_includes. Useful for understanding the data returned by the API.

```json
{
  "id": "1",
  "name": "Example Package",
  "price": "100.0",
  "currency": "USD",
  "repeat_times": null,
  "show_offering": false,
  "frequency_times_string": "a week",
  "abbreviated_frequency_times_string": "",
  "living_plate_meal_plan_name": null,
  "billing_frequency": "Weekly",
  "first_time_payment": null,
  "archived": false,
  "visibility_status": "hidden",
  "initial_payment_amount": "100.0",
  "initial_price_with_taxes": "100.0",
  "offering_includes": [
    {
      "id": "1",
      "quantity": "1",
      "is_repeating": true,
      "appointment_type": {
        "id": "1",
        "name": "Initial Consultation",
        "clients_can_book": true
      }
    },
    {
      "id": "2",
      "quantity": "3",
      "is_repeating": true,
      "appointment_type": {
        "id": "2",
        "name": "Follow-up Session",
        "clients_can_book": true
      }
    }
  ]
}
```

--------------------------------

### updateAddendum mutation example

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/updateaddendum

Example mutation for updateAddendum. Note that this mutation is deprecated and does nothing; it should not be used.

```graphql
mutation updateAddendum($input: updateAddendumInput) {
  updateAddendum(input: $input) {
    addendum
    messages
  }
}

```

--------------------------------

### createOnboardingItem

Source: https://docs.gethealthie.com/reference/2024-11-01

Creates OnboardingItem.

```APIDOC
## createOnboardingItem

### Description
Creates OnboardingItem.

### Method
Mutation

### Endpoint
createOnboardingItem
```

--------------------------------

### sent_notification_record.created Example Payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the sent_notification_record.created webhook event. Fires when a notification is sent.

```json
{
  "resource_id": "51000",
  "resource_id_type": "SentNotificationRecord",
  "event_type": "sent_notification_record.created",
  "changed_fields": []
}
```

--------------------------------

### query availableItemTypes

Source: https://docs.gethealthie.com/guides/forms

Lists available item types for an Onboarding Flow. Returns a serialized JSON string containing a list of available types.

```APIDOC
## query availableItemTypes

### Description
Lists available item types for an Onboarding Flow. Returns a serialized JSON string containing a list of available types.

### Method
query

### Endpoint
availableItemTypes

### Parameters
#### Query Parameters
- **onboarding_flow_id** (String) - Optional - ID of the Onboarding Flow to return available types for.

### Request Example
```graphql
query getAvailableItemTypes($onboarding_flow_id: String) {
  availableItemTypes(onboarding_flow_id: $onboarding_flow_id)
}
```

### Response
#### Success Response
Returns a serialized JSON string containing a list of available types. Each type object has an `id` and `name` field, for example: `{"id":"1","name":"Financial Agreement"}`.

#### Response Example
```json
"{\"id\":\"1\",\"name\":\"Financial Agreement\"}"
```
```

--------------------------------

### entry.deleted example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the entry.deleted event, fired when deleteEntry mutation is called.

```json
{
  "resource_id": "22222",
  "resource_id_type": "Entry",
  "event_type": "entry.deleted",
  "changed_fields": []
}
```

--------------------------------

### charting_note_addendum.created example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the charting_note_addendum.created event, fired when createAddendum mutation is called.

```json
{
  "resource_id": "28000",
  "resource_id_type": "ChartingNoteAddendum",
  "event_type": "charting_note_addendum.created",
  "changed_fields": []
}
```

--------------------------------

### createCompletedOnboardingItem

Source: https://docs.gethealthie.com/schema/deletecms1500payload.doc.html

Creates a completed onboarding item.

```APIDOC
## createCompletedOnboardingItem

### Description
Create CompletedOnboardingItem.

### Method
MUTATION

### Endpoint
createCompletedOnboardingItem
```

--------------------------------

### Query: labOrder

Source: https://docs.gethealthie.com/schema/createcms1500payload.doc.html

Fetch onboarding flows collection.

```APIDOC
## Query: labOrder

### Description
Fetch onboarding flows collection.

### Method
QUERY

### Endpoint
labOrder

### Parameters
None documented.

### Response
Returns onboarding flows collection.
```

--------------------------------

### requested_payment.updated example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the requested_payment.updated event, fired when updateRequestedPayment mutation is called.

```json
{
  "resource_id": "66666",
  "resource_id_type": "RequestedPayment",
  "event_type": "requested_payment.updated",
  "changed_fields": ["is_paid"]
}
```

--------------------------------

### Query: labOrder

Source: https://docs.gethealthie.com/schema/createcms1500input.doc.html

Fetch onboarding flows collection.

```APIDOC
## Query: labOrder

### Description
Fetch onboarding flows collection.

### Method
QUERY

### Endpoint
labOrder

```

--------------------------------

### requested_payment.deleted example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the requested_payment.deleted event, fired when deleteRequestedPayment mutation is called.

```json
{
  "resource_id": "66666",
  "resource_id_type": "RequestedPayment",
  "event_type": "requested_payment.deleted",
  "changed_fields": []
}
```

--------------------------------

### custom_module_form.created example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the custom_module_form.created event. Fires when createCustomModuleForm mutation is called.

```json
{
  "resource_id": "44000",
  "resource_id_type": "CustomModuleForm",
  "event_type": "custom_module_form.created",
  "changed_fields": []
}
```

--------------------------------

### Query: labOrder

Source: https://docs.gethealthie.com/reference

Fetches onboarding flows collection.

```APIDOC
## Query: labOrder

### Description
Fetches onboarding flows collection.

### Method
QUERY

### Endpoint
labOrder

### Parameters
#### Arguments
- **id** (ID) - Required - The id of the lab order.

### Response
#### Success Response
- **labOrder** (LabOrder) - The lab order object.

```

--------------------------------

### updateNoteScheduler mutation example

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/updatenotescheduler

Example mutation that updates a note scheduler and returns messages and noteScheduler fields.

```graphql
mutation updateNoteScheduler($input: updateNoteSchedulerInput) {
  updateNoteScheduler(input: $input) {
    messages
    noteScheduler
  }
}
```

--------------------------------

### Query: labOrder

Source: https://docs.gethealthie.com/reference/2024-11-01

Fetches onboarding flows collection.

```APIDOC
## Query: labOrder

### Description
Fetches onboarding flows collection.

### Operation
labOrder

### Arguments
None specified in source.

### Returns
Onboarding flows collection.
```

--------------------------------

### Query: labOrder

Source: https://docs.gethealthie.com/schema/cms1500.doc.html

Fetches onboarding flows collection.

```APIDOC
## Query: labOrder

### Description
Fetches onboarding flows collection.

### Method
QUERY

### Endpoint
labOrder

### Parameters
None documented.

### Response
Returns a lab order object.
```

--------------------------------

### createClientViaForm mutation example

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/createclientviaform

Example mutation that calls createClientViaForm with an input variable and returns form_answer_group and messages.

```graphql
mutation createClientViaForm($input: CreateClientViaFormInput) {
  createClientViaForm(input: $input) {
    form_answer_group
    messages
  }
}
```

--------------------------------

### Query: labOrder

Source: https://docs.gethealthie.com/schema/deletecms1500payload.doc.html

Fetches onboarding flows collection.

```APIDOC
## Query: labOrder

### Description
Fetches onboarding flows collection.

### Method
QUERY

### Endpoint
labOrder

### Parameters
#### Arguments
- **id** (ID) - Required - The id of the lab order.

### Response
#### Success Response
- **labOrder** (LabOrder) - The lab order.

```

--------------------------------

### organization_info.deleted example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the organization_info.deleted webhook event. Triggered by the deleteOrganizationInfo GraphQL mutation.

```json
{
  "resource_id": "37000",
  "resource_id_type": "OrganizationInfo",
  "event_type": "organization_info.deleted",
  "changed_fields": []
}
```

--------------------------------

### GraphQL query availabilities with all arguments

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/availabilities

Example query for the `availabilities` GraphQL query, including all available arguments and the fields returned. Use this as a template to fetch availabilities for a date range, optionally filtering by provider, location, appointment type, and other criteria.

```GraphQL
query availabilities(
  $appointment_location_id: ID
  $appointment_type_id: ID
  $appointment_type_ids: [ID]
  $availability_provider_id: ID
  $contact_type_id: ID
  $endDate: ISO8601DateTime
  $end_date_padding: Int
  $includeRepeating: Boolean
  $is_org: Boolean
  $is_repeating: Boolean
  $one_time: Boolean
  $provider_id: ID
  $provider_ids: [ID]
  $include_suborganizations: Boolean
  $show_availability: Boolean
  $startDate: ISO8601DateTime
  $start_date_padding: Int
  $user_id: ID
  $organization_id: ID
  $timezone: String
  $state_license: String
  $tag_ids: [ID]
  $insurance_plan_ids: [ID]
) {
  availabilities(
    appointment_location_id: $appointment_location_id
    appointment_type_id: $appointment_type_id
    appointment_type_ids: $appointment_type_ids
    availability_provider_id: $availability_provider_id
    contact_type_id: $contact_type_id
    endDate: $endDate
    end_date_padding: $end_date_padding
    includeRepeating: $includeRepeating
    is_org: $is_org
    is_repeating: $is_repeating
    one_time: $one_time
    provider_id: $provider_id
    provider_ids: $provider_ids
    include_suborganizations: $include_suborganizations
    show_availability: $show_availability
    startDate: $startDate
    start_date_padding: $start_date_padding
    user_id: $user_id
    organization_id: $organization_id
    timezone: $timezone
    state_license: $state_license
    tag_ids: $tag_ids
    insurance_plan_ids: $insurance_plan_ids
  ) {
    appointment_location_id
    appointment_type_id
    appointment_types
    contact_type_id
    contact_type_ids
    created_at
    day_of_week
    duration_string
    end_on
    has_all_appointment_types
    has_all_contact_types
    id
    is_repeating
    origin_start_date
    range_end
    range_start
    repeating_availability_id
    resourceId
    timezone
    timezone_abbr
    updated_at
    user
    user_id
  }
}
```

--------------------------------

### organization_info.created example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the organization_info.created webhook event. Triggered by the createOrganization GraphQL mutation.

```json
{
  "resource_id": "37000",
  "resource_id_type": "OrganizationInfo",
  "event_type": "organization_info.created",
  "changed_fields": []
}
```

--------------------------------

### products query example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/products

Example GraphQL query for fetching products with pagination and filtering arguments. Use this to retrieve product data with optional keywords, ordering, sorting, offset, page size, and cursor-based pagination.

```graphql
query products(
  $keywords: String
  $order_by: ProductOrderKeys
  $sort_by: String
  $offset: Int
  $page_size: Int
  $should_paginate: Boolean
  $after: Cursor
) {
  products(
    keywords: $keywords
    order_by: $order_by
    sort_by: $sort_by
    offset: $offset
    page_size: $page_size
    should_paginate: $should_paginate
    after: $after
  ) {
    created_at
    cursor
    id
    name
    price
    remaining_quantity
    tax_description
    tax_rate
    taxable
    unlimited_quantity
    user
  }
}
```

--------------------------------

### task.deleted example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the task.deleted webhook event. Triggered by the deleteTask GraphQL mutation.

```json
{
  "resource_id": "11000",
  "resource_id_type": "Task",
  "event_type": "task.deleted",
  "changed_fields": []
}
```

--------------------------------

### charting_note_addendum.updated example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the charting_note_addendum.updated event, fired when a charting note addendum is updated.

```json
{
  "resource_id": "28000",
  "resource_id_type": "ChartingNoteAddendum",
  "event_type": "charting_note_addendum.updated",
  "changed_fields": ["content"]
}
```

--------------------------------

### List Packages with offerings query

Source: https://docs.gethealthie.com/guides/billing/packages

Use this query to retrieve a list of packages. Requires an authenticated account. Supports optional arguments for filtering, pagination, and sorting. Returns a list of `Offering` objects.

```graphql
query getOfferings(
  $offset: Int
  $should_paginate: Boolean
  $keywords: String
  $sort_by: String
  $provider_id: ID
  $offering_id: ID
  $offering_ids: [ID]
  $only_client_visible: Boolean
  $status: String
  $client_visibility: String
  $offering_user_group_id: ID
  $show_only_visible: Boolean
) {
  offerings(
    offset: $offset
    should_paginate: $should_paginate
    keywords: $keywords
    sort_by: $sort_by
    provider_id: $provider_id
    offering_id: $offering_id
    offering_ids: $offering_ids
    only_client_visible: $only_client_visible
    status: $status
    client_visibility: $client_visibility
    offering_user_group_id: $offering_user_group_id
    show_only_visible: $show_only_visible
  ) {
    id
    name
    billing_frequency
    currency
    price
    initial_payment_amount
    initial_price_with_taxes
  }
}

```

--------------------------------

### charting_note_addendum.deleted example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the charting_note_addendum.deleted event, fired when a charting note addendum is destroyed.

```json
{
  "resource_id": "28000",
  "resource_id_type": "ChartingNoteAddendum",
  "event_type": "charting_note_addendum.deleted",
  "changed_fields": []
}
```

--------------------------------

### Appointment Setting object example fields

Source: https://docs.gethealthie.com/guides/scheduling/appointments

Example JSON showing some fields of an Appointment Setting object, including cancellation and rescheduling options, appointment locations, and notification settings.

```json
{
  "id": "1",
  "allow_clients_to_cancel_appt": true,
  "allow_clients_to_reschedule_appt": true,
  "allow_past_appointment_rescheduling": false,
  "always_send_confirm_notification": false,
  "appointment_locations": [
    {
      "id": "1",
      "location": "Bob's Office"
    }
  ],
  "appt_type_confirmed_email": false,
  "appt_type_reminder_email": false,
  "appt_type_website_booking_email": false,
  "ask_clients_to_confirm": false,
  "ask_to_confirm_via_text": false,
  "auto_invoicing": false,
  "buffer": "0",
  "calendar_color_schemes": [],
  "calendar_interval": "30",
  "cant_cancel_message": "Please contact provider to cancel",
  "cant_reschedule_message": "Please contact provider to reschedule",
  "client_should_call_provider": false,
  "clients_have_billing": true,
  "confirm_by_default": false
}
```

--------------------------------

### newClientPriceString GraphQL Query Example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/newclientpricestring

Example GraphQL query that calls newClientPriceString with the new_client_num argument. The query returns a string with upgrade price information.

```GraphQL
query newClientPriceString($new_client_num: Int) {
  newClientPriceString(new_client_num: $new_client_num)
}
```

--------------------------------

### monthlyBillingItemsData GraphQL query example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/monthlybillingitemsdata

Example query that fetches monthly billing items data. It accepts optional Boolean arguments gross and org_level, and returns a list of MonthlyBillingItemsDataType objects. The example selects the amount and month fields.

```graphql
query monthlyBillingItemsData($gross: Boolean, $org_level: Boolean) {
  monthlyBillingItemsData(gross: $gross, org_level: $org_level) {
    amount
    month
  }
}
```

--------------------------------

### labOrder

Source: https://docs.gethealthie.com/schema/cms1500policyinput.doc.html

Fetch onboarding flows collection.

```APIDOC
## labOrder

### Description
Fetch onboarding flows collection.

### Query
labOrder
```

--------------------------------

### deleteFaxAcctInfo GraphQL Mutation Example

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/deletefaxacctinfo

Example mutation that calls deleteFaxAcctInfo with an input variable and returns messages and success_string.

```graphql
mutation deleteFaxAcctInfo($input: destroyFaxAcctInfoInput) {
  deleteFaxAcctInfo(input: $input) {
    messages
    success_string
  }
}
```

--------------------------------

### sent_notification_record.updated Example Payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the sent_notification_record.updated webhook event. Fires when a sent notification record is updated.

```json
{
  "resource_id": "51000",
  "resource_id_type": "SentNotificationRecord",
  "event_type": "sent_notification_record.updated",
  "changed_fields": ["status"]
}
```

--------------------------------

### onboardingFlows

Source: https://docs.gethealthie.com/schema/cms1500policyinput.doc.html

Fetch onboarding flows collection.

```APIDOC
## onboardingFlows

### Description
Fetch onboarding flows collection.

### Method
QUERY

### Endpoint
onboardingFlows

```

--------------------------------

### createEbook mutation example

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/createebook

Use this mutation to create an ebook. It takes a createEbookInput argument and returns a createEbookPayload with messages and visitor fields.

```graphql
mutation createEbook($input: createEbookInput) {
  createEbook(input: $input) {
    messages
    visitor
  }
}

```

--------------------------------

### availability.created example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the availability.created webhook event. Triggered by the createAvailability and bulkCreateAvailability GraphQL mutations.

```json
{
  "resource_id": "40000",
  "resource_id_type": "Availability",
  "event_type": "availability.created",
  "changed_fields": []
}
```

--------------------------------

### diagnosis.create example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the diagnosis.create event, fired when a diagnosis is added. Note the event_type is diagnosis.created.

```json
{
  "resource_id": "26000",
  "resource_id_type": "Diagnosis",
  "event_type": "diagnosis.created",
  "changed_fields": [],
  "icd_code_id": "67890",
  "user_id": "22222"
}
```

--------------------------------

### Example response from getEntry query

Source: https://docs.gethealthie.com/guides/automation-examples/metric-value-out-of-range

Example response showing a Weight metric with metric_stat 250. Check added_by_user.is_patient to determine if the Metric was added by the Patient, and third_party_source for external sources like Apple Health.

```json
{
  "data": {
    "entry": {
      "id": "555",
      "type": "MetricEntry",
      "category": "Weight",
      "metric_stat": 250,
      "third_party_source": null,
      "poster": {
        "id": "2",
        "full_name": "John Doe",
        "dietitian_id": "1"
      },
      "added_by_user": {
        "id": "2",
        "full_name": "John Doe",
        "dietitian_id": "1",
        "is_patient": true
      }
    }
  }
}
```

--------------------------------

### care_plan.deactivated example payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the care_plan.deactivated event. Fires when a care plan is removed as the active plan.

```json
{
  "resource_id": "23000",
  "resource_id_type": "CarePlan",
  "event_type": "care_plan.deactivated",
  "changed_fields": []
}
```

--------------------------------

### Query onboardingFlows

Source: https://docs.gethealthie.com/guides/forms

GraphQL query to list onboarding flows. Available to authenticated provider/staff accounts. Supports arguments like offset, keywords, sort_by, and should_paginate.

```graphql
query onboardingFlows($offset: Int, $keywords: String, $sort_by: String, $should_paginate: Boolean) {
  onboardingFlows(offset: $offset, keywords: $keywords, sort_by: $sort_by, should_paginate: $should_paginate) {
    id
    name
    is_multiple_providers
    has_forms_after_welcome
  }
}
```

--------------------------------

### userPackageSelections query example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/userpackageselections

Example GraphQL query that fetches user package selections with optional filters. It accepts offering_id, user_id, offset, page_size, and after cursor, and returns fields like billing_item, created_at, cursor, id, offering, and user.

```graphql
query userPackageSelections(
  $offering_id: ID
  $user_id: ID
  $offset: Int
  $page_size: Int
  $after: Cursor
) {
  userPackageSelections(
    offering_id: $offering_id
    user_id: $user_id
    offset: $offset
    page_size: $page_size
    after: $after
  ) {
    billing_item
    billing_item_id
    created_at
    cursor
    id
    initial_price_with_offering_coupon
    offering
    offering_coupon_id
    recurring_payment
    requested_payment
    requested_payment_id
    user
  }
}
```

--------------------------------

### accepted_insurance_plan.deleted Example Payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the accepted_insurance_plan.deleted webhook event, fired when an accepted insurance plan is removed.

```json
{
  "resource_id": "47000",
  "resource_id_type": "AcceptedInsurancePlan",
  "event_type": "accepted_insurance_plan.deleted",
  "changed_fields": []
}
```

--------------------------------

### accepted_insurance_plan.created Example Payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the accepted_insurance_plan.created webhook event, fired when an accepted insurance plan is added.

```json
{
  "resource_id": "47000",
  "resource_id_type": "AcceptedInsurancePlan",
  "event_type": "accepted_insurance_plan.created",
  "changed_fields": []
}
```

--------------------------------

### createOnboardingItem

Source: https://docs.gethealthie.com/reference/2024-11-01/mutations/createonboardingitem

Creates an onboarding item using the provided input. Returns a payload containing messages and the created onboarding item.

```APIDOC
## createOnboardingItem

### Description
Creates an onboarding item using the provided input.

### Arguments
- **input** (`createOnboardingItemInput`) - Parameters for createOnboardingItem.

### Returns
- **createOnboardingItemPayload** - The result of the mutation.

### Example
```graphql
mutation createOnboardingItem($input: createOnboardingItemInput) {
  createOnboardingItem(input: $input) {
    messages
    onboardingItem
  }
}
```
```

--------------------------------

### patient.created Example Payload

Source: https://docs.gethealthie.com/guides/webhooks/event-reference

Example payload for the patient.created event. Fires when createClient, completeCheckout, or createNotificationContact mutation is called.

```json
{
  "resource_id": "45678",
  "resource_id_type": "User",
  "event_type": "patient.created",
  "changed_fields": []
}
```

--------------------------------

### sdkConfig query example

Source: https://docs.gethealthie.com/reference/2024-11-01/queries/sdkconfig

GraphQL query to fetch SDK configuration for a given version. The version is passed as a variable of type String. The query returns an SDKConfig object.

```graphql
query sdkConfig($version: String) {
  sdkConfig(version: $version)
}
```
Tokens:
Raw