Skip to content

Commit 063124f

Browse files
natalialuzuriaganatalialuzuriaga
authored
Merge pull request #30 from DSACMS/nat/docs-major-update
Nat/docs major update
2 parents cb886e4 + b02c227 commit 063124f

7 files changed

Lines changed: 1173 additions & 448 deletions

File tree

‎docs/examples.md‎

Lines changed: 150 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -8,55 +8,85 @@ DedupliFHIR is a desktop app tool that uses AI deduplication to identify duplica
88

99
```
1010
{
11-
"name": "dedupliFHIR",
12-
"description": "Prototype for basic deduplication and aggregation of eCQM data","longDescription": "A CLI bundled with an electron front-end that provides data-linkage and AI deduplication for reported ACO data at scale.",
13-
"status": "Production",
14-
"permissions": {
15-
"license": [
16-
{
17-
"name": "CC0 1.0 Universal",
18-
"URL": "https://github.com/DSACMS/dedupliFHIR/blob/main/LICENSE"
19-
}
20-
],
21-
"usageType": "openSource",
22-
"exemptionText": ""
23-
},
24-
"organization": "Centers for Medicare & Medicaid Services",
25-
"repositoryURL": "https://github.com/DSACMS/dedupliFHIR",
26-
"vcs": "git",
27-
"laborHours": 4252,
28-
"platforms": ["windows", "mac", "linux"],
29-
"categories": ["data-analytics", "application-development", "data-collection"],
30-
"softwareType": "standalone/desktop",
31-
"languages": [
32-
"Python",
33-
"JavaScript",
34-
"HTML",
35-
"CSS",
36-
"Shell",
37-
"Makefile"
11+
"name": "dedupliFHIR",
12+
"description": "Prototype for basic deduplication and aggregation of eCQM data",
13+
"longDescription": "A CLI bundled with an electron front-end that provides data-linkage and AI deduplication for reported ACO data at scale.",
14+
"status": "Production",
15+
"permissions": {
16+
"license": [
17+
{
18+
"name": "CC0 1.0 Universal",
19+
"URL": "https://github.com/DSACMS/dedupliFHIR/blob/main/LICENSE"
20+
}
3821
],
39-
"maintenance": "internal",
40-
"date": {
41-
"created": "2023-06-22T17:08:19Z",
42-
"lastModified": "2025-02-10T19:13:19Z",
43-
"metaDataLastUpdated": "2025-02-10T19:14:29.970Z"
44-
},
45-
"tags": ["AI", "deduplication", "data", "ACA", "FHIR"],
46-
"contact": {
47-
"email": "opensource@cms.hhs.gov",
48-
"name": "CMS Open Source Team"
49-
},
50-
"localisation": false,
51-
"repositoryType": "application",
52-
"userInput": "Yes",
53-
"fismaLevel": "Moderate",
54-
"group": "CMS/OA/DSAC",
55-
"subsetInHealthcare": "Operational",
56-
"userType": "Providers",
57-
"repositoryHost": "Github.com",
58-
"maturityModelTier": "3",
59-
"projectType": "Tools"
22+
"usageType": "openSource",
23+
"exemptionText": ""
24+
},
25+
"organization": "Centers for Medicare & Medicaid Services",
26+
"repositoryURL": "https://github.com/DSACMS/dedupliFHIR",
27+
"projectURL": "",
28+
"repositoryHost": "github.com/DSACMS",
29+
"repositoryVisibility": "public",
30+
"vcs": "git",
31+
"laborHours": 4271,
32+
"reuseFrequency": {
33+
"forks": 3,
34+
"clones": 0
35+
},
36+
"platforms": [
37+
"windows",
38+
"mac",
39+
"linux"
40+
],
41+
"categories": [
42+
"data-analytics",
43+
"application-development",
44+
"data-collection"
45+
],
46+
"softwareType": "standalone/desktop",
47+
"languages": [
48+
"Python",
49+
"JavaScript",
50+
"HTML",
51+
"CSS",
52+
"Shell",
53+
"Makefile"
54+
],
55+
"maintenance": "internal",
56+
"contractNumber": [],
57+
"date": {
58+
"created": "2023-06-22T17:08:19Z",
59+
"lastModified": "2025-02-13T18:44:26Z",
60+
"metaDataLastUpdated": "2025-06-10T14:55:32.836Z"
61+
},
62+
"tags": [
63+
"AI",
64+
"deduplication",
65+
"data",
66+
"ACA",
67+
"FHIR",
68+
"featured"
69+
],
70+
"contact": {
71+
"email": "opensource@cms.hhs.gov",
72+
"name": "CMS Open Source Team"
73+
},
74+
"feedbackMechanisms": "https://github.com/DSACMS/dedupliFHIR/issues",
75+
"localisation": false,
76+
"repositoryType": "application",
77+
"userInput": "true",
78+
"fismaLevel": "Moderate",
79+
"group": "CMS/OA/DSAC",
80+
"projects": [],
81+
"systems": [],
82+
"upstream": "https://github.com/DSACMS/dedupliFHIR/network/dependencies",
83+
"subsetInHealthcare": [
84+
"Operational"
85+
],
86+
"userType": [
87+
"Providers"
88+
],
89+
"maturityModelTier": "3"
6090
}
6191
```
6292

@@ -66,54 +96,78 @@ The CMS Metrics Website is a [tier 3](https://github.com/DSACMS/repo-scaffolder/
6696

6797
```
6898
{
69-
"name": "metrics",
70-
"description": "Experimentations in Open Source Repository Metrics",
71-
"longDescription": "The CMS Repository Metrics Website shows an overview of software development activity across open source projects within a specified organization. This webpage is meant to be used by developers and program managers interested in repository health within CMS open source projects.",
72-
"status": "Production",
73-
"permissions": {
74-
"license": [
75-
{
76-
"name": "CC0 1.0 Universal",
77-
"URL": "https://github.com/DSACMS/metrics/blob/main/LICENSE.md"
78-
}
79-
],
80-
"usageType": "openSource",
81-
"exemptionText": ""
82-
},
83-
"organization": "Centers for Medicare & Medicaid Services",
84-
"repositoryURL": "https://github.com/DSACMS/metrics",
85-
"vcs": "git",
86-
"laborHours": 20475,
87-
"platforms": ["web"],
88-
"categories": ["data-visualization", "data-analytics"],
89-
"softwareType": "standalone/web",
90-
"languages": [
91-
"Liquid",
92-
"JavaScript",
93-
"CSS",
94-
"Shell",
95-
"Python"
99+
"name": "metrics",
100+
"description": "CMS Open Source Repository Metrics Website",
101+
"longDescription": "The CMS Repository Metrics Website shows an overview of software development activity across open source projects within a specified organization. It is designed for developers and program managers interested in monitoring health and activity of CMS open source repositories.",
102+
"status": "Production",
103+
"permissions": {
104+
"license": [
105+
{
106+
"name": "CC0 1.0 Universal",
107+
"URL": "https://github.com/DSACMS/metrics/blob/main/LICENSE.md"
108+
}
96109
],
97-
"maintenance": "internal",
98-
"date": {
99-
"created": "2023-07-18T14:10:58Z",
100-
"lastModified": "2025-02-11T19:10:14Z",
101-
"metaDataLastUpdated": "2025-02-11T19:20:16.212Z"
102-
},
103-
"tags": ["metrics", "ospo", "repository"],
104-
"contact": {
105-
"email": "opensource@cms.hhs.gov",
106-
"name": "CMS/OA/DSAC"
107-
},
108-
"localisation": false,
109-
"repositoryType": "website",
110-
"userInput": "No",
111-
"fismaLevel": "Low",
112-
"group": "CMS/OA/DSAC",
113-
"subsetInHealthcare": "Operational",
114-
"userType": "Government",
115-
"repositoryHost": "Github.com",
116-
"maturityModelTier": 3,
117-
"projectType": "Website"
110+
"usageType": "openSource",
111+
"exemptionText": ""
112+
},
113+
"organization": "Centers for Medicare & Medicaid Services",
114+
"repositoryURL": "https://github.com/DSACMS/metrics",
115+
"projectURL": "https://dsacms.github.io/metrics/",
116+
"repositoryHost": "github.com/DSACMS",
117+
"repositoryVisibility": "public",
118+
"vcs": "git",
119+
"laborHours": 20722,
120+
"reuseFrequency": {
121+
"forks": 4,
122+
"clones": 0
123+
},
124+
"platforms": [
125+
"web"
126+
],
127+
"categories": [
128+
"data-visualization",
129+
"data-analytics"
130+
],
131+
"softwareType": "standalone/web",
132+
"languages": [
133+
"Liquid",
134+
"JavaScript",
135+
"CSS",
136+
"Python",
137+
"Shell"
138+
],
139+
"maintenance": "internal",
140+
"contractNumber": [],
141+
"date": {
142+
"created": "2023-07-18T14:10:58Z",
143+
"lastModified": "2025-06-01T11:36:12Z",
144+
"metaDataLastUpdated": "2025-06-06T16:36:38.949Z"
145+
},
146+
"tags": [
147+
"metrics",
148+
"ospo",
149+
"repository",
150+
"featured"
151+
],
152+
"contact": {
153+
"email": "opensource@cms.hhs.gov",
154+
"name": "CMS/OA/DSAC/OSPO"
155+
},
156+
"feedbackMechanisms": "https://github.com/DSACMS/metrics/issues",
157+
"localisation": false,
158+
"repositoryType": "website",
159+
"userInput": "No",
160+
"fismaLevel": "Low",
161+
"group": "CMS/OA/DSAC",
162+
"projects": [],
163+
"systems": [],
164+
"upstream": "https://github.com/DSACMS/metrics/network/dependencies",
165+
"subsetInHealthcare": [
166+
"Operational"
167+
],
168+
"userType": [
169+
"Government"
170+
],
171+
"maturityModelTier": 3
118172
}
119173
```

‎docs/faq.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ The SHARE IT Act of 2024 is legislation designed to enhance transparency, collab
1919
- Standardized reporting on software development and licensing practices.
2020
- Establishment of metadata guidelines to ensure clear documentation and discoverability of software assets.
2121

22+
Learn more at: https://dsacms.github.io/share-it-act-lp/
23+
2224
### Does the SHARE IT Act also apply retroactively to previous custom-developed code?
2325

2426
No. The SHARE IT Act applies only to custom-developed code created on or after July 21, 2025. Code developed prior to this date is not subject to its requirements, however, code created after August 8, 2016 is subject to the Federal Source Code Policy.
@@ -36,6 +38,12 @@ There are [4 exemptions](https://www.congress.gov/bill/118th-congress/house-bill
3638

3739
Yes. All custom-developed code—whether it involves software applications, data analysis, infrastructure/devops, interoperability, or internal tools/scripts—must reside in a repository, unless it qualifies for one of the [four exemptions](https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih#HB45699B7E8734166BE2F6DA2A80F7909).
3840

41+
### When do agencies have to comply?
42+
The SHARE IT Act applies to custom-developed code created on or after July 21, 2025 where agencies must:
43+
- store custom-developed code in a repository
44+
- ensure code is accessible to federal employees and is owned by the agency
45+
- publish metadata on all custom-developed code
46+
3947
## code.json Metadata Standard
4048

4149
### What is code.json?

0 commit comments

Comments
 (0)