athenahealth integration

Process Existing Document

Perform Process Existing Document through athenahealth.

View as Markdown

athena_process_existing_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_sub_class
expression
Document Sub Class
Optional literal value or workflow expression.
Default: "ADMIN_REFERRAL"
document_label
select
Document Label
Optional selected identifier or value.
Options: Admin ("ADMIN"), Admin - Billing Document ("ADMIN_BILLING"), Admin - Consent ("ADMIN_CONSENT"), Admin - HIPAA/Privacy ("ADMIN_HIPAA"), Admin - Insurance Approval Notification ("ADMIN_INSURANCEAPPROVAL"), Admin - Insurance Card ("ADMIN_INSURANCECARD"), Admin - Insurance Denial Notification ("ADMIN_INSURANCEDENIAL"), Admin - Legal ("ADMIN_LEGAL"), Admin - Medical Records Request ("ADMIN_MEDICALRECORDREQ"), Admin - Referral ("ADMIN_REFERRAL"), Admin - Signed Forms & Letters ("ADMIN_SIGNEDFORMSLETTERS"), Clinical Document ("CLINICALDOCUMENT"), Clinical Document - Admission/Discharge Summary ("CLINICALDOCUMENT_ADMISSIONDISCHARGE"), Clinical Document - Consult Note ("CLINICALDOCUMENT_CONSULTNOTE"), Clinical Document - Emergency/Urgent Care ("CLINICALDOCUMENT_URGENTCARE"), Clinical Document - Mental Health Consult ("CLINICALDOCUMENT_MENTALHEALTH"), Clinical Document - Operative Note ("CLINICALDOCUMENT_OPERATIVENOTE"), Cover Sheet ("COVERSHEET"), Encounter Document - Authorization ("ENCOUNTERDOCUMENT_AUTHORIZATION"), Encounter Document - Health History Questionnaire ("ENCOUNTERDOCUMENT_PATIENTHISTORY"), Encounter Document - Image Documentation ("ENCOUNTERDOCUMENT_IMAGEDOC"), Encounter Document - Procedure Documentation ("ENCOUNTERDOCUMENT_PROCEDUREDOC"), Encounter Document - Progress Note ("ENCOUNTERDOCUMENT_PROGRESSNOTE"), Imaging/Diagnostic Result ("IMAGINGRESULT"), Lab Result ("LABRESULT"), Medical Record Document - Chart for Abstraction ("MEDICALRECORD_CHARTTOABSTRACT"), Medical Record Document - Flowsheet ("MEDICALRECORD_COUMADIN"), Medical Record Document - Growth Chart ("MEDICALRECORD_GROWTHCHART"), Medical Record Document - Historical Medical Record ("MEDICALRECORD_HISTORICAL"), Medical Record Document - Patient Diary ("MEDICALRECORD_PATIENTDIARY"), Medical Record Document - Vaccination Record ("MEDICALRECORD_VACCINATION"), Order (Already Signed) ("ORDER"), Phone Message ("PHONEMESSAGE"), Physician Authorization ("PHYSICIANAUTH"), Physician Authorization - Care Plan Oversight ("PHYSICIANAUTH_CAREPLANOVERSIGHT"), Prescription - Change ("PRESCRIPTION_CHANGE"), Prescription - Clarification ("PRESCRIPTION_CLARIFICATION"), Prescription - New ("PRESCRIPTION_NEW"), Prescription - Prior Authorization Request ("PRESCRIPTION_PRIORAUTHREQUEST"), Prescription - Renewal ("PRESCRIPTION_RENEWAL")
order_type
remote_search_selectdynamic options
Order Type
Optional value. Retrieve allowed values from the dynamic options endpoint.
provider_username
selectdynamic options
Provider Username
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
action_note
textarea
Action Note
Optional text value.
urgent
boolean
Urgent
Optional true-or-false value.
Default: false
skip_if_urgent
boolean
Skip If Urgent
Optional true-or-false value.
Default: true
review_action_reason_id
expression
Review Action Reason Id
Optional literal value or workflow expression.
assigned_to
selectrequireddynamic options
Assigned To
Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
bucket_name
expressionrequired
Bucket Name
Required literal value or workflow expression.
expected_patient_id
expression
Expected Patient Id
Optional literal value or workflow expression.
chart_id
expression
Chart Id
Optional literal value or workflow expression.
projection_timeout_seconds
number
Projection Timeout Seconds
Optional numeric value.
Default: 60
write_enabled
boolean
Write Enabled
Optional true-or-false value.
Default: false

Outputs

successSuccess
write_skippedWrite Skipped
skippedSkipped
submittedSubmitted
verifiedVerified
projection_verifiedProjection Verified
outcomeOutcome
document_idDocument Id
document_classDocument Class
document_sub_classDocument Sub Class
order_type_idOrder Type Id
order_type_nameOrder Type Name
patient_idPatient Id
chart_idChart Id
provider_usernameProvider Username
priorityPriority
statusStatus
note_verifiedNote Verified
assigned_toAssigned To
bucket_nameBucket Name
attemptsAttempts
retryableRetryable
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",
    "assigned_to",
    "bucket_name"
  ],
  "properties": {
    "urgent": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "chart_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_type": {
      "description": "Optional value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "remote_search_select"
    },
    "action_note": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "assigned_to": {
      "type": "string",
      "description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "bucket_name": {
      "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"
    },
    "write_enabled": {
      "type": "boolean",
      "default": false,
      "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"
    },
    "document_label": {
      "enum": [
        "ADMIN",
        "ADMIN_BILLING",
        "ADMIN_CONSENT",
        "ADMIN_HIPAA",
        "ADMIN_INSURANCEAPPROVAL",
        "ADMIN_INSURANCECARD",
        "ADMIN_INSURANCEDENIAL",
        "ADMIN_LEGAL",
        "ADMIN_MEDICALRECORDREQ",
        "ADMIN_REFERRAL",
        "ADMIN_SIGNEDFORMSLETTERS",
        "CLINICALDOCUMENT",
        "CLINICALDOCUMENT_ADMISSIONDISCHARGE",
        "CLINICALDOCUMENT_CONSULTNOTE",
        "CLINICALDOCUMENT_URGENTCARE",
        "CLINICALDOCUMENT_MENTALHEALTH",
        "CLINICALDOCUMENT_OPERATIVENOTE",
        "COVERSHEET",
        "ENCOUNTERDOCUMENT_AUTHORIZATION",
        "ENCOUNTERDOCUMENT_PATIENTHISTORY",
        "ENCOUNTERDOCUMENT_IMAGEDOC",
        "ENCOUNTERDOCUMENT_PROCEDUREDOC",
        "ENCOUNTERDOCUMENT_PROGRESSNOTE",
        "IMAGINGRESULT",
        "LABRESULT",
        "MEDICALRECORD_CHARTTOABSTRACT",
        "MEDICALRECORD_COUMADIN",
        "MEDICALRECORD_GROWTHCHART",
        "MEDICALRECORD_HISTORICAL",
        "MEDICALRECORD_PATIENTDIARY",
        "MEDICALRECORD_VACCINATION",
        "ORDER",
        "PHONEMESSAGE",
        "PHYSICIANAUTH",
        "PHYSICIANAUTH_CAREPLANOVERSIGHT",
        "PRESCRIPTION_CHANGE",
        "PRESCRIPTION_CLARIFICATION",
        "PRESCRIPTION_NEW",
        "PRESCRIPTION_PRIORAUTHREQUEST",
        "PRESCRIPTION_RENEWAL"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "skip_if_urgent": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "provider_username": {
      "type": "string",
      "description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "document_sub_class": {
      "default": "ADMIN_REFERRAL",
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "expected_patient_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "review_action_reason_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "projection_timeout_seconds": {
      "type": "number",
      "default": 60,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "outcome": {},
    "skipped": {},
    "success": {},
    "attempts": {},
    "chart_id": {},
    "priority": {},
    "verified": {},
    "retryable": {},
    "submitted": {},
    "patient_id": {},
    "assigned_to": {},
    "bucket_name": {},
    "document_id": {},
    "error_message": {},
    "note_verified": {},
    "order_type_id": {},
    "write_skipped": {},
    "document_class": {},
    "order_type_name": {},
    "provider_username": {},
    "document_sub_class": {},
    "projection_verified": {}
  },
  "additionalProperties": true
}

View all athenahealth actions