Parameters

Action

Parameters

Hide parameters

Patient ID

string

ID This field maps to the destination API client_id, overrides profile ID if specified field.

Insurance Policy Array Index

int64

This field maps to the destination API 0..n policies array index (default 0) field.

Member ID

string

required

ID PII This field maps to the destination API num field.

Insurance Plan ID

string

required

This field maps to the destination API insurance_plan_id field.

Holder First Name

string

PII This field maps to the destination API holder_first field.

Holder Last Name

string

PII This field maps to the destination API holder_last field.

Holder Relationship

string

required

PII This field maps to the destination API holder_relationship field.

Holder Date of Birth

string

PII This field maps to the destination API holder_dob field.

Holder Gender

string

This field maps to the destination API holder_gender field.

Group ID

string

This field maps to the destination API group_id field.

Insurance Card Front ID

string

This field maps to the destination API insurance_card_front_id field.

Insurance Card Back ID

string

This field maps to the destination API insurance_card_back_id field.

Insurance Type

string

This field maps to the destination API type_string field.

Priority Type

string

This field maps to the destination API priority_type field.

{
  "$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"
  }
}

{
  "$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 a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.

Policy

Fetch Action Response Object

Hide fields

insurance_plan

object

Insurance plan details

CEL

$result_object_key.insurance_plan

Example

{
"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

CEL

$result_object_key.insurance_plan.payer_id

Example

"629913"

insurance_plan.payer_name

string

Name of the insurance payer

CEL

$result_object_key.insurance_plan.payer_name

Example

"Blue Cross Blue Shield"

insurance_plan.id

string

ID of the insurance plan

CEL

$result_object_key.insurance_plan.id

Example

"611231"

insurance_plan.name_and_id

string

Name of the payer and id of payer

CEL

$result_object_key.insurance_plan.name_and_id

Example

"Blue Cross Blue Shield - 629913"

num

string

PII Policy number

CEL

$result_object_key.num

Example

"1912310"

group_num

string

Group number

CEL

$result_object_key.group_num

Example

"331256"

notes

string

Notes about the policy

CEL

$result_object_key.notes

Example

"Policy is active"

effective_end

values.v1.Date

Date the policy coverage expires

CEL

$result_object_key.effective_end

Example

"2024-07-04"

string

required

ID for the policy

CEL

$result_object_key.id

Example

"202402"

patient_id

string

required

ID PII ID of the patient associated with the policy

CEL

$result_object_key.patient_id

Example

"100121"

insurance_card_front_id

string

HI ID PII ID of the insurance card front image object

CEL

$result_object_key.insurance_card_front_id

Example

"123451"

insurance_card_back_id

string

HI ID PII ID of the insurance card back image object

CEL

$result_object_key.insurance_card_back_id

Example

"123452"

updated_at

timing.v1.Timestamp

required

Last time the Policy was updated

CEL

$result_object_key.updated_at

Example

"2024-07-01T11:29:19+00:00"

insurance_type

string

The type of insurance: type_string

CEL

$result_object_key.insurance_type

Example

"Medicaid"

priority_type

string

The priority type of insurance: priority_type

CEL

$result_object_key.priority_type

Example

"Primary"

benefits

object

required

Insurance plan details

CEL

$result_object_key.benefits

Example

[
{
"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

CEL

$result_object_key.benefits.map(x, x.coinsurance)

Example

[
"15"
]

benefits.map(x, x.copay)

[]string

required

Mapped array of: Copay amount due

CEL

$result_object_key.benefits.map(x, x.copay)

Example

[
"50"
]

benefits.map(x, x.deductible_calendar_year)

[]string

required

Mapped array of: Deductible amount for the calendar year

CEL

$result_object_key.benefits.map(x, x.deductible_calendar_year)

Example

[
"2000"
]

benefits.map(x, x.deductible_year_to_date)

[]string

required

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

CEL

$result_object_key.benefits.map(x, x.deductible_year_to_date)

Example

[
"1500"
]

Events

Actions

Integrations

Create Or Update Insurance Policy

Parameters

Result Object Field Details

Events

Actions

Integrations

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details