Skip to documentation
NikoHealth integration

Edit Existing Order (v1)

Perform Edit Existing Order (v1) through NikoHealth.

View as Markdown
nikohealth_edit_order
writenikohealth

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • order_id
    expressionrequired
    Order Id

    Required literal value or workflow expression.

  • product_swaps
    expression
    Product Swaps

    Optional literal value or workflow expression.

  • add_items
    expression
    Add Items

    Optional literal value or workflow expression.

  • diagnosis_codes
    expression
    Diagnosis Codes

    Optional literal value or workflow expression.

  • diagnosis_code_prefixes
    expression
    Diagnosis Code Prefixes

    Optional literal value or workflow expression.

  • dry_run
    boolean
    Dry Run

    Optional true-or-false value.

    Default: true

Outputs

  • successSuccess
  • order_idOrder Id
  • edit_statusEdit Status
  • applied_opsApplied Ops
  • item_countItem Count
  • diagnosis_countDiagnosis Count
  • confirmed_by_readbackConfirmed By Readback
  • refusal_reasonRefusal Reason
  • refusal_fieldRefusal Field
  • refusal_detailRefusal Detail
  • failure_categoryFailure Category
  • retryableRetryable
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
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",
    "order_id"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "order_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "add_items": {
      "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"
    },
    "product_swaps": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "diagnosis_codes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "diagnosis_code_prefixes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "order_id": {},
    "retryable": {},
    "item_count": {},
    "applied_ops": {},
    "edit_status": {},
    "refusal_field": {},
    "refusal_detail": {},
    "refusal_reason": {},
    "diagnosis_count": {},
    "failure_category": {},
    "confirmed_by_readback": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions