{
  "actual_name": "Paulina Patient",
  "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": "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": null,
  "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_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_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
}
{
  "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_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_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."
}

Events

Triggering Webhook Types

The following event types are associated with the Patient event payload from Elation.

  • Elation Patient Created Or Updated
  • Elation Patient Deleted
{
  "actual_name": "Paulina Patient",
  "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": "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": null,
  "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_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_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
}
{
  "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_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_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

Patient
Event Payload