ecqm-bundler

ecqm-bundler

CLI for bundling CQL files as an eCQM FHIR Bundle.

Installation

The CLI can be globally installed through npm:

npm install -g ecqm-bundler

Usage

Must have an instance of the cql-translation-service running somewhere.

Basic Usage

Individual Dependency List

ecqm-bundler -c /path/to/main/cql/file.cql --deps /path/to/dep1.cql /path/to/dep2.cql -v /path/to/valueset/directory

Dependency Directory

ecqm-bundler -c /path/to/main/cql/file.cql --deps-directory /path/to/deps/directory -v /path/to/valueset/directory

Advanced Usage/Features

Customizing Measure Properties

Current Measure resource customizations include the Measure Improvement Notation and the Measure Scoring Code:

ecqm-bundler -c /path/to/main/cql/file.cql --deps-directory /path/to/deps/directory -v /path/to/valueset/directory --scoring-code "proportion" --improvement-notation "negative"

ValueSet Resolution

By default, the bundler will look in the directory specified by -v/--valueset for any JSON files that have a url property which matches what is included by any pieces of the CQL logic. You can disable this behavior with the --no-valuesets option, but note that the resulting eCQM FHIR Bundle may not yield proper calculation results due to lack of ValueSet resources:

ecqm-bundler -c /path/to/main/cql/file.cql --deps-directory /path/to/deps/directory --no-valuesets

Customizing Population Expressions

The bundler will add population group criteria to the Measure resource, which references specific CQL expressions that identify the relevant eCQM population. By default, it uses "Numerator", "Denominator", and "Initial Population" as the expression definition names. These can be customized with the -n/--numer, -d/--denom, -i/--ipop options respectively:

ecqm-bundler -c /path/to/main/cql/file.cql --deps-directory /path/to/deps/directory -v /path/to/valueset/directory -n "numer def" -d "denom def" -i "ipop def"

Customizing Canonical URLs

By default, the bundler just uses an example.com URL as the base canonical URL for the resources (e.g. http://example.com/Measure/measure-123). This can be customized using the --canonical-base option:

ecqm-bundler -c /path/to/main/cql/file.cql --deps-directory /path/to/deps/directory -v /path/to/valueset/directory --canonical-base "http://example.com/other/canonical/base"

Full List of Options

Usage: ecqm-bundler [options]

Options:
  -c, --cql-file <path>
  --deps <deps...>                       List of CQL dependency files of the main file (default: [])
  --deps-directory <path>                Directory containing all dependent CQL files
  -n,--numer <expr>                      Numerator expression name of measure (default: "Numerator")
  -i,--ipop <expr>                       Numerator expression name of measure (default: "Initial Population")
  -d,--denom <expr>                      Denominator expression name of measure (default: "Denominator")
  -o, --out <path>                       Path to output file (default: "./measure-bundle.json")
  -v, --valuesets <path>                 Path to directory containing necessary valueset resource
  --no-valuesets                         Disable valueset detection and bundling
  -u, --translator-url <url>             URL of cql translation service to use (default: "http://localhost:8080/cql/translator")
  --canonical-base <url>                 Base URL to use for the canonical URLs of library and measure resources (default: "http://example.com")
  -i, --improvement-notation <notation>  Measure's improvement notation (choices: "positive", "negative", default: "positive")
  -s, --scoring-code <scoring>           Measure's scoring code (choices: "proportion", "ratio", "continuous-variable", "cohort", default: "proportion")
  -h, --help                             display help for command