Skip to documentation
athenahealth integration

Download Referral Document

Perform Download Referral Document through athenahealth.

View as Markdown
athena_download_referral_document
writeathenahealth

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • document_class
    expression
    Document Class

    Optional literal value or workflow expression.

    Default: "ADMIN"

  • document_type
    expression
    Document Type

    Optional literal value or workflow expression.

    Default: "Referral"

  • apply_rotation
    boolean
    Apply Rotation

    Optional true-or-false value.

    Default: true

Outputs

  • successSuccess
  • document_idDocument Id
  • athena_document_idAthena Document Id
  • athena_document_classAthena Document Class
  • athena_document_sub_classAthena Document Sub Class
  • athena_document_statusAthena Document Status
  • page_countPage Count
  • rotated_page_countRotated Page Count
  • sizeSize
  • sha256Sha256
  • was_existingWas Existing
  • 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"
  ],
  "properties": {
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_type": {
      "default": "Referral",
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "apply_rotation": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "document_class": {
      "default": "ADMIN",
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "size": {},
    "error": {},
    "sha256": {},
    "success": {},
    "page_count": {},
    "document_id": {},
    "was_existing": {},
    "error_message": {},
    "athena_document_id": {},
    "rotated_page_count": {},
    "athena_document_class": {},
    "athena_document_status": {},
    "athena_document_sub_class": {}
  },
  "additionalProperties": true
}
View all athenahealth actions