Skip to documentation
eClinicalWorks integration

Read Encounter

Perform Read Encounter through eClinicalWorks.

View as Markdown
ecw_read_encounter
readeclinicalworks

Inputs

  • encounter_id
    textrequired
    Encounter Id

    Required text value.

  • visit_type_allowlist
    multi_select
    Visit Type Allowlist

    Optional list of selected values.

  • no_dx_required_visit_types
    multi_select
    No Dx Required Visit Types

    Optional list of selected values.

Outputs

  • successSuccess
  • patient_idPatient Id
  • encounter_idEncounter Id
  • member_idMember Id
  • patient_first_namePatient First Name
  • patient_last_namePatient Last Name
  • patient_dobPatient Dob
  • visit_typeVisit Type
  • visit_dateVisit Date
  • diagnosis_codesDiagnosis Codes
  • assessment_planAssessment Plan
  • progress_note_commentProgress Note Comment
  • reasonReason
  • supervising_provider_nameSupervising Provider Name
  • appointment_provider_nameAppointment Provider Name
  • supervising_provider_last_nameSupervising Provider Last Name
  • referring_provider_nameReferring Provider Name
  • patient_addressPatient Address
  • patient_cityPatient City
  • patient_zipPatient Zip
  • failure_categoryFailure Category
  • 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"
  ],
  "properties": {
    "encounter_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "visit_type_allowlist": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    },
    "no_dx_required_visit_types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values.",
      "x-workflow-field-type": "multi_select"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "reason": {},
    "success": {},
    "member_id": {},
    "patient_id": {},
    "visit_date": {},
    "visit_type": {},
    "patient_dob": {},
    "patient_zip": {},
    "encounter_id": {},
    "patient_city": {},
    "assessment_plan": {},
    "diagnosis_codes": {},
    "patient_address": {},
    "failure_category": {},
    "patient_last_name": {},
    "patient_first_name": {},
    "progress_note_comment": {},
    "referring_provider_name": {},
    "appointment_provider_name": {},
    "supervising_provider_name": {},
    "supervising_provider_last_name": {}
  },
  "additionalProperties": true
}
View all eClinicalWorks actions