Skip to documentation
NikoHealth integration

Check Patient Document Exists

Perform Check Patient Document Exists through NikoHealth.

View as Markdown
nikohealth_check_patient_document_exists
writenikohealth

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • document_type
    expressionrequired
    Document Type

    Required literal value or workflow expression.

  • filename_prefix
    expressionrequired
    Filename Prefix

    Required literal value or workflow expression.

  • include_previous_versions
    boolean
    Include Previous Versions

    Optional true-or-false value.

    Default: true

  • pseudonymized_filename_template
    expression
    Pseudonymized Filename Template

    Optional literal value or workflow expression.

  • pseudonymization_purpose
    expression
    Pseudonymization Purpose

    Optional literal value or workflow expression.

Outputs

  • successSuccess
  • statusStatus
  • foundFound
  • matched_document_idMatched Document Id
  • matched_formatMatched Format
  • matched_legacy_formatMatched Legacy Format
  • 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",
    "document_type",
    "filename_prefix"
  ],
  "properties": {
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_type": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "filename_prefix": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "pseudonymization_purpose": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "include_previous_versions": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "pseudonymized_filename_template": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "found": {},
    "status": {},
    "success": {},
    "matched_format": {},
    "matched_document_id": {},
    "matched_legacy_format": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions