eClinicalWorks integration

ECW Search Progress Notes

Perform ECW Search Progress Notes through eClinicalWorks.

View as Markdown

ecw_search_progress_notes

readeclinicalworks

Inputs

encounters
json
Encounters
Optional JSON value.
encounter_ids
json
Encounter Ids
Optional JSON value.
query
textrequired
Query
Required text value.
enc_type
text
Enc Type
Optional text value.
context_chars
number
Context Chars
Optional numeric value.
Default: 160

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": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "enc_type": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "encounters": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "context_chars": {
      "type": "number",
      "default": 160,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "encounter_ids": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    }
  },
  "additionalProperties": false
}

Output schema

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

View all eClinicalWorks actions