Skip to documentation
athenahealth integration

Read Referral Attachments

Perform Read Referral Attachments through athenahealth.

View as Markdown
athena_read_referral_attachments
read

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • chart_id
    expressionrequired
    Chart Id

    Required literal value or workflow expression.

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • document_class
    expressionrequired
    Document Class

    Required literal value or workflow expression.

    Default: "PATIENTCASE"

  • target_document_id
    expression
    Target Document Id

    Optional literal value or workflow expression.

Outputs

  • successSuccess
  • document_idDocument Id
  • document_classDocument Class
  • patient_idPatient Id
  • chart_idChart Id
  • attachment_countAttachment Count
  • attached_countAttached Count
  • attachmentsAttachments
  • target_document_idTarget Document Id
  • target_attachment_foundTarget Attachment Found
  • target_attachment_attachedTarget Attachment Attached
  • errorError
  • error_messageError Message

Output schema completeness: best_effort_declared

Safety

External effect
read
Confirmation recommended
No
Retry safe
Yes
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "document_id",
    "chart_id",
    "patient_id",
    "document_class"
  ],
  "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"
    },
    "document_class": {
      "default": "PATIENTCASE",
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "target_document_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "chart_id": {},
    "patient_id": {},
    "attachments": {},
    "document_id": {},
    "error_message": {},
    "attached_count": {},
    "document_class": {},
    "attachment_count": {},
    "target_document_id": {},
    "target_attachment_found": {},
    "target_attachment_attached": {}
  },
  "additionalProperties": true
}
View all athenahealth actions