CEDStandards
Add element to store SEA/Local Usage Notes
This is for capturing needs not currently supported by the CEDS model. Please do not send or share actual data as examples in this issue or in attachments.
Author(s): CJ Gilbert; Kristy Webber
Authoring Organization(s): State of Michigan/CEPI
Email address: [email protected]
Use Case Title: Add element to store SEA/Local Usage Notes
Use Case Description
Element name: Local Usage Notes
Element Definition: State-specific usage and/or governance details designated by the SEA as essential to understanding and using this element or option correctly.
Usage note: Organizations may use this field to hyperlink to data governance documentation for the specific element and/or option.
Date Type: Alphanumeric, length 512
Use Case Background
CEDS reference tables come prepopulated with all of the CEDS options as well as the CEDS definitions or descriptions for those options.
In some cases, the definitions/descriptions are so vague or ambiguous that they provide users with no additional context to help understand the option.
In other cases, the definition is clear, but there is state-specific context that would be useful to include within the Ref table so that future developers and analysts exploring the data will see that context.
We propose adding an implementation variable element to hold Local Usage Notes. An example of how this would be useful: when an element’s definition says “as defined by the state,” the Local Usage Notes element would allow the SEA to enrich the CEDS definition with state-specific details in the Ref table.
We suggest making this an alphanumeric field with length 512 to allow organizations to make critical governance/usage details available within the Ref tables (decreasing the likelihood of such information being 'lost' over time). Alternatively, this field could be used by organizations to put in a hyperlink pointing to where more detailed governance/usage documentation is kept.
Location of Element in the Domain Entity Schema Implementation Variables
Revised solution to use case 926, recommended by individuals from Michigan, Mississippi, and New York.
CEDS OSC Issue_926 LocalUsageNotes - Proposed Solution - V2.docx
Proposed Solution for Issue 926
https://github.com/user-attachments/files/18029060/CEDS.OSC.Issue_926.LocalUsageNotes.-.Proposed.Solution.-.V2.docx
The attached document is the proposed solution for this use case. As a community, please review. If no objections exist for the proposed solution, it will be approved as part of the CEDS standard 60 days following the announcement of this proposal as outlined in the OSC Use Case Rubrics/Process (The OSC Use Case Rubrics/Process can be found here: https://github.com/CEDStandards/CEDS-Elements/tree/master/doc).
