Skip to documentation
NikoHealth integration

Upload Document to Patient

Perform Upload Document to Patient through NikoHealth.

View as Markdown
nikohealth_upload_document
writenikohealth

Inputs

  • patient_id
    textrequired
    Patient Id

    Required text value.

  • document_id
    expression
    Document Id

    Optional literal value or workflow expression.

  • s3_key
    expression
    S3 Key

    Optional literal value or workflow expression.

  • s3_uri
    expression
    S3 Uri

    Optional literal value or workflow expression.

  • filename
    expression
    Filename

    Optional literal value or workflow expression.

  • sha256
    expression
    Sha256

    Optional literal value or workflow expression.

  • content_type
    expression
    Content Type

    Optional literal value or workflow expression.

    Default: "application/pdf"

  • document_type
    selectdynamic options
    Document Type

    Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.

    Default: "auto"

  • enabled
    boolean
    Enabled

    Optional true-or-false value.

    Default: true

  • skip_if_missing_source
    boolean
    Skip If Missing Source

    Optional true-or-false value.

    Default: false

  • delete_source_artifact_after_upload
    boolean
    Delete Source Artifact After Upload

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • statusStatus
  • uploadedUploaded
  • skippedSkipped
  • document_idDocument Id
  • patient_idPatient Id
  • patient_document_idPatient Document Id
  • workflow_artifact_deletedWorkflow Artifact Deleted
  • s3_keyS3 Key
  • filenameFilename
  • 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"
  ],
  "properties": {
    "s3_key": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "s3_uri": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sha256": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "enabled": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "filename": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "document_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "content_type": {
      "default": "application/pdf",
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_type": {
      "type": "string",
      "default": "auto",
      "description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "skip_if_missing_source": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "delete_source_artifact_after_upload": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "s3_key": {},
    "status": {},
    "skipped": {},
    "success": {},
    "filename": {},
    "uploaded": {},
    "patient_id": {},
    "document_id": {},
    "patient_document_id": {},
    "workflow_artifact_deleted": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions