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