eClinicalWorks integration

ECW Read Patient Progress Notes

Perform ECW Read Patient Progress Notes through eClinicalWorks.

View as Markdown

ecw_read_patient_progress_notes

readeclinicalworks

Inputs

patient_id
textrequired
Patient Id
Required text value.
note_types
json
Note Types
Optional JSON value.
lookback_days
number
Lookback Days
Optional numeric value.
Default: 180
start_date
text
Start Date
Optional text value.
end_date
text
End Date
Optional text value.
include_cancelled
boolean
Include Cancelled
Optional true-or-false value.
Default: false
max_notes
number
Max Notes
Optional numeric value.
Default: 10
encounter_ids
json
Encounter Ids
Optional JSON value.
include_diagnoses
boolean
Include Diagnoses
Optional true-or-false value.
Default: true

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": [
    "patient_id"
  ],
  "properties": {
    "end_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "max_notes": {
      "type": "number",
      "default": 10,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "note_types": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "patient_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "start_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "encounter_ids": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "lookback_days": {
      "type": "number",
      "default": 180,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "include_cancelled": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "include_diagnoses": {
      "type": "boolean",
      "default": true,
      "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