Skip to documentation
eClinicalWorks integration

ECW Download Patient Document

Perform ECW Download Patient Document through eClinicalWorks.

View as Markdown
ecw_download_patient_document
write

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "eClinicalWorks",
  "params": {
    "max_ocr_chars": 12000,
    "include_ocr_text": true
  },
  "handler": "ecw_download_patient_document"
}

Action contracts and connections · Run recovery

Inputs

  • patient_id
    textrequired
    Patient Id

    Required text value.

  • document_id
    textrequired
    Document Id

    Required text value.

  • include_ocr_text
    boolean
    Include Ocr Text

    Optional true-or-false value.

    Default: true

  • max_ocr_chars
    number
    Max Ocr Chars

    Optional numeric value.

    Default: 12000

Outputs

  • successSuccess
  • document_idDocument Id
  • filenameFilename
  • document_nameDocument Name
  • document_dateDocument Date
  • pdf_base64Pdf Base64
  • byte_countByte Count
  • page_countPage Count
  • ocr_textOcr Text
  • ocr_text_lengthOcr Text Length
  • error_messageError Message

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_id"
  ],
  "properties": {
    "patient_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "document_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "max_ocr_chars": {
      "type": "number",
      "default": 12000,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "include_ocr_text": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "success": {},
    "filename": {},
    "ocr_text": {},
    "byte_count": {},
    "page_count": {},
    "pdf_base64": {},
    "document_id": {},
    "document_date": {},
    "document_name": {},
    "error_message": {},
    "ocr_text_length": {}
  },
  "additionalProperties": true
}
View all eClinicalWorks actions