From 40f726aaef548666b3dcb60115f6672cefa423f5 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Wed, 13 Aug 2025 08:58:19 -0700 Subject: [PATCH 1/2] Updated docs with missing updates Signed-off-by: Natalia Luzuriaga --- docs/examples.md | 2 ++ docs/metadata.md | 34 ++++++++++++++++++++++++++-------- docs/procedures.md | 2 +- schemas/cms/schema-0.2.0.json | 2 +- 4 files changed, 30 insertions(+), 10 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index c622a24..32e8fa8 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -72,6 +72,7 @@ DedupliFHIR is a desktop app tool that uses AI deduplication to identify duplica "name": "CMS Open Source Team" }, "feedbackMechanisms": "https://github.com/DSACMS/dedupliFHIR/issues", + "AIUseCaseInventory": true, "localisation": false, "repositoryType": "application", "userInput": "true", @@ -154,6 +155,7 @@ The CMS Metrics Website is a [tier 3](https://github.com/DSACMS/repo-scaffolder/ "name": "CMS/OA/DSAC/OSPO" }, "feedbackMechanisms": "https://github.com/DSACMS/metrics/issues", + "AIUseCaseInventory": true, "localisation": false, "repositoryType": "website", "userInput": "No", diff --git a/docs/metadata.md b/docs/metadata.md index bf40a2a..5f9b50f 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -4,11 +4,11 @@ - federal code.json standard, created as part of [M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf) - required metadata outlined in the [SHARE IT ACT](https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih) (e.g. repository visibility, contract number) -- publiccode.yml metadata, an international metadata standard +- [publiccode.yml](https://yml.publiccode.tools/) metadata, an international metadata standard By harmonizing various standards, this opens up the opportunity to share our work not just on an agency level but also on a national and international level. -The generic code.json schema can be found in the [`schemas` directory](../schemas/schema-1.0.0.json). +The generic code.json schema can be found in the [`schemas` directory](../schemas/schema-2.0.0.json). ### Extending the schema for agency use @@ -74,7 +74,7 @@ We encourage agencies to contribute by [submitting an agency schema addition iss required 🇺🇸 str - A short description of the project. It should be a single line containing a single sentence. Maximum 150 characters are allowed. + A one or two sentence description of the software. @@ -109,7 +109,7 @@ We encourage agencies to contribute by [submitting an agency schema addition iss required 🇺🇸📜 str - A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByNationalSecurity: The source code is primarily for use in national security system as defined in section 11103 of title 40, USC; (4) exemptByNationalIntelligence: The source code is developed by an agency or part of an agency that is an element of the intelligence community, as defined in section 3(4) of the National Security Act of 1947; (5) exemptByFOIA: The source code is exempt under the Freedom of Information Act; (6) exemptByEAR: The source code is exempt under the Export Administration Regulations; (7) exemptByITAR: The source code is exempt under the the International Traffic in Arms Regulations; (8) exemptByTSA: The source code is exempt under the regulations of the Transportation Security Administration relating to the protection of Sensitive Security Information; (9) exemptByClassifiedInformation: The source code is exempt under the Federal laws and regulations governing the sharing of classified information not covered by exemptByNationalSecurity, exemptByNationalIntelligence, exemptbyFOIA, exemptByEAR, exemptByITAR, and exemptByTSA; (10) exemptByPrivacyRisk: The sharing or public accessibility of the source code would create an identifiable risk to the privacy of an individual; (11) exemptByIPRestriction: The sharing of the source code is limited by patent or intellectual property restrictions; (12) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel; (13) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (14) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (15) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)", + A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByNationalSecurity: The source code is primarily for use in national security system as defined in section 11103 of title 40, USC; (4) exemptByNationalIntelligence: The source code is developed by an agency or part of an agency that is an element of the intelligence community, as defined in section 3(4) of the National Security Act of 1947; (5) exemptByFOIA: The source code is exempt under the Freedom of Information Act; (6) exemptByEAR: The source code is exempt under the Export Administration Regulations; (7) exemptByITAR: The source code is exempt under the the International Traffic in Arms Regulations; (8) exemptByTSA: The source code is exempt under the regulations of the Transportation Security Administration relating to the protection of Sensitive Security Information; (9) exemptByClassifiedInformation: The source code is exempt under the Federal laws and regulations governing the sharing of classified information not covered by exemptByNationalSecurity, exemptByNationalIntelligence, exemptbyFOIA, exemptByEAR, exemptByITAR, and exemptByTSA; (10) exemptByPrivacyRisk: The sharing or public accessibility of the source code would create an identifiable risk to the privacy of an individual; (11) exemptByIPRestriction: The sharing of the source code is limited by patent or intellectual property restrictions; (12) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel; (13) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (14) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (15) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)" - openSource
@@ -369,12 +369,19 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json). required 🇺🇸📜 str - A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByLaw: The sharing of the source code is restricted by law or regulation, including—but not limited to—patent or intellectual property law, the Export Asset Regulations, the International Traffic in Arms Regulation, and the Federal laws and regulations governing classified information; (4) exemptByNationalSecurity: The sharing of the source code would create an identifiable risk to the detriment of national security, confidentiality of Government information, or individual privacy; (5) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel, (6) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (7) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (8) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016) + A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByNationalSecurity: The source code is primarily for use in national security system as defined in section 11103 of title 40, USC; (4) exemptByNationalIntelligence: The source code is developed by an agency or part of an agency that is an element of the intelligence community, as defined in section 3(4) of the National Security Act of 1947; (5) exemptByFOIA: The source code is exempt under the Freedom of Information Act; (6) exemptByEAR: The source code is exempt under the Export Administration Regulations; (7) exemptByITAR: The source code is exempt under the the International Traffic in Arms Regulations; (8) exemptByTSA: The source code is exempt under the regulations of the Transportation Security Administration relating to the protection of Sensitive Security Information; (9) exemptByClassifiedInformation: The source code is exempt under the Federal laws and regulations governing the sharing of classified information not covered by exemptByNationalSecurity, exemptByNationalIntelligence, exemptbyFOIA, exemptByEAR, exemptByITAR, and exemptByTSA; (10) exemptByPrivacyRisk: The sharing or public accessibility of the source code would create an identifiable risk to the privacy of an individual; (11) exemptByIPRestriction: The sharing of the source code is limited by patent or intellectual property restrictions; (12) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel; (13) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (14) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (15) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)" - openSource
- governmentWideReuse
- - exemptByLaw
- exemptByNationalSecurity
+ - exemptByNationalIntelligence
+ - exemptByFOIA
+ - exemptByEAR
+ - exemptByITAR
+ - exemptByTSA
+ - exemptByClassifiedInformation
+ - exemptByPrivacyRisk
+ - exemptByIPRestriction
- exemptByAgencySystem
- exemptByAgencyMission
- exemptByCIO
@@ -394,7 +401,7 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json). required 🇺🇸 str - Organization responsible for the project + The organization or component within the agency to which the releases listed belong. Centers for Medicare & Medicaid Services @@ -574,6 +581,17 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json). - Submitting issues to repo
+ + AIUseCaseInventory + required + 📜 + bool + Indicates if the software is included in the agency's AI use case inventory + + - true
+ - false + + localisation required @@ -693,7 +711,7 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json). -Full schema can be found in [schema-0.1.0.json](../schemas/cms/schema-0.1.0.json). +Full schema can be found in [schema-0.2.0.json](../schemas/cms/schema-0.2.0.json). ### Adding new metadata fields diff --git a/docs/procedures.md b/docs/procedures.md index e2bed30..1981d4c 100644 --- a/docs/procedures.md +++ b/docs/procedures.md @@ -2,7 +2,7 @@ The CMS Open Source Program Office developed various tools that can automate detecting, adding, and updating metadata to repositories. -Learn more at: https://dsacms.github.io/share-it-act-lp/ +> **Note**: Learn more about our SHARE IT Act tools: https://dsacms.github.io/share-it-act-lp/ ## Creating a code.json file diff --git a/schemas/cms/schema-0.2.0.json b/schemas/cms/schema-0.2.0.json index eb53488..e58de93 100644 --- a/schemas/cms/schema-0.2.0.json +++ b/schemas/cms/schema-0.2.0.json @@ -114,7 +114,7 @@ }, "organization": { "type": "string", - "description": "Organization responsible for the project", + "description": "The organization or component within the agency to which the releases listed belong.", "enum": [ "Centers for Medicare & Medicaid Services" ] From 650b3f3c1f4771ecb104ea50a647a9973af117f0 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Wed, 13 Aug 2025 10:10:17 -0700 Subject: [PATCH 2/2] Update procedures.md --- docs/procedures.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/procedures.md b/docs/procedures.md index 1981d4c..0968f76 100644 --- a/docs/procedures.md +++ b/docs/procedures.md @@ -2,7 +2,7 @@ The CMS Open Source Program Office developed various tools that can automate detecting, adding, and updating metadata to repositories. -> **Note**: Learn more about our SHARE IT Act tools: https://dsacms.github.io/share-it-act-lp/ +> **Learn more about our SHARE IT Act tools**: https://dsacms.github.io/share-it-act-lp/ ## Creating a code.json file @@ -120,4 +120,4 @@ python main.py --agency AGENCY_NAME --orgs "org1,org2" --output code.json --vers ##### Example: ```bash python3 main.py --agency CMS --orgs "DSACMS,CMSgov,CMS-Enterprise" --output code.json --version 1.0.0 -``` \ No newline at end of file +```