> ## 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 Hint Health

![images/hint\_health.svg](https://mintcdn.com/morfhealth/KAegzeO2rhNgE8aD/images/hint_health.svg?fit=max\&auto=format\&n=KAegzeO2rhNgE8aD\&q=85\&s=73ef426b5efecb68f325efcea1719198)

# Parameters

**Action** `Parameters`

**parameters**

**ID** `string`

`ID`
This field maps to the destination API `id` 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.

**Email** `string`

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

**Sex** `string`

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

**Gender Identity** `string`

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

**Date Of Birth** `string`

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

**Phone** `string`

`PII`
This field maps to the destination API `phones[0].number` field.

**Address Line 1** `string`

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

**Address Line 2** `string`

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

**Address City** `string`

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

**Address State** `string`

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

**Address Zip** `string`

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

**Address Country** `string`

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

**Integration Record ID** `string`

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

**Preferred Language** `string`

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

**Patient Agreement Accepted** `bool`

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

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "account": {
      "name": "Gordon Thomas Sumner",
      "past_due_in_cents": 0
    },
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "age": 60,
    "chosen_first_name": "Alex",
    "chosen_last_name": "Smith",
    "chosen_middle_name": "Jordan",
    "chosen_suffix": "Jr.",
    "chosen_title": "Dr.",
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "created_at": null,
    "dob": null,
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": null,
    "email": "bass_man@bumblebeeinc.com",
    "external_link_id": "ext-12345",
    "external_records": [
      {
        "external_id": "ext-98765",
        "source": "ehr_system"
      }
    ],
    "first_name": "Gordon",
    "gender": "male",
    "gender_identity": "man",
    "gender_other": "non-binary",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": null,
    "id": "pat-ab12C345DeF6",
    "import_id": "imp-ab12C345DeF6",
    "import_source": "csv_upload",
    "joined_practice_date": null,
    "known_practice": {
      "id": "prc-ab12C345DeF6",
      "name": "Downtown Medical"
    },
    "last_name": "Sumner",
    "lead_source": {
      "created_at": null,
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "updated_at": null
    },
    "lead_source_other": "Downtown marketing event",
    "location": {
      "address_city": "New York",
      "address_country": "United States",
      "address_latitude": "40.7227998",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_longitude": "-73.9892241",
      "address_state": "NY",
      "address_zip": "10002",
      "distance": "5.2 miles",
      "id": "loc-ab12C345DeF6",
      "location_group": {
        "created_at": null,
        "id": "prg-ab12C345DeF6",
        "integration_record_id": "int-ab12C345DeF6",
        "name": "Downtown Location Group",
        "updated_at": null
      },
      "name": "San Francisco HQ",
      "phone_number": "+15551234567",
      "virtual": false
    },
    "location_group": {
      "created_at": null,
      "id": "prg-ab12C345DeF6",
      "integration_record_id": "int-ab12C345DeF6",
      "name": "Downtown Location Group",
      "updated_at": null
    },
    "master_record_sponsor": "creg-ab12C345DeF6",
    "membership_status": "active",
    "memberships": [
      {
        "company": {
          "id": "com-ab12C345DeF6",
          "name": "Schmoogle Inc."
        },
        "division": {
          "id": "div-ab12C345DeF6",
          "name": "division 20"
        },
        "end_date": null,
        "enrollment_requested_on": null,
        "enrollment_status": "active",
        "member_type": "spouse",
        "payer": {
          "id": "pat-ab12C345DeF6",
          "name": "Gordon Thomas Sumner"
        },
        "plan": {
          "id": "pln-ab12C345DeF6",
          "name": "Membership"
        },
        "start_date": null,
        "status": "active",
        "uses_tobacco": false
      }
    ],
    "merged_into": {
      "id": "pat-zz99Y888XwV7",
      "name": "Gordon Thomas Sumner"
    },
    "middle_name": "Thomas",
    "name": "Gordon Thomas Sumner",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "phones": [
      {
        "number": "+15553050051",
        "type": "mobile"
      }
    ],
    "practitioner": {
      "accepts_enrollments_from_employer": "yes",
      "accepts_enrollments_from_retail": "yes",
      "bio": "Board-certified family medicine physician with 15 years of experience.",
      "created_at": null,
      "education": "MD, Johns Hopkins University",
      "email": "dr.smith@practice.com",
      "gender": "female",
      "gender_other": "non-binary",
      "id": "doc-ab12C345DeF6",
      "integration_record_id": "int-ab12C345DeF6",
      "locations": [
        {
          "address_city": "New York",
          "address_country": "United States",
          "address_latitude": "40.7227998",
          "address_line1": "157 E Houston St",
          "address_line2": "Suite 2402",
          "address_longitude": "-73.9892241",
          "address_state": "NY",
          "address_zip": "10002",
          "distance": "5.2 miles",
          "id": "loc-ab12C345DeF6",
          "location_group": {
            "created_at": null,
            "id": "prg-ab12C345DeF6",
            "integration_record_id": "int-ab12C345DeF6",
            "name": "Downtown Location Group",
            "updated_at": null
          },
          "name": "San Francisco HQ",
          "phone_number": "+15551234567",
          "virtual": false
        }
      ],
      "max_patient_age": "65",
      "min_patient_age": "18",
      "name": "Dr. Jane Smith",
      "npi": {
        "id": "1234567890",
        "name": "Dr. Jane Smith"
      },
      "online_signup_visibility": "visible",
      "panel_size": 250,
      "panel_size_limit": 500,
      "photo_url": "https://app.hint.com/photos/doc-ab12C345DeF6.jpg",
      "specialties": [
        {
          "id": "spc-ab12C345DeF6",
          "name": "Family Medicine"
        }
      ],
      "updated_at": null
    },
    "practitioner_group": {
      "created_at": null,
      "id": "prg-ab12C345DeF6",
      "integration_record_id": "int-ab12C345DeF6",
      "name": "Downtown Location Group",
      "updated_at": null
    },
    "preferred_language": "en",
    "pronouns": "he/him",
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "sex": "male",
    "sponsorships": [
      {
        "company": {
          "id": "com-ab12C345DeF6",
          "name": "Schmoogle Inc."
        },
        "external_id": "ext_id_from_another_system012345",
        "family": {
          "id": "cac-ab12C345DeF6",
          "name": "Sumner Family"
        },
        "id": "creg-ab12C345DeF6",
        "is_subscriber": true,
        "type": "spouse"
      }
    ],
    "suffix": "Jr.",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": null,
    "uses_tobacco": false
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "account": {
      "name": "Name on the billing account",
      "past_due_in_cents": "Amount past due in cents"
    },
    "address_city": "City of the patient's address",
    "address_country": "Country of the patient's address",
    "address_line1": "First line of the patient's address",
    "address_line2": "Second line of the patient's address",
    "address_state": "State of the patient's address",
    "address_zip": "ZIP code of the patient's address",
    "age": "Age of the patient",
    "chosen_first_name": "Patient's chosen or preferred first name",
    "chosen_last_name": "Patient's chosen or preferred last name",
    "chosen_middle_name": "Patient's chosen or preferred middle name",
    "chosen_suffix": "Patient's chosen or preferred suffix",
    "chosen_title": "Patient's chosen or preferred title",
    "company": {
      "id": "Unique identifier for the company",
      "name": "Name of the company"
    },
    "created_at": "Timestamp when the patient record was created",
    "dob": "Patient's date of birth",
    "electronic_communication_consent_accepted": "Whether the patient accepted electronic communication consent",
    "electronic_communication_consent_accepted_at": "Timestamp when the patient accepted electronic communication consent",
    "email": "Patient's email address",
    "external_link_id": "External link identifier for the patient",
    "external_records": {
      "external_id": "External identifier in the source system",
      "source": "Source system of the external record"
    },
    "first_name": "Patient's first name",
    "gender": "Patient's gender",
    "gender_identity": "Patient's gender identity",
    "gender_other": "Patient's gender if not covered by standard options",
    "health_insurance_group_id": "Health insurance group ID",
    "health_insurance_member_id": "Health insurance member ID",
    "health_insurance_payer_id": "Health insurance payer ID",
    "health_insurance_payer_name": "Health insurance payer name",
    "hipaa_authorization_accepted": "Whether the patient accepted the HIPAA authorization",
    "hipaa_authorization_accepted_at": "Timestamp when the patient accepted the HIPAA authorization",
    "id": "Unique identifier for the patient",
    "import_id": "Import batch identifier",
    "import_source": "Source system of the import",
    "joined_practice_date": "Date the patient joined the practice",
    "known_practice": {
      "id": "Unique identifier for the known practice",
      "name": "Name of the known practice"
    },
    "last_name": "Patient's last name",
    "lead_source": {
      "created_at": "Timestamp when the lead source was created",
      "id": "Unique identifier for the lead source",
      "name": "Name of the lead source",
      "updated_at": "Timestamp when the lead source was last updated"
    },
    "lead_source_other": "Description of the lead source when 'Other' is selected",
    "location": {
      "address_city": "City of the location's address",
      "address_country": "Country of the location's address",
      "address_latitude": "Latitude of the location's address",
      "address_line1": "First line of the location's address",
      "address_line2": "Second line of the location's address",
      "address_longitude": "Longitude of the location's address",
      "address_state": "State of the location's address",
      "address_zip": "ZIP code of the location's address",
      "distance": "Distance from the patient to the location",
      "id": "Unique identifier for the location",
      "location_group": {
        "created_at": "Timestamp when the location group was created",
        "id": "Unique identifier for the location group",
        "integration_record_id": "Integration record identifier for the location group",
        "name": "Name of the location group",
        "updated_at": "Timestamp when the location group was last updated"
      },
      "name": "Name of the location",
      "phone_number": "Phone number of the location",
      "virtual": "Whether the location is virtual"
    },
    "location_group": {
      "created_at": "Timestamp when the location group was created",
      "id": "Unique identifier for the location group",
      "integration_record_id": "Integration record identifier for the location group",
      "name": "Name of the location group",
      "updated_at": "Timestamp when the location group was last updated"
    },
    "master_record_sponsor": "Master record sponsor identifier",
    "membership_status": "Current membership status of the patient",
    "memberships": {
      "company": {
        "id": "Unique identifier for the company",
        "name": "Name of the company"
      },
      "division": {
        "id": "Unique identifier for the division",
        "name": "Name of the division"
      },
      "end_date": "End date of the membership",
      "enrollment_requested_on": "Date when enrollment was requested",
      "enrollment_status": "Current enrollment status",
      "member_type": "Type of membership (e.g., employee, spouse, dependent)",
      "payer": {
        "id": "Unique identifier for the payer",
        "name": "Name of the payer"
      },
      "plan": {
        "id": "Unique identifier for the plan",
        "name": "Name of the plan"
      },
      "start_date": "Start date of the membership",
      "status": "Current status of the membership",
      "uses_tobacco": "Whether the member uses tobacco"
    },
    "merged_into": {
      "id": "Unique identifier of the patient record this was merged into",
      "name": "Name of the patient record this was merged into"
    },
    "middle_name": "Patient's middle name",
    "name": "Patient's full name",
    "patient_agreement_accepted": "Whether the patient accepted the patient agreement",
    "patient_agreement_accepted_at": "Timestamp when the patient accepted the patient agreement",
    "phones": {
      "number": "Phone number",
      "type": "Type of phone number (e.g., mobile, home, work)"
    },
    "practitioner": {
      "accepts_enrollments_from_employer": "Whether the practitioner accepts enrollments from employers",
      "accepts_enrollments_from_retail": "Whether the practitioner accepts enrollments from retail",
      "bio": "Practitioner's biography",
      "created_at": "Timestamp when the practitioner record was created",
      "education": "Practitioner's education background",
      "email": "Practitioner's email address",
      "gender": "Practitioner's gender",
      "gender_other": "Practitioner's gender if not covered by standard options",
      "id": "Unique identifier for the practitioner",
      "integration_record_id": "Integration record identifier for the practitioner",
      "locations": {
        "address_city": "City of the location's address",
        "address_country": "Country of the location's address",
        "address_latitude": "Latitude of the location's address",
        "address_line1": "First line of the location's address",
        "address_line2": "Second line of the location's address",
        "address_longitude": "Longitude of the location's address",
        "address_state": "State of the location's address",
        "address_zip": "ZIP code of the location's address",
        "distance": "Distance from the patient to the location",
        "id": "Unique identifier for the location",
        "location_group": {
          "created_at": "Timestamp when the location group was created",
          "id": "Unique identifier for the location group",
          "integration_record_id": "Integration record identifier for the location group",
          "name": "Name of the location group",
          "updated_at": "Timestamp when the location group was last updated"
        },
        "name": "Name of the location",
        "phone_number": "Phone number of the location",
        "virtual": "Whether the location is virtual"
      },
      "max_patient_age": "Maximum patient age the practitioner serves",
      "min_patient_age": "Minimum patient age the practitioner serves",
      "name": "Practitioner's full name",
      "npi": {
        "id": "NPI number",
        "name": "Name associated with the NPI"
      },
      "online_signup_visibility": "Practitioner's visibility for online signup",
      "panel_size": "Current number of patients in the practitioner's panel",
      "panel_size_limit": "Maximum number of patients allowed in the practitioner's panel",
      "photo_url": "URL to the practitioner's photo",
      "specialties": {
        "id": "Unique identifier for the specialty",
        "name": "Name of the specialty"
      },
      "updated_at": "Timestamp when the practitioner record was last updated"
    },
    "practitioner_group": {
      "created_at": "Timestamp when the practitioner group was created",
      "id": "Unique identifier for the practitioner group",
      "integration_record_id": "Integration record identifier for the practitioner group",
      "name": "Name of the practitioner group",
      "updated_at": "Timestamp when the practitioner group was last updated"
    },
    "preferred_language": "Patient's preferred language",
    "pronouns": "Patient's preferred pronouns",
    "provider_web_link": "URL link to the patient's profile in the provider portal",
    "sex": "Patient's biological sex",
    "sponsorships": {
      "company": {
        "id": "Unique identifier for the company",
        "name": "Name of the company"
      },
      "external_id": "External identifier from another system",
      "family": {
        "id": "Unique identifier for the family",
        "name": "Name of the family"
      },
      "id": "Unique identifier for the sponsorship",
      "is_subscriber": "Whether this person is the subscriber",
      "type": "Type of sponsorship (e.g., employee, spouse, dependent)"
    },
    "suffix": "Patient's name suffix",
    "terms_accepted": "Whether the patient accepted the terms of service",
    "terms_accepted_at": "Timestamp when the patient accepted the terms of service",
    "updated_at": "Timestamp when the patient record was last updated",
    "uses_tobacco": "Whether the patient uses tobacco"
  }
}
```

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

Unique identifier for the patient

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

```json Example theme={null}
"pat-ab12C345DeF6"
```

**address\_city** `string`

City of the patient's address

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

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

**address\_country** `string`

Country of the patient's address

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

```json Example theme={null}
"United States"
```

**address\_line1** `string`

First line of the patient's address

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

```json Example theme={null}
"157 E Houston St"
```

**address\_line2** `string`

Second line of the patient's address

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

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

**address\_state** `string`

State of the patient's address

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

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

**address\_zip** `string`

ZIP code of the patient's address

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

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

**age** `int64`

Age of the patient

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

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

**chosen\_first\_name** `string`

Patient's chosen or preferred first name

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

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

**chosen\_last\_name** `string`

Patient's chosen or preferred last name

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

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

**chosen\_middle\_name** `string`

Patient's chosen or preferred middle name

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

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

**chosen\_suffix** `string`

Patient's chosen or preferred suffix

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

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

**chosen\_title** `string`

Patient's chosen or preferred title

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

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

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

Timestamp when the patient record was created

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

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

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

Patient's date of birth

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

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

**electronic\_communication\_consent\_accepted** `bool`

Whether the patient accepted electronic communication consent

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

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

**electronic\_communication\_consent\_accepted\_at** `timing.v1.Timestamp`

Timestamp when the patient accepted electronic communication consent

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

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

**email** `string`

Patient's email address

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

```json Example theme={null}
"bass_man@bumblebeeinc.com"
```

**external\_link\_id** `string`

External link identifier for the patient

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

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

**first\_name** `string`

Patient's first name

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

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

**gender** `string`

Patient's gender

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

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

**gender\_identity** `string`

Patient's gender identity

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

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

**gender\_other** `string`

Patient's gender if not covered by standard options

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

```json Example theme={null}
"non-binary"
```

**health\_insurance\_group\_id** `string`

Health insurance group ID

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

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

**health\_insurance\_member\_id** `string`

Health insurance member ID

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

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

**health\_insurance\_payer\_id** `string`

Health insurance payer ID

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

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

**health\_insurance\_payer\_name** `string`

Health insurance payer name

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

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

**hipaa\_authorization\_accepted** `bool`

Whether the patient accepted the HIPAA authorization

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

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

**hipaa\_authorization\_accepted\_at** `timing.v1.Timestamp`

Timestamp when the patient accepted the HIPAA authorization

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

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

**import\_id** `string`

Import batch identifier

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

```json Example theme={null}
"imp-ab12C345DeF6"
```

**import\_source** `string`

Source system of the import

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

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

**joined\_practice\_date** `values.v1.Date`

Date the patient joined the practice

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

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

**last\_name** `string`

Patient's last name

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

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

**lead\_source\_other** `string`

Description of the lead source when 'Other' is selected

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

```json Example theme={null}
"Downtown marketing event"
```

**master\_record\_sponsor** `string`

Master record sponsor identifier

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

```json Example theme={null}
"creg-ab12C345DeF6"
```

**membership\_status** `string`

Current membership status of the patient

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

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

**middle\_name** `string`

Patient's middle name

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

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

**name** `string`

Patient's full name

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

```json Example theme={null}
"Gordon Thomas Sumner"
```

**patient\_agreement\_accepted** `bool`

Whether the patient accepted the patient agreement

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

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

**patient\_agreement\_accepted\_at** `timing.v1.Timestamp`

Timestamp when the patient accepted the patient agreement

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

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

**preferred\_language** `string`

Patient's preferred language

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

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

**pronouns** `string`

Patient's preferred pronouns

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

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

**provider\_web\_link** `string`

URL link to the patient's profile in the provider portal

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

```json Example theme={null}
"https://app.hint.com/patients/pat-ab12C345DeF6"
```

**sex** `string`

Patient's biological sex

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

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

**suffix** `string`

Patient's name suffix

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

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

**terms\_accepted** `bool`

Whether the patient accepted the terms of service

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

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

**terms\_accepted\_at** `timing.v1.Timestamp`

Timestamp when the patient accepted the terms of service

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

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

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

Timestamp when the patient record was last updated

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

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

**uses\_tobacco** `bool`

Whether the patient uses tobacco

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

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

**account** `object`

Patient's billing account information

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

```json Example theme={null}
{
"name": "Gordon Thomas Sumner",
"past_due_in_cents": 0
}
```

**account.name** `string`

Name on the billing account

```json CEL theme={null}
$result_object_key.account.name
```

```json Example theme={null}
"Gordon Thomas Sumner"
```

**account.past\_due\_in\_cents** `int64`

Amount past due in cents

```json CEL theme={null}
$result_object_key.account.past_due_in_cents
```

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

**company** `object`

Company associated with the patient

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

```json Example theme={null}
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
```

**company.id** `string`

Unique identifier for the company

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

```json Example theme={null}
"com-ab12C345DeF6"
```

**company.name** `string`

Name of the company

```json CEL theme={null}
$result_object_key.company.name
```

```json Example theme={null}
"Schmoogle Inc."
```

**external\_records** `[]object` *required*

External records linked to this patient

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

```json Example theme={null}
[
{
"external_id": "ext-98765",
"source": "ehr_system"
}
]
```

**external\_records.map(x, x.source)** `[]string` *required*

Mapped array of: Source system of the external record

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

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

**external\_records.map(x, x.external\_id)** `[]string` *required*

Mapped array of: External identifier in the source system

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

```json Example theme={null}
[
"ext-98765"
]
```

**known\_practice** `object`

Known practice associated with the patient

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

```json Example theme={null}
{
"id": "prc-ab12C345DeF6",
"name": "Downtown Medical"
}
```

**known\_practice.id** `string`

Unique identifier for the known practice

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

```json Example theme={null}
"prc-ab12C345DeF6"
```

**known\_practice.name** `string`

Name of the known practice

```json CEL theme={null}
$result_object_key.known_practice.name
```

```json Example theme={null}
"Downtown Medical"
```

**lead\_source** `object`

Lead source that referred the patient

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

```json Example theme={null}
{
"created_at": null,
"id": "lds-ab12C345DeF6",
"name": "Other",
"updated_at": null
}
```

**lead\_source.id** `string`

Unique identifier for the lead source

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

```json Example theme={null}
"lds-ab12C345DeF6"
```

**lead\_source.name** `string`

Name of the lead source

```json CEL theme={null}
$result_object_key.lead_source.name
```

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

**lead\_source.created\_at** `timing.v1.Timestamp`

Timestamp when the lead source was created

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

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

**lead\_source.updated\_at** `timing.v1.Timestamp`

Timestamp when the lead source was last updated

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

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

**location** `object`

Primary location assigned to the patient

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

```json Example theme={null}
{
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
}
```

**location.id** `string`

Unique identifier for the location

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

```json Example theme={null}
"loc-ab12C345DeF6"
```

**location.address\_city** `string`

City of the location's address

```json CEL theme={null}
$result_object_key.location.address_city
```

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

**location.address\_country** `string`

Country of the location's address

```json CEL theme={null}
$result_object_key.location.address_country
```

```json Example theme={null}
"United States"
```

**location.address\_latitude** `string`

Latitude of the location's address

```json CEL theme={null}
$result_object_key.location.address_latitude
```

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

**location.address\_line1** `string`

First line of the location's address

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

```json Example theme={null}
"157 E Houston St"
```

**location.address\_line2** `string`

Second line of the location's address

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

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

**location.address\_longitude** `string`

Longitude of the location's address

```json CEL theme={null}
$result_object_key.location.address_longitude
```

```json Example theme={null}
"-73.9892241"
```

**location.address\_state** `string`

State of the location's address

```json CEL theme={null}
$result_object_key.location.address_state
```

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

**location.address\_zip** `string`

ZIP code of the location's address

```json CEL theme={null}
$result_object_key.location.address_zip
```

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

**location.distance** `string`

Distance from the patient to the location

```json CEL theme={null}
$result_object_key.location.distance
```

```json Example theme={null}
"5.2 miles"
```

**location.name** `string`

Name of the location

```json CEL theme={null}
$result_object_key.location.name
```

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

**location.phone\_number** `string`

Phone number of the location

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

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

**location.virtual** `bool`

Whether the location is virtual

```json CEL theme={null}
$result_object_key.location.virtual
```

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

**location.location\_group** `object`

Location group this location belongs to

```json CEL theme={null}
$result_object_key.location.location_group
```

```json Example theme={null}
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
```

**location.location\_group.id** `string`

Unique identifier for the location group

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

```json Example theme={null}
"prg-ab12C345DeF6"
```

**location.location\_group.created\_at** `timing.v1.Timestamp`

Timestamp when the location group was created

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

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

**location.location\_group.integration\_record\_id** `string`

Integration record identifier for the location group

```json CEL theme={null}
$result_object_key.location.location_group.integration_record_id
```

```json Example theme={null}
"int-ab12C345DeF6"
```

**location.location\_group.name** `string`

Name of the location group

```json CEL theme={null}
$result_object_key.location.location_group.name
```

```json Example theme={null}
"Downtown Location Group"
```

**location.location\_group.updated\_at** `timing.v1.Timestamp`

Timestamp when the location group was last updated

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

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

**location\_group** `object`

Location group assigned to the patient

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

```json Example theme={null}
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
```

**location\_group.id** `string`

Unique identifier for the location group

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

```json Example theme={null}
"prg-ab12C345DeF6"
```

**location\_group.created\_at** `timing.v1.Timestamp`

Timestamp when the location group was created

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

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

**location\_group.integration\_record\_id** `string`

Integration record identifier for the location group

```json CEL theme={null}
$result_object_key.location_group.integration_record_id
```

```json Example theme={null}
"int-ab12C345DeF6"
```

**location\_group.name** `string`

Name of the location group

```json CEL theme={null}
$result_object_key.location_group.name
```

```json Example theme={null}
"Downtown Location Group"
```

**location\_group.updated\_at** `timing.v1.Timestamp`

Timestamp when the location group was last updated

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

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

**memberships** `[]object` *required*

Patient's membership enrollments

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

```json Example theme={null}
[
{
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"division": {
"id": "div-ab12C345DeF6",
"name": "division 20"
},
"end_date": null,
"enrollment_requested_on": null,
"enrollment_status": "active",
"member_type": "spouse",
"payer": {
"id": "pat-ab12C345DeF6",
"name": "Gordon Thomas Sumner"
},
"plan": {
"id": "pln-ab12C345DeF6",
"name": "Membership"
},
"start_date": null,
"status": "active",
"uses_tobacco": false
}
]
```

**memberships.map(x, x.end\_date)** `[]values.v1.Date` *required*

Mapped array of: End date of the membership

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

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

**memberships.map(x, x.enrollment\_requested\_on)** `[]values.v1.Date` *required*

Mapped array of: Date when enrollment was requested

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

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

**memberships.map(x, x.enrollment\_status)** `[]string` *required*

Mapped array of: Current enrollment status

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

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

**memberships.map(x, x.member\_type)** `[]string` *required*

Mapped array of: Type of membership (e.g., employee, spouse, dependent)

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

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

**memberships.map(x, x.start\_date)** `[]values.v1.Date` *required*

Mapped array of: Start date of the membership

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

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

**memberships.map(x, x.status)** `[]string` *required*

Mapped array of: Current status of the membership

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

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

**memberships.map(x, x.uses\_tobacco)** `[]bool` *required*

Mapped array of: Whether the member uses tobacco

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

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

**memberships.map(x, x.company)** `[]bool` *required*

Mapped array of: Company associated with the membership

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

```json Example theme={null}
[
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
]
```

**memberships.map(x, x.division)** `[]bool` *required*

Mapped array of: Division within the company

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

```json Example theme={null}
[
{
"id": "div-ab12C345DeF6",
"name": "division 20"
}
]
```

**memberships.map(x, x.payer)** `[]bool` *required*

Mapped array of: Payer responsible for the membership

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

```json Example theme={null}
[
{
"id": "pat-ab12C345DeF6",
"name": "Gordon Thomas Sumner"
}
]
```

**memberships.map(x, x.plan)** `[]bool` *required*

Mapped array of: Plan associated with the membership

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

```json Example theme={null}
[
{
"id": "pln-ab12C345DeF6",
"name": "Membership"
}
]
```

**merged\_into** `object`

Patient record this patient was merged into

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

```json Example theme={null}
{
"id": "pat-zz99Y888XwV7",
"name": "Gordon Thomas Sumner"
}
```

**merged\_into.id** `string`

Unique identifier of the patient record this was merged into

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

```json Example theme={null}
"pat-zz99Y888XwV7"
```

**merged\_into.name** `string`

Name of the patient record this was merged into

```json CEL theme={null}
$result_object_key.merged_into.name
```

```json Example theme={null}
"Gordon Thomas Sumner"
```

**phones** `[]object` *required*

Phone numbers associated with the patient

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

```json Example theme={null}
[
{
"number": "+15553050051",
"type": "mobile"
}
]
```

**phones.map(x, x.number)** `[]string` *required*

Mapped array of: Phone number

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

```json Example theme={null}
[
"+15553050051"
]
```

**phones.map(x, x.type)** `[]string` *required*

Mapped array of: Type of phone number (e.g., mobile, home, work)

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

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

**practitioner** `object`

Primary practitioner assigned to the patient

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

```json Example theme={null}
{
"accepts_enrollments_from_employer": "yes",
"accepts_enrollments_from_retail": "yes",
"bio": "Board-certified family medicine physician with 15 years of experience.",
"created_at": null,
"education": "MD, Johns Hopkins University",
"email": "dr.smith@practice.com",
"gender": "female",
"gender_other": "non-binary",
"id": "doc-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"locations": [
{
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
  "created_at": null,
  "id": "prg-ab12C345DeF6",
  "integration_record_id": "int-ab12C345DeF6",
  "name": "Downtown Location Group",
  "updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
}
],
"max_patient_age": "65",
"min_patient_age": "18",
"name": "Dr. Jane Smith",
"npi": {
"id": "1234567890",
"name": "Dr. Jane Smith"
},
"online_signup_visibility": "visible",
"panel_size": 250,
"panel_size_limit": 500,
"photo_url": "https://app.hint.com/photos/doc-ab12C345DeF6.jpg",
"specialties": [
{
"id": "spc-ab12C345DeF6",
"name": "Family Medicine"
}
],
"updated_at": null
}
```

**practitioner.id** `string`

Unique identifier for the practitioner

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

```json Example theme={null}
"doc-ab12C345DeF6"
```

**practitioner.accepts\_enrollments\_from\_employer** `string`

Whether the practitioner accepts enrollments from employers

```json CEL theme={null}
$result_object_key.practitioner.accepts_enrollments_from_employer
```

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

**practitioner.accepts\_enrollments\_from\_retail** `string`

Whether the practitioner accepts enrollments from retail

```json CEL theme={null}
$result_object_key.practitioner.accepts_enrollments_from_retail
```

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

**practitioner.bio** `string`

Practitioner's biography

```json CEL theme={null}
$result_object_key.practitioner.bio
```

```json Example theme={null}
"Board-certified family medicine physician with 15 years of experience."
```

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

Timestamp when the practitioner record was created

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

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

**practitioner.education** `string`

Practitioner's education background

```json CEL theme={null}
$result_object_key.practitioner.education
```

```json Example theme={null}
"MD, Johns Hopkins University"
```

**practitioner.email** `string`

Practitioner's email address

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

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

**practitioner.gender** `string`

Practitioner's gender

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

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

**practitioner.gender\_other** `string`

Practitioner's gender if not covered by standard options

```json CEL theme={null}
$result_object_key.practitioner.gender_other
```

```json Example theme={null}
"non-binary"
```

**practitioner.integration\_record\_id** `string`

Integration record identifier for the practitioner

```json CEL theme={null}
$result_object_key.practitioner.integration_record_id
```

```json Example theme={null}
"int-ab12C345DeF6"
```

**practitioner.max\_patient\_age** `string`

Maximum patient age the practitioner serves

```json CEL theme={null}
$result_object_key.practitioner.max_patient_age
```

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

**practitioner.min\_patient\_age** `string`

Minimum patient age the practitioner serves

```json CEL theme={null}
$result_object_key.practitioner.min_patient_age
```

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

**practitioner.name** `string`

Practitioner's full name

```json CEL theme={null}
$result_object_key.practitioner.name
```

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

**practitioner.online\_signup\_visibility** `string`

Practitioner's visibility for online signup

```json CEL theme={null}
$result_object_key.practitioner.online_signup_visibility
```

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

**practitioner.panel\_size** `int64`

Current number of patients in the practitioner's panel

```json CEL theme={null}
$result_object_key.practitioner.panel_size
```

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

**practitioner.panel\_size\_limit** `int64`

Maximum number of patients allowed in the practitioner's panel

```json CEL theme={null}
$result_object_key.practitioner.panel_size_limit
```

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

**practitioner.photo\_url** `string`

URL to the practitioner's photo

```json CEL theme={null}
$result_object_key.practitioner.photo_url
```

```json Example theme={null}
"https://app.hint.com/photos/doc-ab12C345DeF6.jpg"
```

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

Timestamp when the practitioner record was last updated

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

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

**practitioner.locations** `[]object`

Locations where the practitioner practices

```json CEL theme={null}
$result_object_key.practitioner.locations
```

```json Example theme={null}
[
{
"address_city": "New York",
"address_country": "United States",
"address_latitude": "40.7227998",
"address_line1": "157 E Houston St",
"address_line2": "Suite 2402",
"address_longitude": "-73.9892241",
"address_state": "NY",
"address_zip": "10002",
"distance": "5.2 miles",
"id": "loc-ab12C345DeF6",
"location_group": {
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
},
"name": "San Francisco HQ",
"phone_number": "+15551234567",
"virtual": false
}
]
```

**practitioner.locations.map(x, x.id)** `[]string` *required*

Mapped array of: Unique identifier for the location

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.id)
```

```json Example theme={null}
[
"loc-ab12C345DeF6"
]
```

**practitioner.locations.map(x, x.address\_city)** `[]string` *required*

Mapped array of: City of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_city)
```

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

**practitioner.locations.map(x, x.address\_country)** `[]string` *required*

Mapped array of: Country of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_country)
```

```json Example theme={null}
[
"United States"
]
```

**practitioner.locations.map(x, x.address\_latitude)** `[]string` *required*

Mapped array of: Latitude of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_latitude)
```

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

**practitioner.locations.map(x, x.address\_line1)** `[]string` *required*

Mapped array of: First line of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_line1)
```

```json Example theme={null}
[
"157 E Houston St"
]
```

**practitioner.locations.map(x, x.address\_line2)** `[]string` *required*

Mapped array of: Second line of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_line2)
```

```json Example theme={null}
[
"Suite 2402"
]
```

**practitioner.locations.map(x, x.address\_longitude)** `[]string` *required*

Mapped array of: Longitude of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_longitude)
```

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

**practitioner.locations.map(x, x.address\_state)** `[]string` *required*

Mapped array of: State of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_state)
```

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

**practitioner.locations.map(x, x.address\_zip)** `[]string` *required*

Mapped array of: ZIP code of the location's address

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.address_zip)
```

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

**practitioner.locations.map(x, x.distance)** `[]string` *required*

Mapped array of: Distance from the patient to the location

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.distance)
```

```json Example theme={null}
[
"5.2 miles"
]
```

**practitioner.locations.map(x, x.name)** `[]string` *required*

Mapped array of: Name of the location

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

```json Example theme={null}
[
"San Francisco HQ"
]
```

**practitioner.locations.map(x, x.phone\_number)** `[]string` *required*

Mapped array of: Phone number of the location

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.phone_number)
```

```json Example theme={null}
[
"+15551234567"
]
```

**practitioner.locations.map(x, x.virtual)** `[]bool` *required*

Mapped array of: Whether the location is virtual

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.virtual)
```

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

**practitioner.locations.map(x, x.location\_group)** `[]bool` *required*

Mapped array of: Location group this location belongs to

```json CEL theme={null}
$result_object_key.practitioner.locations.map(x, x.location_group)
```

```json Example theme={null}
[
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
]
```

**practitioner.npi** `object`

National Provider Identifier for the practitioner

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

```json Example theme={null}
{
"id": "1234567890",
"name": "Dr. Jane Smith"
}
```

**practitioner.npi.id** `string`

NPI number

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

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

**practitioner.npi.name** `string`

Name associated with the NPI

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

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

**practitioner.specialties** `[]object`

Practitioner's specialties

```json CEL theme={null}
$result_object_key.practitioner.specialties
```

```json Example theme={null}
[
{
"id": "spc-ab12C345DeF6",
"name": "Family Medicine"
}
]
```

**practitioner.specialties.map(x, x.id)** `[]string` *required*

Mapped array of: Unique identifier for the specialty

```json CEL theme={null}
$result_object_key.practitioner.specialties.map(x, x.id)
```

```json Example theme={null}
[
"spc-ab12C345DeF6"
]
```

**practitioner.specialties.map(x, x.name)** `[]string` *required*

Mapped array of: Name of the specialty

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

```json Example theme={null}
[
"Family Medicine"
]
```

**practitioner\_group** `object`

Practitioner group assigned to the patient

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

```json Example theme={null}
{
"created_at": null,
"id": "prg-ab12C345DeF6",
"integration_record_id": "int-ab12C345DeF6",
"name": "Downtown Location Group",
"updated_at": null
}
```

**practitioner\_group.id** `string`

Unique identifier for the practitioner group

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

```json Example theme={null}
"prg-ab12C345DeF6"
```

**practitioner\_group.created\_at** `timing.v1.Timestamp`

Timestamp when the practitioner group was created

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

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

**practitioner\_group.integration\_record\_id** `string`

Integration record identifier for the practitioner group

```json CEL theme={null}
$result_object_key.practitioner_group.integration_record_id
```

```json Example theme={null}
"int-ab12C345DeF6"
```

**practitioner\_group.name** `string`

Name of the practitioner group

```json CEL theme={null}
$result_object_key.practitioner_group.name
```

```json Example theme={null}
"Downtown Location Group"
```

**practitioner\_group.updated\_at** `timing.v1.Timestamp`

Timestamp when the practitioner group was last updated

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

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

**sponsorships** `[]object` *required*

Sponsorships associated with the patient

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

```json Example theme={null}
[
{
"company": {
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
},
"external_id": "ext_id_from_another_system012345",
"family": {
"id": "cac-ab12C345DeF6",
"name": "Sumner Family"
},
"id": "creg-ab12C345DeF6",
"is_subscriber": true,
"type": "spouse"
}
]
```

**sponsorships.map(x, x.id)** `[]string` *required*

Mapped array of: Unique identifier for the sponsorship

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

```json Example theme={null}
[
"creg-ab12C345DeF6"
]
```

**sponsorships.map(x, x.external\_id)** `[]string` *required*

Mapped array of: External identifier from another system

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

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

**sponsorships.map(x, x.is\_subscriber)** `[]bool` *required*

Mapped array of: Whether this person is the subscriber

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

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

**sponsorships.map(x, x.type)** `[]string` *required*

Mapped array of: Type of sponsorship (e.g., employee, spouse, dependent)

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

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

**sponsorships.map(x, x.company)** `[]bool` *required*

Mapped array of: Company associated with the sponsorship

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

```json Example theme={null}
[
{
"id": "com-ab12C345DeF6",
"name": "Schmoogle Inc."
}
]
```

**sponsorships.map(x, x.family)** `[]bool` *required*

Mapped array of: Family associated with the sponsorship

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

```json Example theme={null}
[
{
"id": "cac-ab12C345DeF6",
"name": "Sumner Family"
}
]
```


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