athenahealth Bulk Data API

The Bulk Data API from athenahealth — 2 operation(s) for bulk data.

Documentation GitHub OpenAPI

Business capability

Healthcare Interoperability Operations BC-2900.60

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /Group/{id}/$export Start a bulk FHIR export for a patient group · Group Bulk Export #

Ask an LLM

“How do I export all FHIR data for a group of patients at once?”

“Can a bulk export include only certain resource types or changes since a date?”

Tell an agent

Start a bulk export for group {id}.

Export {_type} resources for group {id} changed since {_since}.

GET /bulk/status/{jobid} Check progress of a bulk export job · Get Bulk Export Status #

Ask an LLM

“Is my bulk data export finished yet?”

“Where do I get the download links once a bulk export completes?”

Tell an agent

Check the status of bulk export job {jobid}.

Get the output files for finished export job {jobid}.

DELETE /bulk/status/{jobid} Cancel a running bulk export · Cancel Bulk Export #

Ask an LLM

“How do I stop a bulk export that is still running?”

“Can I cancel an export job I kicked off by mistake?”

Tell an agent destructive · confirm first

Cancel bulk export job {jobid}.

Abort export {jobid} and discard it.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/athenahealth:athena-health-bulk-data-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: athenahealth FHIR Access Bulk Data API
  description: 'FHIR Bulk Data Access ($export) for athenahealth. Implements the FHIR

    Bulk Data Access (Flat FHIR) Export Implementation Guide and the FHIR

    Asynchronous Request Pattern for Group-level export.'
  version: 2.0.0
servers:
- url: https://api.platform.athenahealth.com/fhir/r4
  description: Production
- url: https://api.preview.platform.athenahealth.com/fhir/r4
  description: Preview
security:
- backend: []
tags:
- name: Bulk Data
paths:
  /Group/{id}/$export:
    get:
      summary: Group Bulk Export
      operationId: groupBulkExport
      tags:
      - Bulk Data
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: _type
        in: query
        schema:
          type: string
      - name: _since
        in: query
        schema:
          type: string
          format: date-time
      - name: _outputFormat
        in: query
        schema:
          type: string
          default: application/fhir+ndjson
      - name: Accept
        in: header
        schema:
          type: string
          default: application/fhir+json
      - name: Prefer
        in: header
        schema:
          type: string
          default: respond-async
      responses:
        '202':
          description: Bulk export accepted; poll Content-Location for status
          headers:
            Content-Location:
              schema:
                type: string
                format: uri
  /bulk/status/{jobid}:
    get:
      summary: Get Bulk Export Status
      operationId: getBulkExportStatus
      tags:
      - Bulk Data
      parameters:
      - name: jobid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Manifest of NDJSON output files
        '202':
          description: Still processing
    delete:
      summary: Cancel Bulk Export
      operationId: cancelBulkExport
      tags:
      - Bulk Data
      parameters:
      - name: jobid
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Cancellation accepted
components:
  securitySchemes:
    backend:
      type: oauth2
      description: SMART Backend Services (JWT client assertion)
      flows:
        clientCredentials:
          tokenUrl: https://api.platform.athenahealth.com/oauth2/v1/token
          scopes:
            system/*.read: System-level read for Bulk Data

athenahealth Bulk Data API

Operations 3

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification