Read CCDA Document
Perform Read CCDA Document through athenahealth.
athena_read_ccda_documentreadathenahealth
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"
}Inputs
- Document Id
document_idexpressionrequiredRequired literal value or workflow expression.
Outputs
successSuccessoutcomeOutcomedocument_idDocument Iddocument_classDocument Classdocument_sub_classDocument Sub ClassstatusStatussourceSourcepriorityPrioritypatient_linkedPatient Linkedpatient_idPatient Idchart_idChart Idversion_tokenVersion Tokenassigned_toAssigned Toorder_type_idOrder Type Idsource_interface_message_idSource Interface Message Idavailable_actionsAvailable Actionsccda_document_codeCcda Document Codepatient_first_namePatient First Namepatient_middle_namePatient Middle Namepatient_last_namePatient Last Namepatient_dobPatient Dobpatient_sexPatient Sexpatient_address_line1Patient Address Line1patient_address_line2Patient Address Line2patient_cityPatient Citypatient_statePatient Statepatient_zipPatient Zippatient_home_phonePatient Home Phonepatient_mobile_phonePatient Mobile Phonepatient_emailPatient Emailreferral_countReferral Countreferral_idReferral Idreferral_priorityReferral Priorityreferral_reasonReferral Reasonreferring_provider_first_nameReferring Provider First Namereferring_provider_last_nameReferring Provider Last Namereferring_provider_credentialReferring Provider Credentialreferring_provider_npiReferring Provider Npireferring_organization_nameReferring Organization Namereferred_to_provider_first_nameReferred To Provider First Namereferred_to_provider_last_nameReferred To Provider Last Namereferred_to_provider_credentialReferred To Provider Credentialreferred_to_provider_npiReferred To Provider Npireferred_to_specialtyReferred To Specialtydiagnosis_codesDiagnosis CodesdiagnosesDiagnosesreferralsReferralsinsurance_countInsurance Countprimary_payer_namePrimary Payer Nameprimary_payer_addressPrimary Payer Addressprimary_member_idPrimary Member Idprimary_group_numberPrimary Group Numberprimary_plan_typePrimary Plan TypeinsurancesInsurancesproblem_codesProblem Codesparse_warningsParse WarningserrorErrorerror_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
}