> ## Documentation Index > Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get Patient > Documentation for the Get Patient action for Athena ![images/athena.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/athena.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=8583fdd7ec593228b6241d194b1076d0) # Parameters **Action** `Parameters` **parameters** **Patient ID** `string` *required* `ID` This field maps to the destination API `patient` field. ```json Result Object Example theme={null} { "$result_object_key": { "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" } } ``` ```json Result Object Description theme={null} { "$result_object_key": { "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." } } ``` ### Result Object Field Details You can use the result of the action's data as inputs to downstream workflow actions. Each fetch action requires an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes. Here we demonstrate how to refer to this data using the prefix `$result_object_key`. **Patient** `Fetch Action Response Object` **fields** **id** `string` *required* `ID` Athena patient ID ```json CEL theme={null} $result_object_key.id ``` ```json Example theme={null} "12345" ``` **first\_name** `string` *required* `PII` Patient's first name ```json CEL theme={null} $result_object_key.first_name ``` ```json Example theme={null} "John" ``` **last\_name** `string` *required* `PII` Patient's last name ```json CEL theme={null} $result_object_key.last_name ``` ```json Example theme={null} "Smith" ``` **middle\_name** `string` `PII` Patient's middle name ```json CEL theme={null} $result_object_key.middle_name ``` ```json Example theme={null} "Robert" ``` **suffix** `string` `PII` Patient's name suffix ```json CEL theme={null} $result_object_key.suffix ``` ```json Example theme={null} "Jr." ``` **preferred\_name** `string` `PII` The patient's preferred name (i.e. nickname) ```json CEL theme={null} $result_object_key.preferred_name ``` ```json Example theme={null} "Johnny" ``` **alt\_first\_name** `string` `PII` Alternate first name that differs from legal name ```json CEL theme={null} $result_object_key.alt_first_name ``` ```json Example theme={null} "Jonathan" ``` **date\_of\_birth** `values.v1.Date` *required* `PII` Patient's date of birth ```json CEL theme={null} $result_object_key.date_of_birth ``` ```json Example theme={null} "1980-01-15" ``` **sex** `athena.v1.Sex` `HI` Patient's sex (M/F) ```json CEL theme={null} $result_object_key.sex ``` ```json Example theme={null} athena.v1.Sex.SEX_MALE athena.v1.Sex.SEX_FEMALE ``` **assigned\_sex\_at\_birth** `athena.v1.AssignedSexAtBirth` `HI` Sex that this patient was assigned at birth ```json CEL theme={null} $result_object_key.assigned_sex_at_birth ``` ```json Example theme={null} athena.v1.AssignedSexAtBirth.ASSIGNED_SEX_AT_BIRTH_M athena.v1.AssignedSexAtBirth.ASSIGNED_SEX_AT_BIRTH_F athena.v1.AssignedSexAtBirth.ASSIGNED_SEX_AT_BIRTH_N athena.v1.AssignedSexAtBirth.ASSIGNED_SEX_AT_BIRTH_U ``` **gender\_identity** `string` Gender the patient identifies as ```json CEL theme={null} $result_object_key.gender_identity ``` ```json Example theme={null} "Male" ``` **gender\_identity\_other** `string` If a patient does not identify with any prescribed gender identity choice, this field stores the patient-provided description ```json CEL theme={null} $result_object_key.gender_identity_other ``` ```json Example theme={null} "Non-binary" ``` **preferred\_pronouns** `string` Pronouns this patient uses ```json CEL theme={null} $result_object_key.preferred_pronouns ``` ```json Example theme={null} "he/him" ``` **sexual\_orientation** `athena.v1.SexualOrientation` `HI` Sexual orientation of this patient ```json CEL theme={null} $result_object_key.sexual_orientation ``` ```json Example theme={null} athena.v1.SexualOrientation.SEXUAL_ORIENTATION_BISEXUAL athena.v1.SexualOrientation.SEXUAL_ORIENTATION_LESBIAN_GAY_HOMOSEXUAL athena.v1.SexualOrientation.SEXUAL_ORIENTATION_DONT_KNOW athena.v1.SexualOrientation.SEXUAL_ORIENTATION_SOMETHING_ELSE athena.v1.SexualOrientation.SEXUAL_ORIENTATION_STRAIGHT_HETEROSEXUAL athena.v1.SexualOrientation.SEXUAL_ORIENTATION_CHOOSE_NOT_TO_DISCLOSE athena.v1.SexualOrientation.SEXUAL_ORIENTATION_SOMETHING_ELSE_PLEASE_DESCRIBE ``` **sexual\_orientation\_other** `string` `HI` If a patient does not identify with any prescribed sexual orientation choice, this field stores the patient-provided description ```json CEL theme={null} $result_object_key.sexual_orientation_other ``` ```json Example theme={null} "Pansexual" ``` **marital\_status** `athena.v1.MaritalStatus` Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner) ```json CEL theme={null} $result_object_key.marital_status ``` ```json Example theme={null} athena.v1.MaritalStatus.MARITAL_STATUS_DIVORCED athena.v1.MaritalStatus.MARITAL_STATUS_MARRIED athena.v1.MaritalStatus.MARITAL_STATUS_SINGLE athena.v1.MaritalStatus.MARITAL_STATUS_UNKNOWN athena.v1.MaritalStatus.MARITAL_STATUS_WIDOWED athena.v1.MaritalStatus.MARITAL_STATUS_SEPARATED athena.v1.MaritalStatus.MARITAL_STATUS_PARTNER ``` **language\_6392\_code** `string` Language of the patient, using the ISO 639.2 code. Special case: use "declined" to indicate that the patient declined to answer. ```json CEL theme={null} $result_object_key.language_6392_code ``` ```json Example theme={null} "eng" ``` **race** `string` `PII` 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. ```json CEL theme={null} $result_object_key.race ``` ```json Example theme={null} "2106-3" ``` **race\_code** `string` `PII` The code of the patient's race. ```json CEL theme={null} $result_object_key.race_code ``` ```json Example theme={null} "2106-3" ``` **race\_name** `string` `PII` The name of the patient's race. ```json CEL theme={null} $result_object_key.race_name ``` ```json Example theme={null} "Caucasian" ``` **ethnicity\_code** `string` `PII` 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. ```json CEL theme={null} $result_object_key.ethnicity_code ``` ```json Example theme={null} "2135-2" ``` **ethnicity\_codes** `string` `PII` 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. ```json CEL theme={null} $result_object_key.ethnicity_codes ``` ```json Example theme={null} "2135-2,2186-5" ``` **occupation\_code** `string` `PII` Occupation of the patient. The full set of supported codes can be found using the Athena API GET '/occupations' endpoint. ```json CEL theme={null} $result_object_key.occupation_code ``` ```json Example theme={null} "29-1141" ``` **industry\_code** `string` `PII` Industry of the patient. The full set of supported codes can be found using the Athena API GET '/industries' endpoint. ```json CEL theme={null} $result_object_key.industry_code ``` ```json Example theme={null} "62" ``` **ssn** `string` `PII` The patient's social security number ```json CEL theme={null} $result_object_key.ssn ``` ```json Example theme={null} "123-45-6789" ``` **email** `string` `PII` Patient's email address ```json CEL theme={null} $result_object_key.email ``` ```json Example theme={null} "john.smith@email.com" ``` **home\_phone** `string` `PII` Patient's home phone number ```json CEL theme={null} $result_object_key.home_phone ``` ```json Example theme={null} "+15551234567" ``` **work\_phone** `string` `PII` Patient's work phone number ```json CEL theme={null} $result_object_key.work_phone ``` ```json Example theme={null} "+15552468135" ``` **mobile\_phone** `string` `PII` Patient's mobile phone number ```json CEL theme={null} $result_object_key.mobile_phone ``` ```json Example theme={null} "+15551236543" ``` **has\_mobile** `bool` Set to false if a client has declined a phone number ```json CEL theme={null} $result_object_key.has_mobile ``` ```json Example theme={null} true ``` **mobile\_carrier\_id** `string` The ID of the mobile carrier ```json CEL theme={null} $result_object_key.mobile_carrier_id ``` ```json Example theme={null} "21" ``` **address1** `string` `PII` Patient's address - 1st line ```json CEL theme={null} $result_object_key.address1 ``` ```json Example theme={null} "123 Main Street" ``` **address2** `string` `PII` Patient's address - 2nd line ```json CEL theme={null} $result_object_key.address2 ``` ```json Example theme={null} "Apt 4B" ``` **city** `string` `PII` Patient's city ```json CEL theme={null} $result_object_key.city ``` ```json Example theme={null} "Boston" ``` **state** `string` Patient's state (2 letter abbreviation) ```json CEL theme={null} $result_object_key.state ``` ```json Example theme={null} "MA" ``` **zip** `string` `PII` Patient's zip. Matching occurs on first 5 characters. ```json CEL theme={null} $result_object_key.zip ``` ```json Example theme={null} "02108" ``` **country\_code\_3166** `string` Patient's country code (ISO 3166-1) ```json CEL theme={null} $result_object_key.country_code_3166 ``` ```json Example theme={null} "USA" ``` **contact\_name** `string` `PII` The name of the (emergency) person to contact about the patient ```json CEL theme={null} $result_object_key.contact_name ``` ```json Example theme={null} null ``` **contact\_relationship** `string` Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER) ```json CEL theme={null} $result_object_key.contact_relationship ``` ```json Example theme={null} "SPOUSE" ``` **contact\_home\_phone** `string` `PII` Emergency contact home phone ```json CEL theme={null} $result_object_key.contact_home_phone ``` ```json Example theme={null} "+15551234567" ``` **contact\_mobile\_phone** `string` `PII` Emergency contact mobile phone ```json CEL theme={null} $result_object_key.contact_mobile_phone ``` ```json Example theme={null} "+15551234567" ``` **department\_id** `string` *required* Primary (registration) department ID ```json CEL theme={null} $result_object_key.department_id ``` ```json Example theme={null} "123" ``` **primary\_department\_id** `string` The patient's "current" department. This field is not always set by the practice. ```json CEL theme={null} $result_object_key.primary_department_id ``` ```json Example theme={null} "123" ``` **primary\_provider\_id** `string` The "primary" provider for this patient, if set. ```json CEL theme={null} $result_object_key.primary_provider_id ``` ```json Example theme={null} "PROV456" ``` **deceased\_date** `values.v1.Date` `HI` If present, the date on which a patient died ```json CEL theme={null} $result_object_key.deceased_date ``` ```json Example theme={null} "2023-01-01" ``` **is\_agricultural\_worker** `bool` `PII` Used to identify this patient as an agricultural worker ```json CEL theme={null} $result_object_key.is_agricultural_worker ``` ```json Example theme={null} false ``` **agricultural\_worker\_type** `string` `PII` For patients that are agricultural workers, identifies the type of worker ```json CEL theme={null} $result_object_key.agricultural_worker_type ``` ```json Example theme={null} "SEASONAL" ``` **is\_homeless** `bool` `HI` Used to identify this patient as homeless ```json CEL theme={null} $result_object_key.is_homeless ``` ```json Example theme={null} false ``` **homeless\_type** `string` `HI` For patients that are homeless, provides more detail regarding the patient's homeless situation ```json CEL theme={null} $result_object_key.homeless_type ``` ```json Example theme={null} "TRANSITIONAL" ``` **is\_public\_housing** `bool` Used to identify this patient as living in public housing ```json CEL theme={null} $result_object_key.is_public_housing ``` ```json Example theme={null} false ``` **is\_school\_based\_health\_center** `bool` `PII` Used to identify this patient as school-based health center patient ```json CEL theme={null} $result_object_key.is_school_based_health_center ``` ```json Example theme={null} false ``` **is\_veteran** `bool` Used to identify this patient as a veteran ```json CEL theme={null} $result_object_key.is_veteran ``` ```json Example theme={null} false ``` **poverty\_level\_calculated** `float64 (double)` Patient's poverty level (% of the Federal Poverty Level) ```json CEL theme={null} $result_object_key.poverty_level_calculated ``` ```json Example theme={null} 150 ``` **poverty\_level\_family\_size** `uint64` Patient's family size (used for determining poverty level) ```json CEL theme={null} $result_object_key.poverty_level_family_size ``` ```json Example theme={null} "4" ``` **poverty\_level\_family\_size\_declined** `bool` Indicates if the patient declines to provide family size ```json CEL theme={null} $result_object_key.poverty_level_family_size_declined ``` ```json Example theme={null} false ``` **poverty\_level\_income\_declined** `bool` Indicates if the patient declines to provide income ```json CEL theme={null} $result_object_key.poverty_level_income_declined ``` ```json Example theme={null} false ``` **poverty\_level\_income\_pay\_period** `string` Patient's pay period (used for determining poverty level) ```json CEL theme={null} $result_object_key.poverty_level_income_pay_period ``` ```json Example theme={null} "MONTH" ``` **poverty\_level\_income\_per\_pay\_period** `float64 (double)` Patient's income per specified pay period ```json CEL theme={null} $result_object_key.poverty_level_income_per_pay_period ``` ```json Example theme={null} 3000 ``` **poverty\_level\_income\_range\_declined** `bool` Indicates if the patient declines to provide an income range level ```json CEL theme={null} $result_object_key.poverty_level_income_range_declined ``` ```json Example theme={null} false ``` **notes** `string` Notes associated with this patient ```json CEL theme={null} $result_object_key.notes ``` ```json Example theme={null} "Patient prefers afternoon appointments" ``` **referral\_source\_id** `string` The referral / how did you hear about us ID ```json CEL theme={null} $result_object_key.referral_source_id ``` ```json Example theme={null} "REF789" ``` **referral\_source\_other** `string` If selecting other for referral source, this is the text field that can be filled out ```json CEL theme={null} $result_object_key.referral_source_other ``` ```json Example theme={null} "Online search" ``` **is\_homebound** `bool` If the patient is homebound, this is true ```json CEL theme={null} $result_object_key.is_homebound ``` ```json Example theme={null} false ``` **is\_online\_statement\_only** `bool` Set to true if a patient wishes to get e-statements instead of paper statements ```json CEL theme={null} $result_object_key.is_online_statement_only ``` ```json Example theme={null} true ``` **drivers\_license\_number** `string` `PII` The number of the patient's driver's license ```json CEL theme={null} $result_object_key.drivers_license_number ``` ```json Example theme={null} "S12345678" ``` **drivers\_license\_state\_id** `string` The state of the patient's driver's license. This is in the form of a 2 letter state code. ```json CEL theme={null} $result_object_key.drivers_license_state_id ``` ```json Example theme={null} "MA" ``` **drivers\_license\_expiration\_date** `values.v1.Date` The expiration date of the patient's driver's license ```json CEL theme={null} $result_object_key.drivers_license_expiration_date ``` ```json Example theme={null} "2025-12-31" ``` **consent\_to\_call** `bool` Flag for consent to receive automated calls ```json CEL theme={null} $result_object_key.consent_to_call ``` ```json Example theme={null} true ``` **consent\_to\_text** `bool` Flag for consent to receive text messages ```json CEL theme={null} $result_object_key.consent_to_text ``` ```json Example theme={null} true ``` **do\_not\_call** `bool` Warning! Patient will not receive any communication if true ```json CEL theme={null} $result_object_key.do_not_call ``` ```json Example theme={null} false ``` **default\_pharmacy\_ncpdp\_id** `string` The NCPDP ID of the patient's preferred pharmacy ```json CEL theme={null} $result_object_key.default_pharmacy_ncpdp_id ``` ```json Example theme={null} "123456789" ``` **status** `athena.v1.PatientStatus` The status of the patient ```json CEL theme={null} $result_object_key.status ``` ```json Example theme={null} athena.v1.PatientStatus.PATIENT_STATUS_ACTIVE athena.v1.PatientStatus.PATIENT_STATUS_INACTIVE athena.v1.PatientStatus.PATIENT_STATUS_DELETED athena.v1.PatientStatus.PATIENT_STATUS_PROSPECTIVE ``` **clinical\_order\_type\_group\_id** `string` The clinical order type group of the clinical provider ```json CEL theme={null} $result_object_key.clinical_order_type_group_id ``` ```json Example theme={null} "10" ``` **employer\_id** `int64` The patient's employer's ID ```json CEL theme={null} $result_object_key.employer_id ``` ```json Example theme={null} 12345 ``` **employer\_phone** `string` `PII` The patient's employer's phone number ```json CEL theme={null} $result_object_key.employer_phone ``` ```json Example theme={null} "+15551234567" ``` **next\_of\_kin\_name** `string` `PII` The full name of the next of kin ```json CEL theme={null} $result_object_key.next_of_kin_name ``` ```json Example theme={null} "Jane Smith" ``` **next\_of\_kin\_phone** `string` `PII` The next of kin phone number ```json CEL theme={null} $result_object_key.next_of_kin_phone ``` ```json Example theme={null} "+15551234567" ``` **next\_of\_kin\_relationship** `string` The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER) ```json CEL theme={null} $result_object_key.next_of_kin_relationship ``` ```json Example theme={null} "SPOUSE" ``` **guardian\_first\_name** `string` The first name of the patient's guardian ```json CEL theme={null} $result_object_key.guardian_first_name ``` ```json Example theme={null} "John" ``` **guardian\_last\_name** `string` The last name of the patient's guardian ```json CEL theme={null} $result_object_key.guardian_last_name ``` ```json Example theme={null} "Smith" ``` **guardian\_middle\_name** `string` The middle name of the patient's guardian ```json CEL theme={null} $result_object_key.guardian_middle_name ``` ```json Example theme={null} "Robert" ``` **guardian\_address\_1** `string` The first line of the guardian's address ```json CEL theme={null} $result_object_key.guardian_address_1 ``` ```json Example theme={null} "123 Main St" ``` **guardian\_address\_2** `string` The second line of the guardian's address ```json CEL theme={null} $result_object_key.guardian_address_2 ``` ```json Example theme={null} "Apt 4B" ``` **guardian\_city** `string` The city of the guardian's address ```json CEL theme={null} $result_object_key.guardian_city ``` ```json Example theme={null} "Boston" ``` **guardian\_state** `string` The state of the guardian's address ```json CEL theme={null} $result_object_key.guardian_state ``` ```json Example theme={null} "MA" ``` **guardian\_zip** `string` The ZIP code of the guardian's address ```json CEL theme={null} $result_object_key.guardian_zip ``` ```json Example theme={null} "02108" ``` **guardian\_home\_phone** `string` `PII` The guardian's home phone number ```json CEL theme={null} $result_object_key.guardian_home_phone ``` ```json Example theme={null} "+15551234567" ``` **guardian\_relationship** `string` The relationship of the guardian to the patient ```json CEL theme={null} $result_object_key.guardian_relationship ``` ```json Example theme={null} "PARENT" ``` **guarantor\_first\_name** `string` The first name of the patient's guarantor ```json CEL theme={null} $result_object_key.guarantor_first_name ``` ```json Example theme={null} "Jane" ``` **guarantor\_last\_name** `string` The last name of the patient's guarantor ```json CEL theme={null} $result_object_key.guarantor_last_name ``` ```json Example theme={null} "Doe" ``` **guarantor\_middle\_name** `string` The middle name of the patient's guarantor ```json CEL theme={null} $result_object_key.guarantor_middle_name ``` ```json Example theme={null} "Marie" ``` **guarantor\_address\_1** `string` The first line of the guarantor's address ```json CEL theme={null} $result_object_key.guarantor_address_1 ``` ```json Example theme={null} "456 Oak St" ``` **guarantor\_address\_2** `string` The second line of the guarantor's address ```json CEL theme={null} $result_object_key.guarantor_address_2 ``` ```json Example theme={null} "Suite 101" ``` **guarantor\_city** `string` The city of the guarantor's address ```json CEL theme={null} $result_object_key.guarantor_city ``` ```json Example theme={null} "Cambridge" ``` **guarantor\_state** `string` The state of the guarantor's address ```json CEL theme={null} $result_object_key.guarantor_state ``` ```json Example theme={null} "MA" ``` **guarantor\_zip** `string` The ZIP code of the guarantor's address ```json CEL theme={null} $result_object_key.guarantor_zip ``` ```json Example theme={null} "02142" ``` **guarantor\_country\_code\_3166** `string` The country code of the guarantor's address ```json CEL theme={null} $result_object_key.guarantor_country_code_3166 ``` ```json Example theme={null} "US" ``` **guarantor\_phone** `string` `PII` The guarantor's phone number ```json CEL theme={null} $result_object_key.guarantor_phone ``` ```json Example theme={null} "+15559876543" ``` **guarantor\_relationship** `string` The relationship of the guarantor to the patient ```json CEL theme={null} $result_object_key.guarantor_relationship ``` ```json Example theme={null} "SELF" ``` **guarantor\_dob** `values.v1.Date` The date of birth of the guarantor ```json CEL theme={null} $result_object_key.guarantor_dob ``` ```json Example theme={null} "1980-01-15" ``` **guarantor\_sex** `string` The sex of the guarantor ```json CEL theme={null} $result_object_key.guarantor_sex ``` ```json Example theme={null} "F" ``` **guarantor\_ssn** `string` `PII` The social security number of the guarantor ```json CEL theme={null} $result_object_key.guarantor_ssn ``` ```json Example theme={null} "123-45-6789" ``` **guarantor\_email** `string` `PII` The email address of the guarantor ```json CEL theme={null} $result_object_key.guarantor_email ``` ```json Example theme={null} "jane.doe@example.com" ``` **custom\_fields** `[]object` *required* Custom fields for the patient ```json CEL theme={null} $result_object_key.custom_fields ``` ```json Example theme={null} [ { "custom_field_id": "CF123", "custom_field_value": "Value for non-select field", "option_id": "OPT456" } ] ``` **custom\_fields.map(x, x.custom\_field\_id)** `[]string` *required* Mapped array of: Corresponds to the /customfields customfieldid ```json CEL theme={null} $result_object_key.custom_fields.map(x, x.custom_field_id) ``` ```json Example theme={null} [ "CF123" ] ``` **custom\_fields.map(x, x.custom\_field\_value)** `[]string` *required* Mapped array of: For a non-select custom field, the value ```json CEL theme={null} $result_object_key.custom_fields.map(x, x.custom_field_value) ``` ```json Example theme={null} [ "Value for non-select field" ] ``` **custom\_fields.map(x, x.option\_id)** `[]string` *required* Mapped array of: For a select custom field, the selectid value (from /customfield's selectlist) ```json CEL theme={null} $result_object_key.custom_fields.map(x, x.option_id) ``` ```json Example theme={null} [ "OPT456" ] ``` **balances** `[]object` *required* List of balances for this patient ```json CEL theme={null} $result_object_key.balances ``` ```json Example theme={null} "[{\"department_list\":\"1,2\",\"balance\":\"100.00\"}]" ``` **balances.map(x, x.department\_list)** `[]string` *required* Mapped array of: The department list associated with this balance ```json CEL theme={null} $result_object_key.balances.map(x, x.department_list) ``` ```json Example theme={null} [ "1,2" ] ``` **balances.map(x, x.balance)** `[]string` *required* Mapped array of: The balance amount ```json CEL theme={null} $result_object_key.balances.map(x, x.balance) ``` ```json Example theme={null} [ "100.00" ] ``` **balances.map(x, x.provider\_group\_id)** `[]int64` *required* Mapped array of: The provider group ID associated with this balance ```json CEL theme={null} $result_object_key.balances.map(x, x.provider_group_id) ``` ```json Example theme={null} [ 123 ] ``` **balances.map(x, x.clean\_balance)** `[]bool` *required* Mapped array of: Is the balance clean ```json CEL theme={null} $result_object_key.balances.map(x, x.clean_balance) ``` ```json Example theme={null} [ true ] ``` **insurances** `[]object` *required* List of active insurance packages for this patient ```json CEL theme={null} $result_object_key.insurances ``` ```json Example theme={null} "[{\"insurance_id\":\"INS123\"}]" ``` **insurances.map(x, x.id)** `[]string` *required* Mapped array of: Insurance ID ```json CEL theme={null} $result_object_key.insurances.map(x, x.id) ``` ```json Example theme={null} [ "123" ] ``` **insurances.map(x, x.insurance\_id)** `[]string` *required* Mapped array of: Insurance identifier ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_id) ``` ```json Example theme={null} [ "INS456" ] ``` **insurances.map(x, x.insurance\_id\_number)** `[]string` *required* `PII` Mapped array of: Insurance ID number ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_id_number) ``` ```json Example theme={null} [ "ABC123456789" ] ``` **insurances.map(x, x.insurance\_package\_address1)** `[]string` *required* Mapped array of: Insurance package address - 1st line ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_package_address1) ``` ```json Example theme={null} [ "123 Insurance St" ] ``` **insurances.map(x, x.insurance\_package\_city)** `[]string` *required* Mapped array of: Insurance package city ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_package_city) ``` ```json Example theme={null} [ "Boston" ] ``` **insurances.map(x, x.insurance\_package\_id)** `[]int64` *required* Mapped array of: Insurance package ID ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_package_id) ``` ```json Example theme={null} [ 789 ] ``` **insurances.map(x, x.insurance\_package\_state)** `[]string` *required* Mapped array of: Insurance package state (2 letter abbreviation) ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_package_state) ``` ```json Example theme={null} [ "MA" ] ``` **insurances.map(x, x.insurance\_package\_zip)** `[]string` *required* Mapped array of: Insurance package zip code ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_package_zip) ``` ```json Example theme={null} [ "02108" ] ``` **insurances.map(x, x.insurance\_phone)** `[]string` *required* Mapped array of: Insurance phone number ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_phone) ``` ```json Example theme={null} [ "+15551234567" ] ``` **insurances.map(x, x.insurance\_plan\_display\_name)** `[]string` *required* Mapped array of: Insurance plan display name ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_plan_display_name) ``` ```json Example theme={null} [ "Blue Cross Blue Shield PPO" ] ``` **insurances.map(x, x.insurance\_plan\_name)** `[]string` *required* Mapped array of: Insurance plan name ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_plan_name) ``` ```json Example theme={null} [ "PPO" ] ``` **insurances.map(x, x.insurance\_policy\_holder)** `[]string` *required* `PII` Mapped array of: Insurance policy holder ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder) ``` ```json Example theme={null} [ "John Smith" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_address1)** `[]string` *required* `PII` Mapped array of: Insurance policy holder address - 1st line ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_address1) ``` ```json Example theme={null} [ "123 Main St" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_city)** `[]string` *required* `PII` Mapped array of: Insurance policy holder city ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_city) ``` ```json Example theme={null} [ "Boston" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_country\_code)** `[]string` *required* Mapped array of: Insurance policy holder country code ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_country_code) ``` ```json Example theme={null} [ "US" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_country\_iso3166)** `[]string` *required* Mapped array of: Insurance policy holder country (ISO 3166-1) ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_country_iso3166) ``` ```json Example theme={null} [ "USA" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_dob)** `[]values.v1.Date` *required* `PII` Mapped array of: Insurance policy holder date of birth ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_dob) ``` ```json Example theme={null} [ "1980-01-15" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_first\_name)** `[]string` *required* `PII` Mapped array of: Insurance policy holder first name ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_first_name) ``` ```json Example theme={null} [ "John" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_last\_name)** `[]string` *required* `PII` Mapped array of: Insurance policy holder last name ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_last_name) ``` ```json Example theme={null} [ "Smith" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_sex)** `[]string` *required* `PII` Mapped array of: Insurance policy holder sex ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_sex) ``` ```json Example theme={null} [ "M" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_state)** `[]string` *required* Mapped array of: Insurance policy holder state (2 letter abbreviation) ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_state) ``` ```json Example theme={null} [ "MA" ] ``` **insurances.map(x, x.insurance\_policy\_holder\_zip)** `[]string` *required* `PII` Mapped array of: Insurance policy holder zip code ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_policy_holder_zip) ``` ```json Example theme={null} [ "02108" ] ``` **insurances.map(x, x.insurance\_type)** `[]string` *required* Mapped array of: Insurance type ```json CEL theme={null} $result_object_key.insurances.map(x, x.insurance_type) ``` ```json Example theme={null} [ "Commercial" ] ``` **insurances.map(x, x.insured\_address)** `[]string` *required* `PII` Mapped array of: Insured person's address ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_address) ``` ```json Example theme={null} [ "123 Main St" ] ``` **insurances.map(x, x.insured\_city)** `[]string` *required* `PII` Mapped array of: Insured person's city ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_city) ``` ```json Example theme={null} [ "Boston" ] ``` **insurances.map(x, x.insured\_country\_code)** `[]string` *required* Mapped array of: Insured person's country code ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_country_code) ``` ```json Example theme={null} [ "US" ] ``` **insurances.map(x, x.insured\_country\_iso3166)** `[]string` *required* Mapped array of: Insured person's country (ISO 3166-1) ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_country_iso3166) ``` ```json Example theme={null} [ "USA" ] ``` **insurances.map(x, x.insured\_dob)** `[]values.v1.Date` *required* `PII` Mapped array of: Insured person's date of birth ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_dob) ``` ```json Example theme={null} [ "1980-01-15" ] ``` **insurances.map(x, x.insured\_entity\_type\_id)** `[]int64` *required* Mapped array of: Insured entity type ID ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_entity_type_id) ``` ```json Example theme={null} [ 1 ] ``` **insurances.map(x, x.insured\_first\_name)** `[]string` *required* `PII` Mapped array of: Insured person's first name ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_first_name) ``` ```json Example theme={null} [ "John" ] ``` **insurances.map(x, x.insured\_last\_name)** `[]string` *required* `PII` Mapped array of: Insured person's last name ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_last_name) ``` ```json Example theme={null} [ "Smith" ] ``` **insurances.map(x, x.insured\_sex)** `[]string` *required* `PII` Mapped array of: Insured person's sex ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_sex) ``` ```json Example theme={null} [ "M" ] ``` **insurances.map(x, x.insured\_state)** `[]string` *required* Mapped array of: Insured person's state (2 letter abbreviation) ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_state) ``` ```json Example theme={null} [ "MA" ] ``` **insurances.map(x, x.insured\_zip)** `[]string` *required* `PII` Mapped array of: Insured person's zip code ```json CEL theme={null} $result_object_key.insurances.map(x, x.insured_zip) ``` ```json Example theme={null} [ "02108" ] ``` **insurances.map(x, x.irc\_name)** `[]string` *required* Mapped array of: IRC name ```json CEL theme={null} $result_object_key.insurances.map(x, x.irc_name) ``` ```json Example theme={null} [ "IRC123" ] ``` **insurances.map(x, x.relationship\_to\_insured)** `[]string` *required* Mapped array of: Relationship to insured person ```json CEL theme={null} $result_object_key.insurances.map(x, x.relationship_to_insured) ``` ```json Example theme={null} [ "SELF" ] ``` **insurances.map(x, x.relationship\_to\_insured\_id)** `[]int64` *required* Mapped array of: Relationship to insured person ID ```json CEL theme={null} $result_object_key.insurances.map(x, x.relationship_to_insured_id) ``` ```json Example theme={null} [ 1 ] ``` **insurances.map(x, x.sequence\_number)** `[]int64` *required* Mapped array of: Sequence number ```json CEL theme={null} $result_object_key.insurances.map(x, x.sequence_number) ``` ```json Example theme={null} [ 1 ] ``` **insurances.map(x, x.eligibility\_last\_checked)** `[]string` *required* Mapped array of: When eligibility was last checked ```json CEL theme={null} $result_object_key.insurances.map(x, x.eligibility_last_checked) ``` ```json Example theme={null} [ "2023-05-01T14:30:00Z" ] ``` **insurances.map(x, x.eligibility\_reason)** `[]string` *required* Mapped array of: Reason for eligibility status ```json CEL theme={null} $result_object_key.insurances.map(x, x.eligibility_reason) ``` ```json Example theme={null} [ "Active coverage" ] ``` **insurances.map(x, x.eligibility\_status)** `[]string` *required* Mapped array of: Status of eligibility ```json CEL theme={null} $result_object_key.insurances.map(x, x.eligibility_status) ``` ```json Example theme={null} [ "ELIGIBLE" ] ``` **all\_patient\_statuses** `[]object` *required* List of all patient statuses for this patient ```json CEL theme={null} $result_object_key.all_patient_statuses ``` ```json Example theme={null} "[{\"status\":\"active\",\"department_id\":1}]" ``` **all\_patient\_statuses.map(x, x.status)** `[]string` *required* Mapped array of: The status of the patient (e.g., active, inactive, etc.) ```json CEL theme={null} $result_object_key.all_patient_statuses.map(x, x.status) ``` ```json Example theme={null} [ "active" ] ``` **all\_patient\_statuses.map(x, x.department\_id)** `[]int64` *required* Mapped array of: The department ID associated with this status ```json CEL theme={null} $result_object_key.all_patient_statuses.map(x, x.department_id) ``` ```json Example theme={null} [ 1 ] ``` **all\_patient\_statuses.map(x, x.primary\_provider\_id)** `[]int64` *required* Mapped array of: The primary provider ID associated with this status ```json CEL theme={null} $result_object_key.all_patient_statuses.map(x, x.primary_provider_id) ``` ```json Example theme={null} [ 123 ] ``` **contact\_preference** `string` The preferred method of contact for the patient ```json CEL theme={null} $result_object_key.contact_preference ``` ```json Example theme={null} "EMAIL" ``` **contact\_preference\_announcement\_email** `bool` If true, patient prefers to get announcement communications via email ```json CEL theme={null} $result_object_key.contact_preference_announcement_email ``` ```json Example theme={null} true ``` **contact\_preference\_announcement\_phone** `bool` If true, patient prefers to get announcement communications via phone ```json CEL theme={null} $result_object_key.contact_preference_announcement_phone ``` ```json Example theme={null} false ``` **contact\_preference\_announcement\_sms** `bool` If true, patient prefers to get announcement communications via SMS ```json CEL theme={null} $result_object_key.contact_preference_announcement_sms ``` ```json Example theme={null} false ``` **contact\_preference\_appointment\_email** `bool` If true, patient prefers to get appointment communications via email ```json CEL theme={null} $result_object_key.contact_preference_appointment_email ``` ```json Example theme={null} true ``` **contact\_preference\_appointment\_phone** `bool` If true, patient prefers to get appointment communications via phone ```json CEL theme={null} $result_object_key.contact_preference_appointment_phone ``` ```json Example theme={null} false ``` **contact\_preference\_appointment\_sms** `bool` If true, patient prefers to get appointment communications via SMS ```json CEL theme={null} $result_object_key.contact_preference_appointment_sms ``` ```json Example theme={null} false ``` **contact\_preference\_billing\_email** `bool` If true, patient prefers to get billing communications via email ```json CEL theme={null} $result_object_key.contact_preference_billing_email ``` ```json Example theme={null} true ``` **contact\_preference\_billing\_phone** `bool` If true, patient prefers to get billing communications via phone ```json CEL theme={null} $result_object_key.contact_preference_billing_phone ``` ```json Example theme={null} false ``` **contact\_preference\_billing\_sms** `bool` If true, patient prefers to get billing communications via SMS ```json CEL theme={null} $result_object_key.contact_preference_billing_sms ``` ```json Example theme={null} false ``` **contact\_preference\_lab\_email** `bool` If true, patient prefers to get lab communications via email ```json CEL theme={null} $result_object_key.contact_preference_lab_email ``` ```json Example theme={null} true ``` **contact\_preference\_lab\_phone** `bool` If true, patient prefers to get lab communications via phone ```json CEL theme={null} $result_object_key.contact_preference_lab_phone ``` ```json Example theme={null} false ``` **contact\_preference\_lab\_sms** `bool` If true, patient prefers to get lab communications via SMS ```json CEL theme={null} $result_object_key.contact_preference_lab_sms ``` ```json Example theme={null} false ``` **has\_drivers\_license** `bool` True if patient has a driver's license ```json CEL theme={null} $result_object_key.has_drivers_license ``` ```json Example theme={null} true ``` **drivers\_license\_ssn** `string` `PII` The SSN on the patient's driver's license ```json CEL theme={null} $result_object_key.drivers_license_ssn ``` ```json Example theme={null} "123-45-6789" ``` **drivers\_license\_url** `string` The URL to the patient's driver's license image ```json CEL theme={null} $result_object_key.drivers_license_url ``` ```json Example theme={null} "https://example.com/license.jpg" ``` **email\_exists** `bool` True if the patient's email exists ```json CEL theme={null} $result_object_key.email_exists ``` ```json Example theme={null} true ``` **employer\_address** `string` The patient's employer's address ```json CEL theme={null} $result_object_key.employer_address ``` ```json Example theme={null} "123 Main St" ``` **employer\_city** `string` The patient's employer's city ```json CEL theme={null} $result_object_key.employer_city ``` ```json Example theme={null} "Boston" ``` **employer\_fax** `string` The patient's employer's fax number ```json CEL theme={null} $result_object_key.employer_fax ``` ```json Example theme={null} "+15551234567" ``` **employer\_name** `string` The patient's employer's name ```json CEL theme={null} $result_object_key.employer_name ``` ```json Example theme={null} "Acme Corp" ``` **employer\_state** `string` The patient's employer's state (2 letter abbreviation) ```json CEL theme={null} $result_object_key.employer_state ``` ```json Example theme={null} "MA" ``` **employer\_zip** `string` The patient's employer's zip code ```json CEL theme={null} $result_object_key.employer_zip ``` ```json Example theme={null} "02108" ``` **last\_updated\_by** `string` User who last updated the patient record ```json CEL theme={null} $result_object_key.last_updated_by ``` ```json Example theme={null} "jsmith" ``` **local\_patient\_id** `string` Local patient ID (if present) ```json CEL theme={null} $result_object_key.local_patient_id ``` ```json Example theme={null} "15001" ``` **have\_patient\_photo** `bool` True if the patient has a photo uploaded ```json CEL theme={null} $result_object_key.have_patient_photo ``` ```json Example theme={null} false ``` **portal\_status** `object` The patient's portal status ```json CEL theme={null} $result_object_key.portal_status ``` ```json Example theme={null} { "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\_status.blocked\_failed\_logins** `bool` Indicates if the patient is blocked due to failed login attempts ```json CEL theme={null} $result_object_key.portal_status.blocked_failed_logins ``` ```json Example theme={null} false ``` **portal\_status.entity\_to\_display** `string` The entity to display in the portal ```json CEL theme={null} $result_object_key.portal_status.entity_to_display ``` ```json Example theme={null} "patient" ``` **portal\_status.family\_blocked\_failed\_logins** `bool` Indicates if the patient's family is blocked due to failed login attempts ```json CEL theme={null} $result_object_key.portal_status.family_blocked_failed_logins ``` ```json Example theme={null} false ``` **portal\_status.family\_registered** `bool` Indicates if the patient's family is registered for portal access ```json CEL theme={null} $result_object_key.portal_status.family_registered ``` ```json Example theme={null} true ``` **portal\_status.no\_portal** `bool` Indicates if the patient has no portal access ```json CEL theme={null} $result_object_key.portal_status.no_portal ``` ```json Example theme={null} false ``` **portal\_status.portal\_registration\_date** `string` The date when the patient registered for portal access ```json CEL theme={null} $result_object_key.portal_status.portal_registration_date ``` ```json Example theme={null} "2023-05-15" ``` **portal\_status.registered** `bool` Indicates if the patient is registered for portal access ```json CEL theme={null} $result_object_key.portal_status.registered ``` ```json Example theme={null} true ``` **portal\_status.status** `athena.v1.PortalStatusValue` The status of the patient's portal access ```json CEL theme={null} $result_object_key.portal_status.status ``` ```json Example theme={null} athena.v1.PortalStatusValue.PORTAL_STATUS_VALUE_REGISTERED athena.v1.PortalStatusValue.PORTAL_STATUS_VALUE_NOT_REGISTERED athena.v1.PortalStatusValue.PORTAL_STATUS_VALUE_FAMILY_LOGIN athena.v1.PortalStatusValue.PORTAL_STATUS_VALUE_NO_PORTAL athena.v1.PortalStatusValue.PORTAL_STATUS_VALUE_BLOCKED_FAILED_LOGINS athena.v1.PortalStatusValue.PORTAL_STATUS_VALUE_FAMILY_BLOCKED_FAILED_LOGINS ``` **portal\_status.terms\_accepted** `bool` Indicates if the patient has accepted the portal terms and conditions ```json CEL theme={null} $result_object_key.portal_status.terms_accepted ``` ```json Example theme={null} true ``` **portal\_terms\_on\_file** `bool` True if the patient has accepted the portal's Terms and Conditions ```json CEL theme={null} $result_object_key.portal_terms_on_file ``` ```json Example theme={null} true ``` **portal\_access\_given** `bool` True if the patient has been given access to the portal ```json CEL theme={null} $result_object_key.portal_access_given ``` ```json Example theme={null} true ``` **portal\_signature\_on\_file** `bool` Indicates if the patient's signature is on file for the portal ```json CEL theme={null} $result_object_key.portal_signature_on_file ``` ```json Example theme={null} true ``` **privacy\_information\_verified** `bool` True if the patient's privacy information has been verified ```json CEL theme={null} $result_object_key.privacy_information_verified ``` ```json Example theme={null} false ``` **registration\_date** `values.v1.Date` Date the patient was registered ```json CEL theme={null} $result_object_key.registration_date ``` ```json Example theme={null} "2024-05-01" ``` **test\_patient** `bool` True if this record has been marked as a test patient ```json CEL theme={null} $result_object_key.test_patient ``` ```json Example theme={null} false ``` **last\_email** `string` `PII` Patient's previous email address ```json CEL theme={null} $result_object_key.last_email ``` ```json Example theme={null} "john.smith@email.com" ``` **care\_summary\_delivery\_preference** `athena.v1.CareSummaryDeliveryPreference` The patient's preferred method of receiving care summaries ```json CEL theme={null} $result_object_key.care_summary_delivery_preference ``` ```json Example theme={null} athena.v1.CareSummaryDeliveryPreference.CARE_SUMMARY_DELIVERY_PREFERENCE_PAPER athena.v1.CareSummaryDeliveryPreference.CARE_SUMMARY_DELIVERY_PREFERENCE_PORTAL ``` **first\_appointment\_datetime** `timing.v1.Timestamp` The date and time of the patient's first appointment ```json CEL theme={null} $result_object_key.first_appointment_datetime ``` ```json Example theme={null} "2024-05-01T09:00:00Z" ``` **last\_appointment\_datetime** `timing.v1.Timestamp` The date and time of the patient's last (most recent) appointment ```json CEL theme={null} $result_object_key.last_appointment_datetime ``` ```json Example theme={null} "2024-05-02T15:30:00Z" ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.