Skip to content

Commit 40f726a

Browse files
Updated docs with missing updates
Signed-off-by: Natalia Luzuriaga <natalia.luzuriaga@cms.hhs.gov>
1 parent b02c227 commit 40f726a

4 files changed

Lines changed: 30 additions & 10 deletions

File tree

docs/examples.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ DedupliFHIR is a desktop app tool that uses AI deduplication to identify duplica
7272
"name": "CMS Open Source Team"
7373
},
7474
"feedbackMechanisms": "https://github.com/DSACMS/dedupliFHIR/issues",
75+
"AIUseCaseInventory": true,
7576
"localisation": false,
7677
"repositoryType": "application",
7778
"userInput": "true",
@@ -154,6 +155,7 @@ The CMS Metrics Website is a [tier 3](https://github.com/DSACMS/repo-scaffolder/
154155
"name": "CMS/OA/DSAC/OSPO"
155156
},
156157
"feedbackMechanisms": "https://github.com/DSACMS/metrics/issues",
158+
"AIUseCaseInventory": true,
157159
"localisation": false,
158160
"repositoryType": "website",
159161
"userInput": "No",

docs/metadata.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
- 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)
66
- 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)
7-
- publiccode.yml metadata, an international metadata standard
7+
- [publiccode.yml](https://yml.publiccode.tools/) metadata, an international metadata standard
88

99
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.
1010

11-
The generic code.json schema can be found in the [`schemas` directory](../schemas/schema-1.0.0.json).
11+
The generic code.json schema can be found in the [`schemas` directory](../schemas/schema-2.0.0.json).
1212

1313
### Extending the schema for agency use
1414

@@ -74,7 +74,7 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
7474
<td>required</td>
7575
<td>🇺🇸</td>
7676
<td>str</td>
77-
<td>A short description of the project. It should be a single line containing a single sentence. Maximum 150 characters are allowed.</td>
77+
<td>A one or two sentence description of the software.</td>
7878
<td></td>
7979
</tr>
8080
<tr>
@@ -109,7 +109,7 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
109109
<td>required</td>
110110
<td>🇺🇸📜</td>
111111
<td>str</td>
112-
<td>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)",
112+
<td>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)"
113113
</td>
114114
<td>
115115
- openSource<br>
@@ -369,12 +369,19 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
369369
<td>required</td>
370370
<td>🇺🇸📜</td>
371371
<td>str</td>
372-
<td>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)</td>
372+
<td>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)"</td>
373373
<td>
374374
- openSource<br>
375375
- governmentWideReuse<br>
376-
- exemptByLaw<br>
377376
- exemptByNationalSecurity<br>
377+
- exemptByNationalIntelligence<br>
378+
- exemptByFOIA<br>
379+
- exemptByEAR<br>
380+
- exemptByITAR<br>
381+
- exemptByTSA<br>
382+
- exemptByClassifiedInformation<br>
383+
- exemptByPrivacyRisk<br>
384+
- exemptByIPRestriction<br>
378385
- exemptByAgencySystem<br>
379386
- exemptByAgencyMission<br>
380387
- exemptByCIO<br>
@@ -394,7 +401,7 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
394401
<td>required</td>
395402
<td>🇺🇸</td>
396403
<td>str</td>
397-
<td>Organization responsible for the project</td>
404+
<td>The organization or component within the agency to which the releases listed belong.</td>
398405
<td>Centers for Medicare & Medicaid Services</td>
399406
</tr>
400407
<tr>
@@ -574,6 +581,17 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
574581
- Submitting issues to repo<br>
575582
</td>
576583
</tr>
584+
<tr>
585+
<td>AIUseCaseInventory</td>
586+
<td>required</td>
587+
<td>📜</td>
588+
<td>bool</td>
589+
<td>Indicates if the software is included in the agency's AI use case inventory</td>
590+
<td>
591+
- true<br>
592+
- false
593+
</td>
594+
</tr>
577595
<tr>
578596
<td>localisation</td>
579597
<td>required</td>
@@ -693,7 +711,7 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
693711
</tbody>
694712
</table>
695713

696-
Full schema can be found in [schema-0.1.0.json](../schemas/cms/schema-0.1.0.json).
714+
Full schema can be found in [schema-0.2.0.json](../schemas/cms/schema-0.2.0.json).
697715

698716
### Adding new metadata fields
699717

docs/procedures.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The CMS Open Source Program Office developed various tools that can automate detecting, adding, and updating metadata to repositories.
44

5-
Learn more at: https://dsacms.github.io/share-it-act-lp/
5+
> **Note**: Learn more about our SHARE IT Act tools: https://dsacms.github.io/share-it-act-lp/
66
77
## Creating a code.json file
88

schemas/cms/schema-0.2.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
},
115115
"organization": {
116116
"type": "string",
117-
"description": "Organization responsible for the project",
117+
"description": "The organization or component within the agency to which the releases listed belong.",
118118
"enum": [
119119
"Centers for Medicare & Medicaid Services"
120120
]

0 commit comments

Comments
 (0)