athenahealth integration

List Referral Documents

Perform List Referral Documents through athenahealth.

View as Markdown

athena_list_referral_documents

readathenahealth

Inputs

bucket_name
expressionrequired
Bucket Name
Required literal value or workflow expression.
assigned_to
expressionrequired
Assigned To
Required literal value or workflow expression.
subject_types
expression
Subject Types
Optional literal value or workflow expression.
document_classes
expression
Document Classes
Optional literal value or workflow expression.
document_sub_classes
expression
Document Sub Classes
Optional literal value or workflow expression.
Default: "ADMIN_REFERRAL"
per_page
number
Per Page
Optional numeric value.
Default: 50
max_items
number
Max Items
Optional numeric value.
Default: 200
sort_column
expression
Sort Column
Optional literal value or workflow expression.
sort_direction
expression
Sort Direction
Optional literal value or workflow expression.
sort_field
expression
Sort Field
Optional literal value or workflow expression.

Outputs

successSuccess
bucket_nameBucket Name
assigned_toAssigned To
documentsDocuments
document_countDocument Count
countCount
document_idsDocument Ids
scanned_countScanned Count
filtered_out_countFiltered Out Count
bucket_total_countBucket Total Count
pages_readPages Read
truncatedTruncated
subject_types_seenSubject Types Seen
document_classes_seenDocument Classes Seen
document_sub_classes_seenDocument Sub Classes Seen
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": [
    "bucket_name",
    "assigned_to"
  ],
  "properties": {
    "per_page": {
      "type": "number",
      "default": 50,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "max_items": {
      "type": "number",
      "default": 200,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "sort_field": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "assigned_to": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "bucket_name": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sort_column": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "subject_types": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "sort_direction": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_classes": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_sub_classes": {
      "default": "ADMIN_REFERRAL",
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "success": {},
    "documents": {},
    "truncated": {},
    "pages_read": {},
    "assigned_to": {},
    "bucket_name": {},
    "document_ids": {},
    "error_message": {},
    "scanned_count": {},
    "document_count": {},
    "bucket_total_count": {},
    "filtered_out_count": {},
    "subject_types_seen": {},
    "document_classes_seen": {},
    "document_sub_classes_seen": {}
  },
  "additionalProperties": true
}

View all athenahealth actions