NikoHealth integration

Create Invoice

Perform Create Invoice through NikoHealth.

View as Markdown

nikohealth_create_claim

irreversiblenikohealth

Inputs

patient_id
expressionrequired
Patient Id
Required literal value or workflow expression.
hcpcs_code
textrequired
Hcpcs Code
Required text value.
service_date_from
expressionrequired
Service Date From
Required literal value or workflow expression.
service_date_to
expression
Service Date To
Optional literal value or workflow expression.
billing_provider_name
textrequired
Billing Provider Name
Required text value.
referring_provider_id
expressionrequired
Referring Provider Id
Required literal value or workflow expression.
diagnosis_codes
expressionrequired
Diagnosis Codes
Required literal value or workflow expression.
insurance_id
expression
Insurance Id
Optional literal value or workflow expression.
place_of_service
text
Place Of Service
Optional text value.
Default: "12"
quantity
number
Quantity
Optional numeric value.
Default: 1
status
text
Status
Optional text value.
Default: "New"
resubmission_code
text
Resubmission Code
Optional text value.
Default: "Original"
order_id
expression
Order Id
Optional literal value or workflow expression.
prefer_latest_order
boolean
Prefer Latest Order
Optional true-or-false value.
Default: false
product_id
expression
Product Id
Optional literal value or workflow expression.
product_name
text
Product Name
Optional text value.
line_name
text
Line Name
Optional text value.
modifiers
expression
Modifiers
Optional literal value or workflow expression.
price_option_id
expression
Price Option Id
Optional literal value or workflow expression.
sale_type
select
Sale Type
Optional selected identifier or value.
Default: "Purchase"
Options: Purchase ("Purchase"), Rental ("Rental")
require_patient_diagnoses
boolean
Require Patient Diagnoses
Optional true-or-false value.
Default: true
fail_on_restrictions
boolean
Fail On Restrictions
Optional true-or-false value.
Default: true
skip_if_empty
boolean
Skip If Empty
Optional true-or-false value.
Default: false
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
skippedSkipped
statusStatus
claim_idClaim Id
can_submitCan Submit
price_option_idPrice Option Id
chargeCharge
allowedAllowed
modifiersModifiers
billing_provider_nameBilling Provider Name
insurance_idInsurance Id
order_idOrder Id
product_idProduct Id
product_nameProduct Name
product_sourceProduct Source
product_candidates_countProduct Candidates Count
restriction_warningsRestriction Warnings
restriction_codesRestriction Codes
validation_errorsValidation Errors
payloadPayload
dry_runDry Run
errorError

Output schema completeness: best_effort_declared

Safety

External effect: irreversible
Confirmation recommended: Yes
Retry safe: No
Dry run supported: Yes

Schemas

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

Input schema

{
  "type": "object",
  "required": [
    "patient_id",
    "hcpcs_code",
    "service_date_from",
    "billing_provider_name",
    "referring_provider_id",
    "diagnosis_codes"
  ],
  "properties": {
    "status": {
      "type": "string",
      "default": "New",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "order_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "quantity": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "line_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "modifiers": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sale_type": {
      "enum": [
        "Purchase",
        "Rental"
      ],
      "type": "string",
      "default": "Purchase",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "hcpcs_code": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "product_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "insurance_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "product_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "skip_if_empty": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "diagnosis_codes": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "price_option_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "service_date_to": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "place_of_service": {
      "type": "string",
      "default": "12",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "resubmission_code": {
      "type": "string",
      "default": "Original",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "service_date_from": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "prefer_latest_order": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "fail_on_restrictions": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "billing_provider_name": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "referring_provider_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "require_patient_diagnoses": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "charge": {},
    "status": {},
    "allowed": {},
    "dry_run": {},
    "payload": {},
    "skipped": {},
    "success": {},
    "claim_id": {},
    "order_id": {},
    "modifiers": {},
    "can_submit": {},
    "product_id": {},
    "insurance_id": {},
    "product_name": {},
    "product_source": {},
    "price_option_id": {},
    "restriction_codes": {},
    "validation_errors": {},
    "restriction_warnings": {},
    "billing_provider_name": {},
    "product_candidates_count": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions