How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CMS Blue Button 2.0 Patient API

Beneficiary demographic and administrative data.

CMS Blue Button 2.0 Patient 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 Patient. 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.2.0, 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.2.0
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 Patient 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.

Patient 2

Beneficiary demographic and administrative data.

GET
/Patient
Search the authorized beneficiary's Patient resource
searchPatient 5 params → 200401
GET
/Patient/{id}
Read the beneficiary's Patient resource by id
readPatient 1 param → 200401404

Schemas 2

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

Bundle
object
A FHIR R4 searchset Bundle wrapping matching resources.
5 properties
Patient
object
FHIR R4 Patient resource for the authorizing Medicare beneficiary.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs CMS Blue Button 2.0 publishes across the network.

CMS Blue Button 2.0 Coverage API
CMS Blue Button 2.0 ExplanationOfBenefit API
CMS Blue Button 2.0 Metadata API
CMS Blue Button 2.0 UserInfo API
Where this information came from

This is an independent, third-party profile of CMS Blue Button 2.0 Patient API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.