Skip to documentation
ClearPathMD integration

Upload Document

Perform Upload Document through ClearPathMD.

View as Markdown
clearpath_upload_document
writeclearpathmd

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • document_type_id
    number
    Document Type Id

    Optional numeric value.

    Default: 1

  • title
    text
    Title

    Optional text value.

  • description
    text
    Description

    Optional text value.

  • order_id
    expression
    Order Id

    Optional literal value or workflow expression.

Outputs

  • successSuccess
  • dataData
  • messageMessage
  • 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": [
    "document_id",
    "patient_id"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "order_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "description": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_type_id": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "data": {},
    "error": {},
    "message": {},
    "success": {}
  },
  "additionalProperties": true
}
View all ClearPathMD actions