{
  "address1": "123 Main Street",
  "address2": "Apt 4B",
  "agricultural_worker_type": "SEASONAL",
  "all_patient_statuses": "[{\"status\":\"active\",\"department_id\":1}]",
  "alt_first_name": "Jonathan",
  "assigned_sex_at_birth": "ASSIGNED_SEX_AT_BIRTH_M",
  "balances": "[{\"department_list\":\"1,2\",\"balance\":\"100.00\"}]",
  "care_summary_delivery_preference": "PORTAL",
  "city": "Boston",
  "clinical_order_type_group_id": "10",
  "consent_to_call": true,
  "consent_to_text": true,
  "contact_home_phone": "+15551234567",
  "contact_mobile_phone": "+15551234567",
  "contact_name": null,
  "contact_preference": "EMAIL",
  "contact_preference_announcement_email": true,
  "contact_preference_announcement_phone": false,
  "contact_preference_announcement_sms": false,
  "contact_preference_appointment_email": true,
  "contact_preference_appointment_phone": false,
  "contact_preference_appointment_sms": false,
  "contact_preference_billing_email": true,
  "contact_preference_billing_phone": false,
  "contact_preference_billing_sms": false,
  "contact_preference_lab_email": true,
  "contact_preference_lab_phone": false,
  "contact_preference_lab_sms": false,
  "contact_relationship": "SPOUSE",
  "country_code_3166": "USA",
  "custom_fields": [
    {
      "custom_field_id": "CF123",
      "custom_field_value": "Value for non-select field",
      "option_id": "OPT456"
    }
  ],
  "date_of_birth": "1980-01-15",
  "deceased_date": "2023-01-01",
  "default_pharmacy_ncpdp_id": "123456789",
  "department_id": "123",
  "do_not_call": false,
  "drivers_license_expiration_date": "2025-12-31",
  "drivers_license_number": "S12345678",
  "drivers_license_ssn": "123-45-6789",
  "drivers_license_state_id": "MA",
  "drivers_license_url": "https://example.com/license.jpg",
  "email": "john.smith@email.com",
  "email_exists": true,
  "employer_address": "123 Main St",
  "employer_city": "Boston",
  "employer_fax": "+15551234567",
  "employer_id": 12345,
  "employer_name": "Acme Corp",
  "employer_phone": "+15551234567",
  "employer_state": "MA",
  "employer_zip": "02108",
  "ethnicity_code": "2135-2",
  "ethnicity_codes": "2135-2,2186-5",
  "first_appointment_datetime": "2024-05-01T09:00:00Z",
  "first_name": "John",
  "gender_identity": "Male",
  "gender_identity_other": "Non-binary",
  "guarantor_address_1": "456 Oak St",
  "guarantor_address_2": "Suite 101",
  "guarantor_city": "Cambridge",
  "guarantor_country_code_3166": "US",
  "guarantor_dob": "1980-01-15",
  "guarantor_email": "jane.doe@example.com",
  "guarantor_first_name": "Jane",
  "guarantor_last_name": "Doe",
  "guarantor_middle_name": "Marie",
  "guarantor_phone": "+15559876543",
  "guarantor_relationship": "SELF",
  "guarantor_sex": "F",
  "guarantor_ssn": "123-45-6789",
  "guarantor_state": "MA",
  "guarantor_zip": "02142",
  "guardian_address_1": "123 Main St",
  "guardian_address_2": "Apt 4B",
  "guardian_city": "Boston",
  "guardian_first_name": "John",
  "guardian_home_phone": "+15551234567",
  "guardian_last_name": "Smith",
  "guardian_middle_name": "Robert",
  "guardian_relationship": "PARENT",
  "guardian_state": "MA",
  "guardian_zip": "02108",
  "has_drivers_license": true,
  "has_mobile": true,
  "have_patient_photo": false,
  "home_phone": "+15551234567",
  "homeless_type": "TRANSITIONAL",
  "id": "12345",
  "industry_code": "62",
  "insurances": "[{\"insurance_id\":\"INS123\"}]",
  "is_agricultural_worker": false,
  "is_homebound": false,
  "is_homeless": false,
  "is_online_statement_only": true,
  "is_public_housing": false,
  "is_school_based_health_center": false,
  "is_veteran": false,
  "language_6392_code": "eng",
  "last_appointment_datetime": "2024-05-02T15:30:00Z",
  "last_email": "john.smith@email.com",
  "last_name": "Smith",
  "last_updated_by": "jsmith",
  "local_patient_id": "15001",
  "marital_status": "MARITAL_STATUS_MARRIED",
  "middle_name": "Robert",
  "mobile_carrier_id": "21",
  "mobile_phone": "+15551236543",
  "next_of_kin_name": "Jane Smith",
  "next_of_kin_phone": "+15551234567",
  "next_of_kin_relationship": "SPOUSE",
  "notes": "Patient prefers afternoon appointments",
  "occupation_code": "29-1141",
  "portal_access_given": true,
  "portal_signature_on_file": true,
  "portal_status": {
    "blocked_failed_logins": false,
    "entity_to_display": "patient",
    "family_blocked_failed_logins": false,
    "family_registered": true,
    "no_portal": false,
    "portal_registration_date": "2023-05-15",
    "registered": true,
    "status": "REGISTERED",
    "terms_accepted": true
  },
  "portal_terms_on_file": true,
  "poverty_level_calculated": 150,
  "poverty_level_family_size": "4",
  "poverty_level_family_size_declined": false,
  "poverty_level_income_declined": false,
  "poverty_level_income_pay_period": "MONTH",
  "poverty_level_income_per_pay_period": 3000,
  "poverty_level_income_range_declined": false,
  "preferred_name": "Johnny",
  "preferred_pronouns": "he/him",
  "primary_department_id": "123",
  "primary_provider_id": "PROV456",
  "privacy_information_verified": false,
  "race": "2106-3",
  "race_code": "2106-3",
  "race_name": "Caucasian",
  "referral_source_id": "REF789",
  "referral_source_other": "Online search",
  "registration_date": "2024-05-01",
  "sex": "SEX_MALE",
  "sexual_orientation": "SEXUAL_ORIENTATION_STRAIGHT_HETEROSEXUAL",
  "sexual_orientation_other": "Pansexual",
  "ssn": "123-45-6789",
  "state": "MA",
  "status": "PATIENT_STATUS_ACTIVE",
  "suffix": "Jr.",
  "test_patient": false,
  "work_phone": "+15552468135",
  "zip": "02108"
}
{
  "address1": "Patient's address - 1st line",
  "address2": "Patient's address - 2nd line",
  "agricultural_worker_type": "For patients that are agricultural workers, identifies the type of worker",
  "all_patient_statuses": {
    "department_id": "The department ID associated with this status",
    "primary_provider_id": "The primary provider ID associated with this status",
    "status": "The status of the patient (e.g., active, inactive, etc.)"
  },
  "alt_first_name": "Alternate first name that differs from legal name",
  "assigned_sex_at_birth": "Sex that this patient was assigned at birth",
  "balances": {
    "balance": "The balance amount",
    "clean_balance": "Is the balance clean",
    "department_list": "The department list associated with this balance",
    "provider_group_id": "The provider group ID associated with this balance"
  },
  "care_summary_delivery_preference": "The patient's preferred method of receiving care summaries",
  "city": "Patient's city",
  "clinical_order_type_group_id": "The clinical order type group of the clinical provider",
  "consent_to_call": "Flag for consent to receive automated calls",
  "consent_to_text": "Flag for consent to receive text messages",
  "contact_home_phone": "Emergency contact home phone",
  "contact_mobile_phone": "Emergency contact mobile phone",
  "contact_name": "The name of the (emergency) person to contact about the patient",
  "contact_preference": "The preferred method of contact for the patient",
  "contact_preference_announcement_email": "If true, patient prefers to get announcement communications via email",
  "contact_preference_announcement_phone": "If true, patient prefers to get announcement communications via phone",
  "contact_preference_announcement_sms": "If true, patient prefers to get announcement communications via SMS",
  "contact_preference_appointment_email": "If true, patient prefers to get appointment communications via email",
  "contact_preference_appointment_phone": "If true, patient prefers to get appointment communications via phone",
  "contact_preference_appointment_sms": "If true, patient prefers to get appointment communications via SMS",
  "contact_preference_billing_email": "If true, patient prefers to get billing communications via email",
  "contact_preference_billing_phone": "If true, patient prefers to get billing communications via phone",
  "contact_preference_billing_sms": "If true, patient prefers to get billing communications via SMS",
  "contact_preference_lab_email": "If true, patient prefers to get lab communications via email",
  "contact_preference_lab_phone": "If true, patient prefers to get lab communications via phone",
  "contact_preference_lab_sms": "If true, patient prefers to get lab communications via SMS",
  "contact_relationship": "Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)",
  "country_code_3166": "Patient's country code (ISO 3166-1)",
  "custom_fields": {
    "custom_field_id": "Corresponds to the /customfields customfieldid",
    "custom_field_value": "For a non-select custom field, the value",
    "option_id": "For a select custom field, the selectid value (from /customfield's selectlist)"
  },
  "date_of_birth": "Patient's date of birth",
  "deceased_date": "If present, the date on which a patient died",
  "default_pharmacy_ncpdp_id": "The NCPDP ID of the patient's preferred pharmacy",
  "department_id": "Primary (registration) department ID",
  "do_not_call": "Warning! Patient will not receive any communication if true",
  "drivers_license_expiration_date": "The expiration date of the patient's driver's license",
  "drivers_license_number": "The number of the patient's driver's license",
  "drivers_license_ssn": "The SSN on the patient's driver's license",
  "drivers_license_state_id": "The state of the patient's driver's license. This is in the form of a 2 letter state code.",
  "drivers_license_url": "The URL to the patient's driver's license image",
  "email": "Patient's email address",
  "email_exists": "True if the patient's email exists",
  "employer_address": "The patient's employer's address",
  "employer_city": "The patient's employer's city",
  "employer_fax": "The patient's employer's fax number",
  "employer_id": "The patient's employer's ID",
  "employer_name": "The patient's employer's name",
  "employer_phone": "The patient's employer's phone number",
  "employer_state": "The patient's employer's state (2 letter abbreviation)",
  "employer_zip": "The patient's employer's zip code",
  "ethnicity_code": "Ethnicity of the patient, using the 2.16.840.1.113883.5.50 codeset. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "ethnicity_codes": "Ethnicities of the patient, using the 2.16.840.1.113883.5.50 codeset. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "first_appointment_datetime": "The date and time of the patient's first appointment",
  "first_name": "Patient's first name",
  "gender_identity": "Gender the patient identifies as",
  "gender_identity_other": "If a patient does not identify with any prescribed gender identity choice, this field stores the patient-provided description",
  "guarantor_address_1": "The first line of the guarantor's address",
  "guarantor_address_2": "The second line of the guarantor's address",
  "guarantor_city": "The city of the guarantor's address",
  "guarantor_country_code_3166": "The country code of the guarantor's address",
  "guarantor_dob": "The date of birth of the guarantor",
  "guarantor_email": "The email address of the guarantor",
  "guarantor_first_name": "The first name of the patient's guarantor",
  "guarantor_last_name": "The last name of the patient's guarantor",
  "guarantor_middle_name": "The middle name of the patient's guarantor",
  "guarantor_phone": "The guarantor's phone number",
  "guarantor_relationship": "The relationship of the guarantor to the patient",
  "guarantor_sex": "The sex of the guarantor",
  "guarantor_ssn": "The social security number of the guarantor",
  "guarantor_state": "The state of the guarantor's address",
  "guarantor_zip": "The ZIP code of the guarantor's address",
  "guardian_address_1": "The first line of the guardian's address",
  "guardian_address_2": "The second line of the guardian's address",
  "guardian_city": "The city of the guardian's address",
  "guardian_first_name": "The first name of the patient's guardian",
  "guardian_home_phone": "The guardian's home phone number",
  "guardian_last_name": "The last name of the patient's guardian",
  "guardian_middle_name": "The middle name of the patient's guardian",
  "guardian_relationship": "The relationship of the guardian to the patient",
  "guardian_state": "The state of the guardian's address",
  "guardian_zip": "The ZIP code of the guardian's address",
  "has_drivers_license": "True if patient has a driver's license",
  "has_mobile": "Set to false if a client has declined a phone number",
  "have_patient_photo": "True if the patient has a photo uploaded",
  "home_phone": "Patient's home phone number",
  "homeless_type": "For patients that are homeless, provides more detail regarding the patient's homeless situation",
  "id": "Athena patient ID",
  "industry_code": "Industry of the patient. The full set of supported codes can be found using the Athena API GET '/industries' endpoint.",
  "insurances": {
    "eligibility_last_checked": "When eligibility was last checked",
    "eligibility_reason": "Reason for eligibility status",
    "eligibility_status": "Status of eligibility",
    "id": "Insurance ID",
    "insurance_id": "Insurance identifier",
    "insurance_id_number": "Insurance ID number",
    "insurance_package_address1": "Insurance package address - 1st line",
    "insurance_package_city": "Insurance package city",
    "insurance_package_id": "Insurance package ID",
    "insurance_package_state": "Insurance package state (2 letter abbreviation)",
    "insurance_package_zip": "Insurance package zip code",
    "insurance_phone": "Insurance phone number",
    "insurance_plan_display_name": "Insurance plan display name",
    "insurance_plan_name": "Insurance plan name",
    "insurance_policy_holder": "Insurance policy holder",
    "insurance_policy_holder_address1": "Insurance policy holder address - 1st line",
    "insurance_policy_holder_city": "Insurance policy holder city",
    "insurance_policy_holder_country_code": "Insurance policy holder country code",
    "insurance_policy_holder_country_iso3166": "Insurance policy holder country (ISO 3166-1)",
    "insurance_policy_holder_dob": "Insurance policy holder date of birth",
    "insurance_policy_holder_first_name": "Insurance policy holder first name",
    "insurance_policy_holder_last_name": "Insurance policy holder last name",
    "insurance_policy_holder_sex": "Insurance policy holder sex",
    "insurance_policy_holder_state": "Insurance policy holder state (2 letter abbreviation)",
    "insurance_policy_holder_zip": "Insurance policy holder zip code",
    "insurance_type": "Insurance type",
    "insured_address": "Insured person's address",
    "insured_city": "Insured person's city",
    "insured_country_code": "Insured person's country code",
    "insured_country_iso3166": "Insured person's country (ISO 3166-1)",
    "insured_dob": "Insured person's date of birth",
    "insured_entity_type_id": "Insured entity type ID",
    "insured_first_name": "Insured person's first name",
    "insured_last_name": "Insured person's last name",
    "insured_sex": "Insured person's sex",
    "insured_state": "Insured person's state (2 letter abbreviation)",
    "insured_zip": "Insured person's zip code",
    "irc_name": "IRC name",
    "relationship_to_insured": "Relationship to insured person",
    "relationship_to_insured_id": "Relationship to insured person ID",
    "sequence_number": "Sequence number"
  },
  "is_agricultural_worker": "Used to identify this patient as an agricultural worker",
  "is_homebound": "If the patient is homebound, this is true",
  "is_homeless": "Used to identify this patient as homeless",
  "is_online_statement_only": "Set to true if a patient wishes to get e-statements instead of paper statements",
  "is_public_housing": "Used to identify this patient as living in public housing",
  "is_school_based_health_center": "Used to identify this patient as school-based health center patient",
  "is_veteran": "Used to identify this patient as a veteran",
  "language_6392_code": "Language of the patient, using the ISO 639.2 code. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "last_appointment_datetime": "The date and time of the patient's last (most recent) appointment",
  "last_email": "Patient's previous email address",
  "last_name": "Patient's last name",
  "last_updated_by": "User who last updated the patient record",
  "local_patient_id": "Local patient ID (if present)",
  "marital_status": "Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner)",
  "middle_name": "Patient's middle name",
  "mobile_carrier_id": "The ID of the mobile carrier",
  "mobile_phone": "Patient's mobile phone number",
  "next_of_kin_name": "The full name of the next of kin",
  "next_of_kin_phone": "The next of kin phone number",
  "next_of_kin_relationship": "The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)",
  "notes": "Notes associated with this patient",
  "occupation_code": "Occupation of the patient. The full set of supported codes can be found using the Athena API GET '/occupations' endpoint.",
  "portal_access_given": "True if the patient has been given access to the portal",
  "portal_signature_on_file": "Indicates if the patient's signature is on file for the portal",
  "portal_status": {
    "blocked_failed_logins": "Indicates if the patient is blocked due to failed login attempts",
    "entity_to_display": "The entity to display in the portal",
    "family_blocked_failed_logins": "Indicates if the patient's family is blocked due to failed login attempts",
    "family_registered": "Indicates if the patient's family is registered for portal access",
    "no_portal": "Indicates if the patient has no portal access",
    "portal_registration_date": "The date when the patient registered for portal access",
    "registered": "Indicates if the patient is registered for portal access",
    "status": "The status of the patient's portal access",
    "terms_accepted": "Indicates if the patient has accepted the portal terms and conditions"
  },
  "portal_terms_on_file": "True if the patient has accepted the portal's Terms and Conditions",
  "poverty_level_calculated": "Patient's poverty level (% of the Federal Poverty Level)",
  "poverty_level_family_size": "Patient's family size (used for determining poverty level)",
  "poverty_level_family_size_declined": "Indicates if the patient declines to provide family size",
  "poverty_level_income_declined": "Indicates if the patient declines to provide income",
  "poverty_level_income_pay_period": "Patient's pay period (used for determining poverty level)",
  "poverty_level_income_per_pay_period": "Patient's income per specified pay period",
  "poverty_level_income_range_declined": "Indicates if the patient declines to provide an income range level",
  "preferred_name": "The patient's preferred name (i.e. nickname)",
  "preferred_pronouns": "Pronouns this patient uses",
  "primary_department_id": "The patient's \"current\" department. This field is not always set by the practice.",
  "primary_provider_id": "The \"primary\" provider for this patient, if set.",
  "privacy_information_verified": "True if the patient's privacy information has been verified",
  "race": "The patient race, using the 2.16.840.1.113883.5.104 codeset. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "race_code": "The code of the patient's race.",
  "race_name": "The name of the patient's race.",
  "referral_source_id": "The referral / how did you hear about us ID",
  "referral_source_other": "If selecting other for referral source, this is the text field that can be filled out",
  "registration_date": "Date the patient was registered",
  "sex": "Patient's sex (M/F)",
  "sexual_orientation": "Sexual orientation of this patient",
  "sexual_orientation_other": "If a patient does not identify with any prescribed sexual orientation choice, this field stores the patient-provided description",
  "ssn": "The patient's social security number",
  "state": "Patient's state (2 letter abbreviation)",
  "status": "The status of the patient",
  "suffix": "Patient's name suffix",
  "test_patient": "True if this record has been marked as a test patient",
  "work_phone": "Patient's work phone number",
  "zip": "Patient's zip. Matching occurs on first 5 characters."
}

Events

Triggering Webhook Types

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

  • Athena Patient Updated
{
  "address1": "123 Main Street",
  "address2": "Apt 4B",
  "agricultural_worker_type": "SEASONAL",
  "all_patient_statuses": "[{\"status\":\"active\",\"department_id\":1}]",
  "alt_first_name": "Jonathan",
  "assigned_sex_at_birth": "ASSIGNED_SEX_AT_BIRTH_M",
  "balances": "[{\"department_list\":\"1,2\",\"balance\":\"100.00\"}]",
  "care_summary_delivery_preference": "PORTAL",
  "city": "Boston",
  "clinical_order_type_group_id": "10",
  "consent_to_call": true,
  "consent_to_text": true,
  "contact_home_phone": "+15551234567",
  "contact_mobile_phone": "+15551234567",
  "contact_name": null,
  "contact_preference": "EMAIL",
  "contact_preference_announcement_email": true,
  "contact_preference_announcement_phone": false,
  "contact_preference_announcement_sms": false,
  "contact_preference_appointment_email": true,
  "contact_preference_appointment_phone": false,
  "contact_preference_appointment_sms": false,
  "contact_preference_billing_email": true,
  "contact_preference_billing_phone": false,
  "contact_preference_billing_sms": false,
  "contact_preference_lab_email": true,
  "contact_preference_lab_phone": false,
  "contact_preference_lab_sms": false,
  "contact_relationship": "SPOUSE",
  "country_code_3166": "USA",
  "custom_fields": [
    {
      "custom_field_id": "CF123",
      "custom_field_value": "Value for non-select field",
      "option_id": "OPT456"
    }
  ],
  "date_of_birth": "1980-01-15",
  "deceased_date": "2023-01-01",
  "default_pharmacy_ncpdp_id": "123456789",
  "department_id": "123",
  "do_not_call": false,
  "drivers_license_expiration_date": "2025-12-31",
  "drivers_license_number": "S12345678",
  "drivers_license_ssn": "123-45-6789",
  "drivers_license_state_id": "MA",
  "drivers_license_url": "https://example.com/license.jpg",
  "email": "john.smith@email.com",
  "email_exists": true,
  "employer_address": "123 Main St",
  "employer_city": "Boston",
  "employer_fax": "+15551234567",
  "employer_id": 12345,
  "employer_name": "Acme Corp",
  "employer_phone": "+15551234567",
  "employer_state": "MA",
  "employer_zip": "02108",
  "ethnicity_code": "2135-2",
  "ethnicity_codes": "2135-2,2186-5",
  "first_appointment_datetime": "2024-05-01T09:00:00Z",
  "first_name": "John",
  "gender_identity": "Male",
  "gender_identity_other": "Non-binary",
  "guarantor_address_1": "456 Oak St",
  "guarantor_address_2": "Suite 101",
  "guarantor_city": "Cambridge",
  "guarantor_country_code_3166": "US",
  "guarantor_dob": "1980-01-15",
  "guarantor_email": "jane.doe@example.com",
  "guarantor_first_name": "Jane",
  "guarantor_last_name": "Doe",
  "guarantor_middle_name": "Marie",
  "guarantor_phone": "+15559876543",
  "guarantor_relationship": "SELF",
  "guarantor_sex": "F",
  "guarantor_ssn": "123-45-6789",
  "guarantor_state": "MA",
  "guarantor_zip": "02142",
  "guardian_address_1": "123 Main St",
  "guardian_address_2": "Apt 4B",
  "guardian_city": "Boston",
  "guardian_first_name": "John",
  "guardian_home_phone": "+15551234567",
  "guardian_last_name": "Smith",
  "guardian_middle_name": "Robert",
  "guardian_relationship": "PARENT",
  "guardian_state": "MA",
  "guardian_zip": "02108",
  "has_drivers_license": true,
  "has_mobile": true,
  "have_patient_photo": false,
  "home_phone": "+15551234567",
  "homeless_type": "TRANSITIONAL",
  "id": "12345",
  "industry_code": "62",
  "insurances": "[{\"insurance_id\":\"INS123\"}]",
  "is_agricultural_worker": false,
  "is_homebound": false,
  "is_homeless": false,
  "is_online_statement_only": true,
  "is_public_housing": false,
  "is_school_based_health_center": false,
  "is_veteran": false,
  "language_6392_code": "eng",
  "last_appointment_datetime": "2024-05-02T15:30:00Z",
  "last_email": "john.smith@email.com",
  "last_name": "Smith",
  "last_updated_by": "jsmith",
  "local_patient_id": "15001",
  "marital_status": "MARITAL_STATUS_MARRIED",
  "middle_name": "Robert",
  "mobile_carrier_id": "21",
  "mobile_phone": "+15551236543",
  "next_of_kin_name": "Jane Smith",
  "next_of_kin_phone": "+15551234567",
  "next_of_kin_relationship": "SPOUSE",
  "notes": "Patient prefers afternoon appointments",
  "occupation_code": "29-1141",
  "portal_access_given": true,
  "portal_signature_on_file": true,
  "portal_status": {
    "blocked_failed_logins": false,
    "entity_to_display": "patient",
    "family_blocked_failed_logins": false,
    "family_registered": true,
    "no_portal": false,
    "portal_registration_date": "2023-05-15",
    "registered": true,
    "status": "REGISTERED",
    "terms_accepted": true
  },
  "portal_terms_on_file": true,
  "poverty_level_calculated": 150,
  "poverty_level_family_size": "4",
  "poverty_level_family_size_declined": false,
  "poverty_level_income_declined": false,
  "poverty_level_income_pay_period": "MONTH",
  "poverty_level_income_per_pay_period": 3000,
  "poverty_level_income_range_declined": false,
  "preferred_name": "Johnny",
  "preferred_pronouns": "he/him",
  "primary_department_id": "123",
  "primary_provider_id": "PROV456",
  "privacy_information_verified": false,
  "race": "2106-3",
  "race_code": "2106-3",
  "race_name": "Caucasian",
  "referral_source_id": "REF789",
  "referral_source_other": "Online search",
  "registration_date": "2024-05-01",
  "sex": "SEX_MALE",
  "sexual_orientation": "SEXUAL_ORIENTATION_STRAIGHT_HETEROSEXUAL",
  "sexual_orientation_other": "Pansexual",
  "ssn": "123-45-6789",
  "state": "MA",
  "status": "PATIENT_STATUS_ACTIVE",
  "suffix": "Jr.",
  "test_patient": false,
  "work_phone": "+15552468135",
  "zip": "02108"
}
{
  "address1": "Patient's address - 1st line",
  "address2": "Patient's address - 2nd line",
  "agricultural_worker_type": "For patients that are agricultural workers, identifies the type of worker",
  "all_patient_statuses": {
    "department_id": "The department ID associated with this status",
    "primary_provider_id": "The primary provider ID associated with this status",
    "status": "The status of the patient (e.g., active, inactive, etc.)"
  },
  "alt_first_name": "Alternate first name that differs from legal name",
  "assigned_sex_at_birth": "Sex that this patient was assigned at birth",
  "balances": {
    "balance": "The balance amount",
    "clean_balance": "Is the balance clean",
    "department_list": "The department list associated with this balance",
    "provider_group_id": "The provider group ID associated with this balance"
  },
  "care_summary_delivery_preference": "The patient's preferred method of receiving care summaries",
  "city": "Patient's city",
  "clinical_order_type_group_id": "The clinical order type group of the clinical provider",
  "consent_to_call": "Flag for consent to receive automated calls",
  "consent_to_text": "Flag for consent to receive text messages",
  "contact_home_phone": "Emergency contact home phone",
  "contact_mobile_phone": "Emergency contact mobile phone",
  "contact_name": "The name of the (emergency) person to contact about the patient",
  "contact_preference": "The preferred method of contact for the patient",
  "contact_preference_announcement_email": "If true, patient prefers to get announcement communications via email",
  "contact_preference_announcement_phone": "If true, patient prefers to get announcement communications via phone",
  "contact_preference_announcement_sms": "If true, patient prefers to get announcement communications via SMS",
  "contact_preference_appointment_email": "If true, patient prefers to get appointment communications via email",
  "contact_preference_appointment_phone": "If true, patient prefers to get appointment communications via phone",
  "contact_preference_appointment_sms": "If true, patient prefers to get appointment communications via SMS",
  "contact_preference_billing_email": "If true, patient prefers to get billing communications via email",
  "contact_preference_billing_phone": "If true, patient prefers to get billing communications via phone",
  "contact_preference_billing_sms": "If true, patient prefers to get billing communications via SMS",
  "contact_preference_lab_email": "If true, patient prefers to get lab communications via email",
  "contact_preference_lab_phone": "If true, patient prefers to get lab communications via phone",
  "contact_preference_lab_sms": "If true, patient prefers to get lab communications via SMS",
  "contact_relationship": "Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)",
  "country_code_3166": "Patient's country code (ISO 3166-1)",
  "custom_fields": {
    "custom_field_id": "Corresponds to the /customfields customfieldid",
    "custom_field_value": "For a non-select custom field, the value",
    "option_id": "For a select custom field, the selectid value (from /customfield's selectlist)"
  },
  "date_of_birth": "Patient's date of birth",
  "deceased_date": "If present, the date on which a patient died",
  "default_pharmacy_ncpdp_id": "The NCPDP ID of the patient's preferred pharmacy",
  "department_id": "Primary (registration) department ID",
  "do_not_call": "Warning! Patient will not receive any communication if true",
  "drivers_license_expiration_date": "The expiration date of the patient's driver's license",
  "drivers_license_number": "The number of the patient's driver's license",
  "drivers_license_ssn": "The SSN on the patient's driver's license",
  "drivers_license_state_id": "The state of the patient's driver's license. This is in the form of a 2 letter state code.",
  "drivers_license_url": "The URL to the patient's driver's license image",
  "email": "Patient's email address",
  "email_exists": "True if the patient's email exists",
  "employer_address": "The patient's employer's address",
  "employer_city": "The patient's employer's city",
  "employer_fax": "The patient's employer's fax number",
  "employer_id": "The patient's employer's ID",
  "employer_name": "The patient's employer's name",
  "employer_phone": "The patient's employer's phone number",
  "employer_state": "The patient's employer's state (2 letter abbreviation)",
  "employer_zip": "The patient's employer's zip code",
  "ethnicity_code": "Ethnicity of the patient, using the 2.16.840.1.113883.5.50 codeset. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "ethnicity_codes": "Ethnicities of the patient, using the 2.16.840.1.113883.5.50 codeset. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "first_appointment_datetime": "The date and time of the patient's first appointment",
  "first_name": "Patient's first name",
  "gender_identity": "Gender the patient identifies as",
  "gender_identity_other": "If a patient does not identify with any prescribed gender identity choice, this field stores the patient-provided description",
  "guarantor_address_1": "The first line of the guarantor's address",
  "guarantor_address_2": "The second line of the guarantor's address",
  "guarantor_city": "The city of the guarantor's address",
  "guarantor_country_code_3166": "The country code of the guarantor's address",
  "guarantor_dob": "The date of birth of the guarantor",
  "guarantor_email": "The email address of the guarantor",
  "guarantor_first_name": "The first name of the patient's guarantor",
  "guarantor_last_name": "The last name of the patient's guarantor",
  "guarantor_middle_name": "The middle name of the patient's guarantor",
  "guarantor_phone": "The guarantor's phone number",
  "guarantor_relationship": "The relationship of the guarantor to the patient",
  "guarantor_sex": "The sex of the guarantor",
  "guarantor_ssn": "The social security number of the guarantor",
  "guarantor_state": "The state of the guarantor's address",
  "guarantor_zip": "The ZIP code of the guarantor's address",
  "guardian_address_1": "The first line of the guardian's address",
  "guardian_address_2": "The second line of the guardian's address",
  "guardian_city": "The city of the guardian's address",
  "guardian_first_name": "The first name of the patient's guardian",
  "guardian_home_phone": "The guardian's home phone number",
  "guardian_last_name": "The last name of the patient's guardian",
  "guardian_middle_name": "The middle name of the patient's guardian",
  "guardian_relationship": "The relationship of the guardian to the patient",
  "guardian_state": "The state of the guardian's address",
  "guardian_zip": "The ZIP code of the guardian's address",
  "has_drivers_license": "True if patient has a driver's license",
  "has_mobile": "Set to false if a client has declined a phone number",
  "have_patient_photo": "True if the patient has a photo uploaded",
  "home_phone": "Patient's home phone number",
  "homeless_type": "For patients that are homeless, provides more detail regarding the patient's homeless situation",
  "id": "Athena patient ID",
  "industry_code": "Industry of the patient. The full set of supported codes can be found using the Athena API GET '/industries' endpoint.",
  "insurances": {
    "eligibility_last_checked": "When eligibility was last checked",
    "eligibility_reason": "Reason for eligibility status",
    "eligibility_status": "Status of eligibility",
    "id": "Insurance ID",
    "insurance_id": "Insurance identifier",
    "insurance_id_number": "Insurance ID number",
    "insurance_package_address1": "Insurance package address - 1st line",
    "insurance_package_city": "Insurance package city",
    "insurance_package_id": "Insurance package ID",
    "insurance_package_state": "Insurance package state (2 letter abbreviation)",
    "insurance_package_zip": "Insurance package zip code",
    "insurance_phone": "Insurance phone number",
    "insurance_plan_display_name": "Insurance plan display name",
    "insurance_plan_name": "Insurance plan name",
    "insurance_policy_holder": "Insurance policy holder",
    "insurance_policy_holder_address1": "Insurance policy holder address - 1st line",
    "insurance_policy_holder_city": "Insurance policy holder city",
    "insurance_policy_holder_country_code": "Insurance policy holder country code",
    "insurance_policy_holder_country_iso3166": "Insurance policy holder country (ISO 3166-1)",
    "insurance_policy_holder_dob": "Insurance policy holder date of birth",
    "insurance_policy_holder_first_name": "Insurance policy holder first name",
    "insurance_policy_holder_last_name": "Insurance policy holder last name",
    "insurance_policy_holder_sex": "Insurance policy holder sex",
    "insurance_policy_holder_state": "Insurance policy holder state (2 letter abbreviation)",
    "insurance_policy_holder_zip": "Insurance policy holder zip code",
    "insurance_type": "Insurance type",
    "insured_address": "Insured person's address",
    "insured_city": "Insured person's city",
    "insured_country_code": "Insured person's country code",
    "insured_country_iso3166": "Insured person's country (ISO 3166-1)",
    "insured_dob": "Insured person's date of birth",
    "insured_entity_type_id": "Insured entity type ID",
    "insured_first_name": "Insured person's first name",
    "insured_last_name": "Insured person's last name",
    "insured_sex": "Insured person's sex",
    "insured_state": "Insured person's state (2 letter abbreviation)",
    "insured_zip": "Insured person's zip code",
    "irc_name": "IRC name",
    "relationship_to_insured": "Relationship to insured person",
    "relationship_to_insured_id": "Relationship to insured person ID",
    "sequence_number": "Sequence number"
  },
  "is_agricultural_worker": "Used to identify this patient as an agricultural worker",
  "is_homebound": "If the patient is homebound, this is true",
  "is_homeless": "Used to identify this patient as homeless",
  "is_online_statement_only": "Set to true if a patient wishes to get e-statements instead of paper statements",
  "is_public_housing": "Used to identify this patient as living in public housing",
  "is_school_based_health_center": "Used to identify this patient as school-based health center patient",
  "is_veteran": "Used to identify this patient as a veteran",
  "language_6392_code": "Language of the patient, using the ISO 639.2 code. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "last_appointment_datetime": "The date and time of the patient's last (most recent) appointment",
  "last_email": "Patient's previous email address",
  "last_name": "Patient's last name",
  "last_updated_by": "User who last updated the patient record",
  "local_patient_id": "Local patient ID (if present)",
  "marital_status": "Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner)",
  "middle_name": "Patient's middle name",
  "mobile_carrier_id": "The ID of the mobile carrier",
  "mobile_phone": "Patient's mobile phone number",
  "next_of_kin_name": "The full name of the next of kin",
  "next_of_kin_phone": "The next of kin phone number",
  "next_of_kin_relationship": "The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)",
  "notes": "Notes associated with this patient",
  "occupation_code": "Occupation of the patient. The full set of supported codes can be found using the Athena API GET '/occupations' endpoint.",
  "portal_access_given": "True if the patient has been given access to the portal",
  "portal_signature_on_file": "Indicates if the patient's signature is on file for the portal",
  "portal_status": {
    "blocked_failed_logins": "Indicates if the patient is blocked due to failed login attempts",
    "entity_to_display": "The entity to display in the portal",
    "family_blocked_failed_logins": "Indicates if the patient's family is blocked due to failed login attempts",
    "family_registered": "Indicates if the patient's family is registered for portal access",
    "no_portal": "Indicates if the patient has no portal access",
    "portal_registration_date": "The date when the patient registered for portal access",
    "registered": "Indicates if the patient is registered for portal access",
    "status": "The status of the patient's portal access",
    "terms_accepted": "Indicates if the patient has accepted the portal terms and conditions"
  },
  "portal_terms_on_file": "True if the patient has accepted the portal's Terms and Conditions",
  "poverty_level_calculated": "Patient's poverty level (% of the Federal Poverty Level)",
  "poverty_level_family_size": "Patient's family size (used for determining poverty level)",
  "poverty_level_family_size_declined": "Indicates if the patient declines to provide family size",
  "poverty_level_income_declined": "Indicates if the patient declines to provide income",
  "poverty_level_income_pay_period": "Patient's pay period (used for determining poverty level)",
  "poverty_level_income_per_pay_period": "Patient's income per specified pay period",
  "poverty_level_income_range_declined": "Indicates if the patient declines to provide an income range level",
  "preferred_name": "The patient's preferred name (i.e. nickname)",
  "preferred_pronouns": "Pronouns this patient uses",
  "primary_department_id": "The patient's \"current\" department. This field is not always set by the practice.",
  "primary_provider_id": "The \"primary\" provider for this patient, if set.",
  "privacy_information_verified": "True if the patient's privacy information has been verified",
  "race": "The patient race, using the 2.16.840.1.113883.5.104 codeset. Special case: use \"declined\" to indicate that the patient declined to answer.",
  "race_code": "The code of the patient's race.",
  "race_name": "The name of the patient's race.",
  "referral_source_id": "The referral / how did you hear about us ID",
  "referral_source_other": "If selecting other for referral source, this is the text field that can be filled out",
  "registration_date": "Date the patient was registered",
  "sex": "Patient's sex (M/F)",
  "sexual_orientation": "Sexual orientation of this patient",
  "sexual_orientation_other": "If a patient does not identify with any prescribed sexual orientation choice, this field stores the patient-provided description",
  "ssn": "The patient's social security number",
  "state": "Patient's state (2 letter abbreviation)",
  "status": "The status of the patient",
  "suffix": "Patient's name suffix",
  "test_patient": "True if this record has been marked as a test patient",
  "work_phone": "Patient's work phone number",
  "zip": "Patient's zip. Matching occurs on first 5 characters."
}

Payload Field Details

Patient
Event Payload