The Developer Portal gives athenahealth clients and third-party health IT companies access to our APIs and sandbox environment to develop integrated solutions that will enhance the value and functionality offered by athenahealth services. Upon building an integrated solution, organizations also have the option to promote their offering via the athenahealth Marketplace.
- If you have questions about how to become an athenahealth Marketplace partner, please apply via the Marketplace information page and our business development team will get back to you.
- If you are a client or working on behalf of a client, please click here to get started.
Getting Started
- Quickstart: In short, our API is RESTful and uses JSON and FHIR DSTU2.
- Documentation: Here is our authentication documentation and the format of the responses (normally JSON).
- The full list of errors we might return is here.
- In order to help you test, evaluate, and use the API, we are willing to make the API available to you pursuant to these Terms of Service (“terms”).
- APIs are categorized in the following 3 sections. Refer to individual categories for the list of APIs.
- CEHRT APIs
- FHIR APIs
- athena APIs
- The process for obtaining production access varies by API category. If you are solely seeking read-only access to CEHRT APIs, listed below, then you may be issued a production client ID without additional verification or consult from athena by completing our CEHRT API request form and attaching it in an email to marketplace@athenahealth.com. For access requests beyond CEHRT APIs (i.e. to access athena APIs or FHIR APIs not included in CEHRT), please refer to our onboarding overview and production access request process.
List of APIs in adherence to 2015 Edition CEHRT Criteria
§170.315(g)(7) Application Access – Patient Selection
API syntax, function names, required and optional parameters and their data types, return variables and their types/structures, exceptions and exception handling methods and their returns:
Type | API Endpoint | ||
---|---|---|---|
Patients |
|
§170.315(g)(8) Application Access – Data Category Request
API syntax, function names, required and optional parameters and their data types, return variables and their types/structures, exceptions and exception handling methods and their returns:
§170.315(g)(9) Application Access – All Data Request
Category |
API Endpoint |
---|---|
CCDA Export | GET /v1/{practiceid}/ccda/{patientid}/ccdaexport |
List of available FHIR APIs
Category | API Endpoint | ||||||||||||||||||||||||||||||||||||||||||||||||||
Appointment |
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Chart |
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Documents and Forms |
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Encounter |
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Patient |
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Practice Configuration |
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Provider |
|
List of athena proprietary APIs
Category | API Endpoint | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Appointments |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Chart |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documents and Forms |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Encounter |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Hospital |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Insurance and Financial |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OB Episode |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Patient |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Practice Configuration |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Provider |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Quality Management / Pop Health |
|