eClinicalWorks integration

Set Visit Status

Perform Set Visit Status through eClinicalWorks.

View as Markdown

ecw_set_visit_status

writeeclinicalworks

Inputs

encounter_id
textrequired
Encounter Id
Required text value.
visit_date
daterequired
Visit Date
Required date in YYYY-MM-DD format.
provider_id
textrequired
Provider Id
Required text value.
target_status
textrequired
Target Status
Required text value.
encounters
json
Encounters
Optional JSON value.

Outputs

successSuccess
errorError
updated_countUpdated Count

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": [
    "encounter_id",
    "visit_date",
    "provider_id",
    "target_status"
  ],
  "properties": {
    "encounters": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "visit_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "provider_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "encounter_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "target_status": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

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

View all eClinicalWorks actions