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 Blue Button 2.0 Coverage API

Medicare coverage resources, one per coverage type.

CMS Blue Button 2.0 Coverage API is one of 5 APIs that CMS Blue Button 2.0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Coverage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

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

2 operations 2 paths 2 schemas 2 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
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

CMS Blue Button 2.0 Coverage API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authorization-code flow with mandatory PKCE (S256 only). Beneficiaries log in with their Medicare.gov credentials and choose whether to share demogra…

Paths & Operations 2

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

Coverage 2

Medicare coverage resources, one per coverage type.

GET
/Coverage
Search a beneficiary's Medicare coverage
searchCoverage 5 params → 200401
GET
/Coverage/{id}
Read a single Coverage resource by id
readCoverage 1 param → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Bundle (5 properties), Coverage (5 properties). Each schema is shown below with its type and property counts.

Coverage
object
FHIR R4 Coverage resource - one per Medicare coverage type (Part A, Part B, Part D).
5 properties
Bundle
object
A FHIR R4 searchset Bundle wrapping matching resources.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cms-blue-button-coverage-api-openapi.yml Raw ↑

Other APIs CMS Blue Button 2.0 publishes across the network.

CMS Blue Button 2.0 ExplanationOfBenefit API
CMS Blue Button 2.0 Metadata API
CMS Blue Button 2.0 Patient API
CMS Blue Button 2.0 UserInfo API