22.7 Release: New: Certified USCDI FHIR R4 Read and Search APIs

Summary	Starting Summer release, athenahealth will publish a set of read-only certified FHIR R4 APIs and our FHIR R4 server base URLs to empower third-party applications to easily integrate with our EHR and connect patients with their health information in accordance with 21^st Century Cures Act.
Products	athenaClinicals, athenaCommunicator, athenaClinicals for Hospitals & Health Systems
Roles	Management/Technical
Available	July 29, 2022 (22.7)
Highlights	Read and Search FHIR R4 APIs on the following 20 USCDI resources: Condition DiagnosticReport DocumentReference Encounter Goal Immunization Device Location Medication MedicationRequest Observation Organization Patient Practitioner Procedure Provenance Binary Onboarding guides using 2-legged and/or 3-legged OAuth (including SMART on FHIR) patterns athenahealth's FHIR R4 server base URLs and a list of Clinicals-only practices for Patient Health Record apps to retrieve patient-requested data from our tablespaces
Setup	N/A
Is this a breaking change?	No, this is not a breaking change
Endpoints affected	N/A
Resources	Refer to the following resources for more information: FHIR R4 Documentation Base FHIR URLs System Apps (2-legged) Patient and Provider Apps (3-legged) Real-time, self-service registration for 3-legged OAuth apps FHIR Bulk Data Access Capability SMART on FHIR Capabilities and Workflows Enable Patient Authentication Against Multiple athenaOne® Practices

Background

The 21^st Century Cures Act promotes greater data access and exchange of electronic health information (EHI) using interoperable technologies. The Cures Act places special emphasis on accessibility of APIs certified under the Office of the National Coordinator (ONC)’s CEHRT program.

Why we're making this change

To stay in compliance with Cures requirements, starting summer release, we will publish on our developer portal a set of athenahealth’s standards based FHIR R4 APIs which have been certified under the 2015 Edition CEHRT (g)(10) criterion and developed in accordance with HL7 FHIR and SMART on FHIR standards. These resource-oriented RESTful APIs allow read and search interaction of USCDI (United States Core Data for Interoperability) clinical data and are intended to empower third-party applications to easily integrate with our EHR and connect patients with their health information.

Certified FHIR R4 APIs are accessed via a “Base Service URL”, the URL for which is the same for all contexts across athenaOne Production (and one for Preview), due to our single-instance multi-tenant configuration. To facilitate ease of access, we will also be publishing the full list of contexts that are accessible via these Base Services URLs to the developer portal.

In addition to satisfying regulatory purposes, expanding our API collection in the FHIR standard format allows us to take forward steps towards an open, collaborative platform and industry interoperability.

What this means to me

With the release of FHIR R4 endpoints, we’re extending our list of certified APIs, which athenahealth offers free of charge to our customers and partners (learn more here). If you are an app developer who builds and deploys solutions to healthcare organizations using athenahealth or to their patients, these certified FHIR R4 endpoints offer additional API integration capability to enable patients’ authorization and access to their health information.

What is changing

New Endpoints that will be added during 22.7 Release:

Category	API Endpoint
Allergies	GET/fhir/r4/AllergyIntolerance/{logicalId}
	GET/fhir/r4/AllergyIntolerance
	POST/fhir/r4/AllergyIntolerance/_search
Binary	GET/fhir/r4/Binary/{logicalId}
Care Plan	GET/fhir/r4/CarePlan/{logicalId}
	GET/fhir/r4/CarePlan
	POST/fhir/r4/CarePlan/_search
Care Team	GET/fhir/r4/CareTeam/{logicalId}
	GET/fhir/r4/CareTeam
	POST/fhir/r4/CareTeam/_search
Devices	GET/fhir/r4/Device/{logicalId}
	GET/fhir/r4/Device
	POST//fhir/r4/Device/_search
Documents and Forms	GET/fhir/r4/DocumentReference/{logicalId}
	GET/fhir/r4/DocumentReference
	POST/fhir/r4/DocumentReference/_search
Encounter	GET/fhir/r4/Encounter/{logicalId}
	GET/fhir/r4/Encounter
	POST/fhir/r4/Encounter/_search
Goals	GET/fhir/r4/Goal/{logicalId}
	GET/fhir/r4/Goal
	POST/fhir/r4/Goal/_search
Immunizations	GET/fhir/r4/Immunization/{logicalId}
	GET/fhir/r4/Immunization
	POST/fhir/r4/Immunization/_search
Lab Results	GET/fhir/r4/DiagnosticReport/{logicalId}
	GET/fhir/r4/DiagnosticReport
	POST/fhir/r4/DiagnosticReport/_search
Medications	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
Observation	GET/fhir/r4/Observation/{logicalId}
	GET/fhir/r4/Observation
	POST/fhir/r4/Observation/_search
Patient	GET/fhir/r4/Patient/{logicalId}
	GET/fhir/r4/Patient
	POST/fhir/r4/Patient/_search
Practice Configuration	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
Problems	GET/fhir/r4/Condition/{logicalId}
	GET//fhir/r4/Condition
	POST/fhir/r4/Condition/_search
Procedures	GET/fhir/r4/Procedure/{logicalId}
	GET/fhir/r4/Procedure
	POST/fhir/r4/Procedure/_search
Provider	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 R4 Base Service URLs:

The FHIR R4 Base Service URLs are published to the developer portal here. On this page is a link to a CSV file that is updated daily and contains the following information for all contexts on athenaOne that have previously gone live, are not marked deleted, and where Clinicals is marked enabled:

The Release Date of the file
The Practice Name, which is the Communicator Brand Name where available, and is otherwise the Context Name
The FHIR R4 Organization ID
The Production FHIR R4 Base Service URL

What will current users of the endpoint need to update in their code?

Nothing

What will happen if users of the endpoint do not update their code?

Nothing

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

22.7 Release: New: Certified USCDI FHIR R4 Read and Search APIs

On this Page