Skip to main content
net6.0

Translates ELM into C# expression trees and can emit those expression trees into either runtime Delegates or C# source code.

Published
Aug 30, 2023
3y ago
Total Downloads
53.8K
53,826

Install

dotnet add package Hl7.Cql.Compiler --version 0.9.0-rc1
ProductVersions
.NET
net6.0

README

Build Status

Introduction

This is NCQA's and Firely's official support SDK for working with CQL on the Microsoft .NET (dotnet) platform. It contains an engine for executing ELM, and/or turning the contents of an ELM file into a .NET assembly so it can be called statically.

Release notes

We are preparing to release version 1.0 of the engine. The engine has been tested by running it against the current NCQA HEDIS measures. There is quite some variation in how CQL is written and interpreted, so it is likely at this early stage that there will be deviations from other engines currently available. As well, we expect parts of the public interface can to change.

The releases notes at firely-cql-sdk/releases for each major version will document these changes and (major) issues we have encountered.

Getting Started

  • Read how to get started with the Demo solution included in the repository.
  • There is a great presentation on the engine from DevDays 2023 (TODO: need approval to publish link)

Dev Start

During development, new alpha releases will appear on Firely's Github Package feed, to be able to use pre-release packages within the cql solution. To use theses packages you must add https://nuget.pkg.github.com/FirelyTeam/index.json to your NuGet sources:

  • Get a Personal Access token (PAT) from github.com with scope read:packages

  • Next open a console on your machine and run dotnet nuget add source --name github --username <USERNAME> --password <PAT> https://nuget.pkg.github.com/FirelyTeam/index.json

USERNAME: your username on GitHub PAT: your Personal access token with at least the scope read:packages

Support

We actively monitor the issues coming in through the GitHub repository at https://github.com/FirelyTeam/firely-cql-sdk/issues. You are welcome to register your bugs and feature suggestions there. For questions and broader discussions, we use the .NET FHIR Implementers chat and CQL chat on Zulip.

Contributing

We are welcoming contributions!

If you want to participate in this project, we're using Git Flow for our branch management. Please submit PRs with changes against the develop branch.

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

This version is marked prerelease. Validate its API and upgrade path before production use.Compatibility metadata lists 1 target framework; confirm the exact target used by your application.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.