-
Notifications
You must be signed in to change notification settings - Fork 10
Statute Link Converter
Purpose: explain how to use the Statute Link Converter in our admin panel.
A lot of regulation text includes references to sections of the Social Security Act. For example: “sections 1902(a)(23), 1902(e)(2), and 1915(a) and (b) and 1932(a)(3) of the Act”.
Here’s how to make those citations within regulation text into convenient links to US Code web pages! We also use this information for our statute reference table.
Our initial set of SSA titles is 11 (administrative topics), 16 (SSI), 18 (Medicare), 19 (Medicaid), and 21 (CHIP).
Reasons you may need to do more imports:
-
We add regulation parts that contain SSA section citations in other titles, and we want to make those citations into links.
- For example, let’s say we add a regulation part that has citations to a section in a less commonly-used title, like Section 301 in Title 3. If we haven’t uploaded the Title 3 file, that citation won’t link anywhere. We may want to import a file to create those links.
- A new law has become effective, and it added more sections to a title of the US Code. For example, Title 3 currently ends with Section 306 (42 U.S.C. 506). Let’s say we put Title 3 in our database, but in a few months a new section gets added, Section 307 (42 U.S.C. 507). Regulation text citations to Section 307 won’t link anywhere. We’ll need to upload a new version of the file to make it into a link.
- We add regulation parts that contain citations to a different Act, in the style of “Section xyz of the Act”, and we want to link those to the appropriate place. (This could happen if we added regulations related to Medicare, Indian Health Service, etc.)
- Figure out what title you’re looking for. For example, Section 1902 is part of Social Security Act Title 19 (XIX).
- Go to the GovInfo Statute Compilations list.
- Browse to find the statute you need – in this case, scroll down to “S”, open it, and scroll down to “Social Security Act”.
- Find the title you want, then right-click on the “USLM” button and select “Copy Link Address”. (“USLM” means United States Legislative Markup. Each USLM file contains statute text in a format that computers can process.)
- Go to our admin panel and select “Statute Link Converters” at left.
- Click the gray “Import Conversions” button near top right.
- Paste your copied link into the URL field (should look something like this:
https://www.govinfo.gov/content/pkg/COMPS-8765/uslm/COMPS-8765.xml
) - Type in the common name of the statute, such as “Social Security Act” or “Affordable Care Act”, that is used in regulation text (for example, as part of statements like “Section XYZ of the Social Security Act”).
- Click the “Import Conversions” button.
- If it tells you that some items were imported but have no name or title, open those links in new tabs so that you can fill out the missing info based on a copy of the title.
- Briefly check the rest of the list against a copy of the title and make sure it’s not missing any sections. (One way to check is to copy that XML link, open it in your browser, and review the information.) If it’s missing something that you expected, tell the team.
- Now you can click “Return”. You’re done!
In our “Statute Link Converters” panel, the gray button labeled “Add statute link converter” allows adding a single section conversion if you need to.
For example, Title 11 has an odd case in its data file (https://www.govinfo.gov/content/pkg/COMPS-8763/uslm/COMPS-8763.xml
). The text of the law does not include the expected explicit connection between section number 1147 and its USC citation, so it’s appropriate for our automated converter to skip this one. If we wanted to include it anyway, we could manually add it using the “Add statute link converter” panel.
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
- Site homepage
- Content authoring
- Search
- Timeline
- Not built
- 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