cqf-tooling

Tooling for CQL and IG Authors

This tooling provides various useful tools for building CQFramework related content and implementation guides, including QUICK page generation, ModelInfo generation from StructureDefinitions, and ValueSet creation.

Usage

Building this project requires Java 11+ and Maven 3.8+. The resulting jar is compatible with Java 11+.

Build the project with:

mvn package

Run a specific operation using (example running Accelerator Kit Processor):

cd tooling-cli

mvn exec:java \
-Dexec.mainClass="org.opencds.cqf.tooling.cli.Main" \
-Dexec.args="-ProcessAcceleratorKit \
-pts=/Users/mutesasiramoses/Desktop/dev/HIV-DAK/cqf-tooling/input/WHO-UCN-HHS-SIA-2022.1-eng.xlsx \
-op=/Users/mutesasiramoses/Desktop/dev/HIV-DAK/cqf-tooling/output \
-dep='HIV.A. Registration,HIV.B. HTS Visit,HIV.C. PrEP Visit,HIV.D. Care-Treatment Core,\
HIV.D.Care-Treatment Additional,HIV.D. TB-HIV,\
HIV.E-F. PMTCT,HIV.G. Diagnostics,HIV.H. Follow Up,HIV.I. Referral,HIV. Surveillance,HIV. Configuration'"

For running directly in VS code , add this to Launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "Run Java",
            "request": "launch",
            "mainClass": "org.opencds.cqf.tooling.cli.Main",
            "projectName": "tooling-cli",
            "args": [
                "-ProcessAcceleratorKit",
                "-op=/home/moses/Desktop/Dev/Projects/HIV-DAK/CQF-TOOL/cqf-tooling/output",
                "-dep='HIV.ARegistration,HIV.BHTSvisit,HIV.CPrEPvisit,HIV.DCare-Treatment,HIV.DHIV-TB,HIV.E-FPMTCT,HIV.GDiagnostics,HIV.HFollow-up,HIV.IReferral,HIV.Prevention,HIV.Surveillance,HIV.Configuration'",
                "-pts=/home/moses/Desktop/Dev/Projects/HIV-DAK/CQF-TOOL/cqf-tooling/input/WHO-UCN-HHS-SIA-2023.27-eng.xlsx"
            ]
        }
    ]
}

For Running Decision Table Processor

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "Run Java",
            "request": "launch",
            "mainClass": "org.opencds.cqf.tooling.cli.Main",
            "projectName": "tooling-cli",
            "args": [
                "-ProcessDecisionTables",
                "-op=/home/moses/Desktop/Dev/Projects/HIV-DAK/CQF-TOOL/cqf-tooling/output",
                "-dtp='HIV.S.1RecommendedServices,HIV.S.2MonitoringARTresponse,HIV.S.3CCAscreening,HIV.S.4HIVretesting,HIV.B2.DTSeriouslyill,HIV.B7.DTTestUsingAlgorithm,HIV.E4.DTTestusingAlgorithm,HIV.E12.DTIndeterminatetest,HIV.B9.DTRetestRecommendation,HIV.C7.DTPrEPSuitability,HIV.C23.DTPEPorPrEPRegimen,HIV.D4.DTScreenforTB,HIV.D12.DTDetScreenings,HIV.D15.DTClinicalstageHIV,HIV.D17.DTTreatmentFailure,HIV.D21.1.DTARTRegimen,HIV.D21.2.DTDrugInteractions'",
                "-pts=/home/moses/Desktop/Dev/Projects/HIV-DAK/CQF-TOOL/cqf-tooling/input/WHO-UCN-HHS-SIA-2023.28-eng.xlsx"
            ]
        }
    ]
}

For Running CQF to Library

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "Run Java",
            "request": "launch",
            "mainClass": "org.opencds.cqf.tooling.cli.Main",
            "projectName": "tooling-cli",
            "args": [
                "-CqlToR4Library",
                "-op=/home/moses/Desktop/Dev/Projects/HIV-DAK/CQF-TOOL/cqf-tooling/output/Library",
                "-ptcql=/home/moses/Desktop/Dev/Projects/HIV-DAK/CQF-TOOL/cqf-tooling/output/input/cql/HIVB2DT.cql",
            ]
        }
    ]
}

Executable jars are produced by the CI system on Maven Central: Download executable jar

This can be run with java -jar tooling-cli-2.0.0.jar -VsacXlsxToValueSetBatch

Documentation of the various operations is provided in the Main class.

Commit Policy

All new development takes place on <feature> branches off master. Once feature development on the branch is complete, the feature branch is submitted to master as a PR. The PR is reviewed by maintainers and regression testing by the CI build occurs.

Changes to the master branch must be done through an approved PR. Delete branches after merging to keep the repository clean.

Merges to master trigger a deployment to the Maven Snapshots repositories. Once ready for a release, the master branch is updated with the correct version number and is tagged. Tags trigger a full release to Maven Central and a corresponding release to Github. Releases SHALL NOT have a SNAPSHOT version, nor any SNAPSHOT dependencies.

Release Process

To release a new version of the tooling:

Update master to be a release version (and all the reviews, bug fixes, etc. that that requires)
1. Regression test against IGs known to use CQF Tooling
Passed Travis Build = ready for release
Create a Github Release (which creates a tag at the current commit of master)
1. Choose the "Auto-generate release notes" option
Travis does the release to Maven
1. Ensure binaries are published to https://oss.sonatype.org/#view-repositories;public~browsestorage~org/opencds/cqf/tooling
Update master to vNext-SNAPSHOT
Close all issues included in the release

Getting Help

Bugs and feature requests can be filed with Github Issues.

The implementers are active on the official FHIR Zulip chat for CQL.

Inquires for commercial support can be directed to info@alphora.com.

Related Projects

Clinical Quality Language - Tooling in support of the CQL specification, including the CQL verifier/translator used in this project.

CQL Support for Atom - Open source CQL IDE with syntax highlighting, linting, and local CQL evaluation.

CQF Ruler - Integrates this project into the HAPI FHIR server, exposing some functionality as services.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.