Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

CMS — Centers for Medicare & Medicaid Services Bulk Export API is one of 25 APIs that CMS — Centers for Medicare & Medicaid Services publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Bulk Export. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 12 operations across 10 paths. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://api.ab2d.cms.gov/api/v2, https://sandbox.ab2d.cms.gov/api/v2.

12 operations 10 paths 0 schemas 2 DELETE10 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.bluebutton.cms.gov/v2/fhir
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

CMS — Centers for Medicare & Medicaid Services Bulk Export API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — AB2D uses SMART Backend Services with okta-issued JWT bearer tokens.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 2 DELETE, 10 GET. Each is listed below with its method, path, parameters, and response codes.

Bulk Export 12
GET
/Patient/$export
Export Patient Claims
exportPatient 5 params → 202
GET
/Group/{contractId}/$export
Export Contract Population
exportContract 4 params → 202
GET
/Job/{jobUuid}/$status
Get Job Status
getJobStatus 1 param → 200202
DELETE
/Job/{jobUuid}/$status
Cancel Job
cancelJob 1 param → 202
GET
/Job/{jobUuid}/file/{filename}
Download Job Output File
downloadOutput 2 params → 200
GET
/Group/{groupId}/$export
Initiate Group Bulk Export
exportGroup 4 params → 202
GET
/jobs/{jobId}
Get Bulk Export Job Status
getJob 1 param → 200202
DELETE
/jobs/{jobId}
Cancel Bulk Export Job
cancelJob 1 param → 202
GET
/jobs
List Bulk Export Jobs
listJobs → 200
GET
/Group/{id}/$export
Group Bulk Export
exportGroup 4 params → 202
GET
/Jobs/{jobId}
Get Export Job Status
getJob 1 param → 200202
GET
/Data/{fileName}
Download Export File
downloadFile 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cms-gov-bulk-export-api-openapi.yml Raw ↑

Other APIs CMS — Centers for Medicare & Medicaid Services publishes across the network.

CMS — Centers for Medicare & Medicaid Services Articles API
CMS — Centers for Medicare & Medicaid Services Auth API
CMS — Centers for Medicare & Medicaid Services Benchmarks API
CMS — Centers for Medicare & Medicaid Services Catalog API
CMS — Centers for Medicare & Medicaid Services Coverage API
CMS — Centers for Medicare & Medicaid Services Data API
CMS — Centers for Medicare & Medicaid Services Drugs API
CMS — Centers for Medicare & Medicaid Services Eligibility API
CMS — Centers for Medicare & Medicaid Services ExplanationOfBenefit API
CMS — Centers for Medicare & Medicaid Services Geography API
CMS — Centers for Medicare & Medicaid Services Group API
CMS — Centers for Medicare & Medicaid Services Issuers API