Overview
An overview of athenahealth's products can be found on the athenahealth website. If a practice has athenaOne (athenaClinicals, athenaCollector, and athenaCommunicator), then they have all the necessary products to integrate with APIs. The required product is based on the athenahealth product the API endpoint integrates with. This is not always the same as the functional outcome. For example, POST /encounter/{encounterid}/services is a part of Encounter: athenaClinicals, and not Insurance and Financial: athenaCollector as one might expect).
Listed below is each section of the API (see Sandbox) with the corresponding required athenahealth product:
Appointments: athenaCollector
Chart: athenaClinicals
Forms and Documents: athenaClinicals
Encounter: athenaClinicals
Hospital: athenaOne for Hospitals and Health Systems
Insurance and Financial: athenaCollector
Obstetrics(OB) Episode: athenaClinicals
Patient: athenaCollector and/or athenaClinicals
Practice Configuration: athenaCollector
Provider: athenaCollector
Quality Management and Pop Health: athenaClinicals
Note: The above mappings are generally true, however there are some subtle exceptions.
Special Cases
Note: Below is not an exhaustive list. We will continue to add to the list as more specials cases arise.
Appointment Reasons
- Patient Appointment Reasons require athenaCommunicator. Patient Appointment Reasons (reasonid) are an optional input parameter used when booking appointments or retrieving open appointment slots.
Forms and Documents
- Health History Forms also require athenaCommunicator.
- Some consents just require athenaCollector.
Insurance and Financial
- Payments endpoints: CCP module; Note: partners can determine this with GET /departments where valid credit cards and other payment details are outputted or not.
- CCM Enrollment endpoints: CCM setup
Patient Secure Messaging
- Endpoints that reference /securemessage/ or /patientsecuremessage/ found within the Patient section require athenaCommunicator.
Miscellaneous
- Any endpoint that contains the word “portal” will need athenaCommunicator.