Events
Triggering Webhook Types
The following event types are associated with the Patient event payload from Elation.Elation Patient Created Or UpdatedElation Patient Deleted
Copy
Ask AI
{
"actual_name": "Paulina Patient",
"address": {
"international_address": {
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
},
"caregiver_practice_id": "65540",
"consents": [
{
"application": "healthix",
"consented": true,
"last_modified_at": "2016-05-02T11:57:41Z"
}
],
"created_at": "2016-05-02T11:57:41Z",
"deleted_at": "2023-01-15",
"dob": "1940-08-29",
"email_addresses": "paul.patient@elationemr.com",
"emergency_contact": {
"address_line1": "101 Lane Street",
"address_line2": "Apt 101",
"city": "Madison",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"relationship": "RELATIONSHIP_CHILD",
"state": "WI",
"zip": "53711"
},
"ethnicity": "ETHNICITY_NOT_HISPANIC_OR_LATINO",
"first_name": "Paula",
"gender_identity": "GENDER_IDENTITY_WOMAN",
"guarantor": {
"address_line1": "101 Lane Street",
"city": "Madison",
"email_address": "guarantor@example.com",
"first_name": "Other",
"id": "123456789",
"last_name": "Test",
"middle_name": "M",
"phone_number": "555-456-7890",
"relationship": "RELATIONSHIP_OTHER",
"state": "WI",
"zip": "53711"
},
"id": "64184451073",
"last_name": "Patient",
"legal_gender_marker": "LEGAL_GENDER_MARKER_FEMALE",
"master_patient_id": "98765432",
"merged_into_chart_id": "64184451099",
"metadata": "{\"custom_field\": \"custom_value\"}",
"middle_name": "P",
"notes": "These are plaintext notes",
"patient_status": {
"deceased_date": "2023-02-23",
"inactive_reason": "INACTIVE_REASON_OTHER",
"last_status_changed_at": "2022-08-24T13:03:05",
"notes": "my notes",
"status": "PATIENT_STATUS_ACTIVE"
},
"phone_numbers": [],
"preference": {
"preferred_pharmacy_1": "PharmID123",
"preferred_pharmacy_2": "PharmID456"
},
"preferred_language": "English",
"preferred_service_location_id": "987654",
"previous_name": {
"first_name": "John",
"last_name": "Doe",
"middle_name": "Michael",
"suffix": "III"
},
"primary_care_provider_id": "131074",
"primary_care_provider_npi": "1234567893",
"primary_email_address": "paul.patient@elationemr.com",
"primary_insurance": {
"address": "123 medicare st",
"carrier": "Blue Cross",
"city": "San Francisco",
"copay": 25,
"created_at": "2020-05-12T22:52:25Z",
"deductible": 1000,
"deleted_at": "2021-04-28T10:50:22Z",
"extension": "123",
"group_id": "test_group_id",
"id": "140767609356371",
"insurance_company_id": "70970048878",
"insurance_plan_id": "70971687279",
"insured_person_address": "550 15th St",
"insured_person_city": "San Francisco",
"insured_person_dob": "1940-08-29",
"insured_person_first_name": "Paula",
"insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
"insured_person_id": "12345",
"insured_person_last_name": "Patient",
"insured_person_ssn": "123456789",
"insured_person_state": "CA",
"insured_person_zip": "94013",
"member_id": "test_member_id",
"payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
"phone_number": "4155551234",
"plan": "Blue Cross Blue Shield",
"relationship_to_insured": "Self",
"state": "CA",
"suite": "Suite 500",
"zip": "94104"
},
"primary_phone_number": "+15551231234",
"primary_physician_id": "131074",
"pronouns": "PRONOUNS_SHE_HER_HERS",
"race": "RACE_CAUCASIAN",
"secondary_insurance": {
"address": "123 medicare st",
"carrier": "Blue Cross",
"city": "San Francisco",
"copay": 25,
"created_at": "2020-05-12T22:52:25Z",
"deductible": 1000,
"deleted_at": "2021-04-28T10:50:22Z",
"extension": "123",
"group_id": "test_group_id",
"id": "140767609356371",
"insurance_company_id": "70970048878",
"insurance_plan_id": "70971687279",
"insured_person_address": "550 15th St",
"insured_person_city": "San Francisco",
"insured_person_dob": "1940-08-29",
"insured_person_first_name": "Paula",
"insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
"insured_person_id": "12345",
"insured_person_last_name": "Patient",
"insured_person_ssn": "123456789",
"insured_person_state": "CA",
"insured_person_zip": "94013",
"member_id": "test_member_id",
"payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
"phone_number": "4155551234",
"plan": "Blue Cross Blue Shield",
"relationship_to_insured": "Self",
"state": "CA",
"suite": "Suite 500",
"zip": "94104"
},
"sex": "SEX_FEMALE",
"sexual_orientation": "SEXUAL_ORIENTATION_PREFER_NOT_TO_SAY",
"sms_opt_in_status": true,
"ssn": "123-45-6789",
"tags": "PAID",
"vip": false
}
Copy
Ask AI
{
"actual_name": "Patient's preferred name if different from legal name.",
"address": {
"international_address": {
"city_state_county_or_districts": null,
"country": null,
"lines": null,
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
},
"caregiver_practice_id": "ID of the caregiver practice.",
"consents": {
"application": "Name of the application or system for which consent was recorded. Max length 255 characters.",
"consented": "Flag indicating whether consent was given.",
"last_modified_at": "Timestamp when the consent was last modified."
},
"created_at": "Timestamp when the patient record was created.",
"deleted_at": "Date when the patient record was deleted, if applicable.",
"dob": "Patient's date of birth in YYYY-MM-DD format.",
"email_addresses": "List of patient's email addresses.",
"emergency_contact": {
"address_line1": "Address line 1 for the emergency contact.",
"address_line2": "Address line 2 for the emergency contact.",
"city": "City information for the emergency contact.",
"first_name": "First name of emergency contact. Max length 70 characters.",
"last_name": "Last name of emergency contact. Max length 70 characters.",
"phone_number": "Phone number of emergency contact. Max length 20 characters.",
"relationship": "Relationship of emergency contact to the patient.",
"state": "State information for the emergency contact.",
"zip": "Zip information for the emergency contact."
},
"ethnicity": "Patient's ethnicity.",
"first_name": "Patient's first name, given name, or forename.",
"gender_identity": "Patient's gender identity.",
"guarantor": {
"address_line1": "Address line 1 for the guarantor.",
"city": "City information for the guarantor.",
"email_address": "Email address of the guarantor.",
"first_name": "First name of the guarantor. Max length 70 characters.",
"id": "Unique identifier for the guarantor.",
"last_name": "Last name of the guarantor. Max length 70 characters.",
"middle_name": "Middle name of the guarantor. Max length 50 characters.",
"phone_number": "Phone number of the guarantor.",
"relationship": "Relationship of the guarantor to the patient.",
"state": "State information for the guarantor.",
"zip": "Zip information for the guarantor."
},
"id": "Unique identifier for the patient in the Elation system.",
"last_name": "Patient's last name, family name, or surname.",
"legal_gender_marker": "Patient's legal gender marker.",
"master_patient_id": "Master patient identifier used to link related patient records.",
"merged_into_chart_id": "ID of the chart that this patient record was merged into, if applicable.",
"metadata": "Additional metadata associated with the patient as a structured object. Can contain arbitrary key-value pairs.",
"middle_name": "Patient's middle name, middle initial, or second given name.",
"notes": "Additional notes about the patient.",
"patient_status": {
"deceased_date": "Date of patient's death, if applicable, in YYYY-MM-DD format.",
"inactive_reason": "Reason for inactive status, if patient status is inactive.",
"last_status_changed_at": "Timestamp of the last status change. Read-only.",
"notes": "Additional notes regarding the patient's status.",
"status": "Current status of the patient (active, deceased, inactive, or prospect)."
},
"phone_numbers": "List of patient's phone numbers. Note: elation limits this set to two phone numbers maximum.",
"preference": {
"preferred_pharmacy_1": "NCPDPID of the patient's primary preferred pharmacy.",
"preferred_pharmacy_2": "NCPDPID of the patient's secondary preferred pharmacy."
},
"preferred_language": "Patient's preferred language.",
"preferred_service_location_id": "ID of the patient's preferred service location.",
"previous_name": {
"first_name": "First name of the previous name.",
"last_name": "Last name of the previous name.",
"middle_name": "Middle name of the previous name.",
"suffix": "Suffix of the previous name."
},
"primary_care_provider_id": "ID of the patient's primary care provider.",
"primary_care_provider_npi": "National Provider Identifier (NPI) of the patient's primary care provider. Must be exactly 10 digits.",
"primary_email_address": "The first email address stored on the Elation Patient",
"primary_insurance": {
"address": "Street address of the insurance company. Max length 200 characters.",
"carrier": "Name of the insurance carrier. Max length 200 characters.",
"city": "City of the insurance company. Max length 50 characters.",
"copay": "Patient's copay amount for this insurance plan.",
"created_at": "Timestamp when the insurance record was created. Read-only.",
"deductible": "Patient's deductible amount for this insurance plan.",
"deleted_at": "Timestamp when the insurance record was deleted, if applicable. Read-only.",
"extension": "Phone extension for the insurance company. Max length 6 characters.",
"group_id": "Group ID for the insurance. Max length 50 characters.",
"id": "Unique identifier for the insurance record.",
"insurance_company_id": "ID of the insurance company from the Insurance Company resource.",
"insurance_plan_id": "ID of the insurance plan from the Insurance Plan resource.",
"insured_person_address": "Address of the insured person. Max length 200 characters.",
"insured_person_city": "City of the insured person. Max length 50 characters.",
"insured_person_dob": "Date of birth of the insured person in string format.",
"insured_person_first_name": "First name of the insured person. Max length 200 characters.",
"insured_person_gender": "Gender marker of the insured person.",
"insured_person_id": "ID of the insured person. Max length 50 characters.",
"insured_person_last_name": "Last name of the insured person. Max length 200 characters.",
"insured_person_ssn": "Social Security Number of the insured person. Must be exactly 9 digits.",
"insured_person_state": "State of the insured person. Two-letter state code.",
"insured_person_zip": "ZIP code of the insured person. Max length 9 characters.",
"member_id": "Member/subscriber ID for the insurance. Max length 50 characters.",
"payment_program": "Payment program category for this insurance.",
"phone_number": "Contact phone number for the insurance company. Max length 20 characters.",
"plan": "Name of the insurance plan. Max length 200 characters.",
"relationship_to_insured": "Relationship of the patient to the insured person. Max length 20 characters.",
"state": "State of the insurance company. Two-letter state code.",
"suite": "Suite/unit for the insurance company address. Max length 35 characters.",
"zip": "ZIP code of the insurance company. Max length 9 characters."
},
"primary_phone_number": "The first phone number stored on the Elation patient",
"primary_physician_id": "ID of the patient's primary physician.",
"pronouns": "Patient's preferred pronouns.",
"race": "Patient's race.",
"secondary_insurance": {
"address": "Street address of the insurance company. Max length 200 characters.",
"carrier": "Name of the insurance carrier. Max length 200 characters.",
"city": "City of the insurance company. Max length 50 characters.",
"copay": "Patient's copay amount for this insurance plan.",
"created_at": "Timestamp when the insurance record was created. Read-only.",
"deductible": "Patient's deductible amount for this insurance plan.",
"deleted_at": "Timestamp when the insurance record was deleted, if applicable. Read-only.",
"extension": "Phone extension for the insurance company. Max length 6 characters.",
"group_id": "Group ID for the insurance. Max length 50 characters.",
"id": "Unique identifier for the insurance record.",
"insurance_company_id": "ID of the insurance company from the Insurance Company resource.",
"insurance_plan_id": "ID of the insurance plan from the Insurance Plan resource.",
"insured_person_address": "Address of the insured person. Max length 200 characters.",
"insured_person_city": "City of the insured person. Max length 50 characters.",
"insured_person_dob": "Date of birth of the insured person in string format.",
"insured_person_first_name": "First name of the insured person. Max length 200 characters.",
"insured_person_gender": "Gender marker of the insured person.",
"insured_person_id": "ID of the insured person. Max length 50 characters.",
"insured_person_last_name": "Last name of the insured person. Max length 200 characters.",
"insured_person_ssn": "Social Security Number of the insured person. Must be exactly 9 digits.",
"insured_person_state": "State of the insured person. Two-letter state code.",
"insured_person_zip": "ZIP code of the insured person. Max length 9 characters.",
"member_id": "Member/subscriber ID for the insurance. Max length 50 characters.",
"payment_program": "Payment program category for this insurance.",
"phone_number": "Contact phone number for the insurance company. Max length 20 characters.",
"plan": "Name of the insurance plan. Max length 200 characters.",
"relationship_to_insured": "Relationship of the patient to the insured person. Max length 20 characters.",
"state": "State of the insurance company. Two-letter state code.",
"suite": "Suite/unit for the insurance company address. Max length 35 characters.",
"zip": "ZIP code of the insurance company. Max length 9 characters."
},
"sex": "Patient's biological sex.",
"sexual_orientation": "Patient's sexual orientation.",
"sms_opt_in_status": "Whether the patient has opted in to receive SMS messages.",
"ssn": "Patient's Social Security Number.",
"tags": "List of tags associated with the patient. Maximum of 10 tags, each with maximum length of 100 characters.",
"vip": "Flag indicating whether the patient is a VIP. Feature must be enabled for practice."
}
Payload Field Details
Hide fields
Hide fields
ID Unique identifier for the patient in the Elation system.CEL
Copy
Ask AI
id
Example
Copy
Ask AI
"64184451073"
PII Patient’s first name, given name, or forename.CEL
Copy
Ask AI
first_name
Example
Copy
Ask AI
"Paula"
PII Patient’s middle name, middle initial, or second given name.CEL
Copy
Ask AI
middle_name
Example
Copy
Ask AI
"P"
PII Patient’s last name, family name, or surname.CEL
Copy
Ask AI
last_name
Example
Copy
Ask AI
"Patient"
PII Patient’s preferred name if different from legal name.CEL
Copy
Ask AI
actual_name
Example
Copy
Ask AI
"Paulina Patient"
Patient’s gender identity.
CEL
Copy
Ask AI
gender_identity
Example
Copy
Ask AI
elation.v1.GenderIdentity.GENDER_IDENTITY_UNKNOWN
elation.v1.GenderIdentity.GENDER_IDENTITY_MAN
elation.v1.GenderIdentity.GENDER_IDENTITY_WOMAN
elation.v1.GenderIdentity.GENDER_IDENTITY_TRANSGENDER_MAN
elation.v1.GenderIdentity.GENDER_IDENTITY_TRANSGENDER_WOMAN
elation.v1.GenderIdentity.GENDER_IDENTITY_NONBINARY
elation.v1.GenderIdentity.GENDER_IDENTITY_OPTION_NOT_LISTED
elation.v1.GenderIdentity.GENDER_IDENTITY_PREFER_NOT_TO_SAY
elation.v1.GenderIdentity.GENDER_IDENTITY_TWO_SPIRIT
HI Patient’s legal gender marker.CEL
Copy
Ask AI
legal_gender_marker
Example
Copy
Ask AI
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_MALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_FEMALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_X
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_UNKNOWN
Patient’s preferred pronouns.
CEL
Copy
Ask AI
pronouns
Example
Copy
Ask AI
elation.v1.Pronouns.PRONOUNS_HE_HIM_HIS
elation.v1.Pronouns.PRONOUNS_SHE_HER_HERS
elation.v1.Pronouns.PRONOUNS_THEY_THEM_THEIRS
elation.v1.Pronouns.PRONOUNS_NOT_LISTED
HI Patient’s biological sex.CEL
Copy
Ask AI
sex
Example
Copy
Ask AI
elation.v1.Sex.SEX_MALE
elation.v1.Sex.SEX_FEMALE
elation.v1.Sex.SEX_OTHER
elation.v1.Sex.SEX_UNKNOWN
HI Patient’s sexual orientation.CEL
Copy
Ask AI
sexual_orientation
Example
Copy
Ask AI
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_UNKNOWN
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_STRAIGHT
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_GAY
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_BISEXUAL
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_OPTION_NOT_LISTED
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_PREFER_NOT_TO_SAY
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_LESBIAN
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_QUEER
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_ASEXUAL
ID of the patient’s primary physician.
CEL
Copy
Ask AI
primary_physician_id
Example
Copy
Ask AI
"131074"
ID of the caregiver practice.
CEL
Copy
Ask AI
caregiver_practice_id
Example
Copy
Ask AI
"65540"
ID of the patient’s preferred service location.
CEL
Copy
Ask AI
preferred_service_location_id
Example
Copy
Ask AI
"987654"
PII Patient’s date of birth in YYYY-MM-DD format.CEL
Copy
Ask AI
dob
Example
Copy
Ask AI
"1940-08-29"
PII Patient’s Social Security Number.CEL
Copy
Ask AI
ssn
Example
Copy
Ask AI
"123-45-6789"
Patient’s race.
CEL
Copy
Ask AI
race
Example
Copy
Ask AI
elation.v1.Race.RACE_NO_RACE_SPECIFIED
elation.v1.Race.RACE_AMERICAN_INDIAN_OR_ALASKA_NATIVE
elation.v1.Race.RACE_ASIAN
elation.v1.Race.RACE_BLACK_OR_AFRICAN_AMERICAN
elation.v1.Race.RACE_NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
elation.v1.Race.RACE_WHITE
elation.v1.Race.RACE_OTHER
elation.v1.Race.RACE_DECLINED_TO_SPECIFY
Patient’s preferred language.
CEL
Copy
Ask AI
preferred_language
Example
Copy
Ask AI
"English"
Patient’s ethnicity.
CEL
Copy
Ask AI
ethnicity
Example
Copy
Ask AI
elation.v1.Ethnicity.ETHNICITY_NO_ETHNICITY_SPECIFIED
elation.v1.Ethnicity.ETHNICITY_HISPANIC_OR_LATINO
elation.v1.Ethnicity.ETHNICITY_NOT_HISPANIC_OR_LATINO
elation.v1.Ethnicity.ETHNICITY_UNKNOWN
elation.v1.Ethnicity.ETHNICITY_DECLINED_TO_SPECIFY
HI Additional notes about the patient.CEL
Copy
Ask AI
notes
Example
Copy
Ask AI
"These are plaintext notes"
Flag indicating whether the patient is a VIP. Feature must be enabled for practice.
CEL
Copy
Ask AI
vip
Example
Copy
Ask AI
false
PII Patient’s address information including street, city, state, and zip code.CEL
Copy
Ask AI
address
Example
Copy
Ask AI
{
"international_address": {
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
}
Description coming soon
CEL
Copy
Ask AI
address.us_address
Example
Copy
Ask AI
{
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
Description coming soon
CEL
Copy
Ask AI
address.us_address.line1
Example
Copy
Ask AI
null
Description coming soon
CEL
Copy
Ask AI
address.us_address.line2
Example
Copy
Ask AI
null
Description coming soon
CEL
Copy
Ask AI
address.us_address.city
Example
Copy
Ask AI
null
Description coming soon
CEL
Copy
Ask AI
address.us_address.state
Example
Copy
Ask AI
null
Description coming soon
CEL
Copy
Ask AI
address.us_address.zip_code
Example
Copy
Ask AI
null
Description coming soon
CEL
Copy
Ask AI
address.international_address
Example
Copy
Ask AI
{
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
}
Description coming soon
CEL
Copy
Ask AI
address.international_address.lines
Example
Copy
Ask AI
[]
Description coming soon
CEL
Copy
Ask AI
address.international_address.city_state_county_or_districts
Example
Copy
Ask AI
[]
Description coming soon
CEL
Copy
Ask AI
address.international_address.postal_code
Example
Copy
Ask AI
null
Description coming soon
CEL
Copy
Ask AI
address.international_address.country
Example
Copy
Ask AI
null
PII List of patient’s phone numbers. Note: elation limits this set to two phone numbers maximum.CEL
Copy
Ask AI
phone_numbers
Example
Copy
Ask AI
[]
PII List of patient’s email addresses.CEL
Copy
Ask AI
email_addresses
Example
Copy
Ask AI
"paul.patient@elationemr.com"
Information about the patient’s guarantor, including contact details and relationship to patient.
CEL
Copy
Ask AI
guarantor
Example
Copy
Ask AI
{
"address_line1": "101 Lane Street",
"city": "Madison",
"email_address": "guarantor@example.com",
"first_name": "Other",
"id": "123456789",
"last_name": "Test",
"middle_name": "M",
"phone_number": "555-456-7890",
"relationship": "RELATIONSHIP_OTHER",
"state": "WI",
"zip": "53711"
}
ID Unique identifier for the guarantor.CEL
Copy
Ask AI
guarantor.id
Example
Copy
Ask AI
"123456789"
PII Address line 1 for the guarantor.CEL
Copy
Ask AI
guarantor.address_line1
Example
Copy
Ask AI
"101 Lane Street"
PII City information for the guarantor.CEL
Copy
Ask AI
guarantor.city
Example
Copy
Ask AI
"Madison"
PII State information for the guarantor.CEL
Copy
Ask AI
guarantor.state
Example
Copy
Ask AI
"WI"
PII Zip information for the guarantor.CEL
Copy
Ask AI
guarantor.zip
Example
Copy
Ask AI
"53711"
PII Phone number of the guarantor.CEL
Copy
Ask AI
guarantor.phone_number
Example
Copy
Ask AI
"555-456-7890"
PII Email address of the guarantor.CEL
Copy
Ask AI
guarantor.email_address
Example
Copy
Ask AI
"guarantor@example.com"
Relationship of the guarantor to the patient.
CEL
Copy
Ask AI
guarantor.relationship
Example
Copy
Ask AI
elation.v1.Relationship.RELATIONSHIP_CAREGIVER
elation.v1.Relationship.RELATIONSHIP_CHILD
elation.v1.Relationship.RELATIONSHIP_FRIEND
elation.v1.Relationship.RELATIONSHIP_GRANDPARENT
elation.v1.Relationship.RELATIONSHIP_GUARDIAN
elation.v1.Relationship.RELATIONSHIP_PARENT
elation.v1.Relationship.RELATIONSHIP_SIBLING
elation.v1.Relationship.RELATIONSHIP_SPOUSE
elation.v1.Relationship.RELATIONSHIP_OTHER
PII First name of the guarantor. Max length 70 characters.CEL
Copy
Ask AI
guarantor.first_name
Example
Copy
Ask AI
"Other"
PII Last name of the guarantor. Max length 70 characters.CEL
Copy
Ask AI
guarantor.last_name
Example
Copy
Ask AI
"Test"
PII Middle name of the guarantor. Max length 50 characters.CEL
Copy
Ask AI
guarantor.middle_name
Example
Copy
Ask AI
"M"
Patient’s primary insurance information, including carrier, plan, and insured person details.
CEL
Copy
Ask AI
primary_insurance
Example
Copy
Ask AI
{
"address": "123 medicare st",
"carrier": "Blue Cross",
"city": "San Francisco",
"copay": 25,
"created_at": "2020-05-12T22:52:25Z",
"deductible": 1000,
"deleted_at": "2021-04-28T10:50:22Z",
"extension": "123",
"group_id": "test_group_id",
"id": "140767609356371",
"insurance_company_id": "70970048878",
"insurance_plan_id": "70971687279",
"insured_person_address": "550 15th St",
"insured_person_city": "San Francisco",
"insured_person_dob": "1940-08-29",
"insured_person_first_name": "Paula",
"insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
"insured_person_id": "12345",
"insured_person_last_name": "Patient",
"insured_person_ssn": "123456789",
"insured_person_state": "CA",
"insured_person_zip": "94013",
"member_id": "test_member_id",
"payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
"phone_number": "4155551234",
"plan": "Blue Cross Blue Shield",
"relationship_to_insured": "Self",
"state": "CA",
"suite": "Suite 500",
"zip": "94104"
}
ID Unique identifier for the insurance record.CEL
Copy
Ask AI
primary_insurance.id
Example
Copy
Ask AI
"140767609356371"
Name of the insurance carrier. Max length 200 characters.
CEL
Copy
Ask AI
primary_insurance.carrier
Example
Copy
Ask AI
"Blue Cross"
PII Member/subscriber ID for the insurance. Max length 50 characters.CEL
Copy
Ask AI
primary_insurance.member_id
Example
Copy
Ask AI
"test_member_id"
Group ID for the insurance. Max length 50 characters.
CEL
Copy
Ask AI
primary_insurance.group_id
Example
Copy
Ask AI
"test_group_id"
Name of the insurance plan. Max length 200 characters.
CEL
Copy
Ask AI
primary_insurance.plan
Example
Copy
Ask AI
"Blue Cross Blue Shield"
PII Contact phone number for the insurance company. Max length 20 characters.CEL
Copy
Ask AI
primary_insurance.phone_number
Example
Copy
Ask AI
"4155551234"
Phone extension for the insurance company. Max length 6 characters.
CEL
Copy
Ask AI
primary_insurance.extension
Example
Copy
Ask AI
"123"
PII Street address of the insurance company. Max length 200 characters.CEL
Copy
Ask AI
primary_insurance.address
Example
Copy
Ask AI
"123 medicare st"
PII Suite/unit for the insurance company address. Max length 35 characters.CEL
Copy
Ask AI
primary_insurance.suite
Example
Copy
Ask AI
"Suite 500"
PII City of the insurance company. Max length 50 characters.CEL
Copy
Ask AI
primary_insurance.city
Example
Copy
Ask AI
"San Francisco"
PII State of the insurance company. Two-letter state code.CEL
Copy
Ask AI
primary_insurance.state
Example
Copy
Ask AI
"CA"
PII ZIP code of the insurance company. Max length 9 characters.CEL
Copy
Ask AI
primary_insurance.zip
Example
Copy
Ask AI
"94104"
HI Patient’s copay amount for this insurance plan.CEL
Copy
Ask AI
primary_insurance.copay
Example
Copy
Ask AI
25
HI Patient’s deductible amount for this insurance plan.CEL
Copy
Ask AI
primary_insurance.deductible
Example
Copy
Ask AI
1000
Payment program category for this insurance.
CEL
Copy
Ask AI
primary_insurance.payment_program
Example
Copy
Ask AI
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_PART_B
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_ADVANTAGE
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICAID
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_HMSA
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_SFHP
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_OTHER
elation.v1.PaymentProgram.PAYMENT_PROGRAM_WORKERS_COMPENSATION
PII First name of the insured person. Max length 200 characters.CEL
Copy
Ask AI
primary_insurance.insured_person_first_name
Example
Copy
Ask AI
"Paula"
PII Last name of the insured person. Max length 200 characters.CEL
Copy
Ask AI
primary_insurance.insured_person_last_name
Example
Copy
Ask AI
"Patient"
PII Address of the insured person. Max length 200 characters.CEL
Copy
Ask AI
primary_insurance.insured_person_address
Example
Copy
Ask AI
"550 15th St"
PII City of the insured person. Max length 50 characters.CEL
Copy
Ask AI
primary_insurance.insured_person_city
Example
Copy
Ask AI
"San Francisco"
PII State of the insured person. Two-letter state code.CEL
Copy
Ask AI
primary_insurance.insured_person_state
Example
Copy
Ask AI
"CA"
PII ZIP code of the insured person. Max length 9 characters.CEL
Copy
Ask AI
primary_insurance.insured_person_zip
Example
Copy
Ask AI
"94013"
ID PII ID of the insured person. Max length 50 characters.CEL
Copy
Ask AI
primary_insurance.insured_person_id
Example
Copy
Ask AI
"12345"
PII Date of birth of the insured person in string format.CEL
Copy
Ask AI
primary_insurance.insured_person_dob
Example
Copy
Ask AI
"1940-08-29"
Gender marker of the insured person.
CEL
Copy
Ask AI
primary_insurance.insured_person_gender
Example
Copy
Ask AI
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_MALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_FEMALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_X
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_UNKNOWN
PII Social Security Number of the insured person. Must be exactly 9 digits.CEL
Copy
Ask AI
primary_insurance.insured_person_ssn
Example
Copy
Ask AI
"123456789"
PII Relationship of the patient to the insured person. Max length 20 characters.CEL
Copy
Ask AI
primary_insurance.relationship_to_insured
Example
Copy
Ask AI
"Self"
ID of the insurance company from the Insurance Company resource.
CEL
Copy
Ask AI
primary_insurance.insurance_company_id
Example
Copy
Ask AI
"70970048878"
ID PII ID of the insurance plan from the Insurance Plan resource.CEL
Copy
Ask AI
primary_insurance.insurance_plan_id
Example
Copy
Ask AI
"70971687279"
Timestamp when the insurance record was created. Read-only.
CEL
Copy
Ask AI
primary_insurance.created_at
Example
Copy
Ask AI
"2020-05-12T22:52:25Z"
Timestamp when the insurance record was deleted, if applicable. Read-only.
CEL
Copy
Ask AI
primary_insurance.deleted_at
Example
Copy
Ask AI
"2021-04-28T10:50:22Z"
Patient’s secondary insurance information, if applicable.
CEL
Copy
Ask AI
secondary_insurance
Example
Copy
Ask AI
{
"address": "123 medicare st",
"carrier": "Blue Cross",
"city": "San Francisco",
"copay": 25,
"created_at": "2020-05-12T22:52:25Z",
"deductible": 1000,
"deleted_at": "2021-04-28T10:50:22Z",
"extension": "123",
"group_id": "test_group_id",
"id": "140767609356371",
"insurance_company_id": "70970048878",
"insurance_plan_id": "70971687279",
"insured_person_address": "550 15th St",
"insured_person_city": "San Francisco",
"insured_person_dob": "1940-08-29",
"insured_person_first_name": "Paula",
"insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
"insured_person_id": "12345",
"insured_person_last_name": "Patient",
"insured_person_ssn": "123456789",
"insured_person_state": "CA",
"insured_person_zip": "94013",
"member_id": "test_member_id",
"payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
"phone_number": "4155551234",
"plan": "Blue Cross Blue Shield",
"relationship_to_insured": "Self",
"state": "CA",
"suite": "Suite 500",
"zip": "94104"
}
ID Unique identifier for the insurance record.CEL
Copy
Ask AI
secondary_insurance.id
Example
Copy
Ask AI
"140767609356371"
Name of the insurance carrier. Max length 200 characters.
CEL
Copy
Ask AI
secondary_insurance.carrier
Example
Copy
Ask AI
"Blue Cross"
PII Member/subscriber ID for the insurance. Max length 50 characters.CEL
Copy
Ask AI
secondary_insurance.member_id
Example
Copy
Ask AI
"test_member_id"
Group ID for the insurance. Max length 50 characters.
CEL
Copy
Ask AI
secondary_insurance.group_id
Example
Copy
Ask AI
"test_group_id"
Name of the insurance plan. Max length 200 characters.
CEL
Copy
Ask AI
secondary_insurance.plan
Example
Copy
Ask AI
"Blue Cross Blue Shield"
PII Contact phone number for the insurance company. Max length 20 characters.CEL
Copy
Ask AI
secondary_insurance.phone_number
Example
Copy
Ask AI
"4155551234"
Phone extension for the insurance company. Max length 6 characters.
CEL
Copy
Ask AI
secondary_insurance.extension
Example
Copy
Ask AI
"123"
PII Street address of the insurance company. Max length 200 characters.CEL
Copy
Ask AI
secondary_insurance.address
Example
Copy
Ask AI
"123 medicare st"
PII Suite/unit for the insurance company address. Max length 35 characters.CEL
Copy
Ask AI
secondary_insurance.suite
Example
Copy
Ask AI
"Suite 500"
PII City of the insurance company. Max length 50 characters.CEL
Copy
Ask AI
secondary_insurance.city
Example
Copy
Ask AI
"San Francisco"
PII State of the insurance company. Two-letter state code.CEL
Copy
Ask AI
secondary_insurance.state
Example
Copy
Ask AI
"CA"
PII ZIP code of the insurance company. Max length 9 characters.CEL
Copy
Ask AI
secondary_insurance.zip
Example
Copy
Ask AI
"94104"
HI Patient’s copay amount for this insurance plan.CEL
Copy
Ask AI
secondary_insurance.copay
Example
Copy
Ask AI
25
HI Patient’s deductible amount for this insurance plan.CEL
Copy
Ask AI
secondary_insurance.deductible
Example
Copy
Ask AI
1000
Payment program category for this insurance.
CEL
Copy
Ask AI
secondary_insurance.payment_program
Example
Copy
Ask AI
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_PART_B
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_ADVANTAGE
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICAID
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_HMSA
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_SFHP
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_OTHER
elation.v1.PaymentProgram.PAYMENT_PROGRAM_WORKERS_COMPENSATION
PII First name of the insured person. Max length 200 characters.CEL
Copy
Ask AI
secondary_insurance.insured_person_first_name
Example
Copy
Ask AI
"Paula"
PII Last name of the insured person. Max length 200 characters.CEL
Copy
Ask AI
secondary_insurance.insured_person_last_name
Example
Copy
Ask AI
"Patient"
PII Address of the insured person. Max length 200 characters.CEL
Copy
Ask AI
secondary_insurance.insured_person_address
Example
Copy
Ask AI
"550 15th St"
PII City of the insured person. Max length 50 characters.CEL
Copy
Ask AI
secondary_insurance.insured_person_city
Example
Copy
Ask AI
"San Francisco"
PII State of the insured person. Two-letter state code.CEL
Copy
Ask AI
secondary_insurance.insured_person_state
Example
Copy
Ask AI
"CA"
PII ZIP code of the insured person. Max length 9 characters.CEL
Copy
Ask AI
secondary_insurance.insured_person_zip
Example
Copy
Ask AI
"94013"
ID PII ID of the insured person. Max length 50 characters.CEL
Copy
Ask AI
secondary_insurance.insured_person_id
Example
Copy
Ask AI
"12345"
PII Date of birth of the insured person in string format.CEL
Copy
Ask AI
secondary_insurance.insured_person_dob
Example
Copy
Ask AI
"1940-08-29"
Gender marker of the insured person.
CEL
Copy
Ask AI
secondary_insurance.insured_person_gender
Example
Copy
Ask AI
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_MALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_FEMALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_X
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_UNKNOWN
PII Social Security Number of the insured person. Must be exactly 9 digits.CEL
Copy
Ask AI
secondary_insurance.insured_person_ssn
Example
Copy
Ask AI
"123456789"
PII Relationship of the patient to the insured person. Max length 20 characters.CEL
Copy
Ask AI
secondary_insurance.relationship_to_insured
Example
Copy
Ask AI
"Self"
ID of the insurance company from the Insurance Company resource.
CEL
Copy
Ask AI
secondary_insurance.insurance_company_id
Example
Copy
Ask AI
"70970048878"
ID PII ID of the insurance plan from the Insurance Plan resource.CEL
Copy
Ask AI
secondary_insurance.insurance_plan_id
Example
Copy
Ask AI
"70971687279"
Timestamp when the insurance record was created. Read-only.
CEL
Copy
Ask AI
secondary_insurance.created_at
Example
Copy
Ask AI
"2020-05-12T22:52:25Z"
Timestamp when the insurance record was deleted, if applicable. Read-only.
CEL
Copy
Ask AI
secondary_insurance.deleted_at
Example
Copy
Ask AI
"2021-04-28T10:50:22Z"
Current status of the patient (active, deceased, inactive, or prospect) with additional status-related information.
CEL
Copy
Ask AI
patient_status
Example
Copy
Ask AI
{
"deceased_date": "2023-02-23",
"inactive_reason": "INACTIVE_REASON_OTHER",
"last_status_changed_at": "2022-08-24T13:03:05",
"notes": "my notes",
"status": "PATIENT_STATUS_ACTIVE"
}
Current status of the patient (active, deceased, inactive, or prospect).
CEL
Copy
Ask AI
patient_status.status
Example
Copy
Ask AI
elation.v1.PatientStatusEnum.PATIENT_STATUS_ACTIVE
elation.v1.PatientStatusEnum.PATIENT_STATUS_DECEASED
elation.v1.PatientStatusEnum.PATIENT_STATUS_INACTIVE
elation.v1.PatientStatusEnum.PATIENT_STATUS_PROSPECT
HI Date of patient’s death, if applicable, in YYYY-MM-DD format.CEL
Copy
Ask AI
patient_status.deceased_date
Example
Copy
Ask AI
"2023-02-23"
Reason for inactive status, if patient status is inactive.
CEL
Copy
Ask AI
patient_status.inactive_reason
Example
Copy
Ask AI
elation.v1.InactiveReason.INACTIVE_REASON_OTHER
elation.v1.InactiveReason.INACTIVE_REASON_PATIENT_LEFT_ON_BAD_TERMS
elation.v1.InactiveReason.INACTIVE_REASON_PATIENT_LEFT_ON_GOOD_TERMS
elation.v1.InactiveReason.INACTIVE_REASON_PRACTICE_ENDED_RELATIONSHIP
elation.v1.InactiveReason.INACTIVE_REASON_UNKNOWN
HI Additional notes regarding the patient’s status.CEL
Copy
Ask AI
patient_status.notes
Example
Copy
Ask AI
"my notes"
Timestamp of the last status change. Read-only.
CEL
Copy
Ask AI
patient_status.last_status_changed_at
Example
Copy
Ask AI
"2022-08-24T13:03:05"
List of consent records for the patient. Each contains consent status, modification date, and application name.
CEL
Copy
Ask AI
consents
Example
Copy
Ask AI
[
{
"application": "healthix",
"consented": true,
"last_modified_at": "2016-05-02T11:57:41Z"
}
]
Mapped array of: Flag indicating whether consent was given.
CEL
Copy
Ask AI
consents.map(x, x.consented)
Example
Copy
Ask AI
[
true
]
Mapped array of: Timestamp when the consent was last modified.
CEL
Copy
Ask AI
consents.map(x, x.last_modified_at)
Example
Copy
Ask AI
[
"2016-05-02T11:57:41Z"
]
Mapped array of: Name of the application or system for which consent was recorded. Max length 255 characters.
CEL
Copy
Ask AI
consents.map(x, x.application)
Example
Copy
Ask AI
[
"healthix"
]
Patient’s preferences, such as preferred pharmacies. Contains up to two preferred pharmacy identifiers.
CEL
Copy
Ask AI
preference
Example
Copy
Ask AI
{
"preferred_pharmacy_1": "PharmID123",
"preferred_pharmacy_2": "PharmID456"
}
HI NCPDPID of the patient’s primary preferred pharmacy.CEL
Copy
Ask AI
preference.preferred_pharmacy_1
Example
Copy
Ask AI
"PharmID123"
HI NCPDPID of the patient’s secondary preferred pharmacy.CEL
Copy
Ask AI
preference.preferred_pharmacy_2
Example
Copy
Ask AI
"PharmID456"
Patient’s emergency contact information including name, relationship, phone, and address details.
CEL
Copy
Ask AI
emergency_contact
Example
Copy
Ask AI
{
"address_line1": "101 Lane Street",
"address_line2": "Apt 101",
"city": "Madison",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"relationship": "RELATIONSHIP_CHILD",
"state": "WI",
"zip": "53711"
}
PII First name of emergency contact. Max length 70 characters.CEL
Copy
Ask AI
emergency_contact.first_name
Example
Copy
Ask AI
"John"
PII Last name of emergency contact. Max length 70 characters.CEL
Copy
Ask AI
emergency_contact.last_name
Example
Copy
Ask AI
"Doe"
HI Relationship of emergency contact to the patient.CEL
Copy
Ask AI
emergency_contact.relationship
Example
Copy
Ask AI
elation.v1.Relationship.RELATIONSHIP_CAREGIVER
elation.v1.Relationship.RELATIONSHIP_CHILD
elation.v1.Relationship.RELATIONSHIP_FRIEND
elation.v1.Relationship.RELATIONSHIP_GRANDPARENT
elation.v1.Relationship.RELATIONSHIP_GUARDIAN
elation.v1.Relationship.RELATIONSHIP_PARENT
elation.v1.Relationship.RELATIONSHIP_SIBLING
elation.v1.Relationship.RELATIONSHIP_SPOUSE
elation.v1.Relationship.RELATIONSHIP_OTHER
PII Phone number of emergency contact. Max length 20 characters.CEL
Copy
Ask AI
emergency_contact.phone_number
Example
Copy
Ask AI
null
PII Address line 1 for the emergency contact.CEL
Copy
Ask AI
emergency_contact.address_line1
Example
Copy
Ask AI
"101 Lane Street"
PII Address line 2 for the emergency contact.CEL
Copy
Ask AI
emergency_contact.address_line2
Example
Copy
Ask AI
"Apt 101"
PII City information for the emergency contact.CEL
Copy
Ask AI
emergency_contact.city
Example
Copy
Ask AI
"Madison"
PII State information for the emergency contact.CEL
Copy
Ask AI
emergency_contact.state
Example
Copy
Ask AI
"WI"
PII Zip information for the emergency contact.CEL
Copy
Ask AI
emergency_contact.zip
Example
Copy
Ask AI
"53711"
National Provider Identifier (NPI) of the patient’s primary care provider. Must be exactly 10 digits.
CEL
Copy
Ask AI
primary_care_provider_npi
Example
Copy
Ask AI
"1234567893"
Patient’s previous first name, if changed.
CEL
Copy
Ask AI
previous_name
Example
Copy
Ask AI
{
"first_name": "John",
"last_name": "Doe",
"middle_name": "Michael",
"suffix": "III"
}
First name of the previous name.
CEL
Copy
Ask AI
previous_name.first_name
Example
Copy
Ask AI
"John"
Last name of the previous name.
CEL
Copy
Ask AI
previous_name.last_name
Example
Copy
Ask AI
"Doe"
Middle name of the previous name.
CEL
Copy
Ask AI
previous_name.middle_name
Example
Copy
Ask AI
"Michael"
Suffix of the previous name.
CEL
Copy
Ask AI
previous_name.suffix
Example
Copy
Ask AI
"III"
ID Master patient identifier used to link related patient records.CEL
Copy
Ask AI
master_patient_id
Example
Copy
Ask AI
"98765432"
HI ID PII Additional metadata associated with the patient as a structured object. Can contain arbitrary key-value pairs.CEL
Copy
Ask AI
metadata
Example
Copy
Ask AI
"{\"custom_field\": \"custom_value\"}"
HI List of tags associated with the patient. Maximum of 10 tags, each with maximum length of 100 characters.CEL
Copy
Ask AI
tags
Example
Copy
Ask AI
"PAID"
ID of the patient’s primary care provider.
CEL
Copy
Ask AI
primary_care_provider_id
Example
Copy
Ask AI
"131074"
Timestamp when the patient record was created.
CEL
Copy
Ask AI
created_at
Example
Copy
Ask AI
"2016-05-02T11:57:41Z"
Date when the patient record was deleted, if applicable.
CEL
Copy
Ask AI
deleted_at
Example
Copy
Ask AI
"2023-01-15"
ID ID of the chart that this patient record was merged into, if applicable.CEL
Copy
Ask AI
merged_into_chart_id
Example
Copy
Ask AI
"64184451099"
Whether the patient has opted in to receive SMS messages.
CEL
Copy
Ask AI
sms_opt_in_status
Example
Copy
Ask AI
true
PII The first email address stored on the Elation PatientCEL
Copy
Ask AI
primary_email_address
Example
Copy
Ask AI
"paul.patient@elationemr.com"
PII The first phone number stored on the Elation patientCEL
Copy
Ask AI
primary_phone_number
Example
Copy
Ask AI
"+15551231234"
