Overview of our API Offerings
athenahealth offers various API frameworks to help you build an integrated solution which best meets your business needs. Before you begin designing your solution, it is recommended that you review the supported APIs within each framework below to determine which API framework(s) will fulfill your solution’s intended use case.
| athenaOne APIs | FHIR APIs | Certified APIs |
|---|---|---|
|
Over 700 proprietary API endpoints across major administrative, clinical, and financial functions. Deliver real-world insights in our native workflows, with our robust library of Write APIs. Key considerations:
Learn more here |
APIs supporting the standard clinical definitions and data structures of the HL7® FHIR® (Fast Healthcare Interoperability Resources). Key considerations:
Learn more here |
athenahealth has chosen to offer access to all Certified FHIR API endpoints at no cost to customers and partners. Key considerations:
Learn more here |
Getting Started
Below are a few items to consider as you begin exploring our API frameworks further:
- In short, our API is RESTful and uses JSON
- Our APIs are accessed using JSON web tokens (JWTs, pronounced “jots”). Here is our authorization documentation on how to obtain an access token to call APIs.
- 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 assigned to the following 3 categories. Refer to each category for the list of APIs included.
- Certified APIs
- FHIR APIs (includes support for both FHIR DSTU2 and FHIR R4)
- athenaOne APIs
- The process for obtaining production access varies by API category. If you are solely seeking read-only access to Certified APIs click here.
- For troubleshooting various error responses you may encounter when calling our APIs, refer to our full list here.
List of Certified APIs (in adherence to 2015 Edition/Cures Update 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 |
§170.315(g)(10) Standardized API for Patient and Population Services
List of available FHIR APIs
| Category | API Endpoint |
|---|---|
| Appointment | GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment/{appointmentid} | |
| Chart | GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Condition | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Condition/Problem-{conditionid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Condition | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Condition/Problem-{conditionid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Medication/{medicationid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder/{medicationorderid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement/{medicationstatementid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Medication/{medicationid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration/{medicationadministrationid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense/{medicationdispenseid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder/{medicationorderid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement/{medicationstatementid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Substance/{substanceid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan/AssessPlan-{assessplanid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan/CareTeam-{careteamid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Goal | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Goal/{goalid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport/{labresultid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport/{labresultid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure/{procedureid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure/{procedureid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/SocialHistory-{socialhistoryid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/Vital-{vitalid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/ClinicalImpression | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/Vital-{vitalid} | |
| GET/fhir/r4/AllergyIntolerance/{logicalId} | |
| GET/fhir/r4/AllergyIntolerance | |
| POST/fhir/r4/AllergyIntolerance/_search | |
| GET/fhir/r4/CarePlan/{logicalId} | |
| GET/fhir/r4/CarePlan | |
| POST/fhir/r4/CarePlan/_search | |
| GET/fhir/r4/CareTeam/{logicalId} | |
| GET/fhir/r4/CareTeam | |
| POST/fhir/r4/CareTeam/_search | |
| GET/fhir/r4/Goal/{logicalId} | |
| GET/fhir/r4/Goal | |
| POST/fhir/r4/Goal/_search | |
| GET/fhir/r4/Immunization/{logicalId} | |
| GET/fhir/r4/Immunization | |
| POST/fhir/r4/Immunization/_search | |
| GET/fhir/r4/DiagnosticReport/{logicalId} | |
| GET/fhir/r4/DiagnosticReport | |
| POST/fhir/r4/DiagnosticReport/_search | |
| GET/fhir/r4/Medication/{logicalId} | |
| GET/fhir/r4/Medication | |
| POST/fhir/r4/Medication/_search | |
| GET/fhir/r4/MedicationRequest/{logicalId} | |
| GET/fhir/r4/MedicationRequest | |
| POST/fhir/r4/MedicationRequest/_search | |
| GET/fhir/r4/Observation/{logicalId} | |
| GET/fhir/r4/Observation | |
| POST/fhir/r4/Observation/_search | |
| GET/fhir/r4/Condition/{logicalId} | |
| GET//fhir/r4/Condition | |
| POST/fhir/r4/Condition/_search | |
| GET/fhir/r4/Procedure/{logicalId} | |
| GET/fhir/r4/Procedure | |
| POST/fhir/r4/Procedure/_search | |
| Documents and Forms | GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference/AmbulatorySummary-{patientid} | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Device | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Device/{deviceid} | |
| GET/fhir/r4/Binary/{logicalId} | |
| GET/fhir/r4/Device/{logicalId} | |
| GET/fhir/r4/Device | |
| POST//fhir/r4/Device/_search | |
| GET/fhir/r4/DocumentReference/{logicalId} | |
| GET/fhir/r4/DocumentReference | |
| POST/fhir/r4/DocumentReference/_search | |
| GET/fhir/r4/ServiceRequest/{logicalId} | |
| GET/fhir/r4/ServiceRequest | |
| POST/fhir/r4/ServiceRequest/_search | |
| Encounter | GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Encounter |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Encounter/{encounterid} | |
| GET/fhir/r4/Encounter/{logicalId} | |
| GET/fhir/r4/Encounter | |
| POST/fhir/r4/Encounter/_search | |
| Patient | GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient | |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient/{patientid} | |
| GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid} | |
| GET/fhir/r4/Patient/{logicalId} | |
| GET/fhir/r4/Patient | |
| POST/fhir/r4/Patient/_search | |
| Practice Configuration | GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Organization/Practice-{practiceid} |
| GET/fhir/r4/Location/{logicalId} | |
| GET/fhir/r4/Location | |
| POST/fhir/r4/Location/_search | |
| GET/fhir/r4/Organization/{logicalId} | |
| GET/fhir/r4/Organization | |
| POST/fhir/r4/Organization/_search | |
| Provider | GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Organization/ClinicalProvider-{clinicalproviderid} |
| GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Practitioner/Provider-{providerid} | |
| GET/fhir/r4/Provenance/{logicalId} | |
| GET/fhir/r4/Provenance | |
| POST/fhir/r4/Provenance/_search | |
| GET/fhir/r4/Practitioner/{logicalId} | |
| GET/fhir/r4/Practitioner | |
| POST/fhir/r4/Practitioner/_search | |
| FHIR Bulk Export | GET/fhir/r4/Group/{logicalId}/$export |
| GET/fhir/r4/$export-poll-status/{jobId} | |
| DELETE/fhir/r4/$export-poll-status/{jobId} |
List of athenaOne APIs
| Category | API Endpoint | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Appointments |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Chart |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Documents and Forms |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Encounter |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Hospital |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Insurance and Financial |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OB Episode |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Patient |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Practice Configuration |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Provider |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Quality Management / Pop Health |
|
|
|