Skip to documentation
athenahealth integration

Read CCDA Document

Perform Read CCDA Document through athenahealth.

View as Markdown
athena_read_ccda_document
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": {},
  "handler": "athena_read_ccda_document"
}

Action contracts and connections · Run recovery

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

Outputs

  • successSuccess
  • outcomeOutcome
  • document_idDocument Id
  • document_classDocument Class
  • document_sub_classDocument Sub Class
  • statusStatus
  • sourceSource
  • priorityPriority
  • patient_linkedPatient Linked
  • patient_idPatient Id
  • chart_idChart Id
  • version_tokenVersion Token
  • assigned_toAssigned To
  • order_type_idOrder Type Id
  • source_interface_message_idSource Interface Message Id
  • available_actionsAvailable Actions
  • ccda_document_codeCcda Document Code
  • patient_first_namePatient First Name
  • patient_middle_namePatient Middle Name
  • patient_last_namePatient Last Name
  • patient_dobPatient Dob
  • patient_sexPatient Sex
  • patient_address_line1Patient Address Line1
  • patient_address_line2Patient Address Line2
  • patient_cityPatient City
  • patient_statePatient State
  • patient_zipPatient Zip
  • patient_home_phonePatient Home Phone
  • patient_mobile_phonePatient Mobile Phone
  • patient_emailPatient Email
  • referral_countReferral Count
  • referral_idReferral Id
  • referral_priorityReferral Priority
  • referral_reasonReferral Reason
  • referring_provider_first_nameReferring Provider First Name
  • referring_provider_last_nameReferring Provider Last Name
  • referring_provider_credentialReferring Provider Credential
  • referring_provider_npiReferring Provider Npi
  • referring_organization_nameReferring Organization Name
  • referred_to_provider_first_nameReferred To Provider First Name
  • referred_to_provider_last_nameReferred To Provider Last Name
  • referred_to_provider_credentialReferred To Provider Credential
  • referred_to_provider_npiReferred To Provider Npi
  • referred_to_specialtyReferred To Specialty
  • diagnosis_codesDiagnosis Codes
  • diagnosesDiagnoses
  • referralsReferrals
  • insurance_countInsurance Count
  • primary_payer_namePrimary Payer Name
  • primary_payer_addressPrimary Payer Address
  • primary_member_idPrimary Member Id
  • primary_group_numberPrimary Group Number
  • primary_plan_typePrimary Plan Type
  • insurancesInsurances
  • problem_codesProblem Codes
  • parse_warningsParse Warnings
  • 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"
  ],
  "properties": {
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "source": {},
    "status": {},
    "outcome": {},
    "success": {},
    "chart_id": {},
    "priority": {},
    "diagnoses": {},
    "referrals": {},
    "insurances": {},
    "patient_id": {},
    "assigned_to": {},
    "document_id": {},
    "patient_dob": {},
    "patient_sex": {},
    "patient_zip": {},
    "referral_id": {},
    "patient_city": {},
    "error_message": {},
    "order_type_id": {},
    "patient_email": {},
    "patient_state": {},
    "problem_codes": {},
    "version_token": {},
    "document_class": {},
    "parse_warnings": {},
    "patient_linked": {},
    "referral_count": {},
    "diagnosis_codes": {},
    "insurance_count": {},
    "referral_reason": {},
    "available_actions": {},
    "patient_last_name": {},
    "primary_member_id": {},
    "primary_plan_type": {},
    "referral_priority": {},
    "ccda_document_code": {},
    "document_sub_class": {},
    "patient_first_name": {},
    "patient_home_phone": {},
    "primary_payer_name": {},
    "patient_middle_name": {},
    "patient_mobile_phone": {},
    "primary_group_number": {},
    "patient_address_line1": {},
    "patient_address_line2": {},
    "primary_payer_address": {},
    "referred_to_specialty": {},
    "referring_provider_npi": {},
    "referred_to_provider_npi": {},
    "referring_organization_name": {},
    "source_interface_message_id": {},
    "referring_provider_last_name": {},
    "referring_provider_credential": {},
    "referring_provider_first_name": {},
    "referred_to_provider_last_name": {},
    "referred_to_provider_credential": {},
    "referred_to_provider_first_name": {}
  },
  "additionalProperties": true
}
View all athenahealth actions