{
  "$result_object_key": {
    "active": true,
    "active_tags": [
      "Weight Loss",
      "Diabetes"
    ],
    "changed_fields": [
      "email_address",
      "first_name",
      "last_name"
    ],
    "client_readable_source": "src",
    "client_source": {
      "id": "3265",
      "readable_source": "John Doe MS, LMFT",
      "ref_source": "12345",
      "ref_source_other": "Instagram",
      "ref_type": "referring_provider",
      "related_insurance_id": "12345",
      "related_object_id": "12345",
      "related_object_name": "Other"
    },
    "course_memberships": [
      {
        "course_id": "54654",
        "course_name": "Nutrition 101",
        "course_status": "active",
        "started_at": "2024-02-14T16:10:11+00:00",
        "updated_at": "2024-03-01T17:12:18+00:00"
      }
    ],
    "date_of_birth": "1950-08-04",
    "default_stripe_customer_detail_id": "cus_123456",
    "diagnoses": [
      {
        "active": true,
        "end_date": "2024-07-04",
        "first_symptom_date": "2023-07-04",
        "icd_code": {
          "code": "F41.1",
          "display_name": "Generalized anxiety disorder"
        }
      }
    ],
    "dietician_organization_id": "5465412",
    "dietitian_email_address": "drfleming@example.com",
    "dietitian_first_name": "Alexander",
    "dietitian_id": "100070",
    "dietitian_last_name": "Fleming",
    "dietitian_organization_id": "20042",
    "email_address": "john.doe@example.com",
    "first_name": "John",
    "gender": "Male",
    "gender_identity": "Male",
    "has_created_password": true,
    "height_meters": 1.75,
    "id": "131391",
    "insurance_authorization": {
      "end_on": "2024-09-01",
      "start_on": "2024-02-12",
      "units_authorized": "10",
      "units_left": "5",
      "units_used": "5",
      "visits_left": "3"
    },
    "last_active": "2024-07-04T09:39:18+00:00",
    "last_appt_date": "2024-04-22T09:00:00-04:00",
    "last_appt_id": "604820",
    "last_name": "Doe",
    "legal_name": "Test Patient",
    "location": {
      "city": "San Francisco",
      "country": "USA",
      "line1": "123 Main Street",
      "line2": "Suite 100",
      "state": "CA",
      "zip": "94117"
    },
    "money_owed": "100.00",
    "next_appt_date": "2024-08-17T10:30:00-04:00",
    "next_appt_id": "604821",
    "next_required_step": "Complete onboarding",
    "notification_contacts": [
      {
        "email_address": "john.doe@example.com",
        "first_name": "John",
        "id": "212012",
        "is_emergency_contact": true,
        "last_name": "Doe",
        "phone_number": "+15551234123",
        "relationship": "Caregiver"
      }
    ],
    "other_provider_ids": [
      "123456",
      "789012"
    ],
    "phone_number": "+15551234123",
    "policies": [
      {
        "benefits": [
          {
            "coinsurance": "15",
            "copay": "50",
            "deductible_calendar_year": "2000",
            "deductible_year_to_date": "1500"
          }
        ],
        "effective_end": "2024-07-04",
        "group_num": "331256",
        "id": "202402",
        "insurance_card_back_id": "123452",
        "insurance_card_front_id": "123451",
        "insurance_plan": {
          "id": "611231",
          "name_and_id": "Blue Cross Blue Shield - 629913",
          "payer_id": "629913",
          "payer_name": "Blue Cross Blue Shield"
        },
        "insurance_type": "Medicaid",
        "notes": "Policy is active",
        "num": "1912310",
        "patient_id": "100121",
        "priority_type": "Primary",
        "updated_at": "2024-07-01T11:29:19+00:00"
      }
    ],
    "primary_ethnicity_code": "2135-2",
    "primary_race": "White",
    "primary_race_code": "1002-5",
    "pronouns": "He/Him",
    "providers": [
      {
        "first_name": "Brian",
        "id": "720312",
        "last_name": "Hippocrates",
        "name": "Dr. Brian Hippocrates",
        "qualifications": "MD"
      }
    ],
    "quick_notes": "Patient is very motivated to get well",
    "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353",
    "referring_physician_emails": [
      "brian.hippocrates@example.com",
      "joseph.lister@example.com"
    ],
    "referring_physicians": [
      {
        "business_name": "Dr. John",
        "created_at": "2024-05-10T08:46:04Z",
        "email": "john.doe@example.com",
        "first_name": "John",
        "full_name": "John Doe",
        "id": "57211",
        "last_name": "Doe",
        "location": {
          "city": "San Francisco",
          "country": "USA",
          "line1": "123 Main Street",
          "line2": "Suite 100",
          "state": "CA",
          "zip": "94117"
        },
        "phone_number": "+15551234123"
      }
    ],
    "referring_provider_name": "Fred Flintstone",
    "set_password_link": "https://passwords.health.co/reset",
    "sex": "Male",
    "sex_assigned_at_birth": "Male",
    "sexual_orientation": "Heterosexual",
    "timezone": "America/Los_Angeles",
    "timing": {
      "created_at": "2022-07-01T00:01:00+00:00",
      "updated_at": "2022-07-01T00:01:00+00:00"
    },
    "unconfirmed_appointment_count": 1,
    "user_group": {
      "created_at": "2024-07-01T11:29:19+00:00",
      "id": "123012",
      "name": "Intake"
    },
    "weight_kilograms": 75
  }
}
{
  "$result_object_key": {
    "active": "Whether the User is active",
    "active_tags": "List of active tags for the User",
    "changed_fields": "Healthie User object fields changed in triggering the event for this User (Patient)",
    "client_readable_source": "Client readable source for the user",
    "client_source": {
      "id": "ID of the client source",
      "readable_source": "Get readable source based on ref_type",
      "ref_source": "The source of how a client was acquired: contain ID or a Other string",
      "ref_source_other": "If ref_source eq 'Other', than it may contain custom string or NULL",
      "ref_type": "The type of the source of how a client was acquired",
      "related_insurance_id": "ID of the related insurance",
      "related_object_id": "ID of the related object, or 'Other'",
      "related_object_name": "Name of the related object"
    },
    "course_memberships": {
      "course_id": "ID of the course",
      "course_name": "Name of the course",
      "course_status": "Status of the course membership",
      "started_at": "Time the course membership started",
      "updated_at": "Time the course membership was last updated"
    },
    "date_of_birth": "Date of birth of the User",
    "default_stripe_customer_detail_id": "Default Stripe customer detail ID",
    "diagnoses": {
      "active": "Whether the diagnosis is currently active",
      "end_date": "Date the diagnosis ended",
      "first_symptom_date": "Date of first symptoms",
      "icd_code": {
        "code": "ICD code",
        "display_name": "Display name for the ICD code"
      }
    },
    "dietician_organization_id": "Organization ID for the user's registered dietitian",
    "dietitian_email_address": "Email address of the User's registered dietitian",
    "dietitian_first_name": "First name of the User's registered dietitian",
    "dietitian_id": "ID of the User's registered dietitian",
    "dietitian_last_name": "Last name of the User's registered dietitian",
    "dietitian_organization_id": "Organization ID for the User's registered dietitian",
    "email_address": "Email address of the User",
    "first_name": "First name of the User",
    "gender": "Gender",
    "gender_identity": "Gender identity",
    "has_created_password": "Whether the User has created a password",
    "height_meters": "Height in meters",
    "id": "ID for the User",
    "insurance_authorization": {
      "end_on": "The day that visits authorized by the insurance company have no effect",
      "start_on": "The day that visits authorized by the insurance company take effect",
      "units_authorized": "Number of units authorized",
      "units_left": "Number of units left",
      "units_used": "Number of units used",
      "visits_left": "Number of visits left"
    },
    "last_active": "Time the User was last active",
    "last_appt_date": "The datetime of the last appointment the Patient had",
    "last_appt_id": "The last scheduled appointment ID for this Patient (if specified)",
    "last_name": "Last name of the User",
    "legal_name": "Legal name of the Patient",
    "location": {
      "city": "City",
      "country": "Country",
      "line1": "First line of the address",
      "line2": "Second line of the address",
      "state": "State",
      "zip": "Zip code"
    },
    "money_owed": "Amount of money owed by the User",
    "next_appt_date": "The timestamp of the next scheduled appointment for this Patient (if scheduled)",
    "next_appt_id": "The next scheduled appointment ID for this Patient (if specified)",
    "next_required_step": "Next required step for the User",
    "notification_contacts": {
      "email_address": "Email address of the notification contact",
      "first_name": "First name of the notification contact",
      "id": "ID for the notification contact",
      "is_emergency_contact": "Whether the notification contact is an emergency contact",
      "last_name": "Last name of the notification contact",
      "phone_number": "Phone number of the notification contact",
      "relationship": "Relationship between the notification contact and the user"
    },
    "other_provider_ids": "List of other provider IDs associated with the User",
    "phone_number": "Phone number of the User",
    "policies": {
      "benefits": {
        "coinsurance": "Coinsurance percentage due",
        "copay": "Copay amount due",
        "deductible_calendar_year": "Deductible amount for the calendar year",
        "deductible_year_to_date": "Deductible amount for the year to-date"
      },
      "effective_end": "Date the policy coverage expires",
      "group_num": "Group number",
      "id": "ID for the policy",
      "insurance_card_back_id": "ID of the insurance card back image object",
      "insurance_card_front_id": "ID of the insurance card front image object",
      "insurance_plan": {
        "id": "ID of the insurance plan",
        "name_and_id": "Name of the payer and id of payer",
        "payer_id": "ID of the insurance payer",
        "payer_name": "Name of the insurance payer"
      },
      "insurance_type": "The type of insurance: `type_string`",
      "notes": "Notes about the policy",
      "num": "Policy number",
      "patient_id": "ID of the patient associated with the policy",
      "priority_type": "The priority type of insurance: `priority_type`",
      "updated_at": "Last time the Policy was updated"
    },
    "primary_ethnicity_code": "The primary ethnicity code for the Patient",
    "primary_race": "Primary race",
    "primary_race_code": "The primary race code for the Patient",
    "pronouns": "Pronouns",
    "providers": {
      "first_name": "First name of the provider",
      "id": "ID for the provider",
      "last_name": "Last name of the provider",
      "name": "Name of the provider",
      "qualifications": "Qualifications of the provider"
    },
    "quick_notes": "Quick notes about the user",
    "record_identifier": "Record identifier for the User (external unique patient ID reference)",
    "referring_physician_emails": "List of referring physician emails",
    "referring_physicians": {
      "business_name": "Provider's business name",
      "created_at": "Provider's creation date",
      "email": "Provider's email",
      "first_name": "Provider's first name",
      "full_name": "Provider's full name",
      "id": "Provider ID",
      "last_name": "Provider's last name",
      "location": {
        "city": "City",
        "country": "Country",
        "line1": "First line of the address",
        "line2": "Second line of the address",
        "state": "State",
        "zip": "Zip code"
      },
      "phone_number": "Provider's phone number"
    },
    "referring_provider_name": "Name of the referring provider",
    "set_password_link": "Password setup hyperlink",
    "sex": "Sex",
    "sex_assigned_at_birth": "Sex assigned at birth",
    "sexual_orientation": "Sexual orientation",
    "timezone": "Timezone registered for the User",
    "timing": {
      "created_at": "Time the object was created",
      "updated_at": "Time the object was updated"
    },
    "unconfirmed_appointment_count": "Number of unconfirmed appointments",
    "user_group": {
      "created_at": "When the User Group was created",
      "id": "ID of the User Group",
      "name": "Name of the User Group"
    },
    "weight_kilograms": "Weight in kilograms"
  }
}

Parameters

Action
Parameters
{
  "$result_object_key": {
    "active": true,
    "active_tags": [
      "Weight Loss",
      "Diabetes"
    ],
    "changed_fields": [
      "email_address",
      "first_name",
      "last_name"
    ],
    "client_readable_source": "src",
    "client_source": {
      "id": "3265",
      "readable_source": "John Doe MS, LMFT",
      "ref_source": "12345",
      "ref_source_other": "Instagram",
      "ref_type": "referring_provider",
      "related_insurance_id": "12345",
      "related_object_id": "12345",
      "related_object_name": "Other"
    },
    "course_memberships": [
      {
        "course_id": "54654",
        "course_name": "Nutrition 101",
        "course_status": "active",
        "started_at": "2024-02-14T16:10:11+00:00",
        "updated_at": "2024-03-01T17:12:18+00:00"
      }
    ],
    "date_of_birth": "1950-08-04",
    "default_stripe_customer_detail_id": "cus_123456",
    "diagnoses": [
      {
        "active": true,
        "end_date": "2024-07-04",
        "first_symptom_date": "2023-07-04",
        "icd_code": {
          "code": "F41.1",
          "display_name": "Generalized anxiety disorder"
        }
      }
    ],
    "dietician_organization_id": "5465412",
    "dietitian_email_address": "drfleming@example.com",
    "dietitian_first_name": "Alexander",
    "dietitian_id": "100070",
    "dietitian_last_name": "Fleming",
    "dietitian_organization_id": "20042",
    "email_address": "john.doe@example.com",
    "first_name": "John",
    "gender": "Male",
    "gender_identity": "Male",
    "has_created_password": true,
    "height_meters": 1.75,
    "id": "131391",
    "insurance_authorization": {
      "end_on": "2024-09-01",
      "start_on": "2024-02-12",
      "units_authorized": "10",
      "units_left": "5",
      "units_used": "5",
      "visits_left": "3"
    },
    "last_active": "2024-07-04T09:39:18+00:00",
    "last_appt_date": "2024-04-22T09:00:00-04:00",
    "last_appt_id": "604820",
    "last_name": "Doe",
    "legal_name": "Test Patient",
    "location": {
      "city": "San Francisco",
      "country": "USA",
      "line1": "123 Main Street",
      "line2": "Suite 100",
      "state": "CA",
      "zip": "94117"
    },
    "money_owed": "100.00",
    "next_appt_date": "2024-08-17T10:30:00-04:00",
    "next_appt_id": "604821",
    "next_required_step": "Complete onboarding",
    "notification_contacts": [
      {
        "email_address": "john.doe@example.com",
        "first_name": "John",
        "id": "212012",
        "is_emergency_contact": true,
        "last_name": "Doe",
        "phone_number": "+15551234123",
        "relationship": "Caregiver"
      }
    ],
    "other_provider_ids": [
      "123456",
      "789012"
    ],
    "phone_number": "+15551234123",
    "policies": [
      {
        "benefits": [
          {
            "coinsurance": "15",
            "copay": "50",
            "deductible_calendar_year": "2000",
            "deductible_year_to_date": "1500"
          }
        ],
        "effective_end": "2024-07-04",
        "group_num": "331256",
        "id": "202402",
        "insurance_card_back_id": "123452",
        "insurance_card_front_id": "123451",
        "insurance_plan": {
          "id": "611231",
          "name_and_id": "Blue Cross Blue Shield - 629913",
          "payer_id": "629913",
          "payer_name": "Blue Cross Blue Shield"
        },
        "insurance_type": "Medicaid",
        "notes": "Policy is active",
        "num": "1912310",
        "patient_id": "100121",
        "priority_type": "Primary",
        "updated_at": "2024-07-01T11:29:19+00:00"
      }
    ],
    "primary_ethnicity_code": "2135-2",
    "primary_race": "White",
    "primary_race_code": "1002-5",
    "pronouns": "He/Him",
    "providers": [
      {
        "first_name": "Brian",
        "id": "720312",
        "last_name": "Hippocrates",
        "name": "Dr. Brian Hippocrates",
        "qualifications": "MD"
      }
    ],
    "quick_notes": "Patient is very motivated to get well",
    "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353",
    "referring_physician_emails": [
      "brian.hippocrates@example.com",
      "joseph.lister@example.com"
    ],
    "referring_physicians": [
      {
        "business_name": "Dr. John",
        "created_at": "2024-05-10T08:46:04Z",
        "email": "john.doe@example.com",
        "first_name": "John",
        "full_name": "John Doe",
        "id": "57211",
        "last_name": "Doe",
        "location": {
          "city": "San Francisco",
          "country": "USA",
          "line1": "123 Main Street",
          "line2": "Suite 100",
          "state": "CA",
          "zip": "94117"
        },
        "phone_number": "+15551234123"
      }
    ],
    "referring_provider_name": "Fred Flintstone",
    "set_password_link": "https://passwords.health.co/reset",
    "sex": "Male",
    "sex_assigned_at_birth": "Male",
    "sexual_orientation": "Heterosexual",
    "timezone": "America/Los_Angeles",
    "timing": {
      "created_at": "2022-07-01T00:01:00+00:00",
      "updated_at": "2022-07-01T00:01:00+00:00"
    },
    "unconfirmed_appointment_count": 1,
    "user_group": {
      "created_at": "2024-07-01T11:29:19+00:00",
      "id": "123012",
      "name": "Intake"
    },
    "weight_kilograms": 75
  }
}
{
  "$result_object_key": {
    "active": "Whether the User is active",
    "active_tags": "List of active tags for the User",
    "changed_fields": "Healthie User object fields changed in triggering the event for this User (Patient)",
    "client_readable_source": "Client readable source for the user",
    "client_source": {
      "id": "ID of the client source",
      "readable_source": "Get readable source based on ref_type",
      "ref_source": "The source of how a client was acquired: contain ID or a Other string",
      "ref_source_other": "If ref_source eq 'Other', than it may contain custom string or NULL",
      "ref_type": "The type of the source of how a client was acquired",
      "related_insurance_id": "ID of the related insurance",
      "related_object_id": "ID of the related object, or 'Other'",
      "related_object_name": "Name of the related object"
    },
    "course_memberships": {
      "course_id": "ID of the course",
      "course_name": "Name of the course",
      "course_status": "Status of the course membership",
      "started_at": "Time the course membership started",
      "updated_at": "Time the course membership was last updated"
    },
    "date_of_birth": "Date of birth of the User",
    "default_stripe_customer_detail_id": "Default Stripe customer detail ID",
    "diagnoses": {
      "active": "Whether the diagnosis is currently active",
      "end_date": "Date the diagnosis ended",
      "first_symptom_date": "Date of first symptoms",
      "icd_code": {
        "code": "ICD code",
        "display_name": "Display name for the ICD code"
      }
    },
    "dietician_organization_id": "Organization ID for the user's registered dietitian",
    "dietitian_email_address": "Email address of the User's registered dietitian",
    "dietitian_first_name": "First name of the User's registered dietitian",
    "dietitian_id": "ID of the User's registered dietitian",
    "dietitian_last_name": "Last name of the User's registered dietitian",
    "dietitian_organization_id": "Organization ID for the User's registered dietitian",
    "email_address": "Email address of the User",
    "first_name": "First name of the User",
    "gender": "Gender",
    "gender_identity": "Gender identity",
    "has_created_password": "Whether the User has created a password",
    "height_meters": "Height in meters",
    "id": "ID for the User",
    "insurance_authorization": {
      "end_on": "The day that visits authorized by the insurance company have no effect",
      "start_on": "The day that visits authorized by the insurance company take effect",
      "units_authorized": "Number of units authorized",
      "units_left": "Number of units left",
      "units_used": "Number of units used",
      "visits_left": "Number of visits left"
    },
    "last_active": "Time the User was last active",
    "last_appt_date": "The datetime of the last appointment the Patient had",
    "last_appt_id": "The last scheduled appointment ID for this Patient (if specified)",
    "last_name": "Last name of the User",
    "legal_name": "Legal name of the Patient",
    "location": {
      "city": "City",
      "country": "Country",
      "line1": "First line of the address",
      "line2": "Second line of the address",
      "state": "State",
      "zip": "Zip code"
    },
    "money_owed": "Amount of money owed by the User",
    "next_appt_date": "The timestamp of the next scheduled appointment for this Patient (if scheduled)",
    "next_appt_id": "The next scheduled appointment ID for this Patient (if specified)",
    "next_required_step": "Next required step for the User",
    "notification_contacts": {
      "email_address": "Email address of the notification contact",
      "first_name": "First name of the notification contact",
      "id": "ID for the notification contact",
      "is_emergency_contact": "Whether the notification contact is an emergency contact",
      "last_name": "Last name of the notification contact",
      "phone_number": "Phone number of the notification contact",
      "relationship": "Relationship between the notification contact and the user"
    },
    "other_provider_ids": "List of other provider IDs associated with the User",
    "phone_number": "Phone number of the User",
    "policies": {
      "benefits": {
        "coinsurance": "Coinsurance percentage due",
        "copay": "Copay amount due",
        "deductible_calendar_year": "Deductible amount for the calendar year",
        "deductible_year_to_date": "Deductible amount for the year to-date"
      },
      "effective_end": "Date the policy coverage expires",
      "group_num": "Group number",
      "id": "ID for the policy",
      "insurance_card_back_id": "ID of the insurance card back image object",
      "insurance_card_front_id": "ID of the insurance card front image object",
      "insurance_plan": {
        "id": "ID of the insurance plan",
        "name_and_id": "Name of the payer and id of payer",
        "payer_id": "ID of the insurance payer",
        "payer_name": "Name of the insurance payer"
      },
      "insurance_type": "The type of insurance: `type_string`",
      "notes": "Notes about the policy",
      "num": "Policy number",
      "patient_id": "ID of the patient associated with the policy",
      "priority_type": "The priority type of insurance: `priority_type`",
      "updated_at": "Last time the Policy was updated"
    },
    "primary_ethnicity_code": "The primary ethnicity code for the Patient",
    "primary_race": "Primary race",
    "primary_race_code": "The primary race code for the Patient",
    "pronouns": "Pronouns",
    "providers": {
      "first_name": "First name of the provider",
      "id": "ID for the provider",
      "last_name": "Last name of the provider",
      "name": "Name of the provider",
      "qualifications": "Qualifications of the provider"
    },
    "quick_notes": "Quick notes about the user",
    "record_identifier": "Record identifier for the User (external unique patient ID reference)",
    "referring_physician_emails": "List of referring physician emails",
    "referring_physicians": {
      "business_name": "Provider's business name",
      "created_at": "Provider's creation date",
      "email": "Provider's email",
      "first_name": "Provider's first name",
      "full_name": "Provider's full name",
      "id": "Provider ID",
      "last_name": "Provider's last name",
      "location": {
        "city": "City",
        "country": "Country",
        "line1": "First line of the address",
        "line2": "Second line of the address",
        "state": "State",
        "zip": "Zip code"
      },
      "phone_number": "Provider's phone number"
    },
    "referring_provider_name": "Name of the referring provider",
    "set_password_link": "Password setup hyperlink",
    "sex": "Sex",
    "sex_assigned_at_birth": "Sex assigned at birth",
    "sexual_orientation": "Sexual orientation",
    "timezone": "Timezone registered for the User",
    "timing": {
      "created_at": "Time the object was created",
      "updated_at": "Time the object was updated"
    },
    "unconfirmed_appointment_count": "Number of unconfirmed appointments",
    "user_group": {
      "created_at": "When the User Group was created",
      "id": "ID of the User Group",
      "name": "Name of the User Group"
    },
    "weight_kilograms": "Weight in kilograms"
  }
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions.

Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow.

Here we demonstrate how to refer to this data using the prefix $result_object_key.

User
Fetch Action Response Object