eClinicalWorks integration

Create Incoming Referral

Perform Create Incoming Referral through eClinicalWorks.

View as Markdown

ecw_create_incoming_referral

writeeclinicalworks

Inputs

patient_id
textrequired
Patient Id
Required text value.
auth_number
textrequired
Auth Number
Required text value.
visit_date
daterequired
Visit Date
Required date in YYYY-MM-DD format.
auth_start_date
daterequired
Auth Start Date
Required date in YYYY-MM-DD format.
auth_end_date
daterequired
Auth End Date
Required date in YYYY-MM-DD format.
reason
textrequired
Reason
Required text value.
sibling_visit_types
json
Sibling Visit Types
Optional JSON value.
referring_provider_last_name
textrequired
Referring Provider Last Name
Required text value.
resolved_provider_last_name
text
Resolved Provider Last Name
Optional text value.
encounter_id
text
Encounter Id
Optional text value.
encounter_ids
json
Encounter Ids
Optional JSON value.
visits_allowed
number
Visits Allowed
Optional numeric value.
Default: 1
match_visit_date
boolean
Match Visit Date
Optional true-or-false value.
Default: false
link_notes
textarea
Link Notes
Optional text value.

Outputs

successSuccess
referral_idReferral Id
patient_idPatient Id
auth_numberAuth Number
errorError

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",
    "auth_number",
    "visit_date",
    "auth_start_date",
    "auth_end_date",
    "reason",
    "referring_provider_last_name"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "link_notes": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "patient_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "visit_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "auth_number": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "encounter_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "auth_end_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "encounter_ids": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "visits_allowed": {
      "type": "number",
      "default": 1,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "auth_start_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "match_visit_date": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "sibling_visit_types": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "resolved_provider_last_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "referring_provider_last_name": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "patient_id": {},
    "auth_number": {},
    "referral_id": {}
  },
  "additionalProperties": true
}

View all eClinicalWorks actions