NikoHealth integration

Find Patients

Perform Find Patients through NikoHealth.

View as Markdown

nikohealth_find_patients

readnikohealth

Inputs

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"
page_size
number
Page Size
Optional numeric value.
Default: 100
max_pages
number
Max Pages
Optional numeric value.
Default: 50
record_limit
number
Record Limit
Optional numeric value.
sort_expression
text
Sort Expression
Optional text value.
Default: "FullName ASC"
tag_ids
expression
Tag Ids
Optional literal value or workflow expression.
tag_names
expression
Tag Names
Optional literal value or workflow expression.
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.

Outputs

successSuccess
patientsPatients
countCount
excluded_by_tag_countExcluded By Tag Count
unknown_tagsUnknown Tags
truncated_by_record_limitTruncated By Record Limit
pages_fetchedPages Fetched
truncated_by_page_capTruncated By Page Cap
window_sourceWindow Source
created_fromCreated From
created_toCreated To
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": {
    "tag_ids": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "timezone": {
      "type": "string",
      "default": "America/Chicago",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_pages": {
      "type": "number",
      "default": 50,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "page_size": {
      "type": "number",
      "default": 100,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "tag_names": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "created_to": {
      "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"
    },
    "sort_expression": {
      "type": "string",
      "default": "FullName ASC",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "exclude_tag_names": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "success": {},
    "patients": {},
    "created_to": {},
    "created_from": {},
    "unknown_tags": {},
    "pages_fetched": {},
    "window_source": {},
    "excluded_by_tag_count": {},
    "truncated_by_page_cap": {},
    "truncated_by_record_limit": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions