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

Centers for Medicare and Medicaid Services Capability API

FHIR server capability statements and metadata.

Centers for Medicare and Medicaid Services Capability API is one of 12 APIs that Centers for Medicare and Medicaid Services publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version v2.

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

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.bluebutton.cms.gov/v2/fhir/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Centers for Medicare and Medicaid Services Capability API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authorization code flow used by Medicare beneficiaries to grant access to a third-party application.

Paths & Operations 1

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

Capability 1

FHIR server capability statements and metadata.

GET
/metadata
Get Capability Statement
getCapabilityStatement → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is FHIRResource (2 properties). Each schema is shown below with its type and property counts.

FHIRResource
object
A generic FHIR R4 resource.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

centers-for-medicare-and-medicaid-services-capability-api-openapi.yml Raw ↑

Other APIs Centers for Medicare and Medicaid Services publishes across the network.

CMS Beneficiary Claims Data API (BCDA)
CMS Data at the Point of Care (DPC) API
CMS Socrata Open Data API (data.cms.gov)
CMS Provider Data Catalog API (Care Compare)
NPPES NPI Registry API
Healthcare.gov Marketplace API
CMS Quality Payment Program (QPP) Measures API
Medicare Coverage Database (MCD) API
Centers for Medicare and Medicaid Services Coverage API
Centers for Medicare and Medicaid Services ExplanationOfBenefit API
Centers for Medicare and Medicaid Services Patient API