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