Availity integration

Generate Eligibility Report

Perform Generate Eligibility Report through Availity.

View as Markdown

availity_generate_eligibility_report

write

Inputs

coverage_response
jsonrequired
Coverage Response
Required JSON value.
response_label
expression
Response Label
Optional literal value or workflow expression.
additional_coverage_responses
json
Additional Coverage Responses
Optional JSON value.
procedure_codes
expression
Procedure Codes
Optional literal value or workflow expression.
submitted_procedure_codes
expression
Submitted Procedure Codes
Optional literal value or workflow expression.
procedure_code_support
expression
Procedure Code Support
Optional literal value or workflow expression.
procedure_code_support_detail
expression
Procedure Code Support Detail
Optional literal value or workflow expression.
include_branding
boolean
Include Branding
Optional true-or-false value.
Default: true
output_path
expression
Output Path
Optional literal value or workflow expression.
persistence_target
select
Persistence Target
Optional selected identifier or value.
Default: "insurance_policy"
Options: Insurance Policy ("insurance_policy"), Standalone Document ("standalone_document")
source_document_id
expression
Source Document Id
Optional literal value or workflow expression.
insurance_policy_id
expression
Insurance Policy Id
Optional literal value or workflow expression.
standalone_document_title
expression
Standalone Document Title
Optional literal value or workflow expression.
show_generated_document_in_inbox
boolean
Show Generated Document In Inbox
Optional true-or-false value.
Default: true
patient_id
expression
Patient Id
Optional literal value or workflow expression.
related_document_ids
expression
Related Document Ids
Optional literal value or workflow expression.
service_types
expression
Service Types
Optional literal value or workflow expression.

Outputs

successSuccess
persistence_targetPersistence Target
insurance_policy_idInsurance Policy Id
document_idDocument Id
pdf_pathPdf Path
s3_pathS3 Path
attachment_pathsAttachment Paths
filenameFilename
content_typeContent Type
coverage_idCoverage Id
related_document_idsRelated Document Ids
patient_idPatient Id
errorError

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": [
    "coverage_response"
  ],
  "properties": {
    "patient_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "output_path": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "service_types": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "response_label": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "procedure_codes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "include_branding": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "coverage_response": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "persistence_target": {
      "enum": [
        "insurance_policy",
        "standalone_document"
      ],
      "type": "string",
      "default": "insurance_policy",
      "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"
    },
    "insurance_policy_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "related_document_ids": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "procedure_code_support": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "standalone_document_title": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "submitted_procedure_codes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "additional_coverage_responses": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "procedure_code_support_detail": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "show_generated_document_in_inbox": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "s3_path": {},
    "success": {},
    "filename": {},
    "pdf_path": {},
    "patient_id": {},
    "coverage_id": {},
    "document_id": {},
    "content_type": {},
    "attachment_paths": {},
    "persistence_target": {},
    "insurance_policy_id": {},
    "related_document_ids": {}
  },
  "additionalProperties": true
}

View all Availity actions