NikoHealth integration

Assign Documents to Order

Perform Assign Documents to Order through NikoHealth.

View as Markdown

nikohealth_assign_order_documents

writenikohealth

Inputs

patient_id
textrequired
Patient Id
Required text value.
order_id
textrequired
Order Id
Required text value.
patient_document_ids
expressionrequired
Patient Document Ids
Required literal value or workflow expression.
merge_existing
boolean
Merge Existing
Optional true-or-false value.
Default: true
enabled
boolean
Enabled
Optional true-or-false value.
Default: true
skip_if_empty
boolean
Skip If Empty
Optional true-or-false value.
Default: false

Outputs

successSuccess
statusStatus
skippedSkipped
patient_idPatient Id
order_idOrder Id
incoming_patient_document_idsIncoming Patient Document Ids
existing_patient_document_idsExisting Patient Document Ids
submitted_patient_document_idsSubmitted Patient Document Ids
patient_document_idsPatient Document Ids
assigned_countAssigned Count
associated_countAssociated Count
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": [
    "patient_id",
    "order_id",
    "patient_document_ids"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "order_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "patient_id": {
      "type": "string",
      "description": "Required 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"
    },
    "merge_existing": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "patient_document_ids": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "skipped": {},
    "success": {},
    "order_id": {},
    "patient_id": {},
    "assigned_count": {},
    "associated_count": {},
    "patient_document_ids": {},
    "existing_patient_document_ids": {},
    "incoming_patient_document_ids": {},
    "submitted_patient_document_ids": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions