# Add Self-Pay Cash Plan

> Perform Add Self-Pay Cash Plan through athenahealth.

Source: [https://genhealth.ai/docs/workflows/integrations/athenahealth/athena_add_self_pay_plan](https://genhealth.ai/docs/workflows/integrations/athenahealth/athena_add_self_pay_plan)

Integration: [athenahealth](https://genhealth.ai/docs/workflows/integrations/athenahealth.md)

- Handler: `athena_add_self_pay_plan`

- Connection type: `athenahealth`

## Inputs

- `patient_id` — Patient Id (expression, required)
  Required literal value or workflow expression.
- `cash_plan_package_id` — Cash Plan Package Id (expression, required)
  Required literal value or workflow expression.
- `cash_plan_member_id` — Cash Plan Member Id (expression)
  Optional literal value or workflow expression.
- `product_type_id` — Product Type Id (expression)
  Optional literal value or workflow expression.
- `sliding_fee_program_id` — Sliding Fee Program Id (expression)
  Optional literal value or workflow expression.
- `sliding_fee_plan_id` — Sliding Fee Plan Id (expression)
  Optional literal value or workflow expression.
- `noninsurance_type_id` — Noninsurance Type Id (expression)
  Optional literal value or workflow expression.
- `program_poverty_based` — Program Poverty Based (boolean)
  Optional true-or-false value.
- `sequence_number` — Sequence Number (select)
  Optional selected identifier or value.
  Default: `"1"`
  Options: Primary ("1"), Secondary ("2"), Tertiary ("3")
- `notes` — Notes (textarea)
  Optional text value.
- `family_size` — Family Size (expression)
  Optional literal value or workflow expression.
- `yearly_income` — Yearly Income (expression)
  Optional literal value or workflow expression.
- `income_per_pay_period` — Income Per Pay Period (expression)
  Optional literal value or workflow expression.
- `pay_period` — Pay Period (expression)
  Optional literal value or workflow expression.
- `issue_date` — Issue Date (date)
  Optional date in YYYY-MM-DD format.
- `expiration_date` — Expiration Date (date)
  Optional date in YYYY-MM-DD format.
- `write_enabled` — Write Enabled (boolean)
  Optional true-or-false value.
  Default: `false`
- `confirm_unverified_write` — Confirm Unverified Write (boolean)
  Optional true-or-false value.
  Default: `false`

## Outputs

- `success` — Success
- `submitted` — Submitted
- `write_skipped` — Write Skipped
- `patient_insurance_id` — Patient Insurance Id
- `patient_id` — Patient Id
- `cash_plan_package_id` — Cash Plan Package Id
- `sequence_number` — Sequence Number
- `submitted_field_count` — Submitted Field Count
- `cash_plan_previewed` — Cash Plan Previewed
- `sliding_fee_program_id` — Sliding Fee Program Id
- `sliding_fee_program_label` — Sliding Fee Program Label
- `sliding_fee_plan_id` — Sliding Fee Plan Id
- `sliding_fee_plan_label` — Sliding Fee Plan Label
- `noninsurance_type_id` — Noninsurance Type Id
- `preview_field_count` — Preview Field Count
- `program_plan_pair_verified` — Program Plan Pair Verified
- `selection_status` — Selection Status
- `verified` — Verified
- `submission_status` — Submission Status
- `manual_review_required` — Manual Review Required
- `readback_status` — Readback Status
- `retryable` — Retryable
- `error` — Error
- `error_message` — Error Message

Output schema completeness: `best_effort_declared`

## Safety

- External effect: `write`
- Confirmation recommended: no
- Retry safe: no
- Dry run supported: no

## Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

### Input schema

```json
{
  "type": "object",
  "required": [
    "patient_id",
    "cash_plan_package_id"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "issue_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "pay_period": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "family_size": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "write_enabled": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "yearly_income": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "expiration_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "product_type_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sequence_number": {
      "enum": [
        "1",
        "2",
        "3"
      ],
      "type": "string",
      "default": "1",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "cash_plan_member_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sliding_fee_plan_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "cash_plan_package_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "noninsurance_type_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "income_per_pay_period": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "program_poverty_based": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "sliding_fee_program_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "confirm_unverified_write": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
```

### Output schema

```json
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "verified": {},
    "retryable": {},
    "submitted": {},
    "patient_id": {},
    "error_message": {},
    "write_skipped": {},
    "readback_status": {},
    "sequence_number": {},
    "selection_status": {},
    "submission_status": {},
    "cash_plan_previewed": {},
    "preview_field_count": {},
    "sliding_fee_plan_id": {},
    "cash_plan_package_id": {},
    "noninsurance_type_id": {},
    "patient_insurance_id": {},
    "submitted_field_count": {},
    "manual_review_required": {},
    "sliding_fee_plan_label": {},
    "sliding_fee_program_id": {},
    "sliding_fee_program_label": {},
    "program_plan_pair_verified": {}
  },
  "additionalProperties": true
}
```