Clinical Quality Language (CQL) for VSCode

Adds syntax highlighting, semantic (error) highlighting, and local execution for the HL7 Clinical Quality Language (CQL) to VS Code

Quick Start

The cqframework.cql extension has been published to the VS Code Marketplace, so the installation is simple. Just search for "Clinical Quality Language" in the marketplace and install the extension. It'll be activated once you open a .cql file.

This extension requires Java to be installed. It'll prompt you to install Java if required.

This project maintains a User Guide that provides detailed instructions on how to use the plugin to author and test CQL content.

More About the Clinical Quality Language

The Clinical Quality Language (CQL) is a domain specific language for expressing electronic clinical quality measures (eCQM) and clinical decision support rules (CDS) in an author-friendly computable format. Find out more about CQL:

• CQL Specification
• CQL Stream on FHIR Zulip Chat
• clinical_quality_language on GitHub
• Clinical Quality Language at HL7
• Clinical Quality Framework (CQF)

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

• atom_cql_support - CQL Support for the Atom editor.
• cql-language-server - The Java and Language Server Protocol based server that powers this extension.
• cql-translator - The ELM generation component used in this project.
• clinical-reasoning - The Java CQL runtime environment used in the extension.

Local Plugin Development

Install npm

Run npm install from the root

Run npm run watch from the root

Run the debug launch from VS Code

TIP: The cql-language-server that provides error highlighting is a Java project. It's also launched in debug mode when this VS Code extension is launched in debug mode, allowing you to attach a Java debugger as well. If you're simultaneously iterating on the cql-language-server, you can create a symlink to that Java artifact and changes will be picked up when VS Code restarts.

On linux: vscode-cql/dist/jars$ ln -s your-repo-home/cql-language-server/ls/service/target/cql-ls-service-1.5.8.jar cql-ls-service-1.5.8.jar

Set your repo home directory and update the versions as needed.

Versioning

This project follows the guidance given by Microsoft for the VS Code marketplace here and publishes prereleases to the VS Code marketplace using odd minor version numbers. Full releases are published using even minor version numbers.

Acknowledgements

This plugin is a reimplementation of much of the functionality in the atom_cql_support plugin for the Atom editor. Additionally, the Red Hat vscode-java plugin was referenced extensively in developing this plugin.

License

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.