NikoHealth integration

Search Patient

Perform Search Patient through NikoHealth.

View as Markdown

nikohealth_search_patient

readnikohealth

Inputs

first_name
text
First Name
Optional text value.
last_name
text
Last Name
Optional text value.
date_of_birth
text
Date Of Birth
Optional text value.
full_address
text
Full Address
Optional text value.
tags
expression
Tags
Optional literal value or workflow expression.
created_from
expression
Created From
Optional literal value or workflow expression.
created_to
expression
Created To
Optional literal value or workflow expression.
sort_by
select
Sort By
Optional selected identifier or value.
Default: "name"
Options: Full Name ("name"), Created Date ("created"), Modified Date ("modified")
sort_descending
boolean
Sort Descending
Optional true-or-false value.
Default: false
page_size
number
Page Size
Optional numeric value.
Default: 100
page_index
number
Page Index
Optional numeric value.
Default: 0

Outputs

patientsPatients
countCount
sort_expressionSort Expression
unknown_tagsUnknown Tags
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": {
    "tags": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sort_by": {
      "enum": [
        "name",
        "created",
        "modified"
      ],
      "type": "string",
      "default": "name",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "last_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "page_size": {
      "type": "number",
      "default": 100,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "created_to": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "first_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "page_index": {
      "type": "number",
      "default": 0,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "created_from": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "full_address": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "date_of_birth": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "sort_descending": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "patients": {},
    "unknown_tags": {},
    "sort_expression": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions