Skip to content

Nat/docs major update #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
natalialuzuriaga merged 8 commits into from
Aug 12, 2025
Merged

Nat/docs major update #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
af01fb5
Update schemas to reflect latest field changes
natalialuzuriaga Aug 11, 2025
70ab144
Added more faqs
natalialuzuriaga Aug 11, 2025
dbfeecc
Added link to SHARE IT Landing Page
natalialuzuriaga Aug 11, 2025
4ac53c1
Updated examples with latest code.json
natalialuzuriaga Aug 11, 2025
c0454ec
Added new section explaining gov schema fields
natalialuzuriaga Aug 11, 2025
33ac2ac
Update schema links
natalialuzuriaga Aug 11, 2025
f8b2e74
Update examples with latest code.json updates
natalialuzuriaga Aug 12, 2025
b02c227
Update CMS schema with latest gov schema updates
natalialuzuriaga Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
246 changes: 150 additions & 96 deletions docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,55 +8,85 @@ DedupliFHIR is a desktop app tool that uses AI deduplication to identify duplica

```
{
"name": "dedupliFHIR",
"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.",
"status": "Production",
"permissions": {
"license": [
{
"name": "CC0 1.0 Universal",
"URL": "https://github.com/DSACMS/dedupliFHIR/blob/main/LICENSE"
}
],
"usageType": "openSource",
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
"repositoryURL": "https://github.com/DSACMS/dedupliFHIR",
"vcs": "git",
"laborHours": 4252,
"platforms": ["windows", "mac", "linux"],
"categories": ["data-analytics", "application-development", "data-collection"],
"softwareType": "standalone/desktop",
"languages": [
"Python",
"JavaScript",
"HTML",
"CSS",
"Shell",
"Makefile"
"name": "dedupliFHIR",
"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.",
"status": "Production",
"permissions": {
"license": [
{
"name": "CC0 1.0 Universal",
"URL": "https://github.com/DSACMS/dedupliFHIR/blob/main/LICENSE"
}
],
"maintenance": "internal",
"date": {
"created": "2023-06-22T17:08:19Z",
"lastModified": "2025-02-10T19:13:19Z",
"metaDataLastUpdated": "2025-02-10T19:14:29.970Z"
},
"tags": ["AI", "deduplication", "data", "ACA", "FHIR"],
"contact": {
"email": "opensource@cms.hhs.gov",
"name": "CMS Open Source Team"
},
"localisation": false,
"repositoryType": "application",
"userInput": "Yes",
"fismaLevel": "Moderate",
"group": "CMS/OA/DSAC",
"subsetInHealthcare": "Operational",
"userType": "Providers",
"repositoryHost": "Github.com",
"maturityModelTier": "3",
"projectType": "Tools"
"usageType": "openSource",
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
"repositoryURL": "https://github.com/DSACMS/dedupliFHIR",
"projectURL": "",
"repositoryHost": "github.com/DSACMS",
"repositoryVisibility": "public",
"vcs": "git",
"laborHours": 4271,
"reuseFrequency": {
"forks": 3,
"clones": 0
},
"platforms": [
"windows",
"mac",
"linux"
],
"categories": [
"data-analytics",
"application-development",
"data-collection"
],
"softwareType": "standalone/desktop",
"languages": [
"Python",
"JavaScript",
"HTML",
"CSS",
"Shell",
"Makefile"
],
"maintenance": "internal",
"contractNumber": [],
"date": {
"created": "2023-06-22T17:08:19Z",
"lastModified": "2025-02-13T18:44:26Z",
"metaDataLastUpdated": "2025-06-10T14:55:32.836Z"
},
"tags": [
"AI",
"deduplication",
"data",
"ACA",
"FHIR",
"featured"
],
"contact": {
"email": "opensource@cms.hhs.gov",
"name": "CMS Open Source Team"
},
"feedbackMechanisms": "https://github.com/DSACMS/dedupliFHIR/issues",
"localisation": false,
"repositoryType": "application",
"userInput": "true",
"fismaLevel": "Moderate",
"group": "CMS/OA/DSAC",
"projects": [],
"systems": [],
"upstream": "https://github.com/DSACMS/dedupliFHIR/network/dependencies",
"subsetInHealthcare": [
"Operational"
],
"userType": [
"Providers"
],
"maturityModelTier": "3"
}
```

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

```
{
"name": "metrics",
"description": "Experimentations in Open Source Repository Metrics",
"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.",
"status": "Production",
"permissions": {
"license": [
{
"name": "CC0 1.0 Universal",
"URL": "https://github.com/DSACMS/metrics/blob/main/LICENSE.md"
}
],
"usageType": "openSource",
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
"repositoryURL": "https://github.com/DSACMS/metrics",
"vcs": "git",
"laborHours": 20475,
"platforms": ["web"],
"categories": ["data-visualization", "data-analytics"],
"softwareType": "standalone/web",
"languages": [
"Liquid",
"JavaScript",
"CSS",
"Shell",
"Python"
"name": "metrics",
"description": "CMS Open Source Repository Metrics Website",
"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.",
"status": "Production",
"permissions": {
"license": [
{
"name": "CC0 1.0 Universal",
"URL": "https://github.com/DSACMS/metrics/blob/main/LICENSE.md"
}
],
"maintenance": "internal",
"date": {
"created": "2023-07-18T14:10:58Z",
"lastModified": "2025-02-11T19:10:14Z",
"metaDataLastUpdated": "2025-02-11T19:20:16.212Z"
},
"tags": ["metrics", "ospo", "repository"],
"contact": {
"email": "opensource@cms.hhs.gov",
"name": "CMS/OA/DSAC"
},
"localisation": false,
"repositoryType": "website",
"userInput": "No",
"fismaLevel": "Low",
"group": "CMS/OA/DSAC",
"subsetInHealthcare": "Operational",
"userType": "Government",
"repositoryHost": "Github.com",
"maturityModelTier": 3,
"projectType": "Website"
"usageType": "openSource",
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
"repositoryURL": "https://github.com/DSACMS/metrics",
"projectURL": "https://dsacms.github.io/metrics/",
"repositoryHost": "github.com/DSACMS",
"repositoryVisibility": "public",
"vcs": "git",
"laborHours": 20722,
"reuseFrequency": {
"forks": 4,
"clones": 0
},
"platforms": [
"web"
],
"categories": [
"data-visualization",
"data-analytics"
],
"softwareType": "standalone/web",
"languages": [
"Liquid",
"JavaScript",
"CSS",
"Python",
"Shell"
],
"maintenance": "internal",
"contractNumber": [],
"date": {
"created": "2023-07-18T14:10:58Z",
"lastModified": "2025-06-01T11:36:12Z",
"metaDataLastUpdated": "2025-06-06T16:36:38.949Z"
},
"tags": [
"metrics",
"ospo",
"repository",
"featured"
],
"contact": {
"email": "opensource@cms.hhs.gov",
"name": "CMS/OA/DSAC/OSPO"
},
"feedbackMechanisms": "https://github.com/DSACMS/metrics/issues",
"localisation": false,
"repositoryType": "website",
"userInput": "No",
"fismaLevel": "Low",
"group": "CMS/OA/DSAC",
"projects": [],
"systems": [],
"upstream": "https://github.com/DSACMS/metrics/network/dependencies",
"subsetInHealthcare": [
"Operational"
],
"userType": [
"Government"
],
"maturityModelTier": 3
}
```
8 changes: 8 additions & 0 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The SHARE IT Act of 2024 is legislation designed to enhance transparency, collab
- Standardized reporting on software development and licensing practices.
- Establishment of metadata guidelines to ensure clear documentation and discoverability of software assets.

Learn more at: https://dsacms.github.io/share-it-act-lp/

### Does the SHARE IT Act also apply retroactively to previous custom-developed code?

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.
Expand All @@ -36,6 +38,12 @@ There are [4 exemptions](https://www.congress.gov/bill/118th-congress/house-bill

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).

### When do agencies have to comply?
The SHARE IT Act applies to custom-developed code created on or after July 21, 2025 where agencies must:
- store custom-developed code in a repository
- ensure code is accessible to federal employees and is owned by the agency
- publish metadata on all custom-developed code

## code.json Metadata Standard

### What is code.json?
Expand Down
Loading
Loading