This project contains modules and documentation in support of the Beneficiary FHIR Data (BFD) Server. The BFD Server is an API designed to serve Medicare beneficiaries' demographic, enrollment, and claims data using the HL7® FHIR® Standard format.
Although this is a public repo, contributing to the BFD is for CMS-approved contributors only, not outside contributors. For more information about our BFD teams, see COMMUNITY.md
It's the vision of this project to provide a comprehensive, performant, and trustworthy platform to transform the way that the CMS enterprise shares and uses data.
This aligns with the overarching mission to enable the CMS Enterprise to drive innovation in data sharing so that beneficiaries and their healthcare partners have the data they need to make informed decisions about their healthcare.
The high-level purpose and location of each piece of the project is listed below.
- apps - contains the source code for each of the deployed BFD applications
- bfd-data-fda - downloads FDA Drug code names into a resource used during BFD drug code name lookups
- bfd-data-npi - downloads CMS NPI (National Provider Identification) names into a resource used during BFD NPI lookups
- bfd-db-migrator - application for safely applying schema updates and data migrations to the BFD database
- bfd-model - contains data models used throughout the BFD project
- bfd-pipeline - application for loading claim data from the provider into the BFD database
- bfd-server - application for serving the BFD database data in FHIR format to users via the BFD API
- bfd-shared-test-utils - utilities shared across BFD projects used in testing
- bfd-shared-utils - utilities shared across BFD projects used in the application code
- utils - non-application scripts used for testing, development, and database management
- insights - contains documentation and resources for maintaining BFD Insights, a platform using AWS Cloudwatch to provide analytics and metrics for BFD applications
- ops - contains the scripts and resources required for packaging and deploying BFD applications
- rfcs - holds the archived and active RFC (Request for Comment) documents for BFD
Many useful guides, documentation items, and runbooks can be found on the BFD Wiki, hosted in this repo.
This includes information about making requests to bfd, synthetic data, and more.
The BFD Wiki contains useful resources like the development environment setup guide, style guide, runbooks for various scenarios, and more.
We want to ensure a welcoming environment for all of our projects. Our staff follow the 18F Code of Conduct and all contributors should do the same.
If you have any questions feel free to reach out on the #bfd channel in CMS slack!
We adhere to the CMS Open Source Policy. If you have any questions, just shoot us an email.
Submit a vulnerability: Vulnerability reports can be submitted through Bugcrowd. Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.
For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see SECURITY.md.
A Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software.
In the spirit of Executive Order 14028 - Improving the Nation’s Cyber Security, a SBOM for this repository is provided here: https://github.com/CMSgov/beneficiary-fhir-data/network/dependencies.
For more information and resources about SBOMs, visit: https://www.cisa.gov/sbom.
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication as indicated in LICENSE.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.