/cql_engine

Clinical Quality Language Evaluation Engine

Primary LanguageJavaApache License 2.0Apache-2.0

CQL Evaluation Engine

The HL7 Clinical Quality Language specification is designed to enable accurate authoring and automated sharing of computable knowledge artifacts including quality measures, decision support rules, orders sets and documentation templates. The specification is constructed using a layered approach informed by modern programming language and compiler design which facilitates the development of language processing applications including static analysis, translation, and evaluation.

The specification includes informative open source tooling that can be used to verify the semantics of CQL libraries; to produce the sharable format, Expression Logical Model (ELM), of those libraries; and to evaluate the resulting libraries using a prototypical JavaScript-based ELM interpreter.

This project builds on that tooling to provide an open source Java-based evaluation engine capable of evaluating the result of any CQL expression.

Repository

This repository uses stable trunk methodology:

Branch Description Status Version
v12 CQL 1.2 Engine Maintenance 1.2.20
master CQL 1.3 Engine Release 1.3.11
develop CQL 1.3 Engine Snapshot 1.3.12-SNAPSHOT
<feature> CQL 1.3 Engine as needed <version>-SNAPSHOT

Commit Policy

All new development takes place on <feature> branches off develop. Changes to new features branches may be committed directly if desired, but PRs are preferred. Once feature development on the branch is complete, the feature branch is submitted to develop as a PR. The PR is reviewed by maintainers and regression testing by the CI build occurs. Once the PR is merged to develop, the CI build publishes a SNAPSHOT.

Changes to master and maintenance branches must be done through an approved PR. Feature branches are merged to the develop branch for regression testing. Only the develop branch may be merged to master. Delete branches after merging to keep the repository clean.

Commits to develop and master trigger a deployment to Maven Central. Master releases SHALL NOT have any SNAPSHOT dependencies.

On merging in to develop, committers must ensure that:

  1. The major, minor, and patch build properties are incremented appropriately.
  2. Update the release on Github with appropriate change notes.
  3. Increment the minor build property on the develop branch (to be automated by #316)

Release Policy

This project uses Semantic Versioning, with the caveat that we track to the version of CQL the engine supports. Releases are published to Maven snapshot and public directories under the org.opencds.cqframework group id. Each release SHALL have a Release in Github. Pre-releases SHALL be marked as such and use the -SNAPSHOT version indicator. For any new release, a SNAPSHOT is released first and must pass integration testing in at least one external system prior to being promoted to a release. SNAPSHOTs may be published from any branch, but SHALL have incremented version numbers consistent with the branch and semantic versioning policies. Releases may only be published from the master or maintenance branches. Only one prior version is maintained at any given time.

Roadmap

  • 1.3.9 - Improved exception handling and stable
  • 1.3.10 - Debugging/tracing/coverage
  • 1.3.11 - FHIR R4 Support
  • 1.4 - CQL 1.4 Support

License

Copyright 2016 University of Utah

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.