Skip to documentation
athenahealth integration

Link Referral Document to Patient

Perform Link Referral Document to Patient through athenahealth.

View as Markdown
athena_link_referral_document_to_patient
writeathenahealth

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • chart_id
    expressionrequired
    Chart Id

    Required literal value or workflow expression.

  • write_enabled
    boolean
    Write Enabled

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • write_skippedWrite Skipped
  • linkedLinked
  • already_linkedAlready Linked
  • verifiedVerified
  • submittedSubmitted
  • retryableRetryable
  • outcomeOutcome
  • document_idDocument Id
  • patient_idPatient Id
  • chart_idChart Id
  • errorError
  • error_messageError Message

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_id",
    "chart_id"
  ],
  "properties": {
    "chart_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "write_enabled": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "linked": {},
    "outcome": {},
    "success": {},
    "chart_id": {},
    "verified": {},
    "retryable": {},
    "submitted": {},
    "patient_id": {},
    "document_id": {},
    "error_message": {},
    "write_skipped": {},
    "already_linked": {}
  },
  "additionalProperties": true
}
View all athenahealth actions