22.7 Release: New: FHIR Bulk Data Access Capability

Summary

The 21st Century Cures Act promotes greater data access and exchange of electronic health information using interoperable technologies. Starting summer release, athenahealth will offer FHIR Bulk Export capability to fulfil the requirements for bulk data export by 21st Century Cures.

Products

athenaClinicals, athenaCommunicator, athenaClinicals for Hospitals & Health Systems

Roles

Management/Technical

Available

July 29, 2022 (22.7)

Highlights

  • FHIR Bulk Export service in compliance with 21st Century Cures
  • Onboarding guides to connect with our FHIR APIs using 2-legged OAuth pattern
  • athenahealth's FHIR R4 base URLs

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:

Background

The 21st Century Cures Act promotes greater data access and exchange using interoperable technologies. The Cures Act places special emphasis on accessibility of APIs certified under the Office of the National Coordinator (ONC)’s CEHRT (Certified Electronic Health Record Technology) program.

What is changing

Starting Summer release (22.7), we will offer FHIR Bulk Export service to fulfil the 21st Century Cures bulk data export requirements. This feature leverages FHIR R4 APIs certified under the 2015 Edition CEHRT (g)(10) criterion. The FHIR Bulk Export service enables API consumers to make asynchronous requests to export USCDI (United States Core Data for Interoperability) clinical data for all patients in a particular athena context.

Why we're making this change

With FHIR Bulk Export, you can retrieve data for multiple patients or resources at a time. Potential use cases to consider for the FHIR Bulk Export service:

  • One-time initial load of data for seeding system such as data warehouse
  • Monthly data capture synchronizations
  • Monthly export of a few specific resources (_type parameter)
  • Population health data transfer

We do not recommend using FHIR Bulk Export for real-time access needs, daily data synchronizations, or scenarios when a single patient’s health information needs to be obtained.

It is also important to note that this feature provides bulk data access to clinical data elements required by USCDI. If there is additional data needed outside of this scope, please explore other data export mechanisms provided by athena, including Data View.

FHIR Bulk Export is an addition to our list of Certified APIs, which athenahealth offers free of charge to our customers and partners (learn more here).

Note

You will also need to be granted access to target specific practice(s) for data exports (either requested by the athenahealth customer you are working with or follow this process to request context access).

What this means to you

New Endpoints that will be added during 22.7 Release:

Our FHIR Bulk Export service enables the data export through $export operation specified by the HL7’s Bulk Data Access Implementation Guide. The export will be executed on a FHIR “Group” resource. Currently, a Group resource for bulk export is synonymous with a context (or tablespace) in athenaOne, which means the Group resource represents “all patients in a practice”.

  • Export Invocation - GET/fhir/r4/Group/{logicalId}/$export

In addition to kicking off an export using $export, our end-to-end FHIR Bulk Export workflow provides endpoints to poll for job status and download files once export has been completed, as well as cancelling an export job.

  • Export Polling and File Download - GET/fhir/r4/$export-poll-status/{jobId}
  • Export Cancellation - DELETE/fhir/r4/$export-poll-status/{jobId}

High-level user experience is:

  1. API user makes a GET request to initiate an export job.
  2. A polling URL containing the jobId is returned in the response Location header.
  3. API user makes a GET request to poll the job status.
  4. Polling URL returns progress indicator in the response header until the job is complete.
  5. API user can cancel the export job at any time by making a DELETE request to the same polling location URL.
  6. Once the export job is 100% complete, the polling URL returns a list of signed URLs to S3 in the Response Body to allow download of the exported files (NDJSON format).

For additional information please refer to our FHIR Bulk Export workflow guide on the Developer Portal.

Access and permissions

Our FHIR APIs are gated using OAuth scopes. First, you need to gain access to our FHIR APIs by requesting applicable FHIR R4 resource scopes to be associated with your app in the developer console. Refer to FHIR Bulk Export workflow guide on the Developer Portal for a list of required resource scopes for FHIR Bulk Export.

You will also need to be granted access to target specific practice(s) for data exports (either requested by the athenahealth customer you are working with or follow this process to request context access).

Note

Bulk export testing is not supported in our Sandbox on the Developer Portal. Postman collection will not be available for this feature.

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

On this Page