athenahealth integration

List Referral Documents

Perform List Referral Documents through athenahealth.

athena_list_referral_documents

readathenahealth

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "athenahealth",
  "params": {
    "per_page": 50,
    "max_items": 200,
    "start_page": 0,
    "exclude_urgent": false,
    "document_sub_classes": "ADMIN_REFERRAL"
  },
  "handler": "athena_list_referral_documents"
}

Action contracts and connections · Run recovery

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"
statuses
expression
Statuses
Optional literal value or workflow expression.
exclude_urgent
boolean
Exclude Urgent
Optional true-or-false value.
Default: false
per_page
number
Per Page
Optional numeric value.
Default: 50
max_items
number
Max Items
Optional numeric value.
Default: 200
start_page
number
Start Page
Optional numeric value.
Default: 0
max_pages
number
Max Pages
Optional numeric value.
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
source_contextSource Context
documentsDocuments
document_countDocument Count
countCount
document_idsDocument Ids
scanned_countScanned Count
filtered_out_countFiltered Out Count
bucket_total_countBucket Total Count
start_pageStart Page
pages_readPages Read
truncatedTruncated
has_previous_pagesHas Previous Pages
window_limitedWindow Limited
subject_types_seenSubject Types Seen
document_classes_seenDocument Classes Seen
document_sub_classes_seenDocument Sub Classes Seen
statuses_seenStatuses 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"
    },
    "statuses": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "max_items": {
      "type": "number",
      "default": 200,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "max_pages": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "sort_field": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "start_page": {
      "type": "number",
      "default": 0,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "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"
    },
    "exclude_urgent": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "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": {},
    "start_page": {},
    "assigned_to": {},
    "bucket_name": {},
    "document_ids": {},
    "error_message": {},
    "scanned_count": {},
    "statuses_seen": {},
    "document_count": {},
    "source_context": {},
    "window_limited": {},
    "bucket_total_count": {},
    "filtered_out_count": {},
    "has_previous_pages": {},
    "subject_types_seen": {},
    "document_classes_seen": {},
    "document_sub_classes_seen": {}
  },
  "additionalProperties": true
}

View all athenahealth actions