NikoHealth integration

Search Orders

Perform Search Orders through NikoHealth.

View as Markdown

nikohealth_search_orders

readnikohealth

Inputs

patient_id
text
Patient Id
Optional text value.
require_patient_id
boolean
Require Patient Id
Optional true-or-false value.
Default: false
status
multi_selectdynamic options
Status
Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.
Default: ["New"]
lookback_hours
number
Lookback Hours
Optional numeric value.
created_from
expression
Created From
Optional literal value or workflow expression.
created_to
expression
Created To
Optional literal value or workflow expression.
timezone
text
Timezone
Optional text value.
Default: "America/Chicago"
order_types
expression
Order Types
Optional literal value or workflow expression.
page_size
number
Page Size
Optional numeric value.
Default: 50
max_pages
number
Max Pages
Optional numeric value.
record_limit
number
Record Limit
Optional numeric value.
sort_expression
text
Sort Expression
Optional text value.
Default: "CreatedDate DESC"
exclude_tag_ids
expression
Exclude Tag Ids
Optional literal value or workflow expression.
exclude_tag_names
expression
Exclude Tag Names
Optional literal value or workflow expression.
hydrate_details
boolean
Hydrate Details
Optional true-or-false value.
Default: false
require_complete
boolean
Require Complete
Optional true-or-false value.
Default: false
default_on_error
boolean
Default On Error
Optional true-or-false value.
Default: false

Outputs

successSuccess
ordersOrders
countCount
excluded_by_tag_countExcluded By Tag Count
truncated_by_record_limitTruncated By Record Limit
pages_fetchedPages Fetched
truncated_by_page_capTruncated By Page Cap
details_hydratedDetails Hydrated
window_sourceWindow Source
created_fromCreated From
created_toCreated To
defaultedDefaulted
reasonReason
errorError

Output schema completeness: best_effort_declared

Safety

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

Schemas

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

Input schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": [
        "New"
      ],
      "description": "Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "multi_select"
    },
    "timezone": {
      "type": "string",
      "default": "America/Chicago",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_pages": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "page_size": {
      "type": "number",
      "default": 50,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "created_to": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "order_types": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "created_from": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "record_limit": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "lookback_hours": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "exclude_tag_ids": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "hydrate_details": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "sort_expression": {
      "type": "string",
      "default": "CreatedDate DESC",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "default_on_error": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "require_complete": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "exclude_tag_names": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "require_patient_id": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "orders": {},
    "reason": {},
    "success": {},
    "defaulted": {},
    "created_to": {},
    "created_from": {},
    "pages_fetched": {},
    "window_source": {},
    "details_hydrated": {},
    "excluded_by_tag_count": {},
    "truncated_by_page_cap": {},
    "truncated_by_record_limit": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions