CMS Blue Button 2.0 ExplanationOfBenefit API
Medicare Parts A, B, and D claims as CARIN Blue Button EOB profiles.
CMS Blue Button 2.0 ExplanationOfBenefit 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 ExplanationOfBenefit. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
CMS Blue Button 2.0 ExplanationOfBenefit 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.
Medicare Parts A, B, and D claims as CARIN Blue Button EOB profiles.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ExplanationOfBenefit (8 properties), Bundle (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from CMS Blue Button 2.0 4
Other APIs CMS Blue Button 2.0 publishes across the network.