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

> Documentation for the Get Policy 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**

**Policy ID** `string` *required*

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

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

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

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

**Policy** `Fetch Action Response Object`

**fields**

**insurance\_plan** `object`

Insurance plan details

```json CEL theme={null}
$result_object_key.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"
}
```

**insurance\_plan.payer\_id** `string`

ID of the insurance payer

```json CEL theme={null}
$result_object_key.insurance_plan.payer_id
```

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

**insurance\_plan.payer\_name** `string`

Name of the insurance payer

```json CEL theme={null}
$result_object_key.insurance_plan.payer_name
```

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

**insurance\_plan.id** `string`

ID of the insurance plan

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

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

**insurance\_plan.name\_and\_id** `string`

Name of the payer and id of payer

```json CEL theme={null}
$result_object_key.insurance_plan.name_and_id
```

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

**num** `string`

`PII` Policy number

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

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

**group\_num** `string`

Group number

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

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

**notes** `string`

Notes about the policy

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

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

**effective\_end** `values.v1.Date`

Date the policy coverage expires

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

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

**id** `string` *required*

ID for the policy

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

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

**patient\_id** `string` *required*

`ID` `PII` ID of the patient associated with the policy

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

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

**insurance\_card\_front\_id** `string`

`HI` `ID` `PII` ID of the insurance card front image object

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

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

**insurance\_card\_back\_id** `string`

`HI` `ID` `PII` ID of the insurance card back image object

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

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

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

Last time the Policy was updated

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

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

**insurance\_type** `string`

The type of insurance: `type_string`

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

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

**priority\_type** `string`

The priority type of insurance: `priority_type`

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

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

**benefits** `[]object` *required*

Insurance plan details

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

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

**benefits.map(x, x.coinsurance)** `[]string` *required*

Mapped array of: Coinsurance percentage due

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

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

**benefits.map(x, x.copay)** `[]string` *required*

Mapped array of: Copay amount due

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

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

**benefits.map(x, x.deductible\_calendar\_year)** `[]string` *required*

Mapped array of: Deductible amount for the calendar year

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

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

**benefits.map(x, x.deductible\_year\_to\_date)** `[]string` *required*

Mapped array of: Deductible amount for the year to-date

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

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


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