CMS — Centers for Medicare & Medicaid Services

CMS — Centers for Medicare & Medicaid Services Bulk Export API

The Bulk Export API from CMS — Centers for Medicare & Medicaid Services — 10 operation(s) for bulk export.

GitHub OpenAPI

Operations 12

GET /Patient/$export Export Patient Claims #
GET /Group/{contractId}/$export Export Contract Population #
GET /Job/{jobUuid}/$status Get Job Status #
DELETE /Job/{jobUuid}/$status Cancel Job #
GET /Job/{jobUuid}/file/{filename} Download Job Output File #
GET /Group/{groupId}/$export Initiate Group Bulk Export #
GET /jobs/{jobId} Get Bulk Export Job Status #
DELETE /jobs/{jobId} Cancel Bulk Export Job #
GET /jobs List Bulk Export Jobs #
GET /Group/{id}/$export Group Bulk Export #
GET /Jobs/{jobId} Get Export Job Status #
GET /Data/{fileName} Download Export File #

Documentation

📖
Documentation
https://bluebutton.cms.gov/developers/
📖
Documentation
https://bcda.cms.gov/
📖
Documentation
https://bcda.cms.gov/guide.html
📖
Documentation
https://ab2d.cms.gov/
📖
Documentation
https://ab2d.cms.gov/getting-started/
📖
Documentation
https://dpc.cms.gov/
📖
Documentation
https://dpc.cms.gov/docs
📖
Documentation
https://bfd.cms.gov/
📖
Documentation
https://developer.cms.gov/marketplace-api/
📖
Documentation
https://www.cms.gov/marketplace/resources/data/public-use-files
📖
Documentation
https://data.cms.gov/provider-data/
📖
Documentation
https://data.cms.gov/provider-data/docs
📖
Documentation
https://qpp.cms.gov/about/resource-library
📖
Documentation
https://www.cms.gov/medicare-coverage-database/reports/reports.aspx

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cms-gov/refs/heads/main/openapi/cms-gov-bulk-export-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cms-gov/refs/heads/main/json-schema/cms-gov-explanation-of-benefit-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cms-gov/refs/heads/main/json-schema/cms-gov-patient-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cms-gov/refs/heads/main/json-schema/cms-gov-coverage-schema.json

Other Resources

🔗
Console
https://bluebutton.cms.gov/api/v2/explorer/
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/cms-gov/refs/heads/main/json-ld/cms-gov-context.jsonld
🔗
Sandbox
https://sandbox.bcda.cms.gov/
🔗
Console
https://sandbox.ab2d.cms.gov/swagger-ui/
🔗
SourceCode
https://github.com/CMSgov/beneficiary-fhir-data
🔗
Portal
https://data.cms.gov/
🔗
Schema
https://data.cms.gov/data.json
🔗
Portal
https://data.cms.gov/provider-data/
🔗
SourceCode
https://github.com/CMSgov/qpp-measures-data
🔗
Portal
https://www.cms.gov/medicare-coverage-database/

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/cms-gov-bulk-export-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

cms-gov-bulk-export-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cms Gov Bulk Export API
  license:
    name: Public Domain (U.S. Government Work)
    url: https://www.usa.gov/government-works
  version: '1.0'
  description: 'Operations tagged Bulk Export across 4 of this provider''s published API definitions: cms-gov-ab2d-openapi.yml, cms-gov-bcda-openapi.yml, cms-gov-bfd-openapi.yml, cms-gov-dpc-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.ab2d.cms.gov/api/v2
  description: Production
- url: https://sandbox.ab2d.cms.gov/api/v2
  description: Sandbox
- url: https://api.bcda.cms.gov/api/v2
  description: Production
- url: https://sandbox.bcda.cms.gov/api/v2
  description: Sandbox
- url: https://prod.bfd.cms.gov/v2/fhir
  description: Production (peering only)
- url: https://sandbox.bfd.cms.gov/v2/fhir
  description: Sandbox (peering only)
- url: https://api.dpc.cms.gov/api/v1
  description: Production
- url: https://sandbox.dpc.cms.gov/api/v1
  description: Sandbox
tags:
- name: Bulk Export
paths:
  /Patient/$export:
    get:
      summary: Export Patient Claims
      operationId: exportPatient
      description: Asynchronously kick off a bulk export of ExplanationOfBenefit resources.
      tags:
      - Bulk Export
      parameters:
      - name: _type
        in: query
        schema:
          type: string
          default: ExplanationOfBenefit
      - name: _since
        in: query
        schema:
          type: string
          format: date-time
      - name: _outputFormat
        in: query
        schema:
          type: string
          enum:
          - application/fhir+ndjson
          - application/ndjson
          - ndjson
      - name: Prefer
        in: header
        required: true
        schema:
          type: string
          enum:
          - respond-async
      - name: Accept
        in: header
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Export job created; poll Content-Location.
          headers:
            Content-Location:
              schema:
                type: string
                format: uri
      security:
      - BearerAuth: []
    servers:
    - url: https://api.ab2d.cms.gov/api/v2
      description: Production
    - url: https://sandbox.ab2d.cms.gov/api/v2
      description: Sandbox
  /Group/{contractId}/$export:
    get:
      summary: Export Contract Population
      operationId: exportContract
      tags:
      - Bulk Export
      parameters:
      - name: contractId
        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: Prefer
        in: header
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
      security:
      - BearerAuth: []
    servers:
    - url: https://api.ab2d.cms.gov/api/v2
      description: Production
    - url: https://sandbox.ab2d.cms.gov/api/v2
      description: Sandbox
  /Job/{jobUuid}/$status:
    get:
      summary: Get Job Status
      operationId: getJobStatus
      tags:
      - Bulk Export
      parameters:
      - name: jobUuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Job complete with manifest
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactionTime:
                    type: string
                    format: date-time
                  output:
                    type: array
                    items:
                      type: object
                  error:
                    type: array
                    items:
                      type: object
        '202':
          description: Job still processing
      security:
      - BearerAuth: []
    delete:
      summary: Cancel Job
      operationId: cancelJob
      tags:
      - Bulk Export
      parameters:
      - name: jobUuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '202':
          description: Cancelled
      security:
      - BearerAuth: []
    servers:
    - url: https://api.ab2d.cms.gov/api/v2
      description: Production
    - url: https://sandbox.ab2d.cms.gov/api/v2
      description: Sandbox
  /Job/{jobUuid}/file/{filename}:
    get:
      summary: Download Job Output File
      operationId: downloadOutput
      tags:
      - Bulk Export
      parameters:
      - name: jobUuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: filename
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: NDJSON file
          content:
            application/fhir+ndjson:
              schema:
                type: string
                format: binary
      security:
      - BearerAuth: []
    servers:
    - url: https://api.ab2d.cms.gov/api/v2
      description: Production
    - url: https://sandbox.ab2d.cms.gov/api/v2
      description: Sandbox
  /Group/{groupId}/$export:
    get:
      summary: Initiate Group Bulk Export
      operationId: exportGroup
      tags:
      - Bulk Export
      parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
          enum:
          - all
          - runout
          - new
      - name: _type
        in: query
        schema:
          type: string
      - name: _since
        in: query
        schema:
          type: string
          format: date-time
      - name: Prefer
        in: header
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
      security:
      - BearerAuth: []
    servers:
    - url: https://api.bcda.cms.gov/api/v2
      description: Production
    - url: https://sandbox.bcda.cms.gov/api/v2
      description: Sandbox
  /jobs/{jobId}:
    get:
      summary: Get Bulk Export Job Status
      operationId: getJob
      tags:
      - Bulk Export
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Job complete, output manifest returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactionTime:
                    type: string
                    format: date-time
                  request:
                    type: string
                  requiresAccessToken:
                    type: boolean
                  output:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        url:
                          type: string
                          format: uri
                  error:
                    type: array
                    items:
                      type: object
        '202':
          description: Still processing
      security:
      - BearerAuth: []
    delete:
      summary: Cancel Bulk Export Job
      operationId: cancelJob
      tags:
      - Bulk Export
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Job cancelled
      security:
      - BearerAuth: []
    servers:
    - url: https://api.bcda.cms.gov/api/v2
      description: Production
    - url: https://sandbox.bcda.cms.gov/api/v2
      description: Sandbox
  /jobs:
    get:
      summary: List Bulk Export Jobs
      operationId: listJobs
      tags:
      - Bulk Export
      responses:
        '200':
          description: List of jobs
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://api.bcda.cms.gov/api/v2
      description: Production
    - url: https://sandbox.bcda.cms.gov/api/v2
      description: Sandbox
  /Group/{id}/$export:
    get:
      summary: Group Bulk Export
      operationId: exportGroup
      tags:
      - Bulk Export
      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: Prefer
        in: header
        required: true
        schema:
          type: string
          enum:
          - respond-async
      responses:
        '202':
          description: Accepted
      security:
      - MutualTLS: []
    servers:
    - url: https://prod.bfd.cms.gov/v2/fhir
      description: Production (peering only)
    - url: https://sandbox.bfd.cms.gov/v2/fhir
      description: Sandbox (peering only)
  /Jobs/{jobId}:
    get:
      summary: Get Export Job Status
      operationId: getJob
      tags:
      - Bulk Export
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Job manifest
        '202':
          description: Still processing
      security:
      - BearerAuth: []
    servers:
    - url: https://api.dpc.cms.gov/api/v1
      description: Production
    - url: https://sandbox.dpc.cms.gov/api/v1
      description: Sandbox
  /Data/{fileName}:
    get:
      summary: Download Export File
      operationId: downloadFile
      tags:
      - Bulk Export
      parameters:
      - name: fileName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: NDJSON file
          content:
            application/fhir+ndjson:
              schema:
                type: string
                format: binary
      security:
      - BearerAuth: []
    servers:
    - url: https://api.dpc.cms.gov/api/v1
      description: Production
    - url: https://sandbox.dpc.cms.gov/api/v1
      description: Sandbox
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: AB2D uses SMART Backend Services with okta-issued JWT bearer tokens.
    MutualTLS:
      type: mutualTLS
      description: BFD requires X.509 client certificates issued by the CMS PKI; access is restricted to peering applications.
x-refined-from:
- cms-gov-ab2d-openapi.yml
- cms-gov-bcda-openapi.yml
- cms-gov-bfd-openapi.yml
- cms-gov-dpc-openapi.yml