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

# Get User

> Documentation for the Get User action for Healthie

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

# Parameters

**Action** `Parameters`

**parameters**

**ID** `string` *required*

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

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "active": true,
    "active_tags": [
      "Weight Loss",
      "Diabetes"
    ],
    "additional_phone_number": "+15559876543",
    "additional_record_identifier": "2847455b-caed-4d97-a79c-1f07316e7fbf",
    "brand": {
      "about_description": "We provide comprehensive health services",
      "brand_email": "brand@example.com",
      "brand_name": "My Health Brand",
      "brand_phone": "+15551234567"
    },
    "changed_fields": [
      "email_address",
      "first_name",
      "last_name"
    ],
    "client_readable_source": "src",
    "client_source": {
      "id": "3265",
      "readable_source": "John Doe MS, LMFT",
      "ref_source": "12345",
      "ref_source_other": "Instagram",
      "ref_type": "referring_provider",
      "related_insurance_id": "12345",
      "related_object_id": "12345",
      "related_object_name": "Other"
    },
    "course_memberships": [
      {
        "course_id": "54654",
        "course_name": "Nutrition 101",
        "course_status": "active",
        "started_at": "2024-02-14T16:10:11+00:00",
        "updated_at": "2024-03-01T17:12:18+00:00"
      }
    ],
    "date_of_birth": "1950-08-04",
    "default_stripe_customer_detail_id": "cus_123456",
    "diagnoses": [
      {
        "active": true,
        "end_date": "2024-07-04",
        "first_symptom_date": "2023-07-04",
        "icd_code": {
          "code": "F41.1",
          "display_name": "Generalized anxiety disorder"
        }
      }
    ],
    "dietician_organization_id": "5465412",
    "dietitian_email_address": "drfleming@example.com",
    "dietitian_first_name": "Alexander",
    "dietitian_id": "100070",
    "dietitian_last_name": "Fleming",
    "dietitian_organization_id": "20042",
    "dietitian_organization_location_id": "12345",
    "dietitian_organization_name": "Morf",
    "email_address": "john.doe@example.com",
    "first_name": "John",
    "gender": "Male",
    "gender_identity": "Male",
    "has_created_password": true,
    "height_meters": 1.75,
    "id": "131391",
    "insurance_authorization": {
      "end_on": "2024-09-01",
      "start_on": "2024-02-12",
      "units_authorized": "10",
      "units_left": "5",
      "units_used": "5",
      "visits_left": "3"
    },
    "is_patient": true,
    "last_active": "2024-07-04T09:39:18+00:00",
    "last_appt_date": "2024-04-22T09:00:00-04:00",
    "last_appt_id": "604820",
    "last_name": "Doe",
    "legal_name": "Test Patient",
    "location": {
      "city": "San Francisco",
      "country": "USA",
      "line1": "123 Main Street",
      "line2": "Suite 100",
      "state": "CA",
      "zip": "94117"
    },
    "metadata": {
      "priority": "High",
      "referral_department": "Cardiology"
    },
    "money_owed": "100.00",
    "next_appt_date": "2024-08-17T10:30:00-04:00",
    "next_appt_id": "604821",
    "next_required_step": "Complete onboarding",
    "notification_contacts": [
      {
        "email_address": "john.doe@example.com",
        "first_name": "John",
        "id": "212012",
        "is_emergency_contact": true,
        "last_name": "Doe",
        "phone_number": "+15551234123",
        "relationship": "Caregiver"
      }
    ],
    "npi": "1234567890",
    "other_provider_ids": [
      "123456",
      "789012"
    ],
    "phone_number": "+15551234123",
    "policies": [
      {
        "benefits": [
          {
            "coinsurance": "15",
            "copay": "50",
            "deductible_calendar_year": "2000",
            "deductible_year_to_date": "1500"
          }
        ],
        "effective_end": "2024-07-04",
        "group_num": "331256",
        "id": "202402",
        "insurance_card_back_id": "123452",
        "insurance_card_front_id": "123451",
        "insurance_plan": {
          "id": "611231",
          "name_and_id": "Blue Cross Blue Shield - 629913",
          "payer_id": "629913",
          "payer_name": "Blue Cross Blue Shield"
        },
        "insurance_type": "Medicaid",
        "notes": "Policy is active",
        "num": "1912310",
        "patient_id": "100121",
        "priority_type": "Primary",
        "updated_at": "2024-07-01T11:29:19+00:00"
      }
    ],
    "primary_ethnicity_code": "2135-2",
    "primary_race": "White",
    "primary_race_code": "1002-5",
    "pronouns": "He/Him",
    "providers": [
      {
        "first_name": "Brian",
        "id": "720312",
        "last_name": "Hippocrates",
        "name": "Dr. Brian Hippocrates",
        "qualifications": "MD"
      }
    ],
    "quick_notes": "Patient is very motivated to get well",
    "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353",
    "referring_physician_emails": [
      "brian.hippocrates@example.com",
      "joseph.lister@example.com"
    ],
    "referring_physicians": [
      {
        "business_name": "Dr. John",
        "created_at": "2024-05-10T08:46:04Z",
        "email": "john.doe@example.com",
        "first_name": "John",
        "full_name": "John Doe",
        "id": "57211",
        "last_name": "Doe",
        "location": {
          "city": "San Francisco",
          "country": "USA",
          "line1": "123 Main Street",
          "line2": "Suite 100",
          "state": "CA",
          "zip": "94117"
        },
        "npi": "1000321231",
        "phone_number": "+15551234123"
      }
    ],
    "referring_provider_name": "Fred Flintstone",
    "set_password_link": "https://passwords.health.co/reset",
    "sex": "Male",
    "sex_assigned_at_birth": "Male",
    "sexual_orientation": "Heterosexual",
    "state_licenses": [
      {
        "full_state_name": "New York",
        "id": "500073",
        "state": "NY"
      }
    ],
    "timezone": "America/Los_Angeles",
    "timing": {
      "created_at": "2022-07-01T00:01:00+00:00",
      "updated_at": "2022-07-01T00:01:00+00:00"
    },
    "unconfirmed_appointment_count": 1,
    "user_group": {
      "created_at": "2024-07-01T11:29:19+00:00",
      "id": "123012",
      "name": "Intake"
    },
    "weight_kilograms": 75
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "active": "Whether the User is active",
    "active_tags": "List of active tags for the User",
    "additional_phone_number": "Additional phone number of the user",
    "additional_record_identifier": "Additional record identifier for the User (an extra external unique patient ID reference)",
    "brand": {
      "about_description": "Brand owner's about description",
      "brand_email": "Brand owner's brand email",
      "brand_name": "Name of provider's brand",
      "brand_phone": "Brand owner's brand phone"
    },
    "changed_fields": "Healthie User object fields changed in triggering the event for this User (Patient)",
    "client_readable_source": "Client readable source for the user",
    "client_source": {
      "id": "ID of the client source",
      "readable_source": "Get readable source based on ref_type",
      "ref_source": "The source of how a client was acquired: contain ID or a Other string",
      "ref_source_other": "If ref_source eq 'Other', than it may contain custom string or NULL",
      "ref_type": "The type of the source of how a client was acquired",
      "related_insurance_id": "ID of the related insurance",
      "related_object_id": "ID of the related object, or 'Other'",
      "related_object_name": "Name of the related object"
    },
    "course_memberships": {
      "course_id": "ID of the course",
      "course_name": "Name of the course",
      "course_status": "Status of the course membership",
      "started_at": "Time the course membership started",
      "updated_at": "Time the course membership was last updated"
    },
    "date_of_birth": "Date of birth of the User",
    "default_stripe_customer_detail_id": "Default Stripe customer detail ID",
    "diagnoses": {
      "active": "Whether the diagnosis is currently active",
      "end_date": "Date the diagnosis ended",
      "first_symptom_date": "Date of first symptoms",
      "icd_code": {
        "code": "ICD code",
        "display_name": "Display name for the ICD code"
      }
    },
    "dietician_organization_id": "Organization ID for the user's registered dietitian",
    "dietitian_email_address": "Email address of the User's registered dietitian",
    "dietitian_first_name": "First name of the User's registered dietitian",
    "dietitian_id": "ID of the User's registered dietitian",
    "dietitian_last_name": "Last name of the User's registered dietitian",
    "dietitian_organization_id": "Organization ID for the User's registered dietitian",
    "dietitian_organization_location_id": "Organization's location ID for the User's registered dietitian",
    "dietitian_organization_name": "Organization name for the user's registered dietitian",
    "email_address": "Email address of the User",
    "first_name": "First name of the User",
    "gender": "Gender",
    "gender_identity": "Gender identity",
    "has_created_password": "Whether the User has created a password",
    "height_meters": "Height in meters",
    "id": "ID for the User",
    "insurance_authorization": {
      "end_on": "The day that visits authorized by the insurance company have no effect",
      "start_on": "The day that visits authorized by the insurance company take effect",
      "units_authorized": "Number of units authorized",
      "units_left": "Number of units left",
      "units_used": "Number of units used",
      "visits_left": "Number of visits left"
    },
    "is_patient": "Whether the user is a patient",
    "last_active": "Time the User was last active",
    "last_appt_date": "The datetime of the last appointment the Patient had",
    "last_appt_id": "The last scheduled appointment ID for this Patient (if specified)",
    "last_name": "Last name of the User",
    "legal_name": "Legal name of the Patient",
    "location": {
      "city": "City",
      "country": "Country",
      "line1": "First line of the address",
      "line2": "Second line of the address",
      "state": "State",
      "zip": "Zip code"
    },
    "metadata": "Metadata for the user",
    "money_owed": "Amount of money owed by the User",
    "next_appt_date": "The timestamp of the next scheduled appointment for this Patient (if scheduled)",
    "next_appt_id": "The next scheduled appointment ID for this Patient (if specified)",
    "next_required_step": "Next required step for the User",
    "notification_contacts": {
      "email_address": "Email address of the notification contact",
      "first_name": "First name of the notification contact",
      "id": "ID for the notification contact",
      "is_emergency_contact": "Whether the notification contact is an emergency contact",
      "last_name": "Last name of the notification contact",
      "phone_number": "Phone number of the notification contact",
      "relationship": "Relationship between the notification contact and the user"
    },
    "npi": "National Provider Identifier, this field only applies if the user is a provider",
    "other_provider_ids": "List of other provider IDs associated with the User",
    "phone_number": "Phone number of the User",
    "policies": {
      "benefits": {
        "coinsurance": "Coinsurance percentage due",
        "copay": "Copay amount due",
        "deductible_calendar_year": "Deductible amount for the calendar year",
        "deductible_year_to_date": "Deductible amount for the year to-date"
      },
      "effective_end": "Date the policy coverage expires",
      "group_num": "Group number",
      "id": "ID for the policy",
      "insurance_card_back_id": "ID of the insurance card back image object",
      "insurance_card_front_id": "ID of the insurance card front image object",
      "insurance_plan": {
        "id": "ID of the insurance plan",
        "name_and_id": "Name of the payer and id of payer",
        "payer_id": "ID of the insurance payer",
        "payer_name": "Name of the insurance payer"
      },
      "insurance_type": "The type of insurance: `type_string`",
      "notes": "Notes about the policy",
      "num": "Policy number",
      "patient_id": "ID of the patient associated with the policy",
      "priority_type": "The priority type of insurance: `priority_type`",
      "updated_at": "Last time the Policy was updated"
    },
    "primary_ethnicity_code": "The primary ethnicity code for the Patient",
    "primary_race": "Primary race",
    "primary_race_code": "The primary race code for the Patient",
    "pronouns": "Pronouns",
    "providers": {
      "first_name": "First name of the provider",
      "id": "ID for the provider",
      "last_name": "Last name of the provider",
      "name": "Name of the provider",
      "qualifications": "Qualifications of the provider"
    },
    "quick_notes": "Quick notes about the user",
    "record_identifier": "Record identifier for the User (external unique patient ID reference)",
    "referring_physician_emails": "List of referring physician emails",
    "referring_physicians": {
      "business_name": "Provider's business name",
      "created_at": "Provider's creation date",
      "email": "Provider's email",
      "first_name": "Provider's first name",
      "full_name": "Provider's full name",
      "id": "Provider ID",
      "last_name": "Provider's last name",
      "location": {
        "city": "City",
        "country": "Country",
        "line1": "First line of the address",
        "line2": "Second line of the address",
        "state": "State",
        "zip": "Zip code"
      },
      "npi": "Provider's NPI",
      "phone_number": "Provider's phone number"
    },
    "referring_provider_name": "Name of the referring provider",
    "set_password_link": "Password setup hyperlink",
    "sex": "Sex",
    "sex_assigned_at_birth": "Sex assigned at birth",
    "sexual_orientation": "Sexual orientation",
    "state_licenses": {
      "full_state_name": "The full name of the State",
      "id": "The unique identifier of the State license",
      "state": "The abbreviation of the State"
    },
    "timezone": "Timezone registered for the User",
    "timing": {
      "created_at": "Time the object was created",
      "updated_at": "Time the object was updated"
    },
    "unconfirmed_appointment_count": "Number of unconfirmed appointments",
    "user_group": {
      "created_at": "When the User Group was created",
      "id": "ID of the User Group",
      "name": "Name of the User Group"
    },
    "weight_kilograms": "Weight in kilograms"
  }
}
```

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

**User** `Fetch Action Response Object`

**fields**

**id** `string` *required*

`ID` ID for the User

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

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

**record\_identifier** `string`

`ID` Record identifier for the User (external unique patient ID reference)

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

```json Example theme={null}
"8e11f3ba-3167-4f47-a549-f43dc19df353"
```

**active** `bool` *required*

Whether the User is active

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

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

**first\_name** `string`

`PII` First name of the User

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

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

**last\_name** `string`

`PII` Last name of the User

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

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

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

`PII` Date of birth of the User

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

```json Example theme={null}
"1950-08-04"
```

**phone\_number** `string`

`PII` Phone number of the User

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

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

**email\_address** `string`

`PII` Email address of the User

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

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

**sex\_assigned\_at\_birth** `string`

`HI` Sex assigned at birth

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

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

**gender** `string`

`HI` Gender

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

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

**gender\_identity** `string`

`HI` Gender identity

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

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

**pronouns** `string`

`HI` Pronouns

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

```json Example theme={null}
"He/Him"
```

**user\_group** `object`

User Group details

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

```json Example theme={null}
{
"created_at": "2024-07-01T11:29:19+00:00",
"id": "123012",
"name": "Intake"
}
```

**user\_group.id** `string`

ID of the User Group

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

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

**user\_group.name** `string`

Name of the User Group

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

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

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

When the User Group was created

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

```json Example theme={null}
"2024-07-01T11:29:19+00:00"
```

**policies** `[]object` *required*

`PII` List of Policies associated with the User

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

```json Example theme={null}
[
{
"benefits": [
{
  "coinsurance": "15",
  "copay": "50",
  "deductible_calendar_year": "2000",
  "deductible_year_to_date": "1500"
}
],
"effective_end": "2024-07-04",
"group_num": "331256",
"id": "202402",
"insurance_card_back_id": "123452",
"insurance_card_front_id": "123451",
"insurance_plan": {
"id": "611231",
"name_and_id": "Blue Cross Blue Shield - 629913",
"payer_id": "629913",
"payer_name": "Blue Cross Blue Shield"
},
"insurance_type": "Medicaid",
"notes": "Policy is active",
"num": "1912310",
"patient_id": "100121",
"priority_type": "Primary",
"updated_at": "2024-07-01T11:29:19+00:00"
}
]
```

**policies.map(x, x.insurance\_plan)** `[]bool` *required*

Mapped array of: Insurance plan details

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

```json Example theme={null}
[
{
"id": "611231",
"name_and_id": "Blue Cross Blue Shield - 629913",
"payer_id": "629913",
"payer_name": "Blue Cross Blue Shield"
}
]
```

**policies.map(x, x.num)** `[]string` *required*

`PII` Mapped array of: Policy number

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

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

**policies.map(x, x.group\_num)** `[]string` *required*

Mapped array of: Group number

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

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

**policies.map(x, x.notes)** `[]string` *required*

Mapped array of: Notes about the policy

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

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

**policies.map(x, x.effective\_end)** `[]values.v1.Date` *required*

Mapped array of: Date the policy coverage expires

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

```json Example theme={null}
[
"2024-07-04"
]
```

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

Mapped array of: ID for the policy

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

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

**policies.map(x, x.patient\_id)** `[]string` *required*

`ID` `PII` Mapped array of: ID of the patient associated with the policy

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

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

**policies.map(x, x.insurance\_card\_front\_id)** `[]string` *required*

`HI` `ID` `PII` Mapped array of: ID of the insurance card front image object

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

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

**policies.map(x, x.insurance\_card\_back\_id)** `[]string` *required*

`HI` `ID` `PII` Mapped array of: ID of the insurance card back image object

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

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

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

Mapped array of: Last time the Policy was updated

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

```json Example theme={null}
[
"2024-07-01T11:29:19+00:00"
]
```

**policies.map(x, x.insurance\_type)** `[]string` *required*

Mapped array of: The type of insurance: `type_string`

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

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

**policies.map(x, x.priority\_type)** `[]string` *required*

Mapped array of: The priority type of insurance: `priority_type`

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

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

**policies.map(x, x.benefits)** `[]bool` *required*

Mapped array of: Insurance plan details

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

```json Example theme={null}
[
[
{
"coinsurance": "15",
"copay": "50",
"deductible_calendar_year": "2000",
"deductible_year_to_date": "1500"
}
]
]
```

**insurance\_authorization** `object`

Insurance authorization details

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

```json Example theme={null}
{
"end_on": "2024-09-01",
"start_on": "2024-02-12",
"units_authorized": "10",
"units_left": "5",
"units_used": "5",
"visits_left": "3"
}
```

**insurance\_authorization.units\_authorized** `string`

Number of units authorized

```json CEL theme={null}
$result_object_key.insurance_authorization.units_authorized
```

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

**insurance\_authorization.units\_used** `string`

Number of units used

```json CEL theme={null}
$result_object_key.insurance_authorization.units_used
```

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

**insurance\_authorization.units\_left** `string`

Number of units left

```json CEL theme={null}
$result_object_key.insurance_authorization.units_left
```

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

**insurance\_authorization.visits\_left** `string`

Number of visits left

```json CEL theme={null}
$result_object_key.insurance_authorization.visits_left
```

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

**insurance\_authorization.start\_on** `values.v1.Date`

The day that visits authorized by the insurance company take effect

```json CEL theme={null}
$result_object_key.insurance_authorization.start_on
```

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

**insurance\_authorization.end\_on** `values.v1.Date`

The day that visits authorized by the insurance company have no effect

```json CEL theme={null}
$result_object_key.insurance_authorization.end_on
```

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

**timezone** `string`

Timezone registered for the User

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

```json Example theme={null}
"America/Los_Angeles"
```

**location** `object`

`PII` Location details

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

```json Example theme={null}
{
"city": "San Francisco",
"country": "USA",
"line1": "123 Main Street",
"line2": "Suite 100",
"state": "CA",
"zip": "94117"
}
```

**location.line1** `string`

First line of the address

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

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

**location.line2** `string`

Second line of the address

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

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

**location.city** `string`

City

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

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

**location.state** `string`

State

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

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

**location.zip** `string`

Zip code

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

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

**location.country** `string`

Country

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

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

**timing** `object` *required*

Create and update times

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

```json Example theme={null}
{
"created_at": "2022-07-01T00:01:00+00:00",
"updated_at": "2022-07-01T00:01:00+00:00"
}
```

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

Time the object was created

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

```json Example theme={null}
"2022-07-01T00:01:00+00:00"
```

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

Time the object was updated

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

```json Example theme={null}
"2022-07-01T00:01:00+00:00"
```

**default\_stripe\_customer\_detail\_id** `string`

`PII` Default Stripe customer detail ID

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

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

**diagnoses** `[]object` *required*

`HI` List of diagnoses associated with the User

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

```json Example theme={null}
[
{
"active": true,
"end_date": "2024-07-04",
"first_symptom_date": "2023-07-04",
"icd_code": {
"code": "F41.1",
"display_name": "Generalized anxiety disorder"
}
}
]
```

**diagnoses.map(x, x.active)** `[]bool` *required*

Mapped array of: Whether the diagnosis is currently active

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

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

**diagnoses.map(x, x.first\_symptom\_date)** `[]values.v1.Date` *required*

Mapped array of: Date of first symptoms

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

```json Example theme={null}
[
"2023-07-04"
]
```

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

Mapped array of: Date the diagnosis ended

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

```json Example theme={null}
[
"2024-07-04"
]
```

**diagnoses.map(x, x.icd\_code)** `[]bool` *required*

Mapped array of: ICD code details

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

```json Example theme={null}
[
{
"code": "F41.1",
"display_name": "Generalized anxiety disorder"
}
]
```

**has\_created\_password** `bool` *required*

Whether the User has created a password

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

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

**last\_active** `timing.v1.Timestamp`

Time the User was last active

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

```json Example theme={null}
"2024-07-04T09:39:18+00:00"
```

**money\_owed** `string`

Amount of money owed by the User

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

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

**next\_required\_step** `string`

Next required step for the User

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

```json Example theme={null}
"Complete onboarding"
```

**client\_readable\_source** `string`

Client readable source for the user

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

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

**referring\_physician\_emails** `[]string` *required*

List of referring physician emails

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

```json Example theme={null}
[
"brian.hippocrates@example.com",
"joseph.lister@example.com"
]
```

**referring\_provider\_name** `string`

Name of the referring provider

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

```json Example theme={null}
"Fred Flintstone"
```

**unconfirmed\_appointment\_count** `uint64`

Number of unconfirmed appointments

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

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

**dietician\_organization\_id** `string`

Organization ID for the user's registered dietitian

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

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

**height\_meters** `float64 (double)`

Height in meters

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

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

**weight\_kilograms** `float64 (double)`

Weight in kilograms

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

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

**quick\_notes** `string`

Quick notes about the user

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

```json Example theme={null}
"Patient is very motivated to get well"
```

**notification\_contacts** `[]object` *required*

`PII` List of notification contacts for the user

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

```json Example theme={null}
[
{
"email_address": "john.doe@example.com",
"first_name": "John",
"id": "212012",
"is_emergency_contact": true,
"last_name": "Doe",
"phone_number": "+15551234123",
"relationship": "Caregiver"
}
]
```

**notification\_contacts.map(x, x.id)** `[]string` *required*

Mapped array of: ID for the notification contact

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

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

**notification\_contacts.map(x, x.first\_name)** `[]string` *required*

Mapped array of: First name of the notification contact

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

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

**notification\_contacts.map(x, x.last\_name)** `[]string` *required*

Mapped array of: Last name of the notification contact

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

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

**notification\_contacts.map(x, x.email\_address)** `[]string` *required*

`PII` Mapped array of: Email address of the notification contact

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

```json Example theme={null}
[
"john.doe@example.com"
]
```

**notification\_contacts.map(x, x.is\_emergency\_contact)** `[]bool` *required*

Mapped array of: Whether the notification contact is an emergency contact

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

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

**notification\_contacts.map(x, x.phone\_number)** `[]string` *required*

`PII` Mapped array of: Phone number of the notification contact

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

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

**notification\_contacts.map(x, x.relationship)** `[]string` *required*

Mapped array of: Relationship between the notification contact and the user

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

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

**dietitian\_organization\_id** `string`

Organization ID for the User's registered dietitian

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

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

**dietitian\_first\_name** `string`

First name of the User's registered dietitian

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

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

**dietitian\_last\_name** `string`

Last name of the User's registered dietitian

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

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

**dietitian\_email\_address** `string`

Email address of the User's registered dietitian

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

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

**dietitian\_id** `string`

ID of the User's registered dietitian

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

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

**sex** `string`

Sex

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

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

**sexual\_orientation** `string`

Sexual orientation

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

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

**primary\_race** `string`

Primary race

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

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

**active\_tags** `[]string` *required*

List of active tags for the User

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

```json Example theme={null}
[
"Weight Loss",
"Diabetes"
]
```

**other\_provider\_ids** `[]string` *required*

List of other provider IDs associated with the User

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

```json Example theme={null}
[
"123456",
"789012"
]
```

**providers** `[]object` *required*

List of providers associated with the user

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

```json Example theme={null}
[
{
"first_name": "Brian",
"id": "720312",
"last_name": "Hippocrates",
"name": "Dr. Brian Hippocrates",
"qualifications": "MD"
}
]
```

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

Mapped array of: ID for the provider

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

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

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

Mapped array of: Name of the provider

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

```json Example theme={null}
[
"Dr. Brian Hippocrates"
]
```

**providers.map(x, x.qualifications)** `[]string` *required*

Mapped array of: Qualifications of the provider

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

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

**providers.map(x, x.first\_name)** `[]string` *required*

Mapped array of: First name of the provider

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

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

**providers.map(x, x.last\_name)** `[]string` *required*

Mapped array of: Last name of the provider

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

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

**course\_memberships** `[]object` *required*

List of course memberships for the User

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

```json Example theme={null}
[
{
"course_id": "54654",
"course_name": "Nutrition 101",
"course_status": "active",
"started_at": "2024-02-14T16:10:11+00:00",
"updated_at": "2024-03-01T17:12:18+00:00"
}
]
```

**course\_memberships.map(x, x.course\_id)** `[]string` *required*

Mapped array of: ID of the course

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

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

**course\_memberships.map(x, x.course\_name)** `[]string` *required*

Mapped array of: Name of the course

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

```json Example theme={null}
[
"Nutrition 101"
]
```

**course\_memberships.map(x, x.course\_status)** `[]string` *required*

Mapped array of: Status of the course membership

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

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

**course\_memberships.map(x, x.started\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Time the course membership started

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

```json Example theme={null}
[
"2024-02-14T16:10:11+00:00"
]
```

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

Mapped array of: Time the course membership was last updated

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

```json Example theme={null}
[
"2024-03-01T17:12:18+00:00"
]
```

**next\_appt\_date** `timing.v1.Timestamp`

The timestamp of the next scheduled appointment for this Patient (if scheduled)

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

```json Example theme={null}
"2024-08-17T10:30:00-04:00"
```

**primary\_race\_code** `string`

The primary race code for the Patient

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

```json Example theme={null}
"1002-5"
```

**primary\_ethnicity\_code** `string`

The primary ethnicity code for the Patient

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

```json Example theme={null}
"2135-2"
```

**last\_appt\_date** `timing.v1.Timestamp`

The datetime of the last appointment the Patient had

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

```json Example theme={null}
"2024-04-22T09:00:00-04:00"
```

**client\_source** `object`

Client source

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

```json Example theme={null}
{
"id": "3265",
"readable_source": "John Doe MS, LMFT",
"ref_source": "12345",
"ref_source_other": "Instagram",
"ref_type": "referring_provider",
"related_insurance_id": "12345",
"related_object_id": "12345",
"related_object_name": "Other"
}
```

**client\_source.id** `string`

ID of the client source

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

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

**client\_source.readable\_source** `string`

Get readable source based on ref\_type

```json CEL theme={null}
$result_object_key.client_source.readable_source
```

```json Example theme={null}
"John Doe MS, LMFT"
```

**client\_source.ref\_source** `string`

The source of how a client was acquired: contain ID or a Other string

```json CEL theme={null}
$result_object_key.client_source.ref_source
```

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

**client\_source.ref\_source\_other** `string`

If ref\_source eq 'Other', than it may contain custom string or NULL

```json CEL theme={null}
$result_object_key.client_source.ref_source_other
```

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

**client\_source.ref\_type** `string`

The type of the source of how a client was acquired

```json CEL theme={null}
$result_object_key.client_source.ref_type
```

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

**client\_source.related\_insurance\_id** `string`

ID of the related insurance

```json CEL theme={null}
$result_object_key.client_source.related_insurance_id
```

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

**client\_source.related\_object\_id** `string`

ID of the related object, or 'Other'

```json CEL theme={null}
$result_object_key.client_source.related_object_id
```

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

**client\_source.related\_object\_name** `string`

Name of the related object

```json CEL theme={null}
$result_object_key.client_source.related_object_name
```

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

**referring\_physicians** `[]object` *required*

List of referring physicians (providers)

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

```json Example theme={null}
[
{
"business_name": "Dr. John",
"created_at": "2024-05-10T08:46:04Z",
"email": "john.doe@example.com",
"first_name": "John",
"full_name": "John Doe",
"id": "57211",
"last_name": "Doe",
"location": {
"city": "San Francisco",
"country": "USA",
"line1": "123 Main Street",
"line2": "Suite 100",
"state": "CA",
"zip": "94117"
},
"npi": "1000321231",
"phone_number": "+15551234123"
}
]
```

**referring\_physicians.map(x, x.id)** `[]string` *required*

Mapped array of: Provider ID

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

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

**referring\_physicians.map(x, x.first\_name)** `[]string` *required*

`PII` Mapped array of: Provider's first name

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

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

**referring\_physicians.map(x, x.last\_name)** `[]string` *required*

`PII` Mapped array of: Provider's last name

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

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

**referring\_physicians.map(x, x.location)** `[]bool` *required*

`PII` Mapped array of: Provider's location

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

```json Example theme={null}
[
{
"city": "San Francisco",
"country": "USA",
"line1": "123 Main Street",
"line2": "Suite 100",
"state": "CA",
"zip": "94117"
}
]
```

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

Mapped array of: Provider's creation date

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

```json Example theme={null}
[
"2024-05-10T08:46:04Z"
]
```

**referring\_physicians.map(x, x.business\_name)** `[]string` *required*

`PII` Mapped array of: Provider's business name

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

```json Example theme={null}
[
"Dr. John"
]
```

**referring\_physicians.map(x, x.phone\_number)** `[]string` *required*

`PII` Mapped array of: Provider's phone number

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

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

**referring\_physicians.map(x, x.email)** `[]string` *required*

`PII` Mapped array of: Provider's email

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

```json Example theme={null}
[
"john.doe@example.com"
]
```

**referring\_physicians.map(x, x.full\_name)** `[]string` *required*

`PII` Mapped array of: Provider's full name

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

```json Example theme={null}
[
"John Doe"
]
```

**referring\_physicians.map(x, x.npi)** `[]string` *required*

Mapped array of: Provider's NPI

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

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

**set\_password\_link** `string`

Password setup hyperlink

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

```json Example theme={null}
"https://passwords.health.co/reset"
```

**next\_appt\_id** `string`

The next scheduled appointment ID for this Patient (if specified)

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

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

**last\_appt\_id** `string`

The last scheduled appointment ID for this Patient (if specified)

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

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

**legal\_name** `string`

`PII` Legal name of the Patient

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

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

**changed\_fields** `[]string` *required*

Healthie User object fields changed in triggering the event for this User (Patient)

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

```json Example theme={null}
[
"email_address",
"first_name",
"last_name"
]
```

**npi** `string`

`ID` National Provider Identifier, this field only applies if the user is a provider

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

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

**is\_patient** `bool`

Whether the user is a patient

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

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

**state\_licenses** `[]object` *required*

The licenses for the Provider if this User is a Provider

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

```json Example theme={null}
[
{
"full_state_name": "New York",
"id": "500073",
"state": "NY"
}
]
```

**state\_licenses.map(x, x.id)** `[]string` *required*

Mapped array of: The unique identifier of the State license

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

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

**state\_licenses.map(x, x.state)** `[]string` *required*

Mapped array of: The abbreviation of the State

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

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

**state\_licenses.map(x, x.full\_state\_name)** `[]string` *required*

Mapped array of: The full name of the State

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

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

**dietitian\_organization\_location\_id** `string`

Organization's location ID for the User's registered dietitian

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

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

**additional\_phone\_number** `string`

`PII` Additional phone number of the user

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

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

**additional\_record\_identifier** `string`

`ID` Additional record identifier for the User (an extra external unique patient ID reference)

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

```json Example theme={null}
"2847455b-caed-4d97-a79c-1f07316e7fbf"
```

**dietitian\_organization\_name** `string`

Organization name for the user's registered dietitian

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

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

**brand** `object`

Brand details for the User

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

```json Example theme={null}
{
"about_description": "We provide comprehensive health services",
"brand_email": "brand@example.com",
"brand_name": "My Health Brand",
"brand_phone": "+15551234567"
}
```

**brand.brand\_name** `string`

Name of provider's brand

```json CEL theme={null}
$result_object_key.brand.brand_name
```

```json Example theme={null}
"My Health Brand"
```

**brand.brand\_email** `string`

Brand owner's brand email

```json CEL theme={null}
$result_object_key.brand.brand_email
```

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

**brand.brand\_phone** `string`

Brand owner's brand phone

```json CEL theme={null}
$result_object_key.brand.brand_phone
```

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

**brand.about\_description** `string`

Brand owner's about description

```json CEL theme={null}
$result_object_key.brand.about_description
```

```json Example theme={null}
"We provide comprehensive health services"
```

**metadata** `object`

`HI` `ID` `PII` Metadata for the user

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

```json Example theme={null}
{
"priority": "High",
"referral_department": "Cardiology"
}
```


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