bcda

command
v0.0.0-...-065a81b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 30, 2025 License: CC0-1.0 Imports: 8 Imported by: 0

Documentation

Overview

Package main Beneficiary Claims Data API

The Beneficiary Claims Data API (BCDA) allows downloading of claims data in accordance with the FHIR Bulk Data Export specification.

If you have a Client ID and Secret you can use this page to explore the API.  To do this:
 1. Click the green "Authorize" button below and enter your Client ID and secret in the Basic Authentication boxes.
 2. Request a bearer token from /auth/token
 3. Click the green "Authorize" button below and put "Bearer {YOUR_TOKEN}" in the bearer_token box.

Until you click logout your token will be presented with every request made. To make requests click on the

"Try it out" button for the desired endpoint.

    Version: 1.0.0
    License: Public Domain https://github.com/CMSgov/bcda-app/blob/main/LICENSE.md
    Contact: bcapi@cms.hhs.gov

    Produces:
    - application/fhir+json
    - application/json

    SecurityDefinitions:
    bearer_token:
         type: apiKey
         name: Authorization
         description: The bulkData endpoints require a Bearer Token. 1) Put your credentials in Basic Authentication, 2) Request a bearer token from /auth/token, 3) Put "Bearer {TOKEN}" in this field (no quotes) using the bearer token retrieved in step 2
         in: header
    basic_auth:
         type: basic

swagger:meta

Directories

Path Synopsis
api
v1
v2
v3
lambda
admin_aco_deny command
cclf command
optout command
fhir
fhir package contains structs representing FHIR data.
fhir package contains structs representing FHIR data.
postgres/postgrestest
Package postgrestest provides CRUD utilities for the postgres database.
Package postgrestest provides CRUD utilities for the postgres database.
v2
v3
web

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL