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