Skip to documentation
athenahealth integration

Add Insurance Authorization

Perform Add Insurance Authorization through athenahealth.

View as Markdown
athena_add_patient_authorization
writeathenahealth

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "athenahealth",
  "params": {
    "units_type": "VISITS",
    "write_enabled": false,
    "authorization_type": "PRE-CERT"
  },
  "handler": "athena_add_patient_authorization"
}

Action contracts and connections · Run recovery

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • chart_id
    expression
    Chart Id

    Optional literal value or workflow expression.

  • patient_insurance_id
    expressionrequired
    Patient Insurance Id

    Required literal value or workflow expression.

  • authorization_type
    select
    Authorization Type

    Optional selected identifier or value.

    Default: "PRE-CERT"

    Options: Pre-Cert ("PRE-CERT"), Referral ("REFERRAL")

  • authorization_number
    expression
    Authorization Number

    Optional literal value or workflow expression.

  • effective_from
    expressionrequired
    Effective From

    Required literal value or workflow expression.

  • effective_to
    expression
    Effective To

    Optional literal value or workflow expression.

  • visits_approved
    expression
    Visits Approved

    Optional literal value or workflow expression.

  • visits_remaining
    expression
    Visits Remaining

    Optional literal value or workflow expression.

  • units_type
    select
    Units Type

    Optional selected identifier or value.

    Default: "VISITS"

    Options: Visits ("VISITS"), Units ("UNITS")

  • icd10_codes
    expression
    Icd10 Codes

    Optional literal value or workflow expression.

  • procedure_codes
    expression
    Procedure Codes

    Optional literal value or workflow expression.

  • additional_information
    expression
    Additional Information

    Optional literal value or workflow expression.

  • notes
    textarea
    Notes

    Optional text value.

  • referred_to_provider_id
    expression
    Referred To Provider Id

    Optional literal value or workflow expression.

  • referring_provider_id
    expression
    Referring Provider Id

    Optional literal value or workflow expression.

  • referred_to_referring_provider_id
    expression
    Referred To Referring Provider Id

    Optional literal value or workflow expression.

  • specialty_id
    expression
    Specialty Id

    Optional literal value or workflow expression.

  • department_id
    expression
    Department Id

    Optional literal value or workflow expression.

  • notes_to_provider
    textarea
    Notes To Provider

    Optional text value.

  • source_document_id
    expression
    Source Document Id

    Optional literal value or workflow expression.

  • write_enabled
    boolean
    Write Enabled

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • submittedSubmitted
  • write_skippedWrite Skipped
  • skip_reasonSkip Reason
  • authorization_idAuthorization Id
  • already_presentAlready Present
  • matched_byMatched By
  • listed_typeListed Type
  • listed_asListed As
  • patient_idPatient Id
  • chart_idChart Id
  • patient_insurance_idPatient Insurance Id
  • insurance_package_nameInsurance Package Name
  • insurance_sequence_numberInsurance Sequence Number
  • department_idDepartment Id
  • department_nameDepartment Name
  • referring_provider_sourceReferring Provider Source
  • authorization_previewAuthorization Preview
  • authorizationAuthorization
  • athenaAthena
  • submitted_field_countSubmitted Field Count
  • mismatched_fieldsMismatched Fields
  • codes_verifiedCodes Verified
  • errorError
  • error_messageError Message
  • failure_phaseFailure Phase
  • error_codeError Code
  • retryableRetryable

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",
    "patient_insurance_id",
    "effective_from"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "chart_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "units_type": {
      "enum": [
        "VISITS",
        "UNITS"
      ],
      "type": "string",
      "default": "VISITS",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "icd10_codes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "effective_to": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "specialty_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "department_id": {
      "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"
    },
    "effective_from": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "procedure_codes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "visits_approved": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "visits_remaining": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "notes_to_provider": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "authorization_type": {
      "enum": [
        "PRE-CERT",
        "REFERRAL"
      ],
      "type": "string",
      "default": "PRE-CERT",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "source_document_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "authorization_number": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_insurance_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "referring_provider_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "additional_information": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "referred_to_provider_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "referred_to_referring_provider_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "athena": {},
    "success": {},
    "chart_id": {},
    "listed_as": {},
    "retryable": {},
    "submitted": {},
    "error_code": {},
    "matched_by": {},
    "patient_id": {},
    "listed_type": {},
    "skip_reason": {},
    "authorization": {},
    "department_id": {},
    "error_message": {},
    "failure_phase": {},
    "write_skipped": {},
    "codes_verified": {},
    "already_present": {},
    "department_name": {},
    "authorization_id": {},
    "mismatched_fields": {},
    "patient_insurance_id": {},
    "authorization_preview": {},
    "submitted_field_count": {},
    "insurance_package_name": {},
    "insurance_sequence_number": {},
    "referring_provider_source": {}
  },
  "additionalProperties": true
}
View all athenahealth actions