Skip to documentation
NikoHealth integration

Run Eligibility Check

Perform Run Eligibility Check through NikoHealth.

View as Markdown
nikohealth_run_eligibility_check
writenikohealth

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • niko_insurance_id
    expression
    Niko Insurance Id

    Optional literal value or workflow expression.

  • force_resubmit
    boolean
    Force Resubmit

    Optional true-or-false value.

    Default: false

  • enabled
    boolean
    Enabled

    Optional true-or-false value.

    Default: true

  • skip_reason
    expression
    Skip Reason

    Optional literal value or workflow expression.

  • update_insurance_status_without_local_policy
    boolean
    Update Insurance Status Without Local Policy

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • statusStatus
  • skippedSkipped
  • is_eligibleIs Eligible
  • alertsAlerts
  • transaction_idTransaction Id
  • eligibility_resultEligibility Result
  • niko_insurance_idNiko Insurance Id
  • insurance_status_updatedInsurance Status Updated
  • status_update_skipped_reasonStatus Update Skipped Reason
  • 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"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "skip_reason": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "force_resubmit": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "niko_insurance_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "update_insurance_status_without_local_policy": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "alerts": {},
    "status": {},
    "skipped": {},
    "success": {},
    "is_eligible": {},
    "error_message": {},
    "transaction_id": {},
    "niko_insurance_id": {},
    "eligibility_result": {},
    "insurance_status_updated": {},
    "status_update_skipped_reason": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions