Clinical Quality Language (CQL) for VSCode

The VS Code CQL extension provides syntax highlighting, semantic (error) highlighting, and local execution for HL7 Clinical Quality Language (CQL).

Requirements

• Visual Studio Code 1.90 or newer
• Java 11 or newer

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. For windows (or java errors) follow these instructions.

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 at alphora.com

Community

This project is being used by multiple groups as part of CQL-based artifact knowledge engineering pipelines. To support development and maintenance of the VS Code plugin as part of those pipelines, several of these stakeholders meet regularly to manage issues, discuss features, and coordinate development. All the work performed by this group is managed on the VSCode Plugin Project Board. Anyone with an interest in development and maintenance of the plugin is welcome to join these meetings. Email bryn at alphora.com to be added to the invite list.

Related Projects

• 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.
• atom_cql_support - CQL Support for the Atom editor.

Development

Development details can be found in the Developer Guide.

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.