Download Referral Document
Perform Download Referral Document through athenahealth.
athena_download_referral_documentwriteathenahealth
Inputs
- Document Id
document_idexpressionrequiredRequired literal value or workflow expression.
- Document Class
document_classexpressionOptional literal value or workflow expression.
Default:
"ADMIN" - Document Type
document_typeexpressionOptional literal value or workflow expression.
Default:
"Referral" - Apply Rotation
apply_rotationbooleanOptional true-or-false value.
Default:
true
Outputs
successSuccessdocument_idDocument Idathena_document_idAthena Document Idathena_document_classAthena Document Classathena_document_sub_classAthena Document Sub Classathena_document_statusAthena Document Statuspage_countPage Countrotated_page_countRotated Page CountsizeSizesha256Sha256was_existingWas ExistingerrorErrorerror_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
}