Skip to documentation
Epic CareLink integration

Check CareLink Patient Write Ready

Perform Check CareLink Patient Write Ready through Epic CareLink.

View as Markdown
carelink_check_patient_write_ready
write

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • patient_exists
    expressionrequired
    Patient Exists

    Required literal value or workflow expression.

Outputs

  • successSuccess
  • readyReady
  • review_requiredReview Required
  • missing_fieldsMissing Fields
  • missing_field_countMissing Field Count
  • errorError
  • failure_categoryFailure Category

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": [
    "document_id",
    "patient_exists"
  ],
  "properties": {
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_exists": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "ready": {},
    "success": {},
    "missing_fields": {},
    "review_required": {},
    "failure_category": {},
    "missing_field_count": {}
  },
  "additionalProperties": true
}
View all Epic CareLink actions