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

![images/elation.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/elation.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=06d58e76eb0b3a5e191b8fc13f4ba68a)

# Parameters

**Action** `Parameters`

**parameters**

**ID** `string`

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

**Caregiver Practice ID** `int64 (Practice)` *required*

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

**Date of Birth** `values.v1.Date` *required*

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

**First Name** `string` *required*

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

**Last Name** `string` *required*

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

**Primary Physician ID** `int64 (Physician)` *required*

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

**Sex** `elation.v1.Sex` *required*

`HI`
This field maps to the destination API `sex` field.

```json Allowed Enumeration Values theme={null}
SEX_MALE
SEX_FEMALE
SEX_OTHER
SEX_UNKNOWN
```

**Pronouns** `elation.v1.Pronouns`

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

```json Allowed Enumeration Values theme={null}
PRONOUNS_HE_HIM_HIS
PRONOUNS_SHE_HER_HERS
PRONOUNS_THEY_THEM_THEIRS
PRONOUNS_NOT_LISTED
```

**Preferred Pharmacy 1** `string`

This field maps to the destination API `preference.preferred_pharmacy_1` field.

**Preferred Pharmacy 2** `string`

This field maps to the destination API `preference.preferred_pharmacy_2` field.

**Emergency Contact First Name** `string`

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

**Emergency Contact Last Name** `string`

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

**Emergency Contact Phone** `string`

`PII`
This field maps to the destination API `emergency_contact.phone` field.

**Emergency Contact Relationship** `string`

This field maps to the destination API `emergency_contact.relationship` field.

**Emergency Contact Address Line 1** `string`

`PII`
This field maps to the destination API `emergency_contact.address_line1` field.

**Emergency Contact Address Line 2** `string`

`PII`
This field maps to the destination API `emergency_contact.address_line2` field.

**Emergency Contact City** `string`

`PII`
This field maps to the destination API `emergency_contact.city` field.

**Emergency Contact State** `string`

`PII`
This field maps to the destination API `emergency_contact.state` field.

**Emergency Contact ZIP** `string`

`PII`
This field maps to the destination API `emergency_contact.zip` field.

**Emergency Contact Notes** `string`

This field maps to the destination API `emergency_contact.notes` field.

**Primary Insurance Plan** `string`

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

**Primary Insurance Member ID** `string`

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

**Secondary Insurance Plan** `string`

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

**Secondary Insurance Member ID** `string`

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

**Tags** `[]string`

`HI`
This field maps to the destination API `tags` field.

**Notes** `string`

`HI`
This field maps to the destination API `notes` field.

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "actual_name": "Paulina Patient",
    "address": {
      "international_address": {
        "city_state_county_or_districts": [],
        "country": null,
        "lines": [],
        "postal_code": null
      },
      "us_address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "zip_code": null
      }
    },
    "caregiver_practice_id": "65540",
    "consents": [
      {
        "application": "healthix",
        "consented": true,
        "last_modified_at": "2016-05-02T11:57:41Z"
      }
    ],
    "created_at": "2016-05-02T11:57:41Z",
    "deleted_at": "2025-12-11T23:56:20Z",
    "dob": "1940-08-29",
    "email_addresses": "paul.patient@elationemr.com",
    "emergency_contact": {
      "address_line1": "101 Lane Street",
      "address_line2": "Apt 101",
      "city": "Madison",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": null,
      "relationship": "RELATIONSHIP_CHILD",
      "state": "WI",
      "zip": "53711"
    },
    "ethnicity": "ETHNICITY_NOT_HISPANIC_OR_LATINO",
    "first_name": "Paula",
    "gender_identity": "GENDER_IDENTITY_WOMAN",
    "guarantor": {
      "address_line1": "101 Lane Street",
      "city": "Madison",
      "email_address": "guarantor@example.com",
      "first_name": "Other",
      "id": "123456789",
      "last_name": "Test",
      "middle_name": "M",
      "phone_number": "555-456-7890",
      "relationship": "RELATIONSHIP_OTHER",
      "state": "WI",
      "zip": "53711"
    },
    "id": "64184451073",
    "last_name": "Patient",
    "legal_gender_marker": "LEGAL_GENDER_MARKER_FEMALE",
    "master_patient_id": "98765432",
    "merged_into_chart_id": "64184451099",
    "metadata": "{\"custom_field\": \"custom_value\"}",
    "middle_name": "P",
    "notes": "These are plaintext notes",
    "patient_status": {
      "deceased_date": "2023-02-23",
      "inactive_reason": "INACTIVE_REASON_OTHER",
      "last_status_changed_at": "2022-08-24T13:03:05",
      "notes": "my notes",
      "status": "PATIENT_STATUS_ACTIVE"
    },
    "phone_numbers": [],
    "preference": {
      "preferred_pharmacy_1": "PharmID123",
      "preferred_pharmacy_2": "PharmID456"
    },
    "preferred_language": "English",
    "preferred_service_location_id": "987654",
    "previous_name": {
      "first_name": "John",
      "last_name": "Doe",
      "middle_name": "Michael",
      "suffix": "III"
    },
    "primary_care_provider_id": "131074",
    "primary_care_provider_npi": "1234567893",
    "primary_email_address": "paul.patient@elationemr.com",
    "primary_insurance": {
      "address": "123 medicare st",
      "carrier": "Blue Cross",
      "city": "San Francisco",
      "copay": 25,
      "created_at": "2020-05-12T22:52:25Z",
      "deductible": 1000,
      "deleted_at": "2021-04-28T10:50:22Z",
      "extension": "123",
      "group_id": "test_group_id",
      "id": "140767609356371",
      "insurance_company_id": "70970048878",
      "insurance_plan_id": "70971687279",
      "insured_person_address": "550 15th St",
      "insured_person_city": "San Francisco",
      "insured_person_dob": "1940-08-29",
      "insured_person_first_name": "Paula",
      "insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
      "insured_person_id": "12345",
      "insured_person_last_name": "Patient",
      "insured_person_ssn": "123456789",
      "insured_person_state": "CA",
      "insured_person_zip": "94013",
      "member_id": "test_member_id",
      "payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
      "phone_number": "4155551234",
      "plan": "Blue Cross Blue Shield",
      "relationship_to_insured": "Self",
      "state": "CA",
      "suite": "Suite 500",
      "zip": "94104"
    },
    "primary_phone_number": "+15551231234",
    "primary_physician_id": "131074",
    "pronouns": "PRONOUNS_SHE_HER_HERS",
    "race": "RACE_CAUCASIAN",
    "secondary_insurance": {
      "address": "123 medicare st",
      "carrier": "Blue Cross",
      "city": "San Francisco",
      "copay": 25,
      "created_at": "2020-05-12T22:52:25Z",
      "deductible": 1000,
      "deleted_at": "2021-04-28T10:50:22Z",
      "extension": "123",
      "group_id": "test_group_id",
      "id": "140767609356371",
      "insurance_company_id": "70970048878",
      "insurance_plan_id": "70971687279",
      "insured_person_address": "550 15th St",
      "insured_person_city": "San Francisco",
      "insured_person_dob": "1940-08-29",
      "insured_person_first_name": "Paula",
      "insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
      "insured_person_id": "12345",
      "insured_person_last_name": "Patient",
      "insured_person_ssn": "123456789",
      "insured_person_state": "CA",
      "insured_person_zip": "94013",
      "member_id": "test_member_id",
      "payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
      "phone_number": "4155551234",
      "plan": "Blue Cross Blue Shield",
      "relationship_to_insured": "Self",
      "state": "CA",
      "suite": "Suite 500",
      "zip": "94104"
    },
    "sex": "SEX_FEMALE",
    "sexual_orientation": "SEXUAL_ORIENTATION_PREFER_NOT_TO_SAY",
    "sms_opt_in_status": true,
    "ssn": "123-45-6789",
    "tags": "PAID",
    "vip": false
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "actual_name": "Patient's preferred name if different from legal name.",
    "address": {
      "international_address": {
        "city_state_county_or_districts": null,
        "country": null,
        "lines": null,
        "postal_code": null
      },
      "us_address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "zip_code": null
      }
    },
    "caregiver_practice_id": "ID of the caregiver practice.",
    "consents": {
      "application": "Name of the application or system for which consent was recorded. Max length 255 characters.",
      "consented": "Flag indicating whether consent was given.",
      "last_modified_at": "Timestamp when the consent was last modified."
    },
    "created_at": "Timestamp when the patient record was created.",
    "deleted_at": "Timestamp when the patient record was deleted, if applicable.",
    "dob": "Patient's date of birth in YYYY-MM-DD format.",
    "email_addresses": "List of patient's email addresses.",
    "emergency_contact": {
      "address_line1": "Address line 1 for the emergency contact.",
      "address_line2": "Address line 2 for the emergency contact.",
      "city": "City information for the emergency contact.",
      "first_name": "First name of emergency contact. Max length 70 characters.",
      "last_name": "Last name of emergency contact. Max length 70 characters.",
      "phone_number": "Phone number of emergency contact. Max length 20 characters.",
      "relationship": "Relationship of emergency contact to the patient.",
      "state": "State information for the emergency contact.",
      "zip": "Zip information for the emergency contact."
    },
    "ethnicity": "Patient's ethnicity.",
    "first_name": "Patient's first name, given name, or forename.",
    "gender_identity": "Patient's gender identity.",
    "guarantor": {
      "address_line1": "Address line 1 for the guarantor.",
      "city": "City information for the guarantor.",
      "email_address": "Email address of the guarantor.",
      "first_name": "First name of the guarantor. Max length 70 characters.",
      "id": "Unique identifier for the guarantor.",
      "last_name": "Last name of the guarantor. Max length 70 characters.",
      "middle_name": "Middle name of the guarantor. Max length 50 characters.",
      "phone_number": "Phone number of the guarantor.",
      "relationship": "Relationship of the guarantor to the patient.",
      "state": "State information for the guarantor.",
      "zip": "Zip information for the guarantor."
    },
    "id": "Unique identifier for the patient in the Elation system.",
    "last_name": "Patient's last name, family name, or surname.",
    "legal_gender_marker": "Patient's legal gender marker.",
    "master_patient_id": "Master patient identifier used to link related patient records.",
    "merged_into_chart_id": "ID of the chart that this patient record was merged into, if applicable.",
    "metadata": "Additional metadata associated with the patient as a structured object. Can contain arbitrary key-value pairs.",
    "middle_name": "Patient's middle name, middle initial, or second given name.",
    "notes": "Additional notes about the patient.",
    "patient_status": {
      "deceased_date": "Date of patient's death, if applicable, in YYYY-MM-DD format.",
      "inactive_reason": "Reason for inactive status, if patient status is inactive.",
      "last_status_changed_at": "Timestamp of the last status change. Read-only.",
      "notes": "Additional notes regarding the patient's status.",
      "status": "Current status of the patient (active, deceased, inactive, or prospect)."
    },
    "phone_numbers": "List of patient's phone numbers. Note: elation limits this set to two phone numbers maximum.",
    "preference": {
      "preferred_pharmacy_1": "NCPDPID of the patient's primary preferred pharmacy.",
      "preferred_pharmacy_2": "NCPDPID of the patient's secondary preferred pharmacy."
    },
    "preferred_language": "Patient's preferred language.",
    "preferred_service_location_id": "ID of the patient's preferred service location.",
    "previous_name": {
      "first_name": "First name of the previous name.",
      "last_name": "Last name of the previous name.",
      "middle_name": "Middle name of the previous name.",
      "suffix": "Suffix of the previous name."
    },
    "primary_care_provider_id": "ID of the patient's primary care provider.",
    "primary_care_provider_npi": "National Provider Identifier (NPI) of the patient's primary care provider. Must be exactly 10 digits.",
    "primary_email_address": "The first email address stored on the Elation Patient",
    "primary_insurance": {
      "address": "Street address of the insurance company. Max length 200 characters.",
      "carrier": "Name of the insurance carrier. Max length 200 characters.",
      "city": "City of the insurance company. Max length 50 characters.",
      "copay": "Patient's copay amount for this insurance plan.",
      "created_at": "Timestamp when the insurance record was created. Read-only.",
      "deductible": "Patient's deductible amount for this insurance plan.",
      "deleted_at": "Timestamp when the insurance record was deleted, if applicable. Read-only.",
      "extension": "Phone extension for the insurance company. Max length 6 characters.",
      "group_id": "Group ID for the insurance. Max length 50 characters.",
      "id": "Unique identifier for the insurance record.",
      "insurance_company_id": "ID of the insurance company from the Insurance Company resource.",
      "insurance_plan_id": "ID of the insurance plan from the Insurance Plan resource.",
      "insured_person_address": "Address of the insured person. Max length 200 characters.",
      "insured_person_city": "City of the insured person. Max length 50 characters.",
      "insured_person_dob": "Date of birth of the insured person in string format.",
      "insured_person_first_name": "First name of the insured person. Max length 200 characters.",
      "insured_person_gender": "Gender marker of the insured person.",
      "insured_person_id": "ID of the insured person. Max length 50 characters.",
      "insured_person_last_name": "Last name of the insured person. Max length 200 characters.",
      "insured_person_ssn": "Social Security Number of the insured person. Must be exactly 9 digits.",
      "insured_person_state": "State of the insured person. Two-letter state code.",
      "insured_person_zip": "ZIP code of the insured person. Max length 9 characters.",
      "member_id": "Member/subscriber ID for the insurance. Max length 50 characters.",
      "payment_program": "Payment program category for this insurance.",
      "phone_number": "Contact phone number for the insurance company. Max length 20 characters.",
      "plan": "Name of the insurance plan. Max length 200 characters.",
      "relationship_to_insured": "Relationship of the patient to the insured person. Max length 20 characters.",
      "state": "State of the insurance company. Two-letter state code.",
      "suite": "Suite/unit for the insurance company address. Max length 35 characters.",
      "zip": "ZIP code of the insurance company. Max length 9 characters."
    },
    "primary_phone_number": "The first phone number stored on the Elation patient",
    "primary_physician_id": "ID of the patient's primary physician.",
    "pronouns": "Patient's preferred pronouns.",
    "race": "Patient's race.",
    "secondary_insurance": {
      "address": "Street address of the insurance company. Max length 200 characters.",
      "carrier": "Name of the insurance carrier. Max length 200 characters.",
      "city": "City of the insurance company. Max length 50 characters.",
      "copay": "Patient's copay amount for this insurance plan.",
      "created_at": "Timestamp when the insurance record was created. Read-only.",
      "deductible": "Patient's deductible amount for this insurance plan.",
      "deleted_at": "Timestamp when the insurance record was deleted, if applicable. Read-only.",
      "extension": "Phone extension for the insurance company. Max length 6 characters.",
      "group_id": "Group ID for the insurance. Max length 50 characters.",
      "id": "Unique identifier for the insurance record.",
      "insurance_company_id": "ID of the insurance company from the Insurance Company resource.",
      "insurance_plan_id": "ID of the insurance plan from the Insurance Plan resource.",
      "insured_person_address": "Address of the insured person. Max length 200 characters.",
      "insured_person_city": "City of the insured person. Max length 50 characters.",
      "insured_person_dob": "Date of birth of the insured person in string format.",
      "insured_person_first_name": "First name of the insured person. Max length 200 characters.",
      "insured_person_gender": "Gender marker of the insured person.",
      "insured_person_id": "ID of the insured person. Max length 50 characters.",
      "insured_person_last_name": "Last name of the insured person. Max length 200 characters.",
      "insured_person_ssn": "Social Security Number of the insured person. Must be exactly 9 digits.",
      "insured_person_state": "State of the insured person. Two-letter state code.",
      "insured_person_zip": "ZIP code of the insured person. Max length 9 characters.",
      "member_id": "Member/subscriber ID for the insurance. Max length 50 characters.",
      "payment_program": "Payment program category for this insurance.",
      "phone_number": "Contact phone number for the insurance company. Max length 20 characters.",
      "plan": "Name of the insurance plan. Max length 200 characters.",
      "relationship_to_insured": "Relationship of the patient to the insured person. Max length 20 characters.",
      "state": "State of the insurance company. Two-letter state code.",
      "suite": "Suite/unit for the insurance company address. Max length 35 characters.",
      "zip": "ZIP code of the insurance company. Max length 9 characters."
    },
    "sex": "Patient's biological sex.",
    "sexual_orientation": "Patient's sexual orientation.",
    "sms_opt_in_status": "Whether the patient has opted in to receive SMS messages.",
    "ssn": "Patient's Social Security Number.",
    "tags": "List of tags associated with the patient. Maximum of 10 tags, each with maximum length of 100 characters.",
    "vip": "Flag indicating whether the patient is a VIP. Feature must be enabled for practice."
  }
}
```

### Result Object Field Details

You can use the result of the action's data as inputs to downstream workflow actions.

Each fetch action requires an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

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

**Patient** `Fetch Action Response Object`

**fields**

**id** `string` *required*

`ID` Unique identifier for the patient in the Elation system.

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

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

**first\_name** `string` *required*

`PII` Patient's first name, given name, or forename.

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

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

**middle\_name** `string`

`PII` Patient's middle name, middle initial, or second given name.

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

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

**last\_name** `string` *required*

`PII` Patient's last name, family name, or surname.

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

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

**actual\_name** `string`

`PII` Patient's preferred name if different from legal name.

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

```json Example theme={null}
"Paulina Patient"
```

**gender\_identity** `elation.v1.GenderIdentity`

Patient's gender identity.

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

```json Example theme={null}
elation.v1.GenderIdentity.GENDER_IDENTITY_UNKNOWN
elation.v1.GenderIdentity.GENDER_IDENTITY_MAN
elation.v1.GenderIdentity.GENDER_IDENTITY_WOMAN
elation.v1.GenderIdentity.GENDER_IDENTITY_TRANSGENDER_MAN
elation.v1.GenderIdentity.GENDER_IDENTITY_TRANSGENDER_WOMAN
elation.v1.GenderIdentity.GENDER_IDENTITY_NONBINARY
elation.v1.GenderIdentity.GENDER_IDENTITY_OPTION_NOT_LISTED
elation.v1.GenderIdentity.GENDER_IDENTITY_PREFER_NOT_TO_SAY
elation.v1.GenderIdentity.GENDER_IDENTITY_TWO_SPIRIT
```

**legal\_gender\_marker** `elation.v1.LegalGenderMarker`

`HI` Patient's legal gender marker.

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

```json Example theme={null}
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_MALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_FEMALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_X
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_UNKNOWN
```

**pronouns** `elation.v1.Pronouns`

Patient's preferred pronouns.

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

```json Example theme={null}
elation.v1.Pronouns.PRONOUNS_HE_HIM_HIS
elation.v1.Pronouns.PRONOUNS_SHE_HER_HERS
elation.v1.Pronouns.PRONOUNS_THEY_THEM_THEIRS
elation.v1.Pronouns.PRONOUNS_NOT_LISTED
```

**sex** `elation.v1.Sex` *required*

`HI` Patient's biological sex.

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

```json Example theme={null}
elation.v1.Sex.SEX_MALE
elation.v1.Sex.SEX_FEMALE
elation.v1.Sex.SEX_OTHER
elation.v1.Sex.SEX_UNKNOWN
```

**sexual\_orientation** `elation.v1.SexualOrientation`

`HI` Patient's sexual orientation.

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

```json Example theme={null}
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_UNKNOWN
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_STRAIGHT
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_GAY
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_BISEXUAL
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_OPTION_NOT_LISTED
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_PREFER_NOT_TO_SAY
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_LESBIAN
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_QUEER
elation.v1.SexualOrientation.SEXUAL_ORIENTATION_ASEXUAL
```

**primary\_physician\_id** `string` *required*

ID of the patient's primary physician.

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

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

**caregiver\_practice\_id** `string` *required*

ID of the caregiver practice.

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

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

**preferred\_service\_location\_id** `string`

ID of the patient's preferred service location.

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

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

**dob** `values.v1.Date` *required*

`PII` Patient's date of birth in YYYY-MM-DD format.

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

```json Example theme={null}
"1940-08-29"
```

**ssn** `string`

`PII` Patient's Social Security Number.

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

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

**race** `elation.v1.Race`

Patient's race.

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

```json Example theme={null}
elation.v1.Race.RACE_NO_RACE_SPECIFIED
elation.v1.Race.RACE_AMERICAN_INDIAN_OR_ALASKA_NATIVE
elation.v1.Race.RACE_ASIAN
elation.v1.Race.RACE_BLACK_OR_AFRICAN_AMERICAN
elation.v1.Race.RACE_NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
elation.v1.Race.RACE_WHITE
elation.v1.Race.RACE_OTHER
elation.v1.Race.RACE_DECLINED_TO_SPECIFY
```

**preferred\_language** `string`

Patient's preferred language.

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

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

**ethnicity** `elation.v1.Ethnicity`

Patient's ethnicity.

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

```json Example theme={null}
elation.v1.Ethnicity.ETHNICITY_NO_ETHNICITY_SPECIFIED
elation.v1.Ethnicity.ETHNICITY_HISPANIC_OR_LATINO
elation.v1.Ethnicity.ETHNICITY_NOT_HISPANIC_OR_LATINO
elation.v1.Ethnicity.ETHNICITY_UNKNOWN
elation.v1.Ethnicity.ETHNICITY_DECLINED_TO_SPECIFY
```

**notes** `string`

`HI` Additional notes about the patient.

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

```json Example theme={null}
"These are plaintext notes"
```

**vip** `bool`

Flag indicating whether the patient is a VIP. Feature must be enabled for practice.

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

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

**address** `object`

`PII` Patient's address information including street, city, state, and zip code.

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

```json Example theme={null}
{
"international_address": {
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
}
```

**address.us\_address** `object`

*Description coming soon*

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

```json Example theme={null}
{
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
```

**address.us\_address.line1** `string`

*Description coming soon*

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

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

**address.us\_address.line2** `string`

*Description coming soon*

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

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

**address.us\_address.city** `string`

*Description coming soon*

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

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

**address.us\_address.state** `string`

*Description coming soon*

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

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

**address.us\_address.zip\_code** `string`

*Description coming soon*

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

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

**address.international\_address** `object`

*Description coming soon*

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

```json Example theme={null}
{
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
}
```

**address.international\_address.lines** `[]string`

*Description coming soon*

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

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

**address.international\_address.city\_state\_county\_or\_districts** `[]string`

*Description coming soon*

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

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

**address.international\_address.postal\_code** `string`

*Description coming soon*

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

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

**address.international\_address.country** `string`

*Description coming soon*

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

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

**phone\_numbers** `[]string` *required*

`PII` List of patient's phone numbers. Note: elation limits this set to two phone numbers maximum.

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

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

**email\_addresses** `[]string` *required*

`PII` List of patient's email addresses.

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

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

**guarantor** `object`

Information about the patient's guarantor, including contact details and relationship to patient.

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

```json Example theme={null}
{
"address_line1": "101 Lane Street",
"city": "Madison",
"email_address": "guarantor@example.com",
"first_name": "Other",
"id": "123456789",
"last_name": "Test",
"middle_name": "M",
"phone_number": "555-456-7890",
"relationship": "RELATIONSHIP_OTHER",
"state": "WI",
"zip": "53711"
}
```

**guarantor.id** `string`

`ID` Unique identifier for the guarantor.

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

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

**guarantor.address\_line1** `string`

`PII` Address line 1 for the guarantor.

```json CEL theme={null}
$result_object_key.guarantor.address_line1
```

```json Example theme={null}
"101 Lane Street"
```

**guarantor.city** `string`

`PII` City information for the guarantor.

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

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

**guarantor.state** `string`

`PII` State information for the guarantor.

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

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

**guarantor.zip** `string`

`PII` Zip information for the guarantor.

```json CEL theme={null}
$result_object_key.guarantor.zip
```

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

**guarantor.phone\_number** `string`

`PII` Phone number of the guarantor.

```json CEL theme={null}
$result_object_key.guarantor.phone_number
```

```json Example theme={null}
"555-456-7890"
```

**guarantor.email\_address** `string`

`PII` Email address of the guarantor.

```json CEL theme={null}
$result_object_key.guarantor.email_address
```

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

**guarantor.relationship** `elation.v1.Relationship`

Relationship of the guarantor to the patient.

```json CEL theme={null}
$result_object_key.guarantor.relationship
```

```json Example theme={null}
elation.v1.Relationship.RELATIONSHIP_CAREGIVER
elation.v1.Relationship.RELATIONSHIP_CHILD
elation.v1.Relationship.RELATIONSHIP_FRIEND
elation.v1.Relationship.RELATIONSHIP_GRANDPARENT
elation.v1.Relationship.RELATIONSHIP_GUARDIAN
elation.v1.Relationship.RELATIONSHIP_PARENT
elation.v1.Relationship.RELATIONSHIP_SIBLING
elation.v1.Relationship.RELATIONSHIP_SPOUSE
elation.v1.Relationship.RELATIONSHIP_OTHER
```

**guarantor.first\_name** `string`

`PII` First name of the guarantor. Max length 70 characters.

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

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

**guarantor.last\_name** `string`

`PII` Last name of the guarantor. Max length 70 characters.

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

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

**guarantor.middle\_name** `string`

`PII` Middle name of the guarantor. Max length 50 characters.

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

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

**primary\_insurance** `object`

Patient's primary insurance information, including carrier, plan, and insured person details.

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

```json Example theme={null}
{
"address": "123 medicare st",
"carrier": "Blue Cross",
"city": "San Francisco",
"copay": 25,
"created_at": "2020-05-12T22:52:25Z",
"deductible": 1000,
"deleted_at": "2021-04-28T10:50:22Z",
"extension": "123",
"group_id": "test_group_id",
"id": "140767609356371",
"insurance_company_id": "70970048878",
"insurance_plan_id": "70971687279",
"insured_person_address": "550 15th St",
"insured_person_city": "San Francisco",
"insured_person_dob": "1940-08-29",
"insured_person_first_name": "Paula",
"insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
"insured_person_id": "12345",
"insured_person_last_name": "Patient",
"insured_person_ssn": "123456789",
"insured_person_state": "CA",
"insured_person_zip": "94013",
"member_id": "test_member_id",
"payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
"phone_number": "4155551234",
"plan": "Blue Cross Blue Shield",
"relationship_to_insured": "Self",
"state": "CA",
"suite": "Suite 500",
"zip": "94104"
}
```

**primary\_insurance.id** `string`

`ID` Unique identifier for the insurance record.

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

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

**primary\_insurance.carrier** `string`

Name of the insurance carrier. Max length 200 characters.

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

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

**primary\_insurance.member\_id** `string`

`PII` Member/subscriber ID for the insurance. Max length 50 characters.

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

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

**primary\_insurance.group\_id** `string`

Group ID for the insurance. Max length 50 characters.

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

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

**primary\_insurance.plan** `string`

Name of the insurance plan. Max length 200 characters.

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

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

**primary\_insurance.phone\_number** `string`

`PII` Contact phone number for the insurance company. Max length 20 characters.

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

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

**primary\_insurance.extension** `string`

Phone extension for the insurance company. Max length 6 characters.

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

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

**primary\_insurance.address** `string`

`PII` Street address of the insurance company. Max length 200 characters.

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

```json Example theme={null}
"123 medicare st"
```

**primary\_insurance.suite** `string`

`PII` Suite/unit for the insurance company address. Max length 35 characters.

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

```json Example theme={null}
"Suite 500"
```

**primary\_insurance.city** `string`

`PII` City of the insurance company. Max length 50 characters.

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

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

**primary\_insurance.state** `string`

`PII` State of the insurance company. Two-letter state code.

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

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

**primary\_insurance.zip** `string`

`PII` ZIP code of the insurance company. Max length 9 characters.

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

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

**primary\_insurance.copay** `float64 (double)`

`HI` Patient's copay amount for this insurance plan.

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

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

**primary\_insurance.deductible** `float64 (double)`

`HI` Patient's deductible amount for this insurance plan.

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

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

**primary\_insurance.payment\_program** `elation.v1.PaymentProgram`

Payment program category for this insurance.

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

```json Example theme={null}
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_PART_B
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_ADVANTAGE
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICAID
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_HMSA
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_SFHP
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_OTHER
elation.v1.PaymentProgram.PAYMENT_PROGRAM_WORKERS_COMPENSATION
```

**primary\_insurance.insured\_person\_first\_name** `string`

`PII` First name of the insured person. Max length 200 characters.

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

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

**primary\_insurance.insured\_person\_last\_name** `string`

`PII` Last name of the insured person. Max length 200 characters.

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

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

**primary\_insurance.insured\_person\_address** `string`

`PII` Address of the insured person. Max length 200 characters.

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

```json Example theme={null}
"550 15th St"
```

**primary\_insurance.insured\_person\_city** `string`

`PII` City of the insured person. Max length 50 characters.

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

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

**primary\_insurance.insured\_person\_state** `string`

`PII` State of the insured person. Two-letter state code.

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

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

**primary\_insurance.insured\_person\_zip** `string`

`PII` ZIP code of the insured person. Max length 9 characters.

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

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

**primary\_insurance.insured\_person\_id** `string`

`ID` `PII` ID of the insured person. Max length 50 characters.

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

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

**primary\_insurance.insured\_person\_dob** `string`

`PII` Date of birth of the insured person in string format.

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

```json Example theme={null}
"1940-08-29"
```

**primary\_insurance.insured\_person\_gender** `elation.v1.LegalGenderMarker`

Gender marker of the insured person.

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

```json Example theme={null}
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_MALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_FEMALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_X
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_UNKNOWN
```

**primary\_insurance.insured\_person\_ssn** `string`

`PII` Social Security Number of the insured person. Must be exactly 9 digits.

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

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

**primary\_insurance.relationship\_to\_insured** `string`

`PII` Relationship of the patient to the insured person. Max length 20 characters.

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

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

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

ID of the insurance company from the Insurance Company resource.

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

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

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

`ID` `PII` ID of the insurance plan from the Insurance Plan resource.

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

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

**primary\_insurance.created\_at** `timing.v1.Timestamp`

Timestamp when the insurance record was created. Read-only.

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

```json Example theme={null}
"2020-05-12T22:52:25Z"
```

**primary\_insurance.deleted\_at** `timing.v1.Timestamp`

Timestamp when the insurance record was deleted, if applicable. Read-only.

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

```json Example theme={null}
"2021-04-28T10:50:22Z"
```

**secondary\_insurance** `object`

Patient's secondary insurance information, if applicable.

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

```json Example theme={null}
{
"address": "123 medicare st",
"carrier": "Blue Cross",
"city": "San Francisco",
"copay": 25,
"created_at": "2020-05-12T22:52:25Z",
"deductible": 1000,
"deleted_at": "2021-04-28T10:50:22Z",
"extension": "123",
"group_id": "test_group_id",
"id": "140767609356371",
"insurance_company_id": "70970048878",
"insurance_plan_id": "70971687279",
"insured_person_address": "550 15th St",
"insured_person_city": "San Francisco",
"insured_person_dob": "1940-08-29",
"insured_person_first_name": "Paula",
"insured_person_gender": "LEGAL_GENDER_MARKER_FEMALE",
"insured_person_id": "12345",
"insured_person_last_name": "Patient",
"insured_person_ssn": "123456789",
"insured_person_state": "CA",
"insured_person_zip": "94013",
"member_id": "test_member_id",
"payment_program": "PAYMENT_PROGRAM_COMMERCIAL_OTHER",
"phone_number": "4155551234",
"plan": "Blue Cross Blue Shield",
"relationship_to_insured": "Self",
"state": "CA",
"suite": "Suite 500",
"zip": "94104"
}
```

**secondary\_insurance.id** `string`

`ID` Unique identifier for the insurance record.

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

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

**secondary\_insurance.carrier** `string`

Name of the insurance carrier. Max length 200 characters.

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

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

**secondary\_insurance.member\_id** `string`

`PII` Member/subscriber ID for the insurance. Max length 50 characters.

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

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

**secondary\_insurance.group\_id** `string`

Group ID for the insurance. Max length 50 characters.

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

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

**secondary\_insurance.plan** `string`

Name of the insurance plan. Max length 200 characters.

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

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

**secondary\_insurance.phone\_number** `string`

`PII` Contact phone number for the insurance company. Max length 20 characters.

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

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

**secondary\_insurance.extension** `string`

Phone extension for the insurance company. Max length 6 characters.

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

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

**secondary\_insurance.address** `string`

`PII` Street address of the insurance company. Max length 200 characters.

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

```json Example theme={null}
"123 medicare st"
```

**secondary\_insurance.suite** `string`

`PII` Suite/unit for the insurance company address. Max length 35 characters.

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

```json Example theme={null}
"Suite 500"
```

**secondary\_insurance.city** `string`

`PII` City of the insurance company. Max length 50 characters.

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

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

**secondary\_insurance.state** `string`

`PII` State of the insurance company. Two-letter state code.

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

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

**secondary\_insurance.zip** `string`

`PII` ZIP code of the insurance company. Max length 9 characters.

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

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

**secondary\_insurance.copay** `float64 (double)`

`HI` Patient's copay amount for this insurance plan.

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

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

**secondary\_insurance.deductible** `float64 (double)`

`HI` Patient's deductible amount for this insurance plan.

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

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

**secondary\_insurance.payment\_program** `elation.v1.PaymentProgram`

Payment program category for this insurance.

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

```json Example theme={null}
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_PART_B
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICARE_ADVANTAGE
elation.v1.PaymentProgram.PAYMENT_PROGRAM_MEDICAID
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_HMSA
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_SFHP
elation.v1.PaymentProgram.PAYMENT_PROGRAM_COMMERCIAL_OTHER
elation.v1.PaymentProgram.PAYMENT_PROGRAM_WORKERS_COMPENSATION
```

**secondary\_insurance.insured\_person\_first\_name** `string`

`PII` First name of the insured person. Max length 200 characters.

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

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

**secondary\_insurance.insured\_person\_last\_name** `string`

`PII` Last name of the insured person. Max length 200 characters.

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

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

**secondary\_insurance.insured\_person\_address** `string`

`PII` Address of the insured person. Max length 200 characters.

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

```json Example theme={null}
"550 15th St"
```

**secondary\_insurance.insured\_person\_city** `string`

`PII` City of the insured person. Max length 50 characters.

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

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

**secondary\_insurance.insured\_person\_state** `string`

`PII` State of the insured person. Two-letter state code.

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

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

**secondary\_insurance.insured\_person\_zip** `string`

`PII` ZIP code of the insured person. Max length 9 characters.

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

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

**secondary\_insurance.insured\_person\_id** `string`

`ID` `PII` ID of the insured person. Max length 50 characters.

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

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

**secondary\_insurance.insured\_person\_dob** `string`

`PII` Date of birth of the insured person in string format.

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

```json Example theme={null}
"1940-08-29"
```

**secondary\_insurance.insured\_person\_gender** `elation.v1.LegalGenderMarker`

Gender marker of the insured person.

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

```json Example theme={null}
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_MALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_FEMALE
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_X
elation.v1.LegalGenderMarker.LEGAL_GENDER_MARKER_UNKNOWN
```

**secondary\_insurance.insured\_person\_ssn** `string`

`PII` Social Security Number of the insured person. Must be exactly 9 digits.

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

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

**secondary\_insurance.relationship\_to\_insured** `string`

`PII` Relationship of the patient to the insured person. Max length 20 characters.

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

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

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

ID of the insurance company from the Insurance Company resource.

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

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

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

`ID` `PII` ID of the insurance plan from the Insurance Plan resource.

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

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

**secondary\_insurance.created\_at** `timing.v1.Timestamp`

Timestamp when the insurance record was created. Read-only.

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

```json Example theme={null}
"2020-05-12T22:52:25Z"
```

**secondary\_insurance.deleted\_at** `timing.v1.Timestamp`

Timestamp when the insurance record was deleted, if applicable. Read-only.

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

```json Example theme={null}
"2021-04-28T10:50:22Z"
```

**patient\_status** `object`

Current status of the patient (active, deceased, inactive, or prospect) with additional status-related information.

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

```json Example theme={null}
{
"deceased_date": "2023-02-23",
"inactive_reason": "INACTIVE_REASON_OTHER",
"last_status_changed_at": "2022-08-24T13:03:05",
"notes": "my notes",
"status": "PATIENT_STATUS_ACTIVE"
}
```

**patient\_status.status** `elation.v1.PatientStatusEnum`

Current status of the patient (active, deceased, inactive, or prospect).

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

```json Example theme={null}
elation.v1.PatientStatusEnum.PATIENT_STATUS_ACTIVE
elation.v1.PatientStatusEnum.PATIENT_STATUS_DECEASED
elation.v1.PatientStatusEnum.PATIENT_STATUS_INACTIVE
elation.v1.PatientStatusEnum.PATIENT_STATUS_PROSPECT
```

**patient\_status.deceased\_date** `values.v1.Date`

`HI` Date of patient's death, if applicable, in YYYY-MM-DD format.

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

```json Example theme={null}
"2023-02-23"
```

**patient\_status.inactive\_reason** `elation.v1.InactiveReason`

Reason for inactive status, if patient status is inactive.

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

```json Example theme={null}
elation.v1.InactiveReason.INACTIVE_REASON_OTHER
elation.v1.InactiveReason.INACTIVE_REASON_PATIENT_LEFT_ON_BAD_TERMS
elation.v1.InactiveReason.INACTIVE_REASON_PATIENT_LEFT_ON_GOOD_TERMS
elation.v1.InactiveReason.INACTIVE_REASON_PRACTICE_ENDED_RELATIONSHIP
elation.v1.InactiveReason.INACTIVE_REASON_UNKNOWN
```

**patient\_status.notes** `string`

`HI` Additional notes regarding the patient's status.

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

```json Example theme={null}
"my notes"
```

**patient\_status.last\_status\_changed\_at** `timing.v1.Timestamp`

Timestamp of the last status change. Read-only.

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

```json Example theme={null}
"2022-08-24T13:03:05"
```

**consents** `[]object` *required*

List of consent records for the patient. Each contains consent status, modification date, and application name.

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

```json Example theme={null}
[
{
"application": "healthix",
"consented": true,
"last_modified_at": "2016-05-02T11:57:41Z"
}
]
```

**consents.map(x, x.consented)** `[]bool` *required*

Mapped array of: Flag indicating whether consent was given.

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

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

**consents.map(x, x.last\_modified\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Timestamp when the consent was last modified.

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

```json Example theme={null}
[
"2016-05-02T11:57:41Z"
]
```

**consents.map(x, x.application)** `[]string` *required*

Mapped array of: Name of the application or system for which consent was recorded. Max length 255 characters.

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

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

**preference** `object`

Patient's preferences, such as preferred pharmacies. Contains up to two preferred pharmacy identifiers.

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

```json Example theme={null}
{
"preferred_pharmacy_1": "PharmID123",
"preferred_pharmacy_2": "PharmID456"
}
```

**preference.preferred\_pharmacy\_1** `string`

`HI` NCPDPID of the patient's primary preferred pharmacy.

```json CEL theme={null}
$result_object_key.preference.preferred_pharmacy_1
```

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

**preference.preferred\_pharmacy\_2** `string`

`HI` NCPDPID of the patient's secondary preferred pharmacy.

```json CEL theme={null}
$result_object_key.preference.preferred_pharmacy_2
```

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

**emergency\_contact** `object`

Patient's emergency contact information including name, relationship, phone, and address details.

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

```json Example theme={null}
{
"address_line1": "101 Lane Street",
"address_line2": "Apt 101",
"city": "Madison",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"relationship": "RELATIONSHIP_CHILD",
"state": "WI",
"zip": "53711"
}
```

**emergency\_contact.first\_name** `string`

`PII` First name of emergency contact. Max length 70 characters.

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

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

**emergency\_contact.last\_name** `string`

`PII` Last name of emergency contact. Max length 70 characters.

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

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

**emergency\_contact.relationship** `elation.v1.Relationship`

`HI` Relationship of emergency contact to the patient.

```json CEL theme={null}
$result_object_key.emergency_contact.relationship
```

```json Example theme={null}
elation.v1.Relationship.RELATIONSHIP_CAREGIVER
elation.v1.Relationship.RELATIONSHIP_CHILD
elation.v1.Relationship.RELATIONSHIP_FRIEND
elation.v1.Relationship.RELATIONSHIP_GRANDPARENT
elation.v1.Relationship.RELATIONSHIP_GUARDIAN
elation.v1.Relationship.RELATIONSHIP_PARENT
elation.v1.Relationship.RELATIONSHIP_SIBLING
elation.v1.Relationship.RELATIONSHIP_SPOUSE
elation.v1.Relationship.RELATIONSHIP_OTHER
```

**emergency\_contact.phone\_number** `string`

`PII` Phone number of emergency contact. Max length 20 characters.

```json CEL theme={null}
$result_object_key.emergency_contact.phone_number
```

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

**emergency\_contact.address\_line1** `string`

`PII` Address line 1 for the emergency contact.

```json CEL theme={null}
$result_object_key.emergency_contact.address_line1
```

```json Example theme={null}
"101 Lane Street"
```

**emergency\_contact.address\_line2** `string`

`PII` Address line 2 for the emergency contact.

```json CEL theme={null}
$result_object_key.emergency_contact.address_line2
```

```json Example theme={null}
"Apt 101"
```

**emergency\_contact.city** `string`

`PII` City information for the emergency contact.

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

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

**emergency\_contact.state** `string`

`PII` State information for the emergency contact.

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

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

**emergency\_contact.zip** `string`

`PII` Zip information for the emergency contact.

```json CEL theme={null}
$result_object_key.emergency_contact.zip
```

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

**primary\_care\_provider\_npi** `string`

National Provider Identifier (NPI) of the patient's primary care provider. Must be exactly 10 digits.

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

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

**previous\_name** `object`

Patient's previous first name, if changed.

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

```json Example theme={null}
{
"first_name": "John",
"last_name": "Doe",
"middle_name": "Michael",
"suffix": "III"
}
```

**previous\_name.first\_name** `string`

First name of the previous name.

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

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

**previous\_name.last\_name** `string`

Last name of the previous name.

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

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

**previous\_name.middle\_name** `string`

Middle name of the previous name.

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

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

**previous\_name.suffix** `string`

Suffix of the previous name.

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

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

**master\_patient\_id** `string`

`ID` Master patient identifier used to link related patient records.

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

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

**metadata** `object`

`HI` `ID` `PII` Additional metadata associated with the patient as a structured object. Can contain arbitrary key-value pairs.

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

```json Example theme={null}
"{\"custom_field\": \"custom_value\"}"
```

**tags** `[]string` *required*

`HI` List of tags associated with the patient. Maximum of 10 tags, each with maximum length of 100 characters.

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

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

**primary\_care\_provider\_id** `string`

ID of the patient's primary care provider.

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

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

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

Timestamp when the patient record was created.

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

```json Example theme={null}
"2016-05-02T11:57:41Z"
```

**merged\_into\_chart\_id** `string`

`ID` ID of the chart that this patient record was merged into, if applicable.

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

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

**sms\_opt\_in\_status** `bool` *required*

Whether the patient has opted in to receive SMS messages.

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

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

**primary\_email\_address** `string`

`PII` The first email address stored on the Elation Patient

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

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

**primary\_phone\_number** `string`

`PII` The first phone number stored on the Elation patient

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

```json Example theme={null}
"+15551231234"
```

**deleted\_at** `timing.v1.Timestamp`

Timestamp when the patient record was deleted, if applicable.

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

```json Example theme={null}
"2025-12-11T23:56:20Z"
```


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