Events
Triggering Webhook Types
The following event types are associated with the Cms1500 event payload from Healthie.Healthie Cms1500 CreatedHealthie Cms1500 Updated
Copy
Ask AI
{
"accept_assignment": true,
"billing_provider_id": "PROV123",
"client_sig_on_file": true,
"cms1500_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"
}
],
"cpt_codes_cms1500s": [
{
"cpt_code": "99215",
"description": "New patient office visit, 45-60 minutes",
"display_name": "New patient office visit",
"mod1": "25",
"mod2": "59",
"mod3": "12",
"mod4": "34",
"pointers": "1",
"service_date": "2025-09-22",
"units": "1"
}
],
"dietician_organization_id": "123450",
"dietitian_email_address": "drfleming@example.com",
"dietitian_first_name": "Alexander",
"dietitian_id": "100070",
"dietitian_last_name": "Fleming",
"dietitian_organization_id": "123450",
"icd_codes_cms1500s": [
{
"active": true,
"code": "F41.1",
"created_at": "2024-01-15T10:30:00Z",
"display_name": "Generalized anxiety disorder",
"end_date": "2024-12-31",
"first_symptom_date": "2024-01-10",
"id": "789012",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"id": "57211",
"insured_sig_on_file": true,
"organization_info_id": "ORG789",
"patient": {
"date_of_birth": "1985-03-15",
"location": {
"city": "San Francisco",
"country": "USA",
"line1": "123 Main Street",
"line2": "Suite 100",
"state": "CA",
"zip": "94117"
},
"sex": "Male"
},
"patient_id": "121250",
"referral_info": {
"case_qualifier": "431",
"prior_auth_number": "AUTH123456",
"ref_provider_first": "John",
"ref_provider_last": "Smith",
"ref_provider_qual": "MD"
},
"service_location_id": "LOC456"
}
Copy
Ask AI
{
"accept_assignment": "The provider agrees to accept assignment",
"billing_provider_id": "The ID of the Billing Provider",
"client_sig_on_file": "True if the client's signature is on file",
"cms1500_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"
},
"cpt_codes_cms1500s": {
"cpt_code": "The CPT code",
"description": "The CPT code description",
"display_name": "The CPT display name used in labels",
"mod1": "First modification code",
"mod2": "Second modification code",
"mod3": "Third modification code",
"mod4": "Fourth modification code",
"pointers": "Diagnostic pointers. These are used to connect Diagnosis(ICD) with appropriate Billing Item(CPT) in CMS1500 form",
"service_date": "The service date for the specific code",
"units": "Units for the CPT code"
},
"dietician_organization_id": "Organization ID for the User's (Patient's) registered dietitian",
"dietitian_email_address": "Email address of the User's (Patient's) registered dietitian",
"dietitian_first_name": "First name of the User's (Patient's) registered dietitian",
"dietitian_id": "ID of the User's (Patient's) registered dietitian",
"dietitian_last_name": "Last name of the User's (Patient's) registered dietitian",
"dietitian_organization_id": "Organization ID for the User's (Patient's) registered dietitian",
"icd_codes_cms1500s": {
"active": "Active IcdCodesCms1500",
"code": "The ICD code",
"created_at": "Date created",
"display_name": "Display name for the ICD code",
"end_date": "End date",
"first_symptom_date": "ICD codes in use for this claim",
"id": "The unique identifier of the CMS 1500 ICD code",
"updated_at": "Date updated"
},
"id": "CMS1500 object ID",
"insured_sig_on_file": "True if the insured's signature is on file",
"organization_info_id": "The ID of the Organization Info",
"patient": {
"date_of_birth": "Date of birth of user",
"location": {
"city": "City",
"country": "Country",
"line1": "First line of the address",
"line2": "Second line of the address",
"state": "State",
"zip": "Zip code"
},
"sex": "Sex of the user (Stated on ID card for insurance purposes)"
},
"patient_id": "Patient's ID",
"referral_info": {
"case_qualifier": "The qualifier for case_date",
"prior_auth_number": "The prior authorization number",
"ref_provider_first": "The first name of the referring provider",
"ref_provider_last": "The last name of the referring provider",
"ref_provider_qual": "The qualifications of the referring provider"
},
"service_location_id": "The ID of the service location"
}
Payload Field Details
Hide fields
Hide fields
CMS1500 object ID
CEL
Copy
Ask AI
id
Example
Copy
Ask AI
"57211"
ID Patient’s IDCEL
Copy
Ask AI
patient_id
Example
Copy
Ask AI
"121250"
Organization ID for the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietician_organization_id
Example
Copy
Ask AI
"123450"
Organization ID for the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_organization_id
Example
Copy
Ask AI
"123450"
First name of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_first_name
Example
Copy
Ask AI
"Alexander"
Last name of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_last_name
Example
Copy
Ask AI
"Fleming"
Email address of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_email_address
Example
Copy
Ask AI
"drfleming@example.com"
ID of the User’s (Patient’s) registered dietitian
CEL
Copy
Ask AI
dietitian_id
Example
Copy
Ask AI
"100070"
The ID of the Billing Provider
CEL
Copy
Ask AI
billing_provider_id
Example
Copy
Ask AI
"PROV123"
The referral info for the CMS1500
CEL
Copy
Ask AI
referral_info
Example
Copy
Ask AI
{
"case_qualifier": "431",
"prior_auth_number": "AUTH123456",
"ref_provider_first": "John",
"ref_provider_last": "Smith",
"ref_provider_qual": "MD"
}
The qualifications of the referring provider
CEL
Copy
Ask AI
referral_info.ref_provider_qual
Example
Copy
Ask AI
"MD"
The first name of the referring provider
CEL
Copy
Ask AI
referral_info.ref_provider_first
Example
Copy
Ask AI
"John"
The last name of the referring provider
CEL
Copy
Ask AI
referral_info.ref_provider_last
Example
Copy
Ask AI
"Smith"
The qualifier for case_date
CEL
Copy
Ask AI
referral_info.case_qualifier
Example
Copy
Ask AI
"431"
The prior authorization number
CEL
Copy
Ask AI
referral_info.prior_auth_number
Example
Copy
Ask AI
"AUTH123456"
The ID of the service location
CEL
Copy
Ask AI
service_location_id
Example
Copy
Ask AI
"LOC456"
The ID of the Organization Info
CEL
Copy
Ask AI
organization_info_id
Example
Copy
Ask AI
"ORG789"
Policies in use for this claim
CEL
Copy
Ask AI
cms1500_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
cms1500_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
cms1500_policies.map(x, x.num)
Example
Copy
Ask AI
[
"1912310"
]
Mapped array of: Group number
CEL
Copy
Ask AI
cms1500_policies.map(x, x.group_num)
Example
Copy
Ask AI
[
"331256"
]
Mapped array of: Notes about the policy
CEL
Copy
Ask AI
cms1500_policies.map(x, x.notes)
Example
Copy
Ask AI
[
"Policy is active"
]
Mapped array of: Date the policy coverage expires
CEL
Copy
Ask AI
cms1500_policies.map(x, x.effective_end)
Example
Copy
Ask AI
[
"2024-07-04"
]
Mapped array of: ID for the policy
CEL
Copy
Ask AI
cms1500_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
cms1500_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
cms1500_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
cms1500_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
cms1500_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_stringCEL
Copy
Ask AI
cms1500_policies.map(x, x.insurance_type)
Example
Copy
Ask AI
[
"Medicaid"
]
Mapped array of: The priority type of insurance:
priority_typeCEL
Copy
Ask AI
cms1500_policies.map(x, x.priority_type)
Example
Copy
Ask AI
[
"Primary"
]
Mapped array of: Insurance plan details
CEL
Copy
Ask AI
cms1500_policies.map(x, x.benefits)
Example
Copy
Ask AI
[
[
{
"coinsurance": "15",
"copay": "50",
"deductible_calendar_year": "2000",
"deductible_year_to_date": "1500"
}
]
]
True if the client’s signature is on file
CEL
Copy
Ask AI
client_sig_on_file
Example
Copy
Ask AI
true
True if the insured’s signature is on file
CEL
Copy
Ask AI
insured_sig_on_file
Example
Copy
Ask AI
true
The provider agrees to accept assignment
CEL
Copy
Ask AI
accept_assignment
Example
Copy
Ask AI
true
ICD codes in use for this claim
CEL
Copy
Ask AI
icd_codes_cms1500s
Example
Copy
Ask AI
[
{
"active": true,
"code": "F41.1",
"created_at": "2024-01-15T10:30:00Z",
"display_name": "Generalized anxiety disorder",
"end_date": "2024-12-31",
"first_symptom_date": "2024-01-10",
"id": "789012",
"updated_at": "2024-01-15T10:30:00Z"
}
]
Mapped array of: The unique identifier of the CMS 1500 ICD code
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.id)
Example
Copy
Ask AI
[
"789012"
]
Mapped array of: Active IcdCodesCms1500
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.active)
Example
Copy
Ask AI
[
true
]
Mapped array of: Display name for the ICD code
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.display_name)
Example
Copy
Ask AI
[
"Generalized anxiety disorder"
]
Mapped array of: Date created
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.created_at)
Example
Copy
Ask AI
[
"2024-01-15T10:30:00Z"
]
Mapped array of: Date updated
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.updated_at)
Example
Copy
Ask AI
[
"2024-01-15T10:30:00Z"
]
Mapped array of: End date
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.end_date)
Example
Copy
Ask AI
[
"2024-12-31"
]
Mapped array of: ICD codes in use for this claim
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.first_symptom_date)
Example
Copy
Ask AI
[
"2024-01-10"
]
Mapped array of: The ICD code
CEL
Copy
Ask AI
icd_codes_cms1500s.map(x, x.code)
Example
Copy
Ask AI
[
"F41.1"
]
CPT codes in use for this claim
CEL
Copy
Ask AI
cpt_codes_cms1500s
Example
Copy
Ask AI
[
{
"cpt_code": "99215",
"description": "New patient office visit, 45-60 minutes",
"display_name": "New patient office visit",
"mod1": "25",
"mod2": "59",
"mod3": "12",
"mod4": "34",
"pointers": "1",
"service_date": "2025-09-22",
"units": "1"
}
]
Mapped array of: Units for the CPT code
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.units)
Example
Copy
Ask AI
[
"1"
]
Mapped array of: First modification code
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.mod1)
Example
Copy
Ask AI
[
"25"
]
Mapped array of: Second modification code
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.mod2)
Example
Copy
Ask AI
[
"59"
]
Mapped array of: Third modification code
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.mod3)
Example
Copy
Ask AI
[
"12"
]
Mapped array of: Fourth modification code
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.mod4)
Example
Copy
Ask AI
[
"34"
]
Mapped array of: Diagnostic pointers. These are used to connect Diagnosis(ICD) with appropriate Billing Item(CPT) in CMS1500 form
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.pointers)
Example
Copy
Ask AI
[
"1"
]
Mapped array of: The CPT code
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.cpt_code)
Example
Copy
Ask AI
[
"99215"
]
Mapped array of: The CPT display name used in labels
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.display_name)
Example
Copy
Ask AI
[
"New patient office visit"
]
Mapped array of: The CPT code description
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.description)
Example
Copy
Ask AI
[
"New patient office visit, 45-60 minutes"
]
Mapped array of: The service date for the specific code
CEL
Copy
Ask AI
cpt_codes_cms1500s.map(x, x.service_date)
Example
Copy
Ask AI
[
"2025-09-22"
]
The patient for the CMS1500
CEL
Copy
Ask AI
patient
Example
Copy
Ask AI
{
"date_of_birth": "1985-03-15",
"location": {
"city": "San Francisco",
"country": "USA",
"line1": "123 Main Street",
"line2": "Suite 100",
"state": "CA",
"zip": "94117"
},
"sex": "Male"
}
Date of birth of user
CEL
Copy
Ask AI
patient.date_of_birth
Example
Copy
Ask AI
"1985-03-15"
Sex of the user (Stated on ID card for insurance purposes)
CEL
Copy
Ask AI
patient.sex
Example
Copy
Ask AI
"Male"
The address of this user
CEL
Copy
Ask AI
patient.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
patient.location.line1
Example
Copy
Ask AI
"123 Main Street"
Second line of the address
CEL
Copy
Ask AI
patient.location.line2
Example
Copy
Ask AI
"Suite 100"
City
CEL
Copy
Ask AI
patient.location.city
Example
Copy
Ask AI
"San Francisco"
State
CEL
Copy
Ask AI
patient.location.state
Example
Copy
Ask AI
"CA"
Zip code
CEL
Copy
Ask AI
patient.location.zip
Example
Copy
Ask AI
"94117"
Country
CEL
Copy
Ask AI
patient.location.country
Example
Copy
Ask AI
"USA"
