Upload Document to Patient
Perform Upload Document to Patient through NikoHealth.
nikohealth_upload_documentInputs
- Patient Id
patient_idtextrequiredRequired text value.
- Document Id
document_idexpressionOptional literal value or workflow expression.
- S3 Key
s3_keyexpressionOptional literal value or workflow expression.
- S3 Uri
s3_uriexpressionOptional literal value or workflow expression.
- Filename
filenameexpressionOptional literal value or workflow expression.
- Sha256
sha256expressionOptional literal value or workflow expression.
- Content Type
content_typeexpressionOptional literal value or workflow expression.
Default:
"application/pdf" - Document Type
document_typeselectdynamic optionsOptional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
Default:
"auto" - Enabled
enabledbooleanOptional true-or-false value.
Default:
true - Skip If Missing Source
skip_if_missing_sourcebooleanOptional true-or-false value.
Default:
false - Delete Source Artifact After Upload
delete_source_artifact_after_uploadbooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessstatusStatusuploadedUploadedskippedSkippeddocument_idDocument Idpatient_idPatient Idpatient_document_idPatient Document Idworkflow_artifact_deletedWorkflow Artifact Deleteds3_keyS3 KeyfilenameFilenameerrorError
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
}