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