-
Notifications
You must be signed in to change notification settings - Fork 11
Decision: Regulation subjects
Thing | Info |
---|---|
Relevant features | Subject pages and search |
Date started | 2024-05-01 |
Date finished | |
Decision status | Draft |
Summary of outcome |
We believe that if we enabled the following interactions, they could help some of our users with policy research:
- When a person looks at a subject page, they see relevant regulation sections in the list of items (alongside resources).
- When a person searches for some keywords, the regulation sections in the results are annotated with subjects (similar to resources).
We can't do this right now because we don't have data that answers the questions "What are the subjects related to a section?" or "What are the sections related to a subject?" We could build it: our devs would enable annotating regulation sections with subjects, and our SME would do the annotations.
We do have data that answers a different question: "What are the top subjects associated with the resources that are tagged to a section?"
Can we use the answer to "What are the top subjects associated with the resources that are tagged to a section?" to also answer "What are the subjects related to a section?"
If not, is it worth building a way to annotate regulation sections with subjects?
Our users need accurate and comprehensive information for their policy research. If we can't provide information that is accurate and comprehensive, we need to either frame the information carefully so that users have the right expectations or not show the information at all. (As an example of careful framing, our statute page include links to SSA but notes it was last updated in 2019, and we observed that at least some users do notice that date.)
In most cases, the regulations are well-structured with clear titles, and they are organized by topic in their own way. Subjects are less necessary for making regulations findable, compared to resources.
For the purpose of displaying "top subjects of related documents" in sidebars, our SME is still reviewing the data, but we think we can have reasonable confidence in this feature being helpful if we limit it to showing subjects tagged to at least X documents (TBD, probably 5ish).
Assuming we use that kind of threshold, some regulation sections won't display any top subjects, and that's fine.
We have so many parts, subparts, and sections that it would take a very long time to hand-annotate all of them with subjects, and our SME capacity is limited. There is not much value in less-than-complete annotation, because people expect to get reasonably comprehensive results if they look up a subject. For example, if a person looked up EPSDT and saw one of the related sections but not all of them, that could be confusing and reduce trust in eRegs.
We have heard more of this kind of user need (looking up stuff by subject) for statute citations than regulations.
We've considered enabling hand-annotation of subjects with related regulation and statute citations, to be displayed as a kind of caption at the top of the subject page (not as an item in the list). That could serve some of the user needs. But it would be a fair bit of work.
We're not sure how we would display regulations on the subject pages - they don't have dates, so by default they would go to the end of the list in alphabetical order with the other undated items.
Our SME does not think this data is usable for this purpose. [Need to add more detail here about why]
Too much work for not enough value.
Maybe, although it's unlikely to be a make-or-break feature for us. Probably more value in figuring out what we can do to make statute more navigable.
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