{
  "active": true,
  "active_tags": [
    "Weight Loss",
    "Diabetes"
  ],
  "additional_phone_number": "+15559876543",
  "additional_record_identifier": "2847455b-caed-4d97-a79c-1f07316e7fbf",
  "brand": {
    "about_description": "We provide comprehensive health services",
    "brand_email": "brand@example.com",
    "brand_name": "My Health Brand",
    "brand_phone": "+15551234567"
  },
  "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",
  "dietitian_organization_location_id": "12345",
  "dietitian_organization_name": "Morf",
  "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"
  },
  "is_patient": true,
  "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"
  },
  "metadata": {
    "priority": "High",
    "referral_department": "Cardiology"
  },
  "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"
    }
  ],
  "npi": "1234567890",
  "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"
      },
      "npi": "1000321231",
      "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",
  "state_licenses": [
    {
      "full_state_name": "New York",
      "id": "500073",
      "state": "NY"
    }
  ],
  "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
}

{
  "active": "Whether the User is active",
  "active_tags": "List of active tags for the User",
  "additional_phone_number": "Additional phone number of the user",
  "additional_record_identifier": "Additional record identifier for the User (an extra external unique patient ID reference)",
  "brand": {
    "about_description": "Brand owner's about description",
    "brand_email": "Brand owner's brand email",
    "brand_name": "Name of provider's brand",
    "brand_phone": "Brand owner's brand phone"
  },
  "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",
  "dietitian_organization_location_id": "Organization's location ID for the User's registered dietitian",
  "dietitian_organization_name": "Organization name 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"
  },
  "is_patient": "Whether the user is a patient",
  "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"
  },
  "metadata": "Metadata for the user",
  "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"
  },
  "npi": "National Provider Identifier, this field only applies if the user is a provider",
  "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"
    },
    "npi": "Provider's NPI",
    "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",
  "state_licenses": {
    "full_state_name": "The full name of the State",
    "id": "The unique identifier of the State license",
    "state": "The abbreviation of the State"
  },
  "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"
}

Events

Triggering Webhook Types

The following event types are associated with the User event payload from Healthie.

Healthie Patient Created
Healthie Patient Updated
Healthie Applied Tag Created
Healthie Applied Tag Deleted

{
  "active": true,
  "active_tags": [
    "Weight Loss",
    "Diabetes"
  ],
  "additional_phone_number": "+15559876543",
  "additional_record_identifier": "2847455b-caed-4d97-a79c-1f07316e7fbf",
  "brand": {
    "about_description": "We provide comprehensive health services",
    "brand_email": "brand@example.com",
    "brand_name": "My Health Brand",
    "brand_phone": "+15551234567"
  },
  "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",
  "dietitian_organization_location_id": "12345",
  "dietitian_organization_name": "Morf",
  "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"
  },
  "is_patient": true,
  "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"
  },
  "metadata": {
    "priority": "High",
    "referral_department": "Cardiology"
  },
  "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"
    }
  ],
  "npi": "1234567890",
  "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"
      },
      "npi": "1000321231",
      "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",
  "state_licenses": [
    {
      "full_state_name": "New York",
      "id": "500073",
      "state": "NY"
    }
  ],
  "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
}

{
  "active": "Whether the User is active",
  "active_tags": "List of active tags for the User",
  "additional_phone_number": "Additional phone number of the user",
  "additional_record_identifier": "Additional record identifier for the User (an extra external unique patient ID reference)",
  "brand": {
    "about_description": "Brand owner's about description",
    "brand_email": "Brand owner's brand email",
    "brand_name": "Name of provider's brand",
    "brand_phone": "Brand owner's brand phone"
  },
  "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",
  "dietitian_organization_location_id": "Organization's location ID for the User's registered dietitian",
  "dietitian_organization_name": "Organization name 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"
  },
  "is_patient": "Whether the user is a patient",
  "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"
  },
  "metadata": "Metadata for the user",
  "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"
  },
  "npi": "National Provider Identifier, this field only applies if the user is a provider",
  "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"
    },
    "npi": "Provider's NPI",
    "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",
  "state_licenses": {
    "full_state_name": "The full name of the State",
    "id": "The unique identifier of the State license",
    "state": "The abbreviation of the State"
  },
  "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"
}

Payload Field Details

Event Payload

Hide fields

string

required

ID ID for the User

CEL

id

Example

"131391"

string

ID Record identifier for the User (external unique patient ID reference)

CEL

record_identifier

Example

"8e11f3ba-3167-4f47-a549-f43dc19df353"

bool

required

Whether the User is active

CEL

active

Example

true

string

PII First name of the User

CEL

first_name

Example

"John"

string

PII Last name of the User

CEL

last_name

Example

"Doe"

values.v1.Date

PII Date of birth of the User

CEL

date_of_birth

Example

"1950-08-04"

string

PII Phone number of the User

CEL

phone_number

Example

"+15551234123"

string

PII Email address of the User

CEL

email_address

Example

"john.doe@example.com"

string

HI Sex assigned at birth

CEL

sex_assigned_at_birth

Example

"Male"

string

HI Gender

CEL

gender

Example

"Male"

string

HI Gender identity

CEL

gender_identity

Example

"Male"

string

HI Pronouns

CEL

pronouns

Example

"He/Him"

object

User Group details

CEL

user_group

Example

{
"created_at": "2024-07-01T11:29:19+00:00",
"id": "123012",
"name": "Intake"
}

string

ID of the User Group

CEL

user_group.id

Example

"123012"

string

Name of the User Group

CEL

user_group.name

Example

"Intake"

timing.v1.Timestamp

When the User Group was created

CEL

user_group.created_at

Example

"2024-07-01T11:29:19+00:00"

[]object

required

PII List of Policies associated with the User

CEL

policies

Example

[
{
"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"
}
]

[]bool

required

Mapped array of: Insurance plan details

CEL

policies.map(x, x.insurance_plan)

Example

[
{
"id": "611231",
"name_and_id": "Blue Cross Blue Shield - 629913",
"payer_id": "629913",
"payer_name": "Blue Cross Blue Shield"
}
]

[]string

required

PII Mapped array of: Policy number

CEL

policies.map(x, x.num)

Example

[
"1912310"
]

[]string

required

Mapped array of: Group number

CEL

policies.map(x, x.group_num)

Example

[
"331256"
]

[]string

required

Mapped array of: Notes about the policy

CEL

policies.map(x, x.notes)

Example

[
"Policy is active"
]

[]values.v1.Date

required

Mapped array of: Date the policy coverage expires

CEL

policies.map(x, x.effective_end)

Example

[
"2024-07-04"
]

[]string

required

Mapped array of: ID for the policy

CEL

policies.map(x, x.id)

Example

[
"202402"
]

[]string

required

ID PII Mapped array of: ID of the patient associated with the policy

CEL

policies.map(x, x.patient_id)

Example

[
"100121"
]

[]string

required

HI ID PII Mapped array of: ID of the insurance card front image object

CEL

policies.map(x, x.insurance_card_front_id)

Example

[
"123451"
]

[]string

required

HI ID PII Mapped array of: ID of the insurance card back image object

CEL

policies.map(x, x.insurance_card_back_id)

Example

[
"123452"
]

[]timing.v1.Timestamp

required

Mapped array of: Last time the Policy was updated

CEL

policies.map(x, x.updated_at)

Example

[
"2024-07-01T11:29:19+00:00"
]

[]string

required

Mapped array of: The type of insurance: type_string

CEL

policies.map(x, x.insurance_type)

Example

[
"Medicaid"
]

[]string

required

Mapped array of: The priority type of insurance: priority_type

CEL

policies.map(x, x.priority_type)

Example

[
"Primary"
]

[]bool

required

Mapped array of: Insurance plan details

CEL

policies.map(x, x.benefits)

Example

[
[
{
"coinsurance": "15",
"copay": "50",
"deductible_calendar_year": "2000",
"deductible_year_to_date": "1500"
}
]
]

object

Insurance authorization details

CEL

insurance_authorization

Example

{
"end_on": "2024-09-01",
"start_on": "2024-02-12",
"units_authorized": "10",
"units_left": "5",
"units_used": "5",
"visits_left": "3"
}

string

Number of units authorized

CEL

insurance_authorization.units_authorized

Example

"10"

string

Number of units used

CEL

insurance_authorization.units_used

Example

"5"

string

Number of units left

CEL

insurance_authorization.units_left

Example

"5"

string

Number of visits left

CEL

insurance_authorization.visits_left

Example

"3"

values.v1.Date

The day that visits authorized by the insurance company take effect

CEL

insurance_authorization.start_on

Example

"2024-02-12"

values.v1.Date

The day that visits authorized by the insurance company have no effect

CEL

insurance_authorization.end_on

Example

"2024-09-01"

string

Timezone registered for the User

CEL

timezone

Example

"America/Los_Angeles"

object

PII Location details

CEL

location

Example

{
"city": "San Francisco",
"country": "USA",
"line1": "123 Main Street",
"line2": "Suite 100",
"state": "CA",
"zip": "94117"
}

string

First line of the address

CEL

location.line1

Example

"123 Main Street"

string

Second line of the address

CEL

location.line2

Example

"Suite 100"

string

City

CEL

location.city

Example

"San Francisco"

string

State

CEL

location.state

Example

"CA"

string

Zip code

CEL

location.zip

Example

"94117"

string

Country

CEL

location.country

Example

"USA"

object

required

Create and update times

CEL

timing

Example

{
"created_at": "2022-07-01T00:01:00+00:00",
"updated_at": "2022-07-01T00:01:00+00:00"
}

timing.v1.Timestamp

required

Time the object was created

CEL

timing.created_at

Example

"2022-07-01T00:01:00+00:00"

timing.v1.Timestamp

required

Time the object was updated

CEL

timing.updated_at

Example

"2022-07-01T00:01:00+00:00"

string

PII Default Stripe customer detail ID

CEL

default_stripe_customer_detail_id

Example

"cus_123456"

[]object

required

HI List of diagnoses associated with the User

CEL

diagnoses

Example

[
{
"active": true,
"end_date": "2024-07-04",
"first_symptom_date": "2023-07-04",
"icd_code": {
"code": "F41.1",
"display_name": "Generalized anxiety disorder"
}
}
]

[]bool

required

Mapped array of: Whether the diagnosis is currently active

CEL

diagnoses.map(x, x.active)

Example

[
true
]

[]values.v1.Date

required

Mapped array of: Date of first symptoms

CEL

diagnoses.map(x, x.first_symptom_date)

Example

[
"2023-07-04"
]

[]values.v1.Date

required

Mapped array of: Date the diagnosis ended

CEL

diagnoses.map(x, x.end_date)

Example

[
"2024-07-04"
]

[]bool

required

Mapped array of: ICD code details

CEL

diagnoses.map(x, x.icd_code)

Example

[
{
"code": "F41.1",
"display_name": "Generalized anxiety disorder"
}
]

bool

required

Whether the User has created a password

CEL

has_created_password

Example

true

timing.v1.Timestamp

Time the User was last active

CEL

last_active

Example

"2024-07-04T09:39:18+00:00"

string

Amount of money owed by the User

CEL

money_owed

Example

"100.00"

string

Next required step for the User

CEL

next_required_step

Example

"Complete onboarding"

string

Client readable source for the user

CEL

client_readable_source

Example

"src"

[]string

required

List of referring physician emails

CEL

referring_physician_emails

Example

[
"brian.hippocrates@example.com",
"joseph.lister@example.com"
]

string

Name of the referring provider

CEL

referring_provider_name

Example

"Fred Flintstone"

uint64

Number of unconfirmed appointments

CEL

unconfirmed_appointment_count

Example

string

Organization ID for the user’s registered dietitian

CEL

dietician_organization_id

Example

"5465412"

float64 (double)

Height in meters

CEL

height_meters

Example

1.75

float64 (double)

Weight in kilograms

CEL

weight_kilograms

Example

string

Quick notes about the user

CEL

quick_notes

Example

"Patient is very motivated to get well"

[]object

required

PII List of notification contacts for the user

CEL

notification_contacts

Example

[
{
"email_address": "john.doe@example.com",
"first_name": "John",
"id": "212012",
"is_emergency_contact": true,
"last_name": "Doe",
"phone_number": "+15551234123",
"relationship": "Caregiver"
}
]

[]string

required

Mapped array of: ID for the notification contact

CEL

notification_contacts.map(x, x.id)

Example

[
"212012"
]

[]string

required

Mapped array of: First name of the notification contact

CEL

notification_contacts.map(x, x.first_name)

Example

[
"John"
]

[]string

required

Mapped array of: Last name of the notification contact

CEL

notification_contacts.map(x, x.last_name)

Example

[
"Doe"
]

[]string

required

PII Mapped array of: Email address of the notification contact

CEL

notification_contacts.map(x, x.email_address)

Example

[
"john.doe@example.com"
]

[]bool

required

Mapped array of: Whether the notification contact is an emergency contact

CEL

notification_contacts.map(x, x.is_emergency_contact)

Example

[
true
]

[]string

required

PII Mapped array of: Phone number of the notification contact

CEL

notification_contacts.map(x, x.phone_number)

Example

[
"+15551234123"
]

[]string

required

Mapped array of: Relationship between the notification contact and the user

CEL

notification_contacts.map(x, x.relationship)

Example

[
"Caregiver"
]

string

Organization ID for the User’s registered dietitian

CEL

dietitian_organization_id

Example

"20042"

string

First name of the User’s registered dietitian

CEL

dietitian_first_name

Example

"Alexander"

string

Last name of the User’s registered dietitian

CEL

dietitian_last_name

Example

"Fleming"

string

Email address of the User’s registered dietitian

CEL

dietitian_email_address

Example

"drfleming@example.com"

string

ID of the User’s registered dietitian

CEL

dietitian_id

Example

"100070"

string

Sex

CEL

sex

Example

"Male"

string

Sexual orientation

CEL

sexual_orientation

Example

"Heterosexual"

string

Primary race

CEL

primary_race

Example

"White"

[]string

required

List of active tags for the User

CEL

active_tags

Example

[
"Weight Loss",
"Diabetes"
]

[]string

required

List of other provider IDs associated with the User

CEL

other_provider_ids

Example

[
"123456",
"789012"
]

[]object

required

List of providers associated with the user

CEL

providers

Example

[
{
"first_name": "Brian",
"id": "720312",
"last_name": "Hippocrates",
"name": "Dr. Brian Hippocrates",
"qualifications": "MD"
}
]

[]string

required

Mapped array of: ID for the provider

CEL

providers.map(x, x.id)

Example

[
"720312"
]

[]string

required

Mapped array of: Name of the provider

CEL

providers.map(x, x.name)

Example

[
"Dr. Brian Hippocrates"
]

[]string

required

Mapped array of: Qualifications of the provider

CEL

providers.map(x, x.qualifications)

Example

[
"MD"
]

[]string

required

Mapped array of: First name of the provider

CEL

providers.map(x, x.first_name)

Example

[
"Brian"
]

[]string

required

Mapped array of: Last name of the provider

CEL

providers.map(x, x.last_name)

Example

[
"Hippocrates"
]

[]object

required

List of course memberships for the User

CEL

course_memberships

Example

[
{
"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"
}
]

[]string

required

Mapped array of: ID of the course

CEL

course_memberships.map(x, x.course_id)

Example

[
"54654"
]

[]string

required

Mapped array of: Name of the course

CEL

course_memberships.map(x, x.course_name)

Example

[
"Nutrition 101"
]

[]string

required

Mapped array of: Status of the course membership

CEL

course_memberships.map(x, x.course_status)

Example

[
"active"
]

[]timing.v1.Timestamp

required

Mapped array of: Time the course membership started

CEL

course_memberships.map(x, x.started_at)

Example

[
"2024-02-14T16:10:11+00:00"
]

[]timing.v1.Timestamp

required

Mapped array of: Time the course membership was last updated

CEL

course_memberships.map(x, x.updated_at)

Example

[
"2024-03-01T17:12:18+00:00"
]

timing.v1.Timestamp

The timestamp of the next scheduled appointment for this Patient (if scheduled)

CEL

next_appt_date

Example

"2024-08-17T10:30:00-04:00"

string

The primary race code for the Patient

CEL

primary_race_code

Example

"1002-5"

string

The primary ethnicity code for the Patient

CEL

primary_ethnicity_code

Example

"2135-2"

timing.v1.Timestamp

The datetime of the last appointment the Patient had

CEL

last_appt_date

Example

"2024-04-22T09:00:00-04:00"

object

Client source

CEL

client_source

Example

{
"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"
}

string

ID of the client source

CEL

client_source.id

Example

"3265"

string

Get readable source based on ref_type

CEL

client_source.readable_source

Example

"John Doe MS, LMFT"

string

The source of how a client was acquired: contain ID or a Other string

CEL

client_source.ref_source

Example

"12345"

string

If ref_source eq ‘Other’, than it may contain custom string or NULL

CEL

client_source.ref_source_other

Example

"Instagram"

string

The type of the source of how a client was acquired

CEL

client_source.ref_type

Example

"referring_provider"

ID of the related insurance

CEL

client_source.related_insurance_id

Example

"12345"

ID of the related object, or ‘Other’

CEL

client_source.related_object_id

Example

"12345"

Name of the related object

CEL

client_source.related_object_name

Example

"Other"

[]object

required

List of referring physicians (providers)

CEL

referring_physicians

Example

[
{
"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"
},
"npi": "1000321231",
"phone_number": "+15551234123"
}
]

[]string

required

Mapped array of: Provider ID

CEL

referring_physicians.map(x, x.id)

Example

[
"57211"
]

[]string

required

PII Mapped array of: Provider’s first name

CEL

referring_physicians.map(x, x.first_name)

Example

[
"John"
]

[]string

required

PII Mapped array of: Provider’s last name

CEL

referring_physicians.map(x, x.last_name)

Example

[
"Doe"
]

[]bool

required

PII Mapped array of: Provider’s location

CEL

referring_physicians.map(x, x.location)

Example

[
{
"city": "San Francisco",
"country": "USA",
"line1": "123 Main Street",
"line2": "Suite 100",
"state": "CA",
"zip": "94117"
}
]

[]timing.v1.Timestamp

required

Mapped array of: Provider’s creation date

CEL

referring_physicians.map(x, x.created_at)

Example

[
"2024-05-10T08:46:04Z"
]

[]string

required

PII Mapped array of: Provider’s business name

CEL

referring_physicians.map(x, x.business_name)

Example

[
"Dr. John"
]

[]string

required

PII Mapped array of: Provider’s phone number

CEL

referring_physicians.map(x, x.phone_number)

Example

[
"+15551234123"
]

[]string

required

PII Mapped array of: Provider’s email

CEL

referring_physicians.map(x, x.email)

Example

[
"john.doe@example.com"
]

[]string

required

PII Mapped array of: Provider’s full name

CEL

referring_physicians.map(x, x.full_name)

Example

[
"John Doe"
]

[]string

required

Mapped array of: Provider’s NPI

CEL

referring_physicians.map(x, x.npi)

Example

[
"1000321231"
]

string

Password setup hyperlink

CEL

set_password_link

Example

"https://passwords.health.co/reset"

string

The next scheduled appointment ID for this Patient (if specified)

CEL

next_appt_id

Example

"604821"

string

The last scheduled appointment ID for this Patient (if specified)

CEL

last_appt_id

Example

"604820"

string

PII Legal name of the Patient

CEL

legal_name

Example

"Test Patient"

[]string

required

Healthie User object fields changed in triggering the event for this User (Patient)

CEL

changed_fields

Example

[
"email_address",
"first_name",
"last_name"
]

string

ID National Provider Identifier, this field only applies if the user is a provider

CEL

npi

Example

"1234567890"

bool

Whether the user is a patient

CEL

is_patient

Example

true

[]object

required

The licenses for the Provider if this User is a Provider

CEL

state_licenses

Example

[
{
"full_state_name": "New York",
"id": "500073",
"state": "NY"
}
]

[]string

required

Mapped array of: The unique identifier of the State license

CEL

state_licenses.map(x, x.id)

Example

[
"500073"
]

[]string

required

Mapped array of: The abbreviation of the State

CEL

state_licenses.map(x, x.state)

Example

[
"NY"
]

[]string

required

Mapped array of: The full name of the State

CEL

state_licenses.map(x, x.full_state_name)

Example

[
"New York"
]

string

Organization’s location ID for the User’s registered dietitian

CEL

dietitian_organization_location_id

Example

"12345"

string

PII Additional phone number of the user

CEL

additional_phone_number

Example

"+15559876543"

string

ID Additional record identifier for the User (an extra external unique patient ID reference)

CEL

additional_record_identifier

Example

"2847455b-caed-4d97-a79c-1f07316e7fbf"

string

Organization name for the user’s registered dietitian

CEL

dietitian_organization_name

Example

"Morf"

object

Brand details for the User

CEL

brand

Example

{
"about_description": "We provide comprehensive health services",
"brand_email": "brand@example.com",
"brand_name": "My Health Brand",
"brand_phone": "+15551234567"
}

string

Name of provider’s brand

CEL

brand.brand_name

Example

"My Health Brand"

string

Brand owner’s brand email

CEL

brand.brand_email

Example

"brand@example.com"

string

Brand owner’s brand phone

CEL

brand.brand_phone

Example

"+15551234567"

string

Brand owner’s about description

CEL

brand.about_description

Example

"We provide comprehensive health services"

object

HI ID PII Metadata for the user

CEL

metadata

Example

{
"priority": "High",
"referral_department": "Cardiology"
}

⌘I

​Events

​Triggering Webhook Types

​Payload Field Details

Events

Triggering Webhook Types

Payload Field Details