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 Metadata API

The Metadata API from CMS — Centers for Medicare & Medicaid Services — 2 operation(s) for metadata.

CMS — Centers for Medicare & Medicaid Services Metadata 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 Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 2 operations across 2 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.

2 operations 2 paths 0 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
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

CMS — Centers for Medicare & Medicaid Services Metadata 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 2

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

Metadata 2
GET
/metadata
Get FHIR Capability Statement
getCapabilityStatement → 200
GET
/attribution_status
Get Attribution Status
getAttributionStatus → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cms-gov-metadata-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 Bulk Export 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