hl7 / cql Goto Github PK

Clincal Quality Language Specification

License: Other

Batchfile 1.04% HTML 94.36% ANTLR 4.00% Shell 0.59% Visual Basic 6.0 0.01%

clinical-quality-language hl7 clinical-decision-support clinical-quality-measurement fhir fhirpath cds query-language cql

cql's Introduction

CQL

This repository contains the source for the Health Level Seven International Clinical Quality Language (CQL) Specification. The specification is stewarded by the HL7 Clinical Decision Support (CDS) Work Group. Changes to the specification are made through the HL7 balloting process.

The specification is published by Health Level Seven International at the following location: http://cql.hl7.org

Repository Organization

This repository is structured as follows:

root - IG Publisher content and settings
- resources - IG resource
- spec - Specification content
- tests - CQL testing suite
- txCache - IG Publisher terminology cache

The spec folder contains:

_layouts - Publishing layouts for the Jekyll build
cql - CQL grammar
dist - HTML assets for the publication
elm - ELM schema and UML
examples - Specification examples
extracted-media - images for the specification
_config.yml - Configuration file for the publication
*.adoc, *.md, *.zip - Specification content

Local Build

The HL7 IG Publisher is committed to this repository to make building as easy as possible. To build locally, clone the repository and issue the following command in the root:

java -jar "org.hl7.fhir.igpublisher.jar" -ig ig.json

Web Build

Commits to this repository will trigger the development build, published here:

http://build.fhir.org/ig/HL7/cql/

cql's People

Contributors

Stargazers

Watchers

Forkers

medblox hossenlopp psbrandt mnsandhya zoedalley cmoesel barbdowns mholck ewhitley abdullah-git1 alexanderkiel path-check nidh1023 evanmachusakncqa brianpos

cql's Issues

Add publication packages for XSD and test case artifacts

Add publication packages for:

info.cqframework.cql - base specification XSDs for ELM and ModelInfo
info.cqframework.cql.tests - CQL test cases

Description of Equivalent in Comparison Operators is inconsistent with Reference

The discussion at the end of the Comparison Operators section is inconsistent with the description of Equivalent functionality in the Logical Specification and CQL Reference. Specifically, it says: "The equivalent operator is the same as equality, except that it returns true if both of the arguments are null, and false if one argument is null and the other is not:" But it should note that equivalence has looser semantics than strict equality for many types (e.g. Strings, Codes, Concepts, and Quantities).

Confusing language in Intersect logical specification

In the Intersect logical spec, the expression is marked as descending from NaryExpression. However, the verbiage below refers to "both arguments" and "either argument", making it sound like Intersect is actually a BinaryExpression. Which is correct? Some other expressions like Union and Except also have the same issue; I'd be happy to put together a PR to align the language in all of them, once I know which way to edit!

Tables

Many tables that look ok on github (.adoc) do not render correctly on HL7 site (.html). For example, Table 2-B.
Compare
https://github.com/HL7/cql/blob/master/spec/2018May/02-authorsguide.adoc#parameters
and
https://cql.hl7.org/2018May/02-authorsguide.html#parameters

Equal Code and Concept overloads are inconsistent with Tuple equality semantics

Quantity division should cancel units

Division should cancel units (just as multiplication multiplies them)

10.1 'cm' div -3.1 'cm should result in -3.0 '1'

https://github.com/HL7/cql/blob/master/tests/cql/CqlArithmeticFunctionsTest.xml#L829

Clarify subtype behavior for `Is` operator in Appendix B

As discussed in this FHIR chat, it is an important semantic that Is also returns true for a subtype relationship where T' is T is true if T' is derived from T. This is mentioned in the developer guide, but not in the system operator definition. This ticket is for adding a note about this behavior to the system operator definition in particular.

Thanks!

Keywords Now() and Today() missing from the grammar

Issue/Question

Now(), Today() and TimeOfDay are supported operators in CQL: https://cql.hl7.org/02-authorsguide.html, but they are not included in the Antlr4 grammar.

IIUC, Antlr4 listners can only listen for the defined keywords in the grammar. In this case, how does a CQL implementation parse and evaluate an expression like Now() + 7 days?

Expand test cases

STU4B#131 recommends continuing to expand test cases in the specification. There was not time to expand the test cases prior to publication of this ballot cycle, so this issue is logged to track additional updates to the test cases to cover the rest of the specification as part of continued STU testing.

Fix Test ExistsListNull

According to the thread CQL Execution the semantics of exists have changed. That change should be reflected in tests, because there is a test called ExistsListNull. Happy to create a PR, if I'm right here.