NikoHealth integration

Get Patient Documents

Perform Get Patient Documents through NikoHealth.

View as Markdown

nikohealth_get_patient_documents

readnikohealth

Inputs

patient_id
textrequired
Patient Id
Required text value.
document_type
text
Document Type
Optional text value.
page_size
number
Page Size
Optional numeric value.
Default: 50
max_pages
number
Max Pages
Optional numeric value.
Default: 1
require_complete
boolean
Require Complete
Optional true-or-false value.
Default: false

Outputs

successSuccess
documentsDocuments
patient_document_idsPatient Document Ids
countCount
page_countPage Count
truncated_by_page_capTruncated By Page Cap
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",
  "required": [
    "patient_id"
  ],
  "properties": {
    "max_pages": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "page_size": {
      "type": "number",
      "default": 50,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "patient_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "document_type": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "require_complete": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "success": {},
    "documents": {},
    "page_count": {},
    "patient_document_ids": {},
    "truncated_by_page_cap": {}
  },
  "additionalProperties": true
}

View all NikoHealth actions