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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
CMS — Centers for Medicare & Medicaid Services

CMS — Centers for Medicare & Medicaid Services Metadata API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

CMS — Centers for Medicare & Medicaid Services Metadata API is one of 56 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 5 operations across 5 paths, and defines 84 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 8 base URLs: https://api.bcda.cms.gov/api/v2, https://sandbox.bcda.cms.gov/api/v2, https://prod.bfd.cms.gov/v2/fhir, https://sandbox.bfd.cms.gov/v2/fhir, https://api.bluebutton.cms.gov/v2/fhir, https://sandbox.bluebutton.cms.gov/v2/fhir, https://api.dpc.cms.gov/api/v1, https://sandbox.dpc.cms.gov/api/v1.

5 operations 5 paths 84 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.bluebutton.cms.gov/v2/fhir
Authentication
HTTP Bearer, Mutual TLS, OAuth 2.0, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 5

CMS — Centers for Medicare & Medicaid Services Metadata API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It requires mutual TLS (MutualTLS). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 4 scopes. It accepts HTTP basic authentication (basic_auth). An API key is passed in the header as Authorization (bearer_token).

  • BearerAuth — BCDA uses SMART Backend Services authentication — token obtained from /auth/token.
  • MutualTLS — BFD requires X.509 client certificates issued by the CMS PKI; access is restricted to peering applications.
  • bearer_token — The Group and Patient endpoints require a Bearer Token. 1) Put your credentials in Basic Authentication, 2) Request a bearer token from /auth/token, 3) Put "Be…

Paths & Operations 5

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

Metadata 5
GET
/metadata
Get FHIR Capability Statement
getCapabilityStatement → 200
GET
/attribution_status
Get Attribution Status
getAttributionStatus → 200
GET
/_version
Get API version
getVersion → 200
GET
/api/v1/metadata
Get metadata
metadata → 200
GET
/api/v2/metadata
Get metadata
metadatav2 → 200

Schemas 84

The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are CapabilityStatement_2 (35 properties), CapabilityStatement_Rest_Resource (18 properties), CapabilityStatement_Rest (11 properties), CapabilityStatement_Messaging_Event (10 properties). Each schema is shown below with its type and property counts.

CapabilityStatement
object
5 properties
ContactPointSystemCode
object
Telecommunications form for contact point See http://hl7.org/fhir/ValueSet/contact-point-system
3 properties
SystemRestfulInteractionCode_Value
integer
SystemRestfulInteractionCode
object
http://hl7.org/fhir/ValueSet/system-restful-interaction
3 properties
CapabilityStatement_2
object
Auto-generated from StructureDefinition for CapabilityStatement, last updated 2017-04-19T07:44:43.294+10:00. A statement of system capabilities. See http://hl7…
35 properties
NarrativeStatusCode_Value
integer
SearchParamTypeCode
object
See http://hl7.org/fhir/ValueSet/search-param-type
3 properties
CapabilityStatement_Rest
object
If the endpoint is a RESTful one
11 properties
DateTime_Precision
integer
ReferenceHandlingPolicyCode_Value
integer
CapabilityStatement_Messaging_Endpoint
object
Where messages should be sent
5 properties
PositiveInt
object
Auto-generated from StructureDefinition for positiveInt, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type positiveInt. See http://hl7.org/fhir/Struct…
3 properties
DateTime
object
Auto-generated from StructureDefinition for dateTime, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type dateTime. See http://hl7.org/fhir/StructureDef…
5 properties
CapabilityStatement_Messaging_SupportedMessage
object
Messages supported by this system
5 properties
CapabilityStatement_Rest_Security_Certificate
object
Certificates associated with security profiles
5 properties
MessageSignificanceCategoryCode
object
See http://hl7.org/fhir/ValueSet/message-significance-category
3 properties
String
object
Auto-generated from StructureDefinition for string, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type string. See http://hl7.org/fhir/StructureDefinit…
3 properties
TypeRestfulInteractionCode_Value
integer
Uri
object
Auto-generated from StructureDefinition for uri, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type uri. See http://hl7.org/fhir/StructureDefinition/uri
3 properties
CapabilityStatement_Rest_SystemInteraction
object
5 properties
isUsageContext_Value_Value
object
TypeRestfulInteractionCode
object
See http://hl7.org/fhir/ValueSet/type-restful-interaction
3 properties
Extension_ValueX
object
Value of extension
1 property
Period
object
Auto-generated from StructureDefinition for Period, last updated 2017-04-19T07:44:43.294+10:00. Time range defined by start and end date/time. See http://hl7.o…
4 properties
isContainedResource_OneofResource
object
ResourceVersionPolicyCode
object
See http://hl7.org/fhir/ValueSet/versioning-policy
3 properties
Id
object
Auto-generated from StructureDefinition for id, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type id. See http://hl7.org/fhir/StructureDefinition/id
3 properties
Markdown
object
Auto-generated from StructureDefinition for markdown, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type markdown. See http://hl7.org/fhir/StructureDef…
3 properties
ContactDetail
object
Auto-generated from StructureDefinition for ContactDetail, last updated 2017-04-19T07:44:43.294+10:00. Contact information. See http://hl7.org/fhir/StructureDe…
4 properties
CapabilityStatement_Rest_Resource
object
Resource served on the REST interface
18 properties
Instant
object
Auto-generated from StructureDefinition for instant, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type instant. See http://hl7.org/fhir/StructureDefin…
5 properties
ConditionalDeleteStatusCode
object
See http://hl7.org/fhir/ValueSet/conditional-delete-status
3 properties
UnknownContentCodeCode
object
A code that indicates whether an application accepts unknown elements or extensions when reading resources. See http://hl7.org/fhir/ValueSet/unknown-content-co…
3 properties
UnknownContentCodeCode_Value
integer
ContactPoint
object
Auto-generated from StructureDefinition for ContactPoint, last updated 2017-04-19T07:44:43.294+10:00. Details of a Technology mediated contact point (phone, fa…
7 properties
isReference_Reference
object
Meta
object
Auto-generated from StructureDefinition for Meta, last updated 2017-04-19T07:44:43.294+10:00. Metadata about a resource. See http://hl7.org/fhir/StructureDefin…
7 properties
CapabilityStatement_Software
object
Software that is covered by this capability statement
6 properties
ContainedResource
object
1 property
EventCapabilityModeCode
object
See http://hl7.org/fhir/ValueSet/event-capability-mode
3 properties
ConditionalReadStatusCode_Value
integer
CapabilityStatement_Rest_Operation
object
Definition of an operation or a custom query
5 properties
Extension
object
Optional Extensions Element See https://www.hl7.org/fhir/datatypes.htmlExtension
4 properties
Base64Binary
object
Auto-generated from StructureDefinition for base64Binary, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type base64Binary. See http://hl7.org/fhir/Stru…
3 properties
CapabilityStatement_Rest_Resource_SearchParam
object
Search parameters supported by implementation
7 properties
MessageSignificanceCategoryCode_Value
integer
ConditionalReadStatusCode
object
See http://hl7.org/fhir/ValueSet/conditional-read-status
3 properties
UnsignedInt
object
Auto-generated from StructureDefinition for unsignedInt, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type unsignedInt. See http://hl7.org/fhir/Struct…
3 properties
UsageContext
object
Auto-generated from StructureDefinition for UsageContext, last updated 2017-04-19T07:44:43.294+10:00. Describes the context of use for a conformance or knowled…
4 properties
ResourceTypeCode_Value
integer
Narrative
object
Auto-generated from StructureDefinition for Narrative, last updated 2017-04-19T07:44:43.294+10:00. A human-readable formatted text, including images. See http:…
4 properties
isExtension_ValueX_Choice
object
Instant_Precision
integer
ReferenceHandlingPolicyCode
object
See http://hl7.org/fhir/ValueSet/reference-handling-policy
3 properties
NarrativeStatusCode
object
The status of a resource narrative See http://hl7.org/fhir/ValueSet/narrative-status
3 properties
Code
object
Auto-generated from StructureDefinition for code, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type code. See http://hl7.org/fhir/StructureDefinition/…
3 properties
DocumentModeCode
object
See http://hl7.org/fhir/ValueSet/document-mode
3 properties
ContactPointUseCode_Value
integer
Primitive value for code
DocumentModeCode_Value
integer
CapabilityStatement_Messaging_Event
object
Declare support for this event
10 properties
RestfulCapabilityModeCode
object
See http://hl7.org/fhir/ValueSet/restful-capability-mode
3 properties
ConditionalDeleteStatusCode_Value
integer
ResourceTypeCode
object
See http://hl7.org/fhir/ValueSet/resource-types
3 properties
UsageContext_Value
object
Value that defines the context
1 property
EventCapabilityModeCode_Value
integer
SearchParamTypeCode_Value
integer
CapabilityStatement_Implementation
object
If this describes a specific instance
5 properties
IdentifierUseCode_Value
integer
Primitive value for code
Identifier
object
Auto-generated from StructureDefinition for Identifier, last updated 2017-04-19T07:44:43.294+10:00. An identifier intended for computation. See http://hl7.org/…
8 properties
CapabilityStatement_Document
object
Document definition
6 properties
CapabilityStatement_Messaging
object
If messaging is supported
8 properties
ContactPointSystemCode_Value
integer
Primitive value for code
Xhtml
object
Auto-generated from StructureDefinition for xhtml, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type xhtml. See http://hl7.org/fhir/StructureDefinitio…
2 properties
Reference
object
A reference from one resource to another See https://www.hl7.org/fhir/datatypes.htmlReference
5 properties
MimeTypeCode
object
See http://www.rfc-editor.org/bcp/bcp13.txt
3 properties
ContactPointUseCode
object
Use of contact point See http://hl7.org/fhir/ValueSet/contact-point-use
3 properties
LanguageCode
object
This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) See http://hl7.org/fhir/ValueSet/languages Note: For historical reasons, th…
3 properties
Coding
object
Auto-generated from StructureDefinition for Coding, last updated 2017-04-19T07:44:43.294+10:00. A reference to a code defined by a terminology system. See http…
7 properties
CapabilityStatement_Rest_Security
object
Information about security of implementation
7 properties
ResourceVersionPolicyCode_Value
integer
CodeableConcept
object
Auto-generated from StructureDefinition for CodeableConcept, last updated 2017-04-19T07:44:43.294+10:00. Concept - reference to a terminology or just text. See…
4 properties
IdentifierUseCode
object
See http://hl7.org/fhir/ValueSet/identifier-use
3 properties
RestfulCapabilityModeCode_Value
integer
CapabilityStatement_Rest_Resource_ResourceInteraction
object
5 properties

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
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Auth API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Benchmarks API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Bulk Export API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Catalog API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Coverage API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Data API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Drugs API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Eligibility API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services ExplanationOfBenefit API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Geography API
AE Profile APIs.io
CMS — Centers for Medicare & Medicaid Services Group API
AE Profile APIs.io
#Metadata
← Back to C APIs
API Details
ID
cms-gov:cms-gov-metadata-api
Base URL
https://api.bluebutton.cms.gov/v2/fhir
Docs
https://bluebutton.cms.gov/developers/
Provider
CMS — Centers for Medicare & Medicaid Services
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cms-gov-metadata-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cms-gov-metadata-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of CMS — Centers for Medicare & Medicaid Services Metadata 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.