Skip to documentation
NikoHealth integration

Download Patient Document

Perform Download Patient Document through NikoHealth.

View as Markdown
nikohealth_download_patient_document
writenikohealth

Inputs

  • patient_document_id
    textrequired
    Patient Document Id

    Required text value.

  • document
    json
    Document

    Optional JSON value.

Outputs

  • successSuccess
  • statusStatus
  • document_idDocument Id
  • niko_patient_document_idNiko Patient Document Id
  • downloadedDownloaded
  • was_existingWas Existing
  • titleTitle
  • sha256Sha256
  • sizeSize
  • 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_document_id"
  ],
  "properties": {
    "document": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "patient_document_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "size": {},
    "error": {},
    "title": {},
    "sha256": {},
    "status": {},
    "success": {},
    "downloaded": {},
    "document_id": {},
    "was_existing": {},
    "niko_patient_document_id": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions