Skip to content

Commit

Permalink
feat: QPPA-7861 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ckawell-sb committed Aug 23, 2023
1 parent 1dfddd0 commit b8a568f
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 23 deletions.
26 changes: 8 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,24 +71,14 @@ To handle UTF-8 encoding, make sure that you save any new csv from excel as `CSV

### Additional Benchmarks

For 2018-2019, only 'full images' of benchmark data are accepted; the csv must contain a full list of included benchmarks. Incremental files are no longer supported (2017 is no longer supported).

To add or update benchmarks, rename your csv to 'benchmarks.csv'
and place that file in staging/$YEAR/benchmarks/.
Replace any existing files of the same name.
Run `nvm use` to make sure you are using the correct versions of npm and Nodejs, then run `npm run build:benchmarks $YEAR` to update benchmark JSON files under benchmarks/.
$YEAR refers to the performance year you are looking to update.
See `build-benchmarks` for more detail.

`build-benchmarks` will call `parse-benchmarks-data.js` directly and validate the data right after.
`parse-benchmarks-data.js` relies on a set of columns to be present and additional empty columns can cause the parsing to fail.
See that file for additional instructions on how to generate the JSON file.

Also, `parse-benchmarks-data.js` cross references for measureIds in `measures/$YEAR/measures-data.json` for the correct usage. If none are matched, either a padded `000` digit will be used for `measureId`s with all digits or a non-spaced version of the `measureId` will be used.

If 2 benchmarks have the same Measure ID, Benchmark Year, Performance Year, and Submission method, an error will be thrown. Benchmarks cannot share this composite key.

Please verify the changes are as expected. (You can run `git diff`.)
To add or update benchmarks, rename your csv to 'benchmarks.csv'
and place that file in staging/$YEAR/benchmarks/.
Replace any existing files of the same name.
Run `nvm use` to make sure you are using the correct versions of npm and Nodejs, then run `npm run build:benchmarks $YEAR` to update benchmark JSON files under benchmarks/.
$YEAR refers to the performance year you are looking to update.
See `build-benchmarks` for more detail.

Please verify the changes are as expected. (You can run `git diff`.)

### Creating and updating MVP (MIPS Value Pathway) data

Expand Down
2 changes: 1 addition & 1 deletion benchmarks/2023/benchmarks-schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ definitions:
submissionMethod:
description: The method for submitting the measure performance data to which this benchmark applies.
enum: [claims, registry, cmsWebInterface, administrativeClaims, electronicHealthRecord, certifiedSurveyVendor]
required: [measureId, performanceYear, benchmarkYear, submissionMethod, deciles]
required: [measureId, performanceYear, benchmarkYear, submissionMethod, percentiles]
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"init:measures": "scripts/measures/initialize-measures",
"update:measures": "scripts/measures/update-measures",
"build:measures": "scripts/measures/build-measures",
"build:benchmarks": "scripts/benchmarks/archive/build-benchmarks",
"update:benchmarks": "scripts/benchmarks/build-benchmarks",
"build:benchmarks:old": "scripts/benchmarks/archive/build-benchmarks",
"build:benchmarks": "scripts/benchmarks/build-benchmarks",
"build:clinical-clusters": "scripts/clinical-clusters/build-clinical-clusters",
"update:mvp": "scripts/mvp/update-mvp",
"parse:mvp": "scripts/mvp/parse-mvp-data",
Expand Down
4 changes: 2 additions & 2 deletions scripts/benchmarks/csv-json-converter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ function convertCsvToJson(csvPath: string, performanceYear: number) {

//maps the csv column values to the matching measures-data fields.
_.each(BENCHMARKS_COLUMN_NAMES, (columnName, measureKeyName) => {
if (row[columnName]) {
measure[measureKeyName] = mapInput(columnName, row);
if (row[measureKeyName]) {
measure[columnName] = mapInput(measureKeyName, row);
}
});

Expand Down
1 change: 1 addition & 0 deletions scripts/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export const QUALITY_CSV_COLUMN_NAMES = {

export const BENCHMARKS_COLUMN_NAMES = {
'measureId': 'measureId',
'qualityId': 'measureId',
'isToppedOut': 'isToppedOut',
'isToppedOutByProgram': 'isToppedOutByProgram',
'isHighPriority': 'isHighPriority',
Expand Down

0 comments on commit b8a568f

Please sign in to comment.