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
ID
This field maps to the destination API id field.PII
This field maps to the destination API first_name field.PII
This field maps to the destination API last_name field.PII
This field maps to the destination API email field.ID
This field maps to the destination API doctor field.This field maps to the destination API
preferred_language field.Allowed Enumeration Values
PREFERRED_LANGUAGE_BLANK
PREFERRED_LANGUAGE_DECLINED
PREFERRED_LANGUAGE_ENG
PREFERRED_LANGUAGE_FRA
PREFERRED_LANGUAGE_ITA
PREFERRED_LANGUAGE_JPN
PREFERRED_LANGUAGE_OTHER
PREFERRED_LANGUAGE_POR
PREFERRED_LANGUAGE_RUS
PREFERRED_LANGUAGE_SPA
PREFERRED_LANGUAGE_UNKNOWN
PREFERRED_LANGUAGE_ZHO
This field maps to the destination API
gender field.Allowed Enumeration Values
GENDER_EMPTY
GENDER_ASKU
GENDER_FEMALE
GENDER_MALE
GENDER_OTHER
GENDER_UNK
PII
This field maps to the destination API date_of_birth field.This field maps to the destination API
race field.Allowed Enumeration Values
RACE_ASIAN
RACE_BLACK
RACE_BLANK
RACE_DECLINED
RACE_HAWAIIAN
RACE_INDIAN
RACE_OTHER
RACE_WHITE
This field maps to the destination API
ethnicity field.Allowed Enumeration Values
ETHNICITY_BLANK
ETHNICITY_DECLINED
ETHNICITY_HISPANIC
ETHNICITY_NOT_HISPANIC
{
"$result_object_key": {
"address": "123 Main Street",
"auto_accident_insurance": {
"auto_accident_case_number": "AAC-2024-001",
"auto_accident_claim_rep_address": "123 Insurance Blvd",
"auto_accident_claim_rep_city": "Los Angeles",
"auto_accident_claim_rep_is_insurer": true,
"auto_accident_claim_rep_name": "John Smith",
"auto_accident_claim_rep_state": "CA",
"auto_accident_claim_rep_zip": "90210",
"auto_accident_company": "State Farm",
"auto_accident_date_of_accident": "2024-01-10",
"auto_accident_disabled_from_date": "2024-01-11",
"auto_accident_disabled_to_date": "2024-02-11",
"auto_accident_had_similar_condition": false,
"auto_accident_is_subscriber_the_patient": true,
"auto_accident_notes": "Rear-ended at intersection",
"auto_accident_patient_relationship_to_subscriber": "01",
"auto_accident_payer_address": "456 Payer St",
"auto_accident_payer_city": "Chicago",
"auto_accident_payer_id": "PAY123",
"auto_accident_payer_state": "IL",
"auto_accident_payer_zip": "60601",
"auto_accident_policy_number": "POL-2024-12345",
"auto_accident_return_to_work_date": "2024-03-01",
"auto_accident_significant_injury": "YES",
"auto_accident_significant_injury_notes": "Whiplash and back pain",
"auto_accident_similar_condition_date": "2020-05-15",
"auto_accident_similar_condition_notes": "Previous back injury",
"auto_accident_state_of_occurrence": "CA",
"auto_accident_still_under_care": true,
"auto_accident_subscriber_address": "789 Main St",
"auto_accident_subscriber_city": "San Francisco",
"auto_accident_subscriber_date_of_birth": "1985-06-15",
"auto_accident_subscriber_first_name": "Jane",
"auto_accident_subscriber_last_name": "Doe",
"auto_accident_subscriber_middle_name": "Marie",
"auto_accident_subscriber_phone_number": "555-123-4567",
"auto_accident_subscriber_social_security": "123-45-6789",
"auto_accident_subscriber_state": "CA",
"auto_accident_subscriber_suffix": "Jr",
"auto_accident_subscriber_zip_code": "94102",
"auto_accident_treatment_duration": "6 months",
"auto_accident_will_require_therapy": true,
"auto_accident_will_require_therapy_rec": "Physical therapy 2x weekly"
},
"cell_phone": "555-123-4567",
"chart_id": "DOEJ001",
"city": "San Francisco",
"copay": "25.00",
"created_at": "2024-01-15T10:30:00Z",
"custom_demographics": [
{
"field_type": 5,
"updated_at": "2024-01-15T10:30:00Z",
"value": "Custom value"
}
],
"date_of_birth": "1990-05-15",
"date_of_death": "2024-12-01",
"date_of_first_appointment": "2020-03-10",
"date_of_last_appointment": "2024-01-05",
"default_pharmacy": "1234567",
"disable_sms_messages": false,
"doctor": 12345,
"email": "patient@example.com",
"emergency_contact_name": "Jane Doe",
"emergency_contact_phone": "555-987-6543",
"emergency_contact_relation": "Spouse",
"employer": "Acme Corporation",
"employer_address": "456 Corporate Blvd",
"employer_city": "Los Angeles",
"employer_state": "CA",
"employer_zip_code": "90210",
"ethnicity": "not_hispanic",
"first_name": "John",
"gender": "Male",
"gender_identity_code": "446151000124109",
"gender_identity_description": "Identifies as male",
"home_phone": "555-111-2222",
"id": "123456",
"last_name": "Doe",
"medication_history_consent": "Y",
"middle_name": "Robert",
"nick_name": "Johnny",
"office_phone": "555-333-4444",
"offices": [],
"patient_flags": [
{
"archived": false,
"color": "#FF0000",
"created_at": "2024-01-15T10:30:00Z",
"doctor": 12345,
"flag_id": 1,
"flag_text": "Requires wheelchair access",
"flag_type": 2,
"name": "High Priority",
"priority": 1,
"updated_at": "2024-01-15T10:30:00Z"
}
],
"patient_flags_attached": [
{
"archived": false,
"color": "#FF0000",
"created_at": "2024-01-15T10:30:00Z",
"doctor": 12345,
"flag_id": 1,
"flag_text": "Requires wheelchair access",
"flag_type": 2,
"name": "High Priority",
"priority": 1,
"updated_at": "2024-01-15T10:30:00Z"
}
],
"patient_payment_profile": "Insurance",
"patient_photo": "https://example.com/photo.jpg",
"patient_photo_date": "2024-01-10",
"patient_status": "A",
"preferred_language": "eng",
"preferred_language_code": "en",
"preferred_language_description": "English",
"preferred_pharmacies": [],
"primary_care_physician": "Dr. Jane Smith",
"primary_insurance": {
"insurance_claim_office_number": "800-555-1234",
"insurance_company": "Blue Cross Blue Shield",
"insurance_group_name": "Employer Health Plan",
"insurance_group_number": "GRP12345",
"insurance_id_number": "XYZ123456789",
"insurance_payer_id": "00123",
"insurance_plan_name": "PPO Gold",
"insurance_plan_type": "HM",
"is_subscriber_the_patient": true,
"patient_relationship_to_subscriber": "01",
"photo_back": "https://example.com/card_back.jpg",
"photo_front": "https://example.com/card_front.jpg",
"subscriber_address": "123 Main St",
"subscriber_city": "New York",
"subscriber_country": "US",
"subscriber_date_of_birth": "1980-05-20",
"subscriber_first_name": "John",
"subscriber_gender": "Male",
"subscriber_last_name": "Doe",
"subscriber_middle_name": "Robert",
"subscriber_social_security": "123-45-6789",
"subscriber_state": "NY",
"subscriber_suffix": "Jr",
"subscriber_zip_code": "10001"
},
"pronouns": "he/him",
"race": "white",
"race_subcategories": [
{
"code": "2028-9",
"description": "Asian Indian"
}
],
"referring_doctor": {
"address": "456 Medical Center Dr",
"email": "dr.smith@hospital.com",
"fax": "555-12-3456",
"first_name": "Robert",
"last_name": "Smith",
"middle_name": "James",
"npi": "1234567890",
"phone": "555-98-7654",
"provider_number": "PROV12345",
"provider_qualifier": "0B",
"specialty": "Cardiologist",
"suffix": "MD"
},
"referring_source": "Website",
"responsible_party_email": "responsible@example.com",
"responsible_party_name": "Mary Doe",
"responsible_party_phone": "555-555-5555",
"responsible_party_relation": "Parent",
"secondary_insurance": {
"insurance_claim_office_number": "800-555-1234",
"insurance_company": "Blue Cross Blue Shield",
"insurance_group_name": "Employer Health Plan",
"insurance_group_number": "GRP12345",
"insurance_id_number": "XYZ123456789",
"insurance_payer_id": "00123",
"insurance_plan_name": "PPO Gold",
"insurance_plan_type": "HM",
"is_subscriber_the_patient": true,
"patient_relationship_to_subscriber": "01",
"photo_back": "https://example.com/card_back.jpg",
"photo_front": "https://example.com/card_front.jpg",
"subscriber_address": "123 Main St",
"subscriber_city": "New York",
"subscriber_country": "US",
"subscriber_date_of_birth": "1980-05-20",
"subscriber_first_name": "John",
"subscriber_gender": "Male",
"subscriber_last_name": "Doe",
"subscriber_middle_name": "Robert",
"subscriber_social_security": "123-45-6789",
"subscriber_state": "NY",
"subscriber_suffix": "Jr",
"subscriber_zip_code": "10001"
},
"social_security_number": "123-45-6789",
"state": "CA",
"tertiary_insurance": {
"insurance_claim_office_number": "800-555-1234",
"insurance_company": "Blue Cross Blue Shield",
"insurance_group_name": "Employer Health Plan",
"insurance_group_number": "GRP12345",
"insurance_id_number": "XYZ123456789",
"insurance_payer_id": "00123",
"insurance_plan_name": "PPO Gold",
"insurance_plan_type": "HM",
"is_subscriber_the_patient": true,
"patient_relationship_to_subscriber": "01",
"photo_back": "https://example.com/card_back.jpg",
"photo_front": "https://example.com/card_front.jpg",
"subscriber_address": "123 Main St",
"subscriber_city": "New York",
"subscriber_country": "US",
"subscriber_date_of_birth": "1980-05-20",
"subscriber_first_name": "John",
"subscriber_gender": "Male",
"subscriber_last_name": "Doe",
"subscriber_middle_name": "Robert",
"subscriber_social_security": "123-45-6789",
"subscriber_state": "NY",
"subscriber_suffix": "Jr",
"subscriber_zip_code": "10001"
},
"updated_at": "2024-01-15T10:30:00Z",
"workers_comp_insurance": {
"property_and_casualty_agency_claim_number": "PCA-2024-001",
"workers_comp_carrier_code": "WCC123",
"workers_comp_case_number": "WC-2024-00123",
"workers_comp_company": "Hartford",
"workers_comp_date_of_accident": "2024-01-05",
"workers_comp_group_name": "Industrial Workers",
"workers_comp_group_number": "WCG456",
"workers_comp_notes": "Injury occurred on job site",
"workers_comp_payer_address": "100 Insurance Way",
"workers_comp_payer_city": "Hartford",
"workers_comp_payer_id": "WCPAY001",
"workers_comp_payer_state": "CT",
"workers_comp_payer_zip": "06103",
"workers_comp_state_of_occurrence": "NY",
"workers_comp_wcb": "WCB12345",
"workers_comp_wcb_rating_code": "A1"
},
"zip_code": "94102"
}
}
{
"$result_object_key": {
"address": "Patient address",
"auto_accident_insurance": {
"auto_accident_case_number": "Auto accident case number",
"auto_accident_claim_rep_address": "Claim representative address",
"auto_accident_claim_rep_city": "Claim representative city",
"auto_accident_claim_rep_is_insurer": "Is the insurer's claim representative the insurer?",
"auto_accident_claim_rep_name": "Claim representative name",
"auto_accident_claim_rep_state": "Claim representative state",
"auto_accident_claim_rep_zip": "Claim representative ZIP code",
"auto_accident_company": "Auto accident insurance company",
"auto_accident_date_of_accident": "Date of the auto accident",
"auto_accident_disabled_from_date": "Patient was disabled (unable to work) from this date",
"auto_accident_disabled_to_date": "Patient was disabled (unable to work) until this date",
"auto_accident_had_similar_condition": "Has the patient had same or similar condition?",
"auto_accident_is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
"auto_accident_notes": "Notes about the auto accident",
"auto_accident_patient_relationship_to_subscriber": "Patient's relationship to subscriber",
"auto_accident_payer_address": "Auto accident payer address",
"auto_accident_payer_city": "Auto accident payer city",
"auto_accident_payer_id": "Auto Accident Payer ID",
"auto_accident_payer_state": "Auto accident payer state",
"auto_accident_payer_zip": "Auto accident payer ZIP code",
"auto_accident_policy_number": "Auto accident policy number",
"auto_accident_return_to_work_date": "If still disabled, patient should be able to return to work on this date",
"auto_accident_significant_injury": "Whether there was a significant injury",
"auto_accident_significant_injury_notes": "Notes about significant injury",
"auto_accident_similar_condition_date": "Date of same or similar condition",
"auto_accident_similar_condition_notes": "Notes about similar condition",
"auto_accident_state_of_occurrence": "State where the auto accident occurred",
"auto_accident_still_under_care": "Is patient still under your care for this condition?",
"auto_accident_subscriber_address": "Subscriber address",
"auto_accident_subscriber_city": "Subscriber city",
"auto_accident_subscriber_date_of_birth": "Subscriber date of birth",
"auto_accident_subscriber_first_name": "Subscriber first name",
"auto_accident_subscriber_last_name": "Subscriber last name",
"auto_accident_subscriber_middle_name": "Subscriber middle name",
"auto_accident_subscriber_phone_number": "Subscriber phone number",
"auto_accident_subscriber_social_security": "Subscriber social security number",
"auto_accident_subscriber_state": "Subscriber state",
"auto_accident_subscriber_suffix": "Subscriber suffix",
"auto_accident_subscriber_zip_code": "Subscriber ZIP code",
"auto_accident_treatment_duration": "Treatment duration",
"auto_accident_will_require_therapy": "Will the patient require rehabilitation and/or occupational therapy?",
"auto_accident_will_require_therapy_rec": "Therapy recommendation"
},
"cell_phone": "Patient cell phone number",
"chart_id": "Chart ID (automatically set using first & last name if absent)",
"city": "Patient city",
"copay": "Patient copay amount",
"created_at": "Timestamp when the patient was created",
"custom_demographics": {
"field_type": "ID of the custom demographics object",
"updated_at": "Timestamp when the custom demographic was last updated",
"value": "Value of the custom demographic"
},
"date_of_birth": "Patient date of birth",
"date_of_death": "Patient date of death (available when show_inactive is passed)",
"date_of_first_appointment": "Date of first patient visit",
"date_of_last_appointment": "Date of previous patient visit",
"default_pharmacy": "NCPDP ID of patient's default pharmacy",
"disable_sms_messages": "If true, suppress SMS/Txt messages to this patient",
"doctor": "Doctor ID",
"email": "Patient email address",
"emergency_contact_name": "Emergency contact name",
"emergency_contact_phone": "Emergency contact phone number",
"emergency_contact_relation": "Emergency contact relationship to patient",
"employer": "Patient employer name",
"employer_address": "Employer address",
"employer_city": "Employer city",
"employer_state": "Employer state (two-letter abbreviation)",
"employer_zip_code": "Employer ZIP code",
"ethnicity": "Patient ethnicity (blank, hispanic, not_hispanic, or declined)",
"first_name": "Patient first name",
"gender": "Patient gender (Male, Female, or Other)",
"gender_identity_code": "Gender identity code",
"gender_identity_description": "Gender identity description",
"home_phone": "Patient home phone number",
"id": "Patient ID",
"last_name": "Patient last name",
"medication_history_consent": "Medication history consent status",
"middle_name": "Patient middle name",
"nick_name": "Common name for patient (should be used instead of first name if supplied)",
"office_phone": "Patient office phone number",
"offices": "IDs of every office this patient has been to",
"patient_flags": {
"archived": "Whether the flag is archived",
"color": "Color of the flag",
"created_at": "Timestamp when the flag was created",
"doctor": "ID of doctor who owns the flag",
"flag_id": "Flag ID",
"flag_text": "Description of the patient flag",
"flag_type": "ID of the associated patient flag type",
"name": "Name of the flag",
"priority": "Priority level of the flag",
"updated_at": "Timestamp when the flag was last updated"
},
"patient_flags_attached": {
"archived": "Whether the flag is archived",
"color": "Color of the flag",
"created_at": "Timestamp when the flag was created",
"doctor": "ID of doctor who owns the flag",
"flag_id": "Flag ID",
"flag_text": "Description of the patient flag",
"flag_type": "ID of the associated patient flag type",
"name": "Name of the flag",
"priority": "Priority level of the flag",
"updated_at": "Timestamp when the flag was last updated"
},
"patient_payment_profile": "Patient payment profile (Cash, Insurance, Insurance Out of Network, Auto Accident, or Worker's Comp)",
"patient_photo": "Patient photo URL",
"patient_photo_date": "Patient photo date (cannot be passed without patient_photo)",
"patient_status": "Patient status: A (active), I (inactive), D (inactive-deceased)",
"preferred_language": "Preferred language (ISO 639 alpha-3 codes)",
"preferred_language_code": "Preferred language code",
"preferred_language_description": "Preferred language description",
"preferred_pharmacies": "NCPDP IDs of patient's preferred pharmacies",
"primary_care_physician": "Referring doctor for this patient",
"primary_insurance": {
"insurance_claim_office_number": "Insurance office phone number",
"insurance_company": "Insurance company name",
"insurance_group_name": "Insurance group name",
"insurance_group_number": "Insurance group number",
"insurance_id_number": "Insurance ID number",
"insurance_payer_id": "Insurance payer ID",
"insurance_plan_name": "Name of insurance plan",
"insurance_plan_type": "Type of insurance plan",
"is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
"patient_relationship_to_subscriber": "HCFA/1500 individual relationship code",
"photo_back": "Photo of back of insurance card",
"photo_front": "Photo of front of insurance card",
"subscriber_address": "Subscriber address",
"subscriber_city": "Subscriber city",
"subscriber_country": "Two-letter country code",
"subscriber_date_of_birth": "Subscriber date of birth",
"subscriber_first_name": "Subscriber first name",
"subscriber_gender": "Subscriber gender - Male or Female",
"subscriber_last_name": "Subscriber last name",
"subscriber_middle_name": "Subscriber middle name",
"subscriber_social_security": "Subscriber social security number",
"subscriber_state": "Two-letter state code",
"subscriber_suffix": "Subscriber suffix (e.g. II or III)",
"subscriber_zip_code": "Subscriber ZIP code"
},
"pronouns": "Patient pronouns",
"race": "Patient race (blank, indian, asian, black, hawaiian, white, or declined)",
"race_subcategories": {
"code": "Race subcategory code",
"description": "Race subcategory description"
},
"referring_doctor": {
"address": "Referring doctor address",
"email": "Referring doctor email",
"fax": "Referring doctor fax (format: xxx-xx-xxxx)",
"first_name": "Referring doctor first name",
"last_name": "Referring doctor last name",
"middle_name": "Referring doctor middle name",
"npi": "Referring doctor NPI number",
"phone": "Referring doctor phone (format: xxx-xx-xxxx)",
"provider_number": "Provider number",
"provider_qualifier": "Provider qualifier (State License #, Provider UPIN #, or Provider Commercial #)",
"specialty": "Referring doctor specialty",
"suffix": "Referring doctor suffix"
},
"referring_source": "Referring source",
"responsible_party_email": "Responsible party email",
"responsible_party_name": "Responsible party name",
"responsible_party_phone": "Responsible party phone number",
"responsible_party_relation": "Responsible party relationship to patient",
"secondary_insurance": {
"insurance_claim_office_number": "Insurance office phone number",
"insurance_company": "Insurance company name",
"insurance_group_name": "Insurance group name",
"insurance_group_number": "Insurance group number",
"insurance_id_number": "Insurance ID number",
"insurance_payer_id": "Insurance payer ID",
"insurance_plan_name": "Name of insurance plan",
"insurance_plan_type": "Type of insurance plan",
"is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
"patient_relationship_to_subscriber": "HCFA/1500 individual relationship code",
"photo_back": "Photo of back of insurance card",
"photo_front": "Photo of front of insurance card",
"subscriber_address": "Subscriber address",
"subscriber_city": "Subscriber city",
"subscriber_country": "Two-letter country code",
"subscriber_date_of_birth": "Subscriber date of birth",
"subscriber_first_name": "Subscriber first name",
"subscriber_gender": "Subscriber gender - Male or Female",
"subscriber_last_name": "Subscriber last name",
"subscriber_middle_name": "Subscriber middle name",
"subscriber_social_security": "Subscriber social security number",
"subscriber_state": "Two-letter state code",
"subscriber_suffix": "Subscriber suffix (e.g. II or III)",
"subscriber_zip_code": "Subscriber ZIP code"
},
"social_security_number": "Patient social security number",
"state": "Patient state (two-letter abbreviation)",
"tertiary_insurance": {
"insurance_claim_office_number": "Insurance office phone number",
"insurance_company": "Insurance company name",
"insurance_group_name": "Insurance group name",
"insurance_group_number": "Insurance group number",
"insurance_id_number": "Insurance ID number",
"insurance_payer_id": "Insurance payer ID",
"insurance_plan_name": "Name of insurance plan",
"insurance_plan_type": "Type of insurance plan",
"is_subscriber_the_patient": "True if the insurance policy is under patient's own name",
"patient_relationship_to_subscriber": "HCFA/1500 individual relationship code",
"photo_back": "Photo of back of insurance card",
"photo_front": "Photo of front of insurance card",
"subscriber_address": "Subscriber address",
"subscriber_city": "Subscriber city",
"subscriber_country": "Two-letter country code",
"subscriber_date_of_birth": "Subscriber date of birth",
"subscriber_first_name": "Subscriber first name",
"subscriber_gender": "Subscriber gender - Male or Female",
"subscriber_last_name": "Subscriber last name",
"subscriber_middle_name": "Subscriber middle name",
"subscriber_social_security": "Subscriber social security number",
"subscriber_state": "Two-letter state code",
"subscriber_suffix": "Subscriber suffix (e.g. II or III)",
"subscriber_zip_code": "Subscriber ZIP code"
},
"updated_at": "Timestamp when the patient was last updated",
"workers_comp_insurance": {
"property_and_casualty_agency_claim_number": "Property and casualty agency claim number",
"workers_comp_carrier_code": "Workers comp carrier code",
"workers_comp_case_number": "Workers comp case number",
"workers_comp_company": "Workers comp insurance company",
"workers_comp_date_of_accident": "Date of the workers comp accident",
"workers_comp_group_name": "Workers comp group name",
"workers_comp_group_number": "Workers comp group number",
"workers_comp_notes": "Notes about the workers comp claim",
"workers_comp_payer_address": "Workers comp payer address",
"workers_comp_payer_city": "Workers comp payer city",
"workers_comp_payer_id": "Workers comp payer ID",
"workers_comp_payer_state": "Workers comp payer state",
"workers_comp_payer_zip": "Workers comp payer ZIP code",
"workers_comp_state_of_occurrence": "State where the workers comp accident occurred",
"workers_comp_wcb": "Workers compensation board number",
"workers_comp_wcb_rating_code": "Workers compensation board rating code"
},
"zip_code": "Patient ZIP code"
}
}
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
Patient ID
CEL
$result_object_key.id
Example
"123456"
Patient address
CEL
$result_object_key.address
Example
"123 Main Street"
Auto accident insurance information
CEL
$result_object_key.auto_accident_insurance
Example
{
"auto_accident_case_number": "AAC-2024-001",
"auto_accident_claim_rep_address": "123 Insurance Blvd",
"auto_accident_claim_rep_city": "Los Angeles",
"auto_accident_claim_rep_is_insurer": true,
"auto_accident_claim_rep_name": "John Smith",
"auto_accident_claim_rep_state": "CA",
"auto_accident_claim_rep_zip": "90210",
"auto_accident_company": "State Farm",
"auto_accident_date_of_accident": "2024-01-10",
"auto_accident_disabled_from_date": "2024-01-11",
"auto_accident_disabled_to_date": "2024-02-11",
"auto_accident_had_similar_condition": false,
"auto_accident_is_subscriber_the_patient": true,
"auto_accident_notes": "Rear-ended at intersection",
"auto_accident_patient_relationship_to_subscriber": "01",
"auto_accident_payer_address": "456 Payer St",
"auto_accident_payer_city": "Chicago",
"auto_accident_payer_id": "PAY123",
"auto_accident_payer_state": "IL",
"auto_accident_payer_zip": "60601",
"auto_accident_policy_number": "POL-2024-12345",
"auto_accident_return_to_work_date": "2024-03-01",
"auto_accident_significant_injury": "YES",
"auto_accident_significant_injury_notes": "Whiplash and back pain",
"auto_accident_similar_condition_date": "2020-05-15",
"auto_accident_similar_condition_notes": "Previous back injury",
"auto_accident_state_of_occurrence": "CA",
"auto_accident_still_under_care": true,
"auto_accident_subscriber_address": "789 Main St",
"auto_accident_subscriber_city": "San Francisco",
"auto_accident_subscriber_date_of_birth": "1985-06-15",
"auto_accident_subscriber_first_name": "Jane",
"auto_accident_subscriber_last_name": "Doe",
"auto_accident_subscriber_middle_name": "Marie",
"auto_accident_subscriber_phone_number": "555-123-4567",
"auto_accident_subscriber_social_security": "123-45-6789",
"auto_accident_subscriber_state": "CA",
"auto_accident_subscriber_suffix": "Jr",
"auto_accident_subscriber_zip_code": "94102",
"auto_accident_treatment_duration": "6 months",
"auto_accident_will_require_therapy": true,
"auto_accident_will_require_therapy_rec": "Physical therapy 2x weekly"
}
Auto accident case number
CEL
$result_object_key.auto_accident_insurance.auto_accident_case_number
Example
"AAC-2024-001"
Claim representative address
CEL
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_address
Example
"123 Insurance Blvd"
Claim representative city
CEL
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_city
Example
"Los Angeles"
Is the insurer’s claim representative the insurer?
CEL
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_is_insurer
Example
true
Claim representative name
CEL
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_name
Example
"John Smith"
Claim representative state
CEL
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_state
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Claim representative ZIP code
CEL
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_zip
Example
"90210"
Auto accident insurance company
CEL
$result_object_key.auto_accident_insurance.auto_accident_company
Example
"State Farm"
Date of the auto accident
CEL
$result_object_key.auto_accident_insurance.auto_accident_date_of_accident
Example
"2024-01-10"
Patient was disabled (unable to work) from this date
CEL
$result_object_key.auto_accident_insurance.auto_accident_disabled_from_date
Example
"2024-01-11"
Patient was disabled (unable to work) until this date
CEL
$result_object_key.auto_accident_insurance.auto_accident_disabled_to_date
Example
"2024-02-11"
Has the patient had same or similar condition?
CEL
$result_object_key.auto_accident_insurance.auto_accident_had_similar_condition
Example
false
True if the insurance policy is under patient’s own name
CEL
$result_object_key.auto_accident_insurance.auto_accident_is_subscriber_the_patient
Example
true
Notes about the auto accident
CEL
$result_object_key.auto_accident_insurance.auto_accident_notes
Example
"Rear-ended at intersection"
Patient’s relationship to subscriber
CEL
$result_object_key.auto_accident_insurance.auto_accident_patient_relationship_to_subscriber
Example
"01"
Auto accident payer address
CEL
$result_object_key.auto_accident_insurance.auto_accident_payer_address
Example
"456 Payer St"
Auto accident payer city
CEL
$result_object_key.auto_accident_insurance.auto_accident_payer_city
Example
"Chicago"
Auto Accident Payer ID
CEL
$result_object_key.auto_accident_insurance.auto_accident_payer_id
Example
"PAY123"
Auto accident payer state
CEL
$result_object_key.auto_accident_insurance.auto_accident_payer_state
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Auto accident payer ZIP code
CEL
$result_object_key.auto_accident_insurance.auto_accident_payer_zip
Example
"60601"
Auto accident policy number
CEL
$result_object_key.auto_accident_insurance.auto_accident_policy_number
Example
"POL-2024-12345"
If still disabled, patient should be able to return to work on this date
CEL
$result_object_key.auto_accident_insurance.auto_accident_return_to_work_date
Example
"2024-03-01"
Whether there was a significant injury
CEL
$result_object_key.auto_accident_insurance.auto_accident_significant_injury
Example
"YES"
Notes about significant injury
CEL
$result_object_key.auto_accident_insurance.auto_accident_significant_injury_notes
Example
"Whiplash and back pain"
Date of same or similar condition
CEL
$result_object_key.auto_accident_insurance.auto_accident_similar_condition_date
Example
"2020-05-15"
Notes about similar condition
CEL
$result_object_key.auto_accident_insurance.auto_accident_similar_condition_notes
Example
"Previous back injury"
State where the auto accident occurred
CEL
$result_object_key.auto_accident_insurance.auto_accident_state_of_occurrence
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Is patient still under your care for this condition?
CEL
$result_object_key.auto_accident_insurance.auto_accident_still_under_care
Example
true
Subscriber address
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_address
Example
"789 Main St"
Subscriber city
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_city
Example
"San Francisco"
Subscriber date of birth
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_date_of_birth
Example
"1985-06-15"
Subscriber first name
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_first_name
Example
"Jane"
Subscriber last name
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_last_name
Example
"Doe"
Subscriber middle name
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_middle_name
Example
"Marie"
Subscriber phone number
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_phone_number
Example
"555-123-4567"
Subscriber social security number
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_social_security
Example
"123-45-6789"
Subscriber state
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_state
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Subscriber suffix
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_suffix
Example
"Jr"
Subscriber ZIP code
CEL
$result_object_key.auto_accident_insurance.auto_accident_subscriber_zip_code
Example
"94102"
Treatment duration
CEL
$result_object_key.auto_accident_insurance.auto_accident_treatment_duration
Example
"6 months"
Will the patient require rehabilitation and/or occupational therapy?
CEL
$result_object_key.auto_accident_insurance.auto_accident_will_require_therapy
Example
true
Therapy recommendation
CEL
$result_object_key.auto_accident_insurance.auto_accident_will_require_therapy_rec
Example
"Physical therapy 2x weekly"
Patient cell phone number
CEL
$result_object_key.cell_phone
Example
"555-123-4567"
Chart ID (automatically set using first & last name if absent)
CEL
$result_object_key.chart_id
Example
"DOEJ001"
Patient city
CEL
$result_object_key.city
Example
"San Francisco"
Patient copay amount
CEL
$result_object_key.copay
Example
"25.00"
Timestamp when the patient was created
CEL
$result_object_key.created_at
Example
"2024-01-15T10:30:00Z"
Custom demographic fields for the patient
CEL
$result_object_key.custom_demographics
Example
[
{
"field_type": 5,
"updated_at": "2024-01-15T10:30:00Z",
"value": "Custom value"
}
]
Mapped array of: ID of the custom demographics object
CEL
$result_object_key.custom_demographics.map(x, x.field_type)
Example
[
5
]
Mapped array of: Timestamp when the custom demographic was last updated
CEL
$result_object_key.custom_demographics.map(x, x.updated_at)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: Value of the custom demographic
CEL
$result_object_key.custom_demographics.map(x, x.value)
Example
[
"Custom value"
]
Patient date of birth
CEL
$result_object_key.date_of_birth
Example
"1990-05-15"
Patient date of death (available when show_inactive is passed)
CEL
$result_object_key.date_of_death
Example
"2024-12-01"
Date of first patient visit
CEL
$result_object_key.date_of_first_appointment
Example
"2020-03-10"
Date of previous patient visit
CEL
$result_object_key.date_of_last_appointment
Example
"2024-01-05"
NCPDP ID of patient’s default pharmacy
CEL
$result_object_key.default_pharmacy
Example
"1234567"
If true, suppress SMS/Txt messages to this patient
CEL
$result_object_key.disable_sms_messages
Example
false
Doctor ID
CEL
$result_object_key.doctor
Example
12345
Patient email address
CEL
$result_object_key.email
Example
"patient@example.com"
Emergency contact name
CEL
$result_object_key.emergency_contact_name
Example
"Jane Doe"
Emergency contact phone number
CEL
$result_object_key.emergency_contact_phone
Example
"555-987-6543"
Emergency contact relationship to patient
CEL
$result_object_key.emergency_contact_relation
Example
"Spouse"
Patient employer name
CEL
$result_object_key.employer
Example
"Acme Corporation"
Employer address
CEL
$result_object_key.employer_address
Example
"456 Corporate Blvd"
Employer city
CEL
$result_object_key.employer_city
Example
"Los Angeles"
Employer state (two-letter abbreviation)
CEL
$result_object_key.employer_state
Example
"CA"
Employer ZIP code
CEL
$result_object_key.employer_zip_code
Example
"90210"
Patient ethnicity (blank, hispanic, not_hispanic, or declined)
CEL
$result_object_key.ethnicity
Example
drchrono.v1.Ethnicity.ETHNICITY_BLANK
drchrono.v1.Ethnicity.ETHNICITY_DECLINED
drchrono.v1.Ethnicity.ETHNICITY_HISPANIC
drchrono.v1.Ethnicity.ETHNICITY_NOT_HISPANIC
Patient first name
CEL
$result_object_key.first_name
Example
"John"
Patient gender (Male, Female, or Other)
CEL
$result_object_key.gender
Example
drchrono.v1.Gender.GENDER_EMPTY
drchrono.v1.Gender.GENDER_ASKU
drchrono.v1.Gender.GENDER_FEMALE
drchrono.v1.Gender.GENDER_MALE
drchrono.v1.Gender.GENDER_OTHER
drchrono.v1.Gender.GENDER_UNK
Gender identity code
CEL
$result_object_key.gender_identity_code
Example
"446151000124109"
Gender identity description
CEL
$result_object_key.gender_identity_description
Example
"Identifies as male"
Patient home phone number
CEL
$result_object_key.home_phone
Example
"555-111-2222"
Patient last name
CEL
$result_object_key.last_name
Example
"Doe"
Medication history consent status
CEL
$result_object_key.medication_history_consent
Example
"Y"
Patient middle name
CEL
$result_object_key.middle_name
Example
"Robert"
Common name for patient (should be used instead of first name if supplied)
CEL
$result_object_key.nick_name
Example
"Johnny"
Patient office phone number
CEL
$result_object_key.office_phone
Example
"555-333-4444"
IDs of every office this patient has been to
CEL
$result_object_key.offices
Example
[]
Possible patient flag types that can be attached to the patient
CEL
$result_object_key.patient_flags
Example
[
{
"archived": false,
"color": "#FF0000",
"created_at": "2024-01-15T10:30:00Z",
"doctor": 12345,
"flag_id": 1,
"flag_text": "Requires wheelchair access",
"flag_type": 2,
"name": "High Priority",
"priority": 1,
"updated_at": "2024-01-15T10:30:00Z"
}
]
Mapped array of: Whether the flag is archived
CEL
$result_object_key.patient_flags.map(x, x.archived)
Example
[
false
]
Mapped array of: Color of the flag
CEL
$result_object_key.patient_flags.map(x, x.color)
Example
[
"#FF0000"
]
Mapped array of: Timestamp when the flag was created
CEL
$result_object_key.patient_flags.map(x, x.created_at)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: ID of doctor who owns the flag
CEL
$result_object_key.patient_flags.map(x, x.doctor)
Example
[
12345
]
Mapped array of: Flag ID
CEL
$result_object_key.patient_flags.map(x, x.flag_id)
Example
[
1
]
Mapped array of: Name of the flag
CEL
$result_object_key.patient_flags.map(x, x.name)
Example
[
"High Priority"
]
Mapped array of: Priority level of the flag
CEL
$result_object_key.patient_flags.map(x, x.priority)
Example
[
1
]
Mapped array of: Timestamp when the flag was last updated
CEL
$result_object_key.patient_flags.map(x, x.updated_at)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: Description of the patient flag
CEL
$result_object_key.patient_flags.map(x, x.flag_text)
Example
[
"Requires wheelchair access"
]
Mapped array of: ID of the associated patient flag type
CEL
$result_object_key.patient_flags.map(x, x.flag_type)
Example
[
2
]
Patient flags attached to the patient
CEL
$result_object_key.patient_flags_attached
Example
[
{
"archived": false,
"color": "#FF0000",
"created_at": "2024-01-15T10:30:00Z",
"doctor": 12345,
"flag_id": 1,
"flag_text": "Requires wheelchair access",
"flag_type": 2,
"name": "High Priority",
"priority": 1,
"updated_at": "2024-01-15T10:30:00Z"
}
]
Mapped array of: Whether the flag is archived
CEL
$result_object_key.patient_flags_attached.map(x, x.archived)
Example
[
false
]
Mapped array of: Color of the flag
CEL
$result_object_key.patient_flags_attached.map(x, x.color)
Example
[
"#FF0000"
]
Mapped array of: Timestamp when the flag was created
CEL
$result_object_key.patient_flags_attached.map(x, x.created_at)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: ID of doctor who owns the flag
CEL
$result_object_key.patient_flags_attached.map(x, x.doctor)
Example
[
12345
]
Mapped array of: Flag ID
CEL
$result_object_key.patient_flags_attached.map(x, x.flag_id)
Example
[
1
]
Mapped array of: Name of the flag
CEL
$result_object_key.patient_flags_attached.map(x, x.name)
Example
[
"High Priority"
]
Mapped array of: Priority level of the flag
CEL
$result_object_key.patient_flags_attached.map(x, x.priority)
Example
[
1
]
Mapped array of: Timestamp when the flag was last updated
CEL
$result_object_key.patient_flags_attached.map(x, x.updated_at)
Example
[
"2024-01-15T10:30:00Z"
]
Mapped array of: Description of the patient flag
CEL
$result_object_key.patient_flags_attached.map(x, x.flag_text)
Example
[
"Requires wheelchair access"
]
Mapped array of: ID of the associated patient flag type
CEL
$result_object_key.patient_flags_attached.map(x, x.flag_type)
Example
[
2
]
Patient payment profile (Cash, Insurance, Insurance Out of Network, Auto Accident, or Worker’s Comp)
CEL
$result_object_key.patient_payment_profile
Example
"Insurance"
Patient photo URL
CEL
$result_object_key.patient_photo
Example
"https://example.com/photo.jpg"
Patient photo date (cannot be passed without patient_photo)
CEL
$result_object_key.patient_photo_date
Example
"2024-01-10"
Patient status: A (active), I (inactive), D (inactive-deceased)
CEL
$result_object_key.patient_status
Example
drchrono.v1.PatientStatus.PATIENT_STATUS_A
drchrono.v1.PatientStatus.PATIENT_STATUS_D
drchrono.v1.PatientStatus.PATIENT_STATUS_I
Preferred language (ISO 639 alpha-3 codes)
CEL
$result_object_key.preferred_language
Example
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_BLANK
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_DECLINED
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_ENG
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_FRA
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_ITA
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_JPN
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_OTHER
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_POR
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_RUS
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_SPA
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_UNKNOWN
drchrono.v1.PreferredLanguage.PREFERRED_LANGUAGE_ZHO
Preferred language code
CEL
$result_object_key.preferred_language_code
Example
"en"
Preferred language description
CEL
$result_object_key.preferred_language_description
Example
"English"
NCPDP IDs of patient’s preferred pharmacies
CEL
$result_object_key.preferred_pharmacies
Example
[]
Referring doctor for this patient
CEL
$result_object_key.primary_care_physician
Example
"Dr. Jane Smith"
Primary insurance information
CEL
$result_object_key.primary_insurance
Example
{
"insurance_claim_office_number": "800-555-1234",
"insurance_company": "Blue Cross Blue Shield",
"insurance_group_name": "Employer Health Plan",
"insurance_group_number": "GRP12345",
"insurance_id_number": "XYZ123456789",
"insurance_payer_id": "00123",
"insurance_plan_name": "PPO Gold",
"insurance_plan_type": "HM",
"is_subscriber_the_patient": true,
"patient_relationship_to_subscriber": "01",
"photo_back": "https://example.com/card_back.jpg",
"photo_front": "https://example.com/card_front.jpg",
"subscriber_address": "123 Main St",
"subscriber_city": "New York",
"subscriber_country": "US",
"subscriber_date_of_birth": "1980-05-20",
"subscriber_first_name": "John",
"subscriber_gender": "Male",
"subscriber_last_name": "Doe",
"subscriber_middle_name": "Robert",
"subscriber_social_security": "123-45-6789",
"subscriber_state": "NY",
"subscriber_suffix": "Jr",
"subscriber_zip_code": "10001"
}
Insurance office phone number
CEL
$result_object_key.primary_insurance.insurance_claim_office_number
Example
"800-555-1234"
Insurance company name
CEL
$result_object_key.primary_insurance.insurance_company
Example
"Blue Cross Blue Shield"
Insurance group name
CEL
$result_object_key.primary_insurance.insurance_group_name
Example
"Employer Health Plan"
Insurance group number
CEL
$result_object_key.primary_insurance.insurance_group_number
Example
"GRP12345"
Insurance ID number
CEL
$result_object_key.primary_insurance.insurance_id_number
Example
"XYZ123456789"
Insurance payer ID
CEL
$result_object_key.primary_insurance.insurance_payer_id
Example
"00123"
Name of insurance plan
CEL
$result_object_key.primary_insurance.insurance_plan_name
Example
"PPO Gold"
Type of insurance plan
CEL
$result_object_key.primary_insurance.insurance_plan_type
Example
"HM"
True if the insurance policy is under patient’s own name
CEL
$result_object_key.primary_insurance.is_subscriber_the_patient
Example
true
HCFA/1500 individual relationship code
CEL
$result_object_key.primary_insurance.patient_relationship_to_subscriber
Example
"01"
Photo of back of insurance card
CEL
$result_object_key.primary_insurance.photo_back
Example
"https://example.com/card_back.jpg"
Photo of front of insurance card
CEL
$result_object_key.primary_insurance.photo_front
Example
"https://example.com/card_front.jpg"
Subscriber address
CEL
$result_object_key.primary_insurance.subscriber_address
Example
"123 Main St"
Subscriber city
CEL
$result_object_key.primary_insurance.subscriber_city
Example
"New York"
Two-letter country code
CEL
$result_object_key.primary_insurance.subscriber_country
Example
"US"
Subscriber date of birth
CEL
$result_object_key.primary_insurance.subscriber_date_of_birth
Example
"1980-05-20"
Subscriber first name
CEL
$result_object_key.primary_insurance.subscriber_first_name
Example
"John"
Subscriber gender - Male or Female
CEL
$result_object_key.primary_insurance.subscriber_gender
Example
drchrono.v1.Gender.GENDER_EMPTY
drchrono.v1.Gender.GENDER_ASKU
drchrono.v1.Gender.GENDER_FEMALE
drchrono.v1.Gender.GENDER_MALE
drchrono.v1.Gender.GENDER_OTHER
drchrono.v1.Gender.GENDER_UNK
Subscriber last name
CEL
$result_object_key.primary_insurance.subscriber_last_name
Example
"Doe"
Subscriber middle name
CEL
$result_object_key.primary_insurance.subscriber_middle_name
Example
"Robert"
Subscriber social security number
CEL
$result_object_key.primary_insurance.subscriber_social_security
Example
"123-45-6789"
Two-letter state code
CEL
$result_object_key.primary_insurance.subscriber_state
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Subscriber suffix (e.g. II or III)
CEL
$result_object_key.primary_insurance.subscriber_suffix
Example
"Jr"
Subscriber ZIP code
CEL
$result_object_key.primary_insurance.subscriber_zip_code
Example
"10001"
Patient pronouns
CEL
$result_object_key.pronouns
Example
"he/him"
Patient race (blank, indian, asian, black, hawaiian, white, or declined)
CEL
$result_object_key.race
Example
drchrono.v1.Race.RACE_ASIAN
drchrono.v1.Race.RACE_BLACK
drchrono.v1.Race.RACE_BLANK
drchrono.v1.Race.RACE_DECLINED
drchrono.v1.Race.RACE_HAWAIIAN
drchrono.v1.Race.RACE_INDIAN
drchrono.v1.Race.RACE_OTHER
drchrono.v1.Race.RACE_WHITE
Race subcategories
CEL
$result_object_key.race_subcategories
Example
[
{
"code": "2028-9",
"description": "Asian Indian"
}
]
Mapped array of: Race subcategory code
CEL
$result_object_key.race_subcategories.map(x, x.code)
Example
[
"2028-9"
]
Mapped array of: Race subcategory description
CEL
$result_object_key.race_subcategories.map(x, x.description)
Example
[
"Asian Indian"
]
Referring doctor information
CEL
$result_object_key.referring_doctor
Example
{
"address": "456 Medical Center Dr",
"email": "dr.smith@hospital.com",
"fax": "555-12-3456",
"first_name": "Robert",
"last_name": "Smith",
"middle_name": "James",
"npi": "1234567890",
"phone": "555-98-7654",
"provider_number": "PROV12345",
"provider_qualifier": "0B",
"specialty": "Cardiologist",
"suffix": "MD"
}
Referring doctor address
CEL
$result_object_key.referring_doctor.address
Example
"456 Medical Center Dr"
Referring doctor email
CEL
$result_object_key.referring_doctor.email
Example
"dr.smith@hospital.com"
Referring doctor fax (format: xxx-xx-xxxx)
CEL
$result_object_key.referring_doctor.fax
Example
"555-12-3456"
Referring doctor first name
CEL
$result_object_key.referring_doctor.first_name
Example
"Robert"
Referring doctor last name
CEL
$result_object_key.referring_doctor.last_name
Example
"Smith"
Referring doctor middle name
CEL
$result_object_key.referring_doctor.middle_name
Example
"James"
Referring doctor NPI number
CEL
$result_object_key.referring_doctor.npi
Example
"1234567890"
Referring doctor phone (format: xxx-xx-xxxx)
CEL
$result_object_key.referring_doctor.phone
Example
"555-98-7654"
Provider number
CEL
$result_object_key.referring_doctor.provider_number
Example
"PROV12345"
Provider qualifier (State License #, Provider UPIN #, or Provider Commercial #)
CEL
$result_object_key.referring_doctor.provider_qualifier
Example
"0B"
Referring doctor specialty
CEL
$result_object_key.referring_doctor.specialty
Example
"Cardiologist"
Referring doctor suffix
CEL
$result_object_key.referring_doctor.suffix
Example
"MD"
Referring source
CEL
$result_object_key.referring_source
Example
"Website"
Responsible party email
CEL
$result_object_key.responsible_party_email
Example
"responsible@example.com"
Responsible party name
CEL
$result_object_key.responsible_party_name
Example
"Mary Doe"
Responsible party phone number
CEL
$result_object_key.responsible_party_phone
Example
"555-555-5555"
Responsible party relationship to patient
CEL
$result_object_key.responsible_party_relation
Example
"Parent"
Secondary insurance information
CEL
$result_object_key.secondary_insurance
Example
{
"insurance_claim_office_number": "800-555-1234",
"insurance_company": "Blue Cross Blue Shield",
"insurance_group_name": "Employer Health Plan",
"insurance_group_number": "GRP12345",
"insurance_id_number": "XYZ123456789",
"insurance_payer_id": "00123",
"insurance_plan_name": "PPO Gold",
"insurance_plan_type": "HM",
"is_subscriber_the_patient": true,
"patient_relationship_to_subscriber": "01",
"photo_back": "https://example.com/card_back.jpg",
"photo_front": "https://example.com/card_front.jpg",
"subscriber_address": "123 Main St",
"subscriber_city": "New York",
"subscriber_country": "US",
"subscriber_date_of_birth": "1980-05-20",
"subscriber_first_name": "John",
"subscriber_gender": "Male",
"subscriber_last_name": "Doe",
"subscriber_middle_name": "Robert",
"subscriber_social_security": "123-45-6789",
"subscriber_state": "NY",
"subscriber_suffix": "Jr",
"subscriber_zip_code": "10001"
}
Insurance office phone number
CEL
$result_object_key.secondary_insurance.insurance_claim_office_number
Example
"800-555-1234"
Insurance company name
CEL
$result_object_key.secondary_insurance.insurance_company
Example
"Blue Cross Blue Shield"
Insurance group name
CEL
$result_object_key.secondary_insurance.insurance_group_name
Example
"Employer Health Plan"
Insurance group number
CEL
$result_object_key.secondary_insurance.insurance_group_number
Example
"GRP12345"
Insurance ID number
CEL
$result_object_key.secondary_insurance.insurance_id_number
Example
"XYZ123456789"
Insurance payer ID
CEL
$result_object_key.secondary_insurance.insurance_payer_id
Example
"00123"
Name of insurance plan
CEL
$result_object_key.secondary_insurance.insurance_plan_name
Example
"PPO Gold"
Type of insurance plan
CEL
$result_object_key.secondary_insurance.insurance_plan_type
Example
"HM"
True if the insurance policy is under patient’s own name
CEL
$result_object_key.secondary_insurance.is_subscriber_the_patient
Example
true
HCFA/1500 individual relationship code
CEL
$result_object_key.secondary_insurance.patient_relationship_to_subscriber
Example
"01"
Photo of back of insurance card
CEL
$result_object_key.secondary_insurance.photo_back
Example
"https://example.com/card_back.jpg"
Photo of front of insurance card
CEL
$result_object_key.secondary_insurance.photo_front
Example
"https://example.com/card_front.jpg"
Subscriber address
CEL
$result_object_key.secondary_insurance.subscriber_address
Example
"123 Main St"
Subscriber city
CEL
$result_object_key.secondary_insurance.subscriber_city
Example
"New York"
Two-letter country code
CEL
$result_object_key.secondary_insurance.subscriber_country
Example
"US"
Subscriber date of birth
CEL
$result_object_key.secondary_insurance.subscriber_date_of_birth
Example
"1980-05-20"
Subscriber first name
CEL
$result_object_key.secondary_insurance.subscriber_first_name
Example
"John"
Subscriber gender - Male or Female
CEL
$result_object_key.secondary_insurance.subscriber_gender
Example
drchrono.v1.Gender.GENDER_EMPTY
drchrono.v1.Gender.GENDER_ASKU
drchrono.v1.Gender.GENDER_FEMALE
drchrono.v1.Gender.GENDER_MALE
drchrono.v1.Gender.GENDER_OTHER
drchrono.v1.Gender.GENDER_UNK
Subscriber last name
CEL
$result_object_key.secondary_insurance.subscriber_last_name
Example
"Doe"
Subscriber middle name
CEL
$result_object_key.secondary_insurance.subscriber_middle_name
Example
"Robert"
Subscriber social security number
CEL
$result_object_key.secondary_insurance.subscriber_social_security
Example
"123-45-6789"
Two-letter state code
CEL
$result_object_key.secondary_insurance.subscriber_state
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Subscriber suffix (e.g. II or III)
CEL
$result_object_key.secondary_insurance.subscriber_suffix
Example
"Jr"
Subscriber ZIP code
CEL
$result_object_key.secondary_insurance.subscriber_zip_code
Example
"10001"
Patient social security number
CEL
$result_object_key.social_security_number
Example
"123-45-6789"
Patient state (two-letter abbreviation)
CEL
$result_object_key.state
Example
"CA"
Tertiary insurance information
CEL
$result_object_key.tertiary_insurance
Example
{
"insurance_claim_office_number": "800-555-1234",
"insurance_company": "Blue Cross Blue Shield",
"insurance_group_name": "Employer Health Plan",
"insurance_group_number": "GRP12345",
"insurance_id_number": "XYZ123456789",
"insurance_payer_id": "00123",
"insurance_plan_name": "PPO Gold",
"insurance_plan_type": "HM",
"is_subscriber_the_patient": true,
"patient_relationship_to_subscriber": "01",
"photo_back": "https://example.com/card_back.jpg",
"photo_front": "https://example.com/card_front.jpg",
"subscriber_address": "123 Main St",
"subscriber_city": "New York",
"subscriber_country": "US",
"subscriber_date_of_birth": "1980-05-20",
"subscriber_first_name": "John",
"subscriber_gender": "Male",
"subscriber_last_name": "Doe",
"subscriber_middle_name": "Robert",
"subscriber_social_security": "123-45-6789",
"subscriber_state": "NY",
"subscriber_suffix": "Jr",
"subscriber_zip_code": "10001"
}
Insurance office phone number
CEL
$result_object_key.tertiary_insurance.insurance_claim_office_number
Example
"800-555-1234"
Insurance company name
CEL
$result_object_key.tertiary_insurance.insurance_company
Example
"Blue Cross Blue Shield"
Insurance group name
CEL
$result_object_key.tertiary_insurance.insurance_group_name
Example
"Employer Health Plan"
Insurance group number
CEL
$result_object_key.tertiary_insurance.insurance_group_number
Example
"GRP12345"
Insurance ID number
CEL
$result_object_key.tertiary_insurance.insurance_id_number
Example
"XYZ123456789"
Insurance payer ID
CEL
$result_object_key.tertiary_insurance.insurance_payer_id
Example
"00123"
Name of insurance plan
CEL
$result_object_key.tertiary_insurance.insurance_plan_name
Example
"PPO Gold"
Type of insurance plan
CEL
$result_object_key.tertiary_insurance.insurance_plan_type
Example
"HM"
True if the insurance policy is under patient’s own name
CEL
$result_object_key.tertiary_insurance.is_subscriber_the_patient
Example
true
HCFA/1500 individual relationship code
CEL
$result_object_key.tertiary_insurance.patient_relationship_to_subscriber
Example
"01"
Photo of back of insurance card
CEL
$result_object_key.tertiary_insurance.photo_back
Example
"https://example.com/card_back.jpg"
Photo of front of insurance card
CEL
$result_object_key.tertiary_insurance.photo_front
Example
"https://example.com/card_front.jpg"
Subscriber address
CEL
$result_object_key.tertiary_insurance.subscriber_address
Example
"123 Main St"
Subscriber city
CEL
$result_object_key.tertiary_insurance.subscriber_city
Example
"New York"
Two-letter country code
CEL
$result_object_key.tertiary_insurance.subscriber_country
Example
"US"
Subscriber date of birth
CEL
$result_object_key.tertiary_insurance.subscriber_date_of_birth
Example
"1980-05-20"
Subscriber first name
CEL
$result_object_key.tertiary_insurance.subscriber_first_name
Example
"John"
Subscriber gender - Male or Female
CEL
$result_object_key.tertiary_insurance.subscriber_gender
Example
drchrono.v1.Gender.GENDER_EMPTY
drchrono.v1.Gender.GENDER_ASKU
drchrono.v1.Gender.GENDER_FEMALE
drchrono.v1.Gender.GENDER_MALE
drchrono.v1.Gender.GENDER_OTHER
drchrono.v1.Gender.GENDER_UNK
Subscriber last name
CEL
$result_object_key.tertiary_insurance.subscriber_last_name
Example
"Doe"
Subscriber middle name
CEL
$result_object_key.tertiary_insurance.subscriber_middle_name
Example
"Robert"
Subscriber social security number
CEL
$result_object_key.tertiary_insurance.subscriber_social_security
Example
"123-45-6789"
Two-letter state code
CEL
$result_object_key.tertiary_insurance.subscriber_state
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Subscriber suffix (e.g. II or III)
CEL
$result_object_key.tertiary_insurance.subscriber_suffix
Example
"Jr"
Subscriber ZIP code
CEL
$result_object_key.tertiary_insurance.subscriber_zip_code
Example
"10001"
Timestamp when the patient was last updated
CEL
$result_object_key.updated_at
Example
"2024-01-15T10:30:00Z"
Workers compensation insurance information
CEL
$result_object_key.workers_comp_insurance
Example
{
"property_and_casualty_agency_claim_number": "PCA-2024-001",
"workers_comp_carrier_code": "WCC123",
"workers_comp_case_number": "WC-2024-00123",
"workers_comp_company": "Hartford",
"workers_comp_date_of_accident": "2024-01-05",
"workers_comp_group_name": "Industrial Workers",
"workers_comp_group_number": "WCG456",
"workers_comp_notes": "Injury occurred on job site",
"workers_comp_payer_address": "100 Insurance Way",
"workers_comp_payer_city": "Hartford",
"workers_comp_payer_id": "WCPAY001",
"workers_comp_payer_state": "CT",
"workers_comp_payer_zip": "06103",
"workers_comp_state_of_occurrence": "NY",
"workers_comp_wcb": "WCB12345",
"workers_comp_wcb_rating_code": "A1"
}
Property and casualty agency claim number
CEL
$result_object_key.workers_comp_insurance.property_and_casualty_agency_claim_number
Example
"PCA-2024-001"
Workers comp carrier code
CEL
$result_object_key.workers_comp_insurance.workers_comp_carrier_code
Example
"WCC123"
Workers comp case number
CEL
$result_object_key.workers_comp_insurance.workers_comp_case_number
Example
"WC-2024-00123"
Workers comp insurance company
CEL
$result_object_key.workers_comp_insurance.workers_comp_company
Example
"Hartford"
Date of the workers comp accident
CEL
$result_object_key.workers_comp_insurance.workers_comp_date_of_accident
Example
"2024-01-05"
Workers comp group name
CEL
$result_object_key.workers_comp_insurance.workers_comp_group_name
Example
"Industrial Workers"
Workers comp group number
CEL
$result_object_key.workers_comp_insurance.workers_comp_group_number
Example
"WCG456"
Notes about the workers comp claim
CEL
$result_object_key.workers_comp_insurance.workers_comp_notes
Example
"Injury occurred on job site"
Workers comp payer address
CEL
$result_object_key.workers_comp_insurance.workers_comp_payer_address
Example
"100 Insurance Way"
Workers comp payer city
CEL
$result_object_key.workers_comp_insurance.workers_comp_payer_city
Example
"Hartford"
Workers comp payer ID
CEL
$result_object_key.workers_comp_insurance.workers_comp_payer_id
Example
"WCPAY001"
Workers comp payer state
CEL
$result_object_key.workers_comp_insurance.workers_comp_payer_state
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Workers comp payer ZIP code
CEL
$result_object_key.workers_comp_insurance.workers_comp_payer_zip
Example
"06103"
State where the workers comp accident occurred
CEL
$result_object_key.workers_comp_insurance.workers_comp_state_of_occurrence
Example
drchrono.v1.USState.US_STATE_AA
drchrono.v1.USState.US_STATE_AE
drchrono.v1.USState.US_STATE_AK
drchrono.v1.USState.US_STATE_AL
drchrono.v1.USState.US_STATE_AP
drchrono.v1.USState.US_STATE_AR
drchrono.v1.USState.US_STATE_AS
drchrono.v1.USState.US_STATE_AZ
drchrono.v1.USState.US_STATE_CA
drchrono.v1.USState.US_STATE_CO
drchrono.v1.USState.US_STATE_CT
drchrono.v1.USState.US_STATE_DC
drchrono.v1.USState.US_STATE_DE
drchrono.v1.USState.US_STATE_FL
drchrono.v1.USState.US_STATE_GA
drchrono.v1.USState.US_STATE_GU
drchrono.v1.USState.US_STATE_HI
drchrono.v1.USState.US_STATE_IA
drchrono.v1.USState.US_STATE_ID
drchrono.v1.USState.US_STATE_IL
drchrono.v1.USState.US_STATE_IN
drchrono.v1.USState.US_STATE_KS
drchrono.v1.USState.US_STATE_KY
drchrono.v1.USState.US_STATE_LA
drchrono.v1.USState.US_STATE_MA
drchrono.v1.USState.US_STATE_MD
drchrono.v1.USState.US_STATE_ME
drchrono.v1.USState.US_STATE_MI
drchrono.v1.USState.US_STATE_MN
drchrono.v1.USState.US_STATE_MO
drchrono.v1.USState.US_STATE_MP
drchrono.v1.USState.US_STATE_MS
drchrono.v1.USState.US_STATE_MT
drchrono.v1.USState.US_STATE_NC
drchrono.v1.USState.US_STATE_ND
drchrono.v1.USState.US_STATE_NE
drchrono.v1.USState.US_STATE_NH
drchrono.v1.USState.US_STATE_NJ
drchrono.v1.USState.US_STATE_NM
drchrono.v1.USState.US_STATE_NV
drchrono.v1.USState.US_STATE_NY
drchrono.v1.USState.US_STATE_OH
drchrono.v1.USState.US_STATE_OK
drchrono.v1.USState.US_STATE_OR
drchrono.v1.USState.US_STATE_PA
drchrono.v1.USState.US_STATE_PR
drchrono.v1.USState.US_STATE_RI
drchrono.v1.USState.US_STATE_SC
drchrono.v1.USState.US_STATE_SD
drchrono.v1.USState.US_STATE_TN
drchrono.v1.USState.US_STATE_TX
drchrono.v1.USState.US_STATE_UT
drchrono.v1.USState.US_STATE_VA
drchrono.v1.USState.US_STATE_VI
drchrono.v1.USState.US_STATE_VT
drchrono.v1.USState.US_STATE_WA
drchrono.v1.USState.US_STATE_WI
drchrono.v1.USState.US_STATE_WV
drchrono.v1.USState.US_STATE_WY
Workers compensation board number
CEL
$result_object_key.workers_comp_insurance.workers_comp_wcb
Example
"WCB12345"
Workers compensation board rating code
CEL
$result_object_key.workers_comp_insurance.workers_comp_wcb_rating_code
Example
"A1"
Patient ZIP code
CEL
$result_object_key.zip_code
Example
"94102"
