eClinicalWorks integration

ECW Read Encounter Attachment

Perform ECW Read Encounter Attachment through eClinicalWorks.

View as Markdown

ecw_read_encounter_attachment

readeclinicalworks

Inputs

encounter_id
textrequired
Encounter Id
Required text value.
patient_id
textrequired
Patient Id
Required text value.
document_id
text
Document Id
Optional text value.
include_ocr_text
boolean
Include Ocr Text
Optional true-or-false value.
Default: false
max_ocr_chars
number
Max Ocr Chars
Optional numeric value.
Default: 12000

Outputs

successSuccess
resultResult
errorError

Output schema completeness: best_effort_declared

Safety

External effect: read
Confirmation recommended: No
Retry safe: Yes
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "required": [
    "encounter_id",
    "patient_id"
  ],
  "properties": {
    "patient_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "document_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "encounter_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": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "result": {},
    "success": {}
  },
  "additionalProperties": true
}

View all eClinicalWorks actions