openapi: 3.1.0
info:
title: CMS Blue Button 2.0 Capability API
description: Blue Button 2.0 is a standards-based HL7 FHIR R4 API that delivers Medicare Part A, B, and D claims data for over 60 million beneficiaries to registered third-party applications. Beneficiaries authorize sharing via OAuth 2.0. Blue Button 2.0 anchors CMS's Patient Access API program under the 21st Century Cures Act.
version: v2
contact:
name: CMS Blue Button Developer Support
url: https://bluebutton.cms.gov/developers/
termsOfService: https://bluebutton.cms.gov/terms/
servers:
- url: https://api.bluebutton.cms.gov/v2/fhir
description: Blue Button 2.0 production FHIR server
- url: https://sandbox.bluebutton.cms.gov/v2/fhir
description: Blue Button 2.0 sandbox FHIR server
security:
- oauth2: []
tags:
- name: Capability
description: FHIR server capability statements and metadata.
paths:
/metadata:
get:
operationId: getCapabilityStatement
summary: Get Capability Statement
description: Returns the FHIR CapabilityStatement describing supported resources and operations.
tags:
- Capability
security: []
responses:
'200':
description: Server capability statement.
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIRResource'
components:
schemas:
FHIRResource:
type: object
description: A generic FHIR R4 resource.
properties:
resourceType:
type: string
id:
type: string
additionalProperties: true
securitySchemes:
oauth2:
type: oauth2
description: OAuth 2.0 authorization code flow used by Medicare beneficiaries to grant access to a third-party application.
flows:
authorizationCode:
authorizationUrl: https://api.bluebutton.cms.gov/v2/o/authorize/
tokenUrl: https://api.bluebutton.cms.gov/v2/o/token/
scopes:
patient/Patient.read: Read beneficiary Patient resource.
patient/Coverage.read: Read beneficiary Coverage resources.
patient/ExplanationOfBenefit.read: Read beneficiary claims.
externalDocs:
description: CMS Blue Button 2.0 API Documentation
url: https://bluebutton.cms.gov/api-documentation/
x-generated-from: https://bluebutton.cms.gov/api-documentation/
x-generated-by: claude-crawl-2026-05-08