> ## 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.

# Create Or Update Patient

> Documentation for the Create Or Update Patient action for Dr Chrono

![images/dr\_chrono.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/dr_chrono.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=6e7f7a8fd54f1a71e28726861963d11a)

# Parameters

**Action** `Parameters`

**parameters**

**Id** `string`

`ID`
This field maps to the destination API `id` field.

**First Name** `string`

`PII`
This field maps to the destination API `first_name` field.

**Last Name** `string`

`PII`
This field maps to the destination API `last_name` field.

**Email** `string`

`PII`
This field maps to the destination API `email` field.

**Doctor** `string (Doctor)`

`ID`
This field maps to the destination API `doctor` field.

**Preferred Language** `drchrono.v1.PreferredLanguage`

This field maps to the destination API `preferred_language` field.

```json Allowed Enumeration Values theme={null}
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
```

**Gender** `drchrono.v1.Gender`

This field maps to the destination API `gender` field.

```json Allowed Enumeration Values theme={null}
GENDER_EMPTY
GENDER_ASKU
GENDER_FEMALE
GENDER_MALE
GENDER_OTHER
GENDER_UNK
```

**Date Of Birth** `values.v1.Date`

`PII`
This field maps to the destination API `date_of_birth` field.

**Race** `drchrono.v1.Race`

This field maps to the destination API `race` field.

```json Allowed Enumeration Values theme={null}
RACE_ASIAN
RACE_BLACK
RACE_BLANK
RACE_DECLINED
RACE_HAWAIIAN
RACE_INDIAN
RACE_OTHER
RACE_WHITE
```

**Ethnicity** `drchrono.v1.Ethnicity`

This field maps to the destination API `ethnicity` field.

```json Allowed Enumeration Values theme={null}
ETHNICITY_BLANK
ETHNICITY_DECLINED
ETHNICITY_HISPANIC
ETHNICITY_NOT_HISPANIC
```

```json Result Object Example theme={null}
{
  "$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"
  }
}
```

```json Result Object Description theme={null}
{
  "$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 an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**Patient** `Fetch Action Response Object`

**fields**

**id** `string` *required*

Patient ID

```json CEL theme={null}
$result_object_key.id
```

```json Example theme={null}
"123456"
```

**address** `string`

Patient address

```json CEL theme={null}
$result_object_key.address
```

```json Example theme={null}
"123 Main Street"
```

**auto\_accident\_insurance** `object` *required*

Auto accident insurance information

```json CEL theme={null}
$result_object_key.auto_accident_insurance
```

```json Example theme={null}
{
"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\_insurance.auto\_accident\_case\_number** `string`

Auto accident case number

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_case_number
```

```json Example theme={null}
"AAC-2024-001"
```

**auto\_accident\_insurance.auto\_accident\_claim\_rep\_address** `string`

Claim representative address

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_address
```

```json Example theme={null}
"123 Insurance Blvd"
```

**auto\_accident\_insurance.auto\_accident\_claim\_rep\_city** `string`

Claim representative city

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_city
```

```json Example theme={null}
"Los Angeles"
```

**auto\_accident\_insurance.auto\_accident\_claim\_rep\_is\_insurer** `bool` *required*

Is the insurer's claim representative the insurer?

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_is_insurer
```

```json Example theme={null}
true
```

**auto\_accident\_insurance.auto\_accident\_claim\_rep\_name** `string`

Claim representative name

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_name
```

```json Example theme={null}
"John Smith"
```

**auto\_accident\_insurance.auto\_accident\_claim\_rep\_state** `drchrono.v1.USState` *required*

Claim representative state

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_state
```

```json Example theme={null}
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\_insurance.auto\_accident\_claim\_rep\_zip** `string`

Claim representative ZIP code

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_claim_rep_zip
```

```json Example theme={null}
"90210"
```

**auto\_accident\_insurance.auto\_accident\_company** `string`

Auto accident insurance company

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_company
```

```json Example theme={null}
"State Farm"
```

**auto\_accident\_insurance.auto\_accident\_date\_of\_accident** `values.v1.Date`

Date of the auto accident

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_date_of_accident
```

```json Example theme={null}
"2024-01-10"
```

**auto\_accident\_insurance.auto\_accident\_disabled\_from\_date** `values.v1.Date`

Patient was disabled (unable to work) from this date

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_disabled_from_date
```

```json Example theme={null}
"2024-01-11"
```

**auto\_accident\_insurance.auto\_accident\_disabled\_to\_date** `values.v1.Date`

Patient was disabled (unable to work) until this date

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_disabled_to_date
```

```json Example theme={null}
"2024-02-11"
```

**auto\_accident\_insurance.auto\_accident\_had\_similar\_condition** `bool` *required*

Has the patient had same or similar condition?

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_had_similar_condition
```

```json Example theme={null}
false
```

**auto\_accident\_insurance.auto\_accident\_is\_subscriber\_the\_patient** `bool` *required*

True if the insurance policy is under patient's own name

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_is_subscriber_the_patient
```

```json Example theme={null}
true
```

**auto\_accident\_insurance.auto\_accident\_notes** `string`

Notes about the auto accident

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_notes
```

```json Example theme={null}
"Rear-ended at intersection"
```

**auto\_accident\_insurance.auto\_accident\_patient\_relationship\_to\_subscriber** `string`

Patient's relationship to subscriber

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_patient_relationship_to_subscriber
```

```json Example theme={null}
"01"
```

**auto\_accident\_insurance.auto\_accident\_payer\_address** `string`

Auto accident payer address

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_payer_address
```

```json Example theme={null}
"456 Payer St"
```

**auto\_accident\_insurance.auto\_accident\_payer\_city** `string`

Auto accident payer city

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_payer_city
```

```json Example theme={null}
"Chicago"
```

**auto\_accident\_insurance.auto\_accident\_payer\_id** `string`

Auto Accident Payer ID

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_payer_id
```

```json Example theme={null}
"PAY123"
```

**auto\_accident\_insurance.auto\_accident\_payer\_state** `drchrono.v1.USState` *required*

Auto accident payer state

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_payer_state
```

```json Example theme={null}
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\_insurance.auto\_accident\_payer\_zip** `string`

Auto accident payer ZIP code

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_payer_zip
```

```json Example theme={null}
"60601"
```

**auto\_accident\_insurance.auto\_accident\_policy\_number** `string`

Auto accident policy number

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_policy_number
```

```json Example theme={null}
"POL-2024-12345"
```

**auto\_accident\_insurance.auto\_accident\_return\_to\_work\_date** `values.v1.Date`

If still disabled, patient should be able to return to work on this date

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_return_to_work_date
```

```json Example theme={null}
"2024-03-01"
```

**auto\_accident\_insurance.auto\_accident\_significant\_injury** `string`

Whether there was a significant injury

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_significant_injury
```

```json Example theme={null}
"YES"
```

**auto\_accident\_insurance.auto\_accident\_significant\_injury\_notes** `string`

Notes about significant injury

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_significant_injury_notes
```

```json Example theme={null}
"Whiplash and back pain"
```

**auto\_accident\_insurance.auto\_accident\_similar\_condition\_date** `values.v1.Date`

Date of same or similar condition

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_similar_condition_date
```

```json Example theme={null}
"2020-05-15"
```

**auto\_accident\_insurance.auto\_accident\_similar\_condition\_notes** `string`

Notes about similar condition

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_similar_condition_notes
```

```json Example theme={null}
"Previous back injury"
```

**auto\_accident\_insurance.auto\_accident\_state\_of\_occurrence** `drchrono.v1.USState` *required*

State where the auto accident occurred

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_state_of_occurrence
```

```json Example theme={null}
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\_insurance.auto\_accident\_still\_under\_care** `bool` *required*

Is patient still under your care for this condition?

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_still_under_care
```

```json Example theme={null}
true
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_address** `string`

Subscriber address

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_address
```

```json Example theme={null}
"789 Main St"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_city** `string`

Subscriber city

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_city
```

```json Example theme={null}
"San Francisco"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_date\_of\_birth** `values.v1.Date`

Subscriber date of birth

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_date_of_birth
```

```json Example theme={null}
"1985-06-15"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_first\_name** `string`

Subscriber first name

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_first_name
```

```json Example theme={null}
"Jane"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_last\_name** `string`

Subscriber last name

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_last_name
```

```json Example theme={null}
"Doe"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_middle\_name** `string`

Subscriber middle name

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_middle_name
```

```json Example theme={null}
"Marie"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_phone\_number** `string`

Subscriber phone number

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_phone_number
```

```json Example theme={null}
"555-123-4567"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_social\_security** `string`

Subscriber social security number

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_social_security
```

```json Example theme={null}
"123-45-6789"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_state** `drchrono.v1.USState` *required*

Subscriber state

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_state
```

```json Example theme={null}
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\_insurance.auto\_accident\_subscriber\_suffix** `string`

Subscriber suffix

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_suffix
```

```json Example theme={null}
"Jr"
```

**auto\_accident\_insurance.auto\_accident\_subscriber\_zip\_code** `string`

Subscriber ZIP code

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_subscriber_zip_code
```

```json Example theme={null}
"94102"
```

**auto\_accident\_insurance.auto\_accident\_treatment\_duration** `string`

Treatment duration

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_treatment_duration
```

```json Example theme={null}
"6 months"
```

**auto\_accident\_insurance.auto\_accident\_will\_require\_therapy** `bool` *required*

Will the patient require rehabilitation and/or occupational therapy?

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_will_require_therapy
```

```json Example theme={null}
true
```

**auto\_accident\_insurance.auto\_accident\_will\_require\_therapy\_rec** `string`

Therapy recommendation

```json CEL theme={null}
$result_object_key.auto_accident_insurance.auto_accident_will_require_therapy_rec
```

```json Example theme={null}
"Physical therapy 2x weekly"
```

**cell\_phone** `string`

Patient cell phone number

```json CEL theme={null}
$result_object_key.cell_phone
```

```json Example theme={null}
"555-123-4567"
```

**chart\_id** `string`

Chart ID (automatically set using first & last name if absent)

```json CEL theme={null}
$result_object_key.chart_id
```

```json Example theme={null}
"DOEJ001"
```

**city** `string`

Patient city

```json CEL theme={null}
$result_object_key.city
```

```json Example theme={null}
"San Francisco"
```

**copay** `string`

Patient copay amount

```json CEL theme={null}
$result_object_key.copay
```

```json Example theme={null}
"25.00"
```

**created\_at** `timing.v1.Timestamp` *required*

Timestamp when the patient was created

```json CEL theme={null}
$result_object_key.created_at
```

```json Example theme={null}
"2024-01-15T10:30:00Z"
```

**custom\_demographics** `[]object` *required*

Custom demographic fields for the patient

```json CEL theme={null}
$result_object_key.custom_demographics
```

```json Example theme={null}
[
{
"field_type": 5,
"updated_at": "2024-01-15T10:30:00Z",
"value": "Custom value"
}
]
```

**custom\_demographics.map(x, x.field\_type)** `[]int64` *required*

Mapped array of: ID of the custom demographics object

```json CEL theme={null}
$result_object_key.custom_demographics.map(x, x.field_type)
```

```json Example theme={null}
[
5
]
```

**custom\_demographics.map(x, x.updated\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Timestamp when the custom demographic was last updated

```json CEL theme={null}
$result_object_key.custom_demographics.map(x, x.updated_at)
```

```json Example theme={null}
[
"2024-01-15T10:30:00Z"
]
```

**custom\_demographics.map(x, x.value)** `[]string` *required*

Mapped array of: Value of the custom demographic

```json CEL theme={null}
$result_object_key.custom_demographics.map(x, x.value)
```

```json Example theme={null}
[
"Custom value"
]
```

**date\_of\_birth** `values.v1.Date`

Patient date of birth

```json CEL theme={null}
$result_object_key.date_of_birth
```

```json Example theme={null}
"1990-05-15"
```

**date\_of\_death** `values.v1.Date`

Patient date of death (available when show\_inactive is passed)

```json CEL theme={null}
$result_object_key.date_of_death
```

```json Example theme={null}
"2024-12-01"
```

**date\_of\_first\_appointment** `values.v1.Date`

Date of first patient visit

```json CEL theme={null}
$result_object_key.date_of_first_appointment
```

```json Example theme={null}
"2020-03-10"
```

**date\_of\_last\_appointment** `values.v1.Date`

Date of previous patient visit

```json CEL theme={null}
$result_object_key.date_of_last_appointment
```

```json Example theme={null}
"2024-01-05"
```

**default\_pharmacy** `string`

NCPDP ID of patient's default pharmacy

```json CEL theme={null}
$result_object_key.default_pharmacy
```

```json Example theme={null}
"1234567"
```

**disable\_sms\_messages** `bool` *required*

If true, suppress SMS/Txt messages to this patient

```json CEL theme={null}
$result_object_key.disable_sms_messages
```

```json Example theme={null}
false
```

**doctor** `int64` *required*

Doctor ID

```json CEL theme={null}
$result_object_key.doctor
```

```json Example theme={null}
12345
```

**email** `string`

Patient email address

```json CEL theme={null}
$result_object_key.email
```

```json Example theme={null}
"patient@example.com"
```

**emergency\_contact\_name** `string`

Emergency contact name

```json CEL theme={null}
$result_object_key.emergency_contact_name
```

```json Example theme={null}
"Jane Doe"
```

**emergency\_contact\_phone** `string`

Emergency contact phone number

```json CEL theme={null}
$result_object_key.emergency_contact_phone
```

```json Example theme={null}
"555-987-6543"
```

**emergency\_contact\_relation** `string`

Emergency contact relationship to patient

```json CEL theme={null}
$result_object_key.emergency_contact_relation
```

```json Example theme={null}
"Spouse"
```

**employer** `string`

Patient employer name

```json CEL theme={null}
$result_object_key.employer
```

```json Example theme={null}
"Acme Corporation"
```

**employer\_address** `string`

Employer address

```json CEL theme={null}
$result_object_key.employer_address
```

```json Example theme={null}
"456 Corporate Blvd"
```

**employer\_city** `string`

Employer city

```json CEL theme={null}
$result_object_key.employer_city
```

```json Example theme={null}
"Los Angeles"
```

**employer\_state** `string`

Employer state (two-letter abbreviation)

```json CEL theme={null}
$result_object_key.employer_state
```

```json Example theme={null}
"CA"
```

**employer\_zip\_code** `string`

Employer ZIP code

```json CEL theme={null}
$result_object_key.employer_zip_code
```

```json Example theme={null}
"90210"
```

**ethnicity** `drchrono.v1.Ethnicity` *required*

Patient ethnicity (blank, hispanic, not\_hispanic, or declined)

```json CEL theme={null}
$result_object_key.ethnicity
```

```json Example theme={null}
drchrono.v1.Ethnicity.ETHNICITY_BLANK
drchrono.v1.Ethnicity.ETHNICITY_DECLINED
drchrono.v1.Ethnicity.ETHNICITY_HISPANIC
drchrono.v1.Ethnicity.ETHNICITY_NOT_HISPANIC
```

**first\_name** `string`

Patient first name

```json CEL theme={null}
$result_object_key.first_name
```

```json Example theme={null}
"John"
```

**gender** `drchrono.v1.Gender` *required*

Patient gender (Male, Female, or Other)

```json CEL theme={null}
$result_object_key.gender
```

```json Example theme={null}
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** `string`

Gender identity code

```json CEL theme={null}
$result_object_key.gender_identity_code
```

```json Example theme={null}
"446151000124109"
```

**gender\_identity\_description** `string`

Gender identity description

```json CEL theme={null}
$result_object_key.gender_identity_description
```

```json Example theme={null}
"Identifies as male"
```

**home\_phone** `string`

Patient home phone number

```json CEL theme={null}
$result_object_key.home_phone
```

```json Example theme={null}
"555-111-2222"
```

**last\_name** `string`

Patient last name

```json CEL theme={null}
$result_object_key.last_name
```

```json Example theme={null}
"Doe"
```

**medication\_history\_consent** `string`

Medication history consent status

```json CEL theme={null}
$result_object_key.medication_history_consent
```

```json Example theme={null}
"Y"
```

**middle\_name** `string`

Patient middle name

```json CEL theme={null}
$result_object_key.middle_name
```

```json Example theme={null}
"Robert"
```

**nick\_name** `string`

Common name for patient (should be used instead of first name if supplied)

```json CEL theme={null}
$result_object_key.nick_name
```

```json Example theme={null}
"Johnny"
```

**office\_phone** `string`

Patient office phone number

```json CEL theme={null}
$result_object_key.office_phone
```

```json Example theme={null}
"555-333-4444"
```

**offices** `[]int64` *required*

IDs of every office this patient has been to

```json CEL theme={null}
$result_object_key.offices
```

```json Example theme={null}
[]
```

**patient\_flags** `[]object` *required*

Possible patient flag types that can be attached to the patient

```json CEL theme={null}
$result_object_key.patient_flags
```

```json Example theme={null}
[
{
"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.map(x, x.archived)** `[]bool` *required*

Mapped array of: Whether the flag is archived

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.archived)
```

```json Example theme={null}
[
false
]
```

**patient\_flags.map(x, x.color)** `[]string` *required*

Mapped array of: Color of the flag

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.color)
```

```json Example theme={null}
[
"#FF0000"
]
```

**patient\_flags.map(x, x.created\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Timestamp when the flag was created

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.created_at)
```

```json Example theme={null}
[
"2024-01-15T10:30:00Z"
]
```

**patient\_flags.map(x, x.doctor)** `[]int64` *required*

Mapped array of: ID of doctor who owns the flag

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.doctor)
```

```json Example theme={null}
[
12345
]
```

**patient\_flags.map(x, x.flag\_id)** `[]int64` *required*

Mapped array of: Flag ID

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.flag_id)
```

```json Example theme={null}
[
1
]
```

**patient\_flags.map(x, x.name)** `[]string` *required*

Mapped array of: Name of the flag

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.name)
```

```json Example theme={null}
[
"High Priority"
]
```

**patient\_flags.map(x, x.priority)** `[]int64` *required*

Mapped array of: Priority level of the flag

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.priority)
```

```json Example theme={null}
[
1
]
```

**patient\_flags.map(x, x.updated\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Timestamp when the flag was last updated

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.updated_at)
```

```json Example theme={null}
[
"2024-01-15T10:30:00Z"
]
```

**patient\_flags.map(x, x.flag\_text)** `[]string` *required*

Mapped array of: Description of the patient flag

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.flag_text)
```

```json Example theme={null}
[
"Requires wheelchair access"
]
```

**patient\_flags.map(x, x.flag\_type)** `[]int64` *required*

Mapped array of: ID of the associated patient flag type

```json CEL theme={null}
$result_object_key.patient_flags.map(x, x.flag_type)
```

```json Example theme={null}
[
2
]
```

**patient\_flags\_attached** `[]object` *required*

Patient flags attached to the patient

```json CEL theme={null}
$result_object_key.patient_flags_attached
```

```json Example theme={null}
[
{
"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.map(x, x.archived)** `[]bool` *required*

Mapped array of: Whether the flag is archived

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.archived)
```

```json Example theme={null}
[
false
]
```

**patient\_flags\_attached.map(x, x.color)** `[]string` *required*

Mapped array of: Color of the flag

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.color)
```

```json Example theme={null}
[
"#FF0000"
]
```

**patient\_flags\_attached.map(x, x.created\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Timestamp when the flag was created

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.created_at)
```

```json Example theme={null}
[
"2024-01-15T10:30:00Z"
]
```

**patient\_flags\_attached.map(x, x.doctor)** `[]int64` *required*

Mapped array of: ID of doctor who owns the flag

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.doctor)
```

```json Example theme={null}
[
12345
]
```

**patient\_flags\_attached.map(x, x.flag\_id)** `[]int64` *required*

Mapped array of: Flag ID

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.flag_id)
```

```json Example theme={null}
[
1
]
```

**patient\_flags\_attached.map(x, x.name)** `[]string` *required*

Mapped array of: Name of the flag

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.name)
```

```json Example theme={null}
[
"High Priority"
]
```

**patient\_flags\_attached.map(x, x.priority)** `[]int64` *required*

Mapped array of: Priority level of the flag

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.priority)
```

```json Example theme={null}
[
1
]
```

**patient\_flags\_attached.map(x, x.updated\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Timestamp when the flag was last updated

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.updated_at)
```

```json Example theme={null}
[
"2024-01-15T10:30:00Z"
]
```

**patient\_flags\_attached.map(x, x.flag\_text)** `[]string` *required*

Mapped array of: Description of the patient flag

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.flag_text)
```

```json Example theme={null}
[
"Requires wheelchair access"
]
```

**patient\_flags\_attached.map(x, x.flag\_type)** `[]int64` *required*

Mapped array of: ID of the associated patient flag type

```json CEL theme={null}
$result_object_key.patient_flags_attached.map(x, x.flag_type)
```

```json Example theme={null}
[
2
]
```

**patient\_payment\_profile** `string`

Patient payment profile (Cash, Insurance, Insurance Out of Network, Auto Accident, or Worker's Comp)

```json CEL theme={null}
$result_object_key.patient_payment_profile
```

```json Example theme={null}
"Insurance"
```

**patient\_photo** `string`

Patient photo URL

```json CEL theme={null}
$result_object_key.patient_photo
```

```json Example theme={null}
"https://example.com/photo.jpg"
```

**patient\_photo\_date** `values.v1.Date`

Patient photo date (cannot be passed without patient\_photo)

```json CEL theme={null}
$result_object_key.patient_photo_date
```

```json Example theme={null}
"2024-01-10"
```

**patient\_status** `drchrono.v1.PatientStatus` *required*

Patient status: A (active), I (inactive), D (inactive-deceased)

```json CEL theme={null}
$result_object_key.patient_status
```

```json Example theme={null}
drchrono.v1.PatientStatus.PATIENT_STATUS_A
drchrono.v1.PatientStatus.PATIENT_STATUS_D
drchrono.v1.PatientStatus.PATIENT_STATUS_I
```

**preferred\_language** `drchrono.v1.PreferredLanguage` *required*

Preferred language (ISO 639 alpha-3 codes)

```json CEL theme={null}
$result_object_key.preferred_language
```

```json Example theme={null}
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** `string`

Preferred language code

```json CEL theme={null}
$result_object_key.preferred_language_code
```

```json Example theme={null}
"en"
```

**preferred\_language\_description** `string`

Preferred language description

```json CEL theme={null}
$result_object_key.preferred_language_description
```

```json Example theme={null}
"English"
```

**preferred\_pharmacies** `[]string` *required*

NCPDP IDs of patient's preferred pharmacies

```json CEL theme={null}
$result_object_key.preferred_pharmacies
```

```json Example theme={null}
[]
```

**primary\_care\_physician** `string`

Referring doctor for this patient

```json CEL theme={null}
$result_object_key.primary_care_physician
```

```json Example theme={null}
"Dr. Jane Smith"
```

**primary\_insurance** `object` *required*

Primary insurance information

```json CEL theme={null}
$result_object_key.primary_insurance
```

```json Example theme={null}
{
"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"
}
```

**primary\_insurance.insurance\_claim\_office\_number** `string`

Insurance office phone number

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_claim_office_number
```

```json Example theme={null}
"800-555-1234"
```

**primary\_insurance.insurance\_company** `string`

Insurance company name

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_company
```

```json Example theme={null}
"Blue Cross Blue Shield"
```

**primary\_insurance.insurance\_group\_name** `string`

Insurance group name

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_group_name
```

```json Example theme={null}
"Employer Health Plan"
```

**primary\_insurance.insurance\_group\_number** `string`

Insurance group number

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_group_number
```

```json Example theme={null}
"GRP12345"
```

**primary\_insurance.insurance\_id\_number** `string`

Insurance ID number

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_id_number
```

```json Example theme={null}
"XYZ123456789"
```

**primary\_insurance.insurance\_payer\_id** `string`

Insurance payer ID

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_payer_id
```

```json Example theme={null}
"00123"
```

**primary\_insurance.insurance\_plan\_name** `string`

Name of insurance plan

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_plan_name
```

```json Example theme={null}
"PPO Gold"
```

**primary\_insurance.insurance\_plan\_type** `string`

Type of insurance plan

```json CEL theme={null}
$result_object_key.primary_insurance.insurance_plan_type
```

```json Example theme={null}
"HM"
```

**primary\_insurance.is\_subscriber\_the\_patient** `bool` *required*

True if the insurance policy is under patient's own name

```json CEL theme={null}
$result_object_key.primary_insurance.is_subscriber_the_patient
```

```json Example theme={null}
true
```

**primary\_insurance.patient\_relationship\_to\_subscriber** `string`

HCFA/1500 individual relationship code

```json CEL theme={null}
$result_object_key.primary_insurance.patient_relationship_to_subscriber
```

```json Example theme={null}
"01"
```

**primary\_insurance.photo\_back** `string`

Photo of back of insurance card

```json CEL theme={null}
$result_object_key.primary_insurance.photo_back
```

```json Example theme={null}
"https://example.com/card_back.jpg"
```

**primary\_insurance.photo\_front** `string`

Photo of front of insurance card

```json CEL theme={null}
$result_object_key.primary_insurance.photo_front
```

```json Example theme={null}
"https://example.com/card_front.jpg"
```

**primary\_insurance.subscriber\_address** `string`

Subscriber address

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_address
```

```json Example theme={null}
"123 Main St"
```

**primary\_insurance.subscriber\_city** `string`

Subscriber city

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_city
```

```json Example theme={null}
"New York"
```

**primary\_insurance.subscriber\_country** `string`

Two-letter country code

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_country
```

```json Example theme={null}
"US"
```

**primary\_insurance.subscriber\_date\_of\_birth** `values.v1.Date`

Subscriber date of birth

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_date_of_birth
```

```json Example theme={null}
"1980-05-20"
```

**primary\_insurance.subscriber\_first\_name** `string`

Subscriber first name

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_first_name
```

```json Example theme={null}
"John"
```

**primary\_insurance.subscriber\_gender** `drchrono.v1.Gender` *required*

Subscriber gender - Male or Female

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_gender
```

```json Example theme={null}
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
```

**primary\_insurance.subscriber\_last\_name** `string`

Subscriber last name

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_last_name
```

```json Example theme={null}
"Doe"
```

**primary\_insurance.subscriber\_middle\_name** `string`

Subscriber middle name

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_middle_name
```

```json Example theme={null}
"Robert"
```

**primary\_insurance.subscriber\_social\_security** `string`

Subscriber social security number

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_social_security
```

```json Example theme={null}
"123-45-6789"
```

**primary\_insurance.subscriber\_state** `drchrono.v1.USState` *required*

Two-letter state code

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_state
```

```json Example theme={null}
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
```

**primary\_insurance.subscriber\_suffix** `string`

Subscriber suffix (e.g. II or III)

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_suffix
```

```json Example theme={null}
"Jr"
```

**primary\_insurance.subscriber\_zip\_code** `string`

Subscriber ZIP code

```json CEL theme={null}
$result_object_key.primary_insurance.subscriber_zip_code
```

```json Example theme={null}
"10001"
```

**pronouns** `string`

Patient pronouns

```json CEL theme={null}
$result_object_key.pronouns
```

```json Example theme={null}
"he/him"
```

**race** `drchrono.v1.Race` *required*

Patient race (blank, indian, asian, black, hawaiian, white, or declined)

```json CEL theme={null}
$result_object_key.race
```

```json Example theme={null}
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** `[]object` *required*

Race subcategories

```json CEL theme={null}
$result_object_key.race_subcategories
```

```json Example theme={null}
[
{
"code": "2028-9",
"description": "Asian Indian"
}
]
```

**race\_subcategories.map(x, x.code)** `[]string` *required*

Mapped array of: Race subcategory code

```json CEL theme={null}
$result_object_key.race_subcategories.map(x, x.code)
```

```json Example theme={null}
[
"2028-9"
]
```

**race\_subcategories.map(x, x.description)** `[]string` *required*

Mapped array of: Race subcategory description

```json CEL theme={null}
$result_object_key.race_subcategories.map(x, x.description)
```

```json Example theme={null}
[
"Asian Indian"
]
```

**referring\_doctor** `object` *required*

Referring doctor information

```json CEL theme={null}
$result_object_key.referring_doctor
```

```json Example theme={null}
{
"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** `string`

Referring doctor address

```json CEL theme={null}
$result_object_key.referring_doctor.address
```

```json Example theme={null}
"456 Medical Center Dr"
```

**referring\_doctor.email** `string`

Referring doctor email

```json CEL theme={null}
$result_object_key.referring_doctor.email
```

```json Example theme={null}
"dr.smith@hospital.com"
```

**referring\_doctor.fax** `string`

Referring doctor fax (format: xxx-xx-xxxx)

```json CEL theme={null}
$result_object_key.referring_doctor.fax
```

```json Example theme={null}
"555-12-3456"
```

**referring\_doctor.first\_name** `string`

Referring doctor first name

```json CEL theme={null}
$result_object_key.referring_doctor.first_name
```

```json Example theme={null}
"Robert"
```

**referring\_doctor.last\_name** `string`

Referring doctor last name

```json CEL theme={null}
$result_object_key.referring_doctor.last_name
```

```json Example theme={null}
"Smith"
```

**referring\_doctor.middle\_name** `string`

Referring doctor middle name

```json CEL theme={null}
$result_object_key.referring_doctor.middle_name
```

```json Example theme={null}
"James"
```

**referring\_doctor.npi** `string`

Referring doctor NPI number

```json CEL theme={null}
$result_object_key.referring_doctor.npi
```

```json Example theme={null}
"1234567890"
```

**referring\_doctor.phone** `string`

Referring doctor phone (format: xxx-xx-xxxx)

```json CEL theme={null}
$result_object_key.referring_doctor.phone
```

```json Example theme={null}
"555-98-7654"
```

**referring\_doctor.provider\_number** `string`

Provider number

```json CEL theme={null}
$result_object_key.referring_doctor.provider_number
```

```json Example theme={null}
"PROV12345"
```

**referring\_doctor.provider\_qualifier** `string`

Provider qualifier (State License #, Provider UPIN #, or Provider Commercial #)

```json CEL theme={null}
$result_object_key.referring_doctor.provider_qualifier
```

```json Example theme={null}
"0B"
```

**referring\_doctor.specialty** `string`

Referring doctor specialty

```json CEL theme={null}
$result_object_key.referring_doctor.specialty
```

```json Example theme={null}
"Cardiologist"
```

**referring\_doctor.suffix** `string`

Referring doctor suffix

```json CEL theme={null}
$result_object_key.referring_doctor.suffix
```

```json Example theme={null}
"MD"
```

**referring\_source** `string`

Referring source

```json CEL theme={null}
$result_object_key.referring_source
```

```json Example theme={null}
"Website"
```

**responsible\_party\_email** `string`

Responsible party email

```json CEL theme={null}
$result_object_key.responsible_party_email
```

```json Example theme={null}
"responsible@example.com"
```

**responsible\_party\_name** `string`

Responsible party name

```json CEL theme={null}
$result_object_key.responsible_party_name
```

```json Example theme={null}
"Mary Doe"
```

**responsible\_party\_phone** `string`

Responsible party phone number

```json CEL theme={null}
$result_object_key.responsible_party_phone
```

```json Example theme={null}
"555-555-5555"
```

**responsible\_party\_relation** `string`

Responsible party relationship to patient

```json CEL theme={null}
$result_object_key.responsible_party_relation
```

```json Example theme={null}
"Parent"
```

**secondary\_insurance** `object` *required*

Secondary insurance information

```json CEL theme={null}
$result_object_key.secondary_insurance
```

```json Example theme={null}
{
"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"
}
```

**secondary\_insurance.insurance\_claim\_office\_number** `string`

Insurance office phone number

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_claim_office_number
```

```json Example theme={null}
"800-555-1234"
```

**secondary\_insurance.insurance\_company** `string`

Insurance company name

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_company
```

```json Example theme={null}
"Blue Cross Blue Shield"
```

**secondary\_insurance.insurance\_group\_name** `string`

Insurance group name

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_group_name
```

```json Example theme={null}
"Employer Health Plan"
```

**secondary\_insurance.insurance\_group\_number** `string`

Insurance group number

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_group_number
```

```json Example theme={null}
"GRP12345"
```

**secondary\_insurance.insurance\_id\_number** `string`

Insurance ID number

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_id_number
```

```json Example theme={null}
"XYZ123456789"
```

**secondary\_insurance.insurance\_payer\_id** `string`

Insurance payer ID

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_payer_id
```

```json Example theme={null}
"00123"
```

**secondary\_insurance.insurance\_plan\_name** `string`

Name of insurance plan

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_plan_name
```

```json Example theme={null}
"PPO Gold"
```

**secondary\_insurance.insurance\_plan\_type** `string`

Type of insurance plan

```json CEL theme={null}
$result_object_key.secondary_insurance.insurance_plan_type
```

```json Example theme={null}
"HM"
```

**secondary\_insurance.is\_subscriber\_the\_patient** `bool` *required*

True if the insurance policy is under patient's own name

```json CEL theme={null}
$result_object_key.secondary_insurance.is_subscriber_the_patient
```

```json Example theme={null}
true
```

**secondary\_insurance.patient\_relationship\_to\_subscriber** `string`

HCFA/1500 individual relationship code

```json CEL theme={null}
$result_object_key.secondary_insurance.patient_relationship_to_subscriber
```

```json Example theme={null}
"01"
```

**secondary\_insurance.photo\_back** `string`

Photo of back of insurance card

```json CEL theme={null}
$result_object_key.secondary_insurance.photo_back
```

```json Example theme={null}
"https://example.com/card_back.jpg"
```

**secondary\_insurance.photo\_front** `string`

Photo of front of insurance card

```json CEL theme={null}
$result_object_key.secondary_insurance.photo_front
```

```json Example theme={null}
"https://example.com/card_front.jpg"
```

**secondary\_insurance.subscriber\_address** `string`

Subscriber address

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_address
```

```json Example theme={null}
"123 Main St"
```

**secondary\_insurance.subscriber\_city** `string`

Subscriber city

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_city
```

```json Example theme={null}
"New York"
```

**secondary\_insurance.subscriber\_country** `string`

Two-letter country code

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_country
```

```json Example theme={null}
"US"
```

**secondary\_insurance.subscriber\_date\_of\_birth** `values.v1.Date`

Subscriber date of birth

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_date_of_birth
```

```json Example theme={null}
"1980-05-20"
```

**secondary\_insurance.subscriber\_first\_name** `string`

Subscriber first name

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_first_name
```

```json Example theme={null}
"John"
```

**secondary\_insurance.subscriber\_gender** `drchrono.v1.Gender` *required*

Subscriber gender - Male or Female

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_gender
```

```json Example theme={null}
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
```

**secondary\_insurance.subscriber\_last\_name** `string`

Subscriber last name

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_last_name
```

```json Example theme={null}
"Doe"
```

**secondary\_insurance.subscriber\_middle\_name** `string`

Subscriber middle name

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_middle_name
```

```json Example theme={null}
"Robert"
```

**secondary\_insurance.subscriber\_social\_security** `string`

Subscriber social security number

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_social_security
```

```json Example theme={null}
"123-45-6789"
```

**secondary\_insurance.subscriber\_state** `drchrono.v1.USState` *required*

Two-letter state code

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_state
```

```json Example theme={null}
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
```

**secondary\_insurance.subscriber\_suffix** `string`

Subscriber suffix (e.g. II or III)

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_suffix
```

```json Example theme={null}
"Jr"
```

**secondary\_insurance.subscriber\_zip\_code** `string`

Subscriber ZIP code

```json CEL theme={null}
$result_object_key.secondary_insurance.subscriber_zip_code
```

```json Example theme={null}
"10001"
```

**social\_security\_number** `string`

Patient social security number

```json CEL theme={null}
$result_object_key.social_security_number
```

```json Example theme={null}
"123-45-6789"
```

**state** `string`

Patient state (two-letter abbreviation)

```json CEL theme={null}
$result_object_key.state
```

```json Example theme={null}
"CA"
```

**tertiary\_insurance** `object` *required*

Tertiary insurance information

```json CEL theme={null}
$result_object_key.tertiary_insurance
```

```json Example theme={null}
{
"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"
}
```

**tertiary\_insurance.insurance\_claim\_office\_number** `string`

Insurance office phone number

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_claim_office_number
```

```json Example theme={null}
"800-555-1234"
```

**tertiary\_insurance.insurance\_company** `string`

Insurance company name

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_company
```

```json Example theme={null}
"Blue Cross Blue Shield"
```

**tertiary\_insurance.insurance\_group\_name** `string`

Insurance group name

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_group_name
```

```json Example theme={null}
"Employer Health Plan"
```

**tertiary\_insurance.insurance\_group\_number** `string`

Insurance group number

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_group_number
```

```json Example theme={null}
"GRP12345"
```

**tertiary\_insurance.insurance\_id\_number** `string`

Insurance ID number

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_id_number
```

```json Example theme={null}
"XYZ123456789"
```

**tertiary\_insurance.insurance\_payer\_id** `string`

Insurance payer ID

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_payer_id
```

```json Example theme={null}
"00123"
```

**tertiary\_insurance.insurance\_plan\_name** `string`

Name of insurance plan

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_plan_name
```

```json Example theme={null}
"PPO Gold"
```

**tertiary\_insurance.insurance\_plan\_type** `string`

Type of insurance plan

```json CEL theme={null}
$result_object_key.tertiary_insurance.insurance_plan_type
```

```json Example theme={null}
"HM"
```

**tertiary\_insurance.is\_subscriber\_the\_patient** `bool` *required*

True if the insurance policy is under patient's own name

```json CEL theme={null}
$result_object_key.tertiary_insurance.is_subscriber_the_patient
```

```json Example theme={null}
true
```

**tertiary\_insurance.patient\_relationship\_to\_subscriber** `string`

HCFA/1500 individual relationship code

```json CEL theme={null}
$result_object_key.tertiary_insurance.patient_relationship_to_subscriber
```

```json Example theme={null}
"01"
```

**tertiary\_insurance.photo\_back** `string`

Photo of back of insurance card

```json CEL theme={null}
$result_object_key.tertiary_insurance.photo_back
```

```json Example theme={null}
"https://example.com/card_back.jpg"
```

**tertiary\_insurance.photo\_front** `string`

Photo of front of insurance card

```json CEL theme={null}
$result_object_key.tertiary_insurance.photo_front
```

```json Example theme={null}
"https://example.com/card_front.jpg"
```

**tertiary\_insurance.subscriber\_address** `string`

Subscriber address

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_address
```

```json Example theme={null}
"123 Main St"
```

**tertiary\_insurance.subscriber\_city** `string`

Subscriber city

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_city
```

```json Example theme={null}
"New York"
```

**tertiary\_insurance.subscriber\_country** `string`

Two-letter country code

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_country
```

```json Example theme={null}
"US"
```

**tertiary\_insurance.subscriber\_date\_of\_birth** `values.v1.Date`

Subscriber date of birth

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_date_of_birth
```

```json Example theme={null}
"1980-05-20"
```

**tertiary\_insurance.subscriber\_first\_name** `string`

Subscriber first name

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_first_name
```

```json Example theme={null}
"John"
```

**tertiary\_insurance.subscriber\_gender** `drchrono.v1.Gender` *required*

Subscriber gender - Male or Female

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_gender
```

```json Example theme={null}
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
```

**tertiary\_insurance.subscriber\_last\_name** `string`

Subscriber last name

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_last_name
```

```json Example theme={null}
"Doe"
```

**tertiary\_insurance.subscriber\_middle\_name** `string`

Subscriber middle name

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_middle_name
```

```json Example theme={null}
"Robert"
```

**tertiary\_insurance.subscriber\_social\_security** `string`

Subscriber social security number

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_social_security
```

```json Example theme={null}
"123-45-6789"
```

**tertiary\_insurance.subscriber\_state** `drchrono.v1.USState` *required*

Two-letter state code

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_state
```

```json Example theme={null}
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
```

**tertiary\_insurance.subscriber\_suffix** `string`

Subscriber suffix (e.g. II or III)

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_suffix
```

```json Example theme={null}
"Jr"
```

**tertiary\_insurance.subscriber\_zip\_code** `string`

Subscriber ZIP code

```json CEL theme={null}
$result_object_key.tertiary_insurance.subscriber_zip_code
```

```json Example theme={null}
"10001"
```

**updated\_at** `timing.v1.Timestamp` *required*

Timestamp when the patient was last updated

```json CEL theme={null}
$result_object_key.updated_at
```

```json Example theme={null}
"2024-01-15T10:30:00Z"
```

**workers\_comp\_insurance** `object` *required*

Workers compensation insurance information

```json CEL theme={null}
$result_object_key.workers_comp_insurance
```

```json Example theme={null}
{
"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"
}
```

**workers\_comp\_insurance.property\_and\_casualty\_agency\_claim\_number** `string`

Property and casualty agency claim number

```json CEL theme={null}
$result_object_key.workers_comp_insurance.property_and_casualty_agency_claim_number
```

```json Example theme={null}
"PCA-2024-001"
```

**workers\_comp\_insurance.workers\_comp\_carrier\_code** `string`

Workers comp carrier code

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_carrier_code
```

```json Example theme={null}
"WCC123"
```

**workers\_comp\_insurance.workers\_comp\_case\_number** `string`

Workers comp case number

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_case_number
```

```json Example theme={null}
"WC-2024-00123"
```

**workers\_comp\_insurance.workers\_comp\_company** `string`

Workers comp insurance company

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_company
```

```json Example theme={null}
"Hartford"
```

**workers\_comp\_insurance.workers\_comp\_date\_of\_accident** `values.v1.Date`

Date of the workers comp accident

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_date_of_accident
```

```json Example theme={null}
"2024-01-05"
```

**workers\_comp\_insurance.workers\_comp\_group\_name** `string`

Workers comp group name

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_group_name
```

```json Example theme={null}
"Industrial Workers"
```

**workers\_comp\_insurance.workers\_comp\_group\_number** `string`

Workers comp group number

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_group_number
```

```json Example theme={null}
"WCG456"
```

**workers\_comp\_insurance.workers\_comp\_notes** `string`

Notes about the workers comp claim

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_notes
```

```json Example theme={null}
"Injury occurred on job site"
```

**workers\_comp\_insurance.workers\_comp\_payer\_address** `string`

Workers comp payer address

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_payer_address
```

```json Example theme={null}
"100 Insurance Way"
```

**workers\_comp\_insurance.workers\_comp\_payer\_city** `string`

Workers comp payer city

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_payer_city
```

```json Example theme={null}
"Hartford"
```

**workers\_comp\_insurance.workers\_comp\_payer\_id** `string`

Workers comp payer ID

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_payer_id
```

```json Example theme={null}
"WCPAY001"
```

**workers\_comp\_insurance.workers\_comp\_payer\_state** `drchrono.v1.USState` *required*

Workers comp payer state

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_payer_state
```

```json Example theme={null}
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\_insurance.workers\_comp\_payer\_zip** `string`

Workers comp payer ZIP code

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_payer_zip
```

```json Example theme={null}
"06103"
```

**workers\_comp\_insurance.workers\_comp\_state\_of\_occurrence** `drchrono.v1.USState` *required*

State where the workers comp accident occurred

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_state_of_occurrence
```

```json Example theme={null}
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\_insurance.workers\_comp\_wcb** `string`

Workers compensation board number

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_wcb
```

```json Example theme={null}
"WCB12345"
```

**workers\_comp\_insurance.workers\_comp\_wcb\_rating\_code** `string`

Workers compensation board rating code

```json CEL theme={null}
$result_object_key.workers_comp_insurance.workers_comp_wcb_rating_code
```

```json Example theme={null}
"A1"
```

**zip\_code** `string`

Patient ZIP code

```json CEL theme={null}
$result_object_key.zip_code
```

```json Example theme={null}
"94102"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.