ECW Download Patient Document
Perform ECW Download Patient Document through eClinicalWorks.
ecw_download_patient_documentwrite
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"
}Inputs
- Patient Id
patient_idtextrequiredRequired text value.
- Document Id
document_idtextrequiredRequired text value.
- Include Ocr Text
include_ocr_textbooleanOptional true-or-false value.
Default:
true - Max Ocr Chars
max_ocr_charsnumberOptional numeric value.
Default:
12000
Outputs
successSuccessdocument_idDocument IdfilenameFilenamedocument_nameDocument Namedocument_dateDocument Datepdf_base64Pdf Base64byte_countByte Countpage_countPage Countocr_textOcr Textocr_text_lengthOcr Text Lengtherror_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
}