The CQF Ruler is a set of plugins for the HAPI FHIR Server that provides an implementation of FHIR's Clinical Reasoning Module and serves as a knowledge artifact repository and a cds-hooks compatible clinical decision support service. It does this via integrating a number of other CQL-related projects, which are listed below.
The easiest way to get started with the cqf-ruler is to pull and run the docker image
docker pull contentgroup/cqf-ruler
docker run -p 8080:8080 contentgroup/cqf-rulerThis will make the cqf-ruler available on http://localhost:8080/cqf-ruler-r4
Other options for deployment are listed on the wiki for more documentation.
Go to http://www.oracle.com/technetwork/java/javase/downloads/ and download the latest (version 11 or higher) JDK for your platform, and install it.
Go to https://maven.apache.org, visit the main "Download" page, and under "Files" download the 3.5.3 binary. Then unpack that archive file and follow the installation instructions in its README.txt. The end result of this should be that the binary "mvn" is now in your path.
mvn package
Builds the project war file (cqf-ruler-dstu3.war and cqf-ruler-r4.war in the projects' target directory)
Visit the wiki for more documentation.
To run the cqf-ruler directory from this project use:
mvn jetty:run -am --projects cqf-ruler-dstu3
The cqf-ruler will be available at http://localhost:8080/cqf-ruler-dstu3/
mvn jetty:run -am --projects cqf-ruler-r4
The cqf-ruler will be available at http://localhost:8080/cqf-ruler-r4/
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.
Additional documentation is on the wiki.
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 [email protected].
HAPI FHIR - Provides the FHIR API and server upon which the cqf-ruler is built.
Clinical Quality Language - Tooling in support of the CQL specification, including the CQL verifier/translator used in this project.
CQL Evaluator - Provides the CQL execution environment used by the cqf-ruler.
CQF Tooling - Provides several operations that the cqf-ruler exposes are services, such as $refresh-generated content.
CQL Support for Atom - Open source CQL IDE with syntax highlighting, linting, and local CQL evaluation.
Copyright 2019+ Dynamic Content Group, LLC (dba Alphora)
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.