athenahealth integration

Add Self-Pay Cash Plan

Perform Add Self-Pay Cash Plan through athenahealth.

View as Markdown

athena_add_self_pay_plan

writeathenahealth

Inputs

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

Outputs

successSuccess
submittedSubmitted
write_skippedWrite Skipped
patient_insurance_idPatient Insurance Id
patient_idPatient Id
cash_plan_package_idCash Plan Package Id
sequence_numberSequence Number
submitted_field_countSubmitted Field Count
cash_plan_previewedCash Plan Previewed
sliding_fee_program_idSliding Fee Program Id
sliding_fee_program_labelSliding Fee Program Label
sliding_fee_plan_idSliding Fee Plan Id
sliding_fee_plan_labelSliding Fee Plan Label
noninsurance_type_idNoninsurance Type Id
preview_field_countPreview Field Count
program_plan_pair_verifiedProgram Plan Pair Verified
selection_statusSelection Status
verifiedVerified
submission_statusSubmission Status
manual_review_requiredManual Review Required
readback_statusReadback Status
retryableRetryable
errorError
error_messageError 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

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

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

View all athenahealth actions