eClinicalWorks integration

Attach PCP Referral

Perform Attach PCP Referral through eClinicalWorks.

View as Markdown

ecw_attach_pcp_referral

writeeclinicalworks

Inputs

patient_id
textrequired
Patient Id
Required text value.
encounter_id
text
Encounter Id
Optional text value.
encounter_ids
json
Encounter Ids
Optional JSON value.
dos
daterequired
Dos
Required date in YYYY-MM-DD format.
referring_provider_last_name
textrequired
Referring Provider Last Name
Required text value.
auth_ukey
textrequired
Auth Ukey
Required text value.
dx_codes
json
Dx Codes
Optional JSON value.
auth_pdf_document_id
textrequired
Auth Pdf Document Id
Required text value.
eligibility_pdf_document_id
textrequired
Eligibility Pdf Document Id
Required text value.
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.
folder_name
text
Folder Name
Optional text value.
supplemental_auth_pdf_document_id
text
Supplemental Auth Pdf Document Id
Optional text value.
supplemental_procedure_codes
json
Supplemental Procedure Codes
Optional JSON value.
supplemental_auth_ukey
text
Supplemental Auth Ukey
Optional text value.
supplemental_auth_end_date
text
Supplemental Auth End Date
Optional text value.

Outputs

successSuccess
referral_idReferral Id

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",
    "dos",
    "referring_provider_last_name",
    "auth_ukey",
    "auth_pdf_document_id",
    "eligibility_pdf_document_id",
    "auth_start_date",
    "auth_end_date"
  ],
  "properties": {
    "dos": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "dx_codes": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "auth_ukey": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "patient_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "folder_name": {
      "type": "string",
      "description": "Optional 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"
    },
    "auth_start_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "auth_pdf_document_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "supplemental_auth_ukey": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "supplemental_auth_end_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "eligibility_pdf_document_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "referring_provider_last_name": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "supplemental_procedure_codes": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "supplemental_auth_pdf_document_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

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

View all eClinicalWorks actions