-
Notifications
You must be signed in to change notification settings - Fork 10
Decision: Display of rules and NPRMs in sidebar
Thing | Info |
---|---|
Relevant features | Supplemental content sidebar |
Date started | 2021-10-18 |
Date finished | |
Decision status | |
Summary of outcome |
We want to display relevant rules in the sidebar subpart-by-subpart and section-by-section, and we want those rules to be connected to their relevant NPRMs.
How can we do this?
How far can we get to that goal in an automated fashion? What elements would need to be done by hand?
What are helpful intermediate steps in iterative development toward this goal?
Each Federal Register document (such as a rule or NPRM) includes unstructured information about which sections it amends. For example, for this proposed rule, it says:
- In the Preamble: "we are proposing to amend § 447.502"
- In the end part where it describes the specific proposed change: "Amend § 447.502 by revising the definitions of “States” and “United States” to read as follows"
Each Federal Register document also includes a structured list of the parts it is related to. For example, for that same rule, the right sidebar includes: 42 CFR 433
42 CFR 438
42 CFR 447
42 CFR 456
. The Federal Register API includes this structured data for documents (cfr_references
).
CFR text includes semi-structured data about its relationship to FR documents:
-
Each part has a "Source" (FR document) statement at the beginning.
- Example: Part 438 says "Source: 67 FR 41095, June 14, 2002, unless otherwise noted."
-
Some subparts: have a "Source" statement at the beginning.
- Example: Part 438 Subpart A says "Source: 81 FR 27853, May 6, 2016, unless otherwise noted."
-
Most sections have footnotes that tell which FR documents established that section and updated it.
- Example: Part 438, Subpart A, Section 438.4 says: "[81 FR 27853, May 6, 2016, as amended at 85 FR 72837, Nov. 13, 2020; 85 FR 72837, Nov. 13, 2020]"
Please note that all pages on this GitHub wiki are draft working documents, not complete or polished.
Our software team puts non-sensitive technical documentation on this wiki to help us maintain a shared understanding of our work, including what we've done and why. As an open source project, this documentation is public in case anything in here is helpful to other teams, including anyone who may be interested in reusing our code for other projects.
For context, see the HHS Open Source Software plan (2016) and CMS Technical Reference Architecture section about Open Source Software, including Business Rule BR-OSS-13: "CMS-Released OSS Code Must Include Documentation Accessible to the Open Source Community".
For CMS staff and contractors: internal documentation on Enterprise Confluence (requires login).
- Federal policy structured data options
- Regulations
- Resources
- Statute
- Citation formats
- Export data
- 2021
- Reg content sources
- Default content view
- System last updated behavior
- Paragraph indenting
- Content authoring workflow
- Browser support
- Focus in left nav submenu
- Multiple content views
- Content review workflow
- Wayfinding while reading content
- Display of rules and NPRMs in sidebar
- Empty states for supplemental content
- 2022
- 2023
- 2024
- Medicaid and CHIP regulations user experience
- Initial pilot research outline
- Comparative analysis
- Statute research
- Usability study SOP
- 2021
- 2022
- 2023-2024: 🔒 Dovetail (requires login)
- 🔒 Overview (requires login)
- Authentication and authorization
- Frontend caching
- Validation checklist
- Search
- Security tools
- Tests and linting
- Archive