Using CQL with FHIR, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cql-ig/ and changes regularly. See the Directory of published versions
Changes
This page details changes made in each version of the Using CQL with FHIR Implementation Guide.
STU1 Publication (version 1.0.0)
The following changes were made as a result of comments received in the 1.0.0-ballot
NOTE: This changelist is inclusive of changes published in the 1.0.0-snapshot version
Non-Compatible Changes
Compatible, Substanive Changes
- FHIR-43885: A Conformance Requirement that SHOULD be followed is confusing Applied (here)
- FHIR-43780: Relax prohibition against string-based membership testing Applied (here)
- FHIR-43698: Conformance requirement 2.10 - provide example Applied (here)
Non-Substantive Changes
- FHIR-45296: QA review fixes
- FHIR-45273: Added guidance on using expressions in artifacts (Applied here)
- FHIR-44666: Documented ModelInfo usage
- FHIR-44551: Added examples of using CQL parameters (Applied here)
- FHIR-44548: Large number of technical corrections Applied (here), (here), (here), (here), and (here)
- FHIR-44541: Attributes versus Elements (Applied here)
- FHIR-44512: add link to cqf-notDoneValueSet (Applied here)
- FHIR-44113: Consider updating examples to align with Conformance Requirement 2.14 Applied (here), (here), and (here)
- FHIR-44099: FHIR version of code structure does not include the term “using” Applied (here)
- FHIR-44091: Missing period (Applied here)
- FHIR-44090: Consider including the terminology operators link (Applied here)
- FHIR-44089: Value set is written 5 different ways Changes applied in the whole section (here)
- FHIR-44087: Missing periods (Applied here)
- FHIR-44086: Confusing Terminology Applied (here)
- FHIR-44082: Incomplete Sentence Applied (here)
- FHIR-44079: Missing period (Applied here)
- FHIR-44077: Too many spaces before colon (Applied here)
- FHIR-44075: Conflicting information about underscores Applied (here)
- FHIR-44073: Incorporated ModelInfo guidance from QICore Applied (here)
- FHIR-44072: Incorporated Patterns guidance from QICore Applied (here)
- FHIR-44071: Updated negation guidance (here)
- FHIR-44069: “When” should be lower case Applied (here)
- FHIR-44066: Should Health Level 7 be upper class Applied (here)
- FHIR-44065: Misspelling of “Explain” in Status: Summary Applied (here)
- FHIR-44063: Consider adding an acronyms page Applied (here), (here), (here), and (here)
- FHIR-44061: Removed multiple periods in banner
- FHIR-44059: Additional documentation on scope and purpose (Applied here)
- FHIR-43931: Fixed incomplete sentence
- FHIR-43915: Clarify double-braces / context in FHIR Query Pattern extension Applied (here)
- FHIR-43901: Created new ModelInfoSettings profile (Applied here)
- FHIR-43886: CQL Library Evaluate: return parameter doesn’t always return all expressions (Applied here)
- FHIR-43882: Added additional details to 2.18.2 to note profiles are StructureDefinitions with derivation set to constraint
- FHIR-43881: Typos: package, csn Applied (here)
- FHIR-43877: Conflict in Mime Type version guidance and Library profiles Applied (here), (here), (here), (here), and (here)
- FHIR-43795: Clarified Tuple and List type representation (Applied here)
- FHIR-43794: Clarified top-level expressions can return tuples and lists (Applied here)
- FHIR-43793: Clarify FHIR Type Mapping for List and Tuple types (Applied here)
- FHIR-43789: Fixed a typo in 2.14
- FHIR-43787: Added Link to and example usage of cqf-notDoneValueSet (Applied here)
- FHIR-43786: Clarified data type names section (Applied here)
- FHIR-43785: Define or Replace “Initial Case” (Applied here)
- FHIR-43783: Clarify purpose of “Representation in Narrative” section Applied (here)
- FHIR-43777: Convert text link to hyperlink (Applied here)
- FHIR-43774: Fixed incomplete sentence in nested libraries (Applied here)
- FHIR-43765: Clarified terminologies are examples only (Applied here)
- FHIR-43764: Clarified description of prefetchData.data (Applied here)
- FHIR-43763: Clarified description of prefetchData.key (Applied here)
- FHIR-43760: Clarified description of prefetchData.data (Applied here)
- FHIR-43759: Clarified description of prefetchData.key (Applied here)
- FHIR-43758: Added binding to CQL Access Modifier (Applied here)
- FHIR-43755: Added guidance on absence of isRetrievable extension (Applied here)
- FHIR-43754: Added guidance on absence of isIncluded extension (Applied here)
- FHIR-43752: Added missing extension references (Applied here)
- FHIR-43747: Added a dependency slice to relatedArtifact in the CQLModule profile
- FHIR-43742: Consider tightening ELM Library profile requirements w/ invariants Applied (here, here)
- FHIR-43741: CQL Module: Consider using invariant to require parameters have defaultValue or cqlType (Applied here)
- FHIR-43740: CQL Module: Clarify inputParameters extension vs Library.parameter element (Applied here)
- FHIR-43739: Tightened CQLModelInfo profile (Applied here)
- FHIR-43738: Tightened CQLLibrary profile (Applied here)
- FHIR-43737: Clarify use of data absent reason codes in CQL Evaluation Result Applied (here)
- FHIR-43734: Mismatch between CQL Capability Statement profile and example Applied (here)
- FHIR-43733: Typo: A library profiles Applied (here)
- FHIR-43732: Incorrect reference to CRMI IG Applied (here)
- FHIR-43731: Page listing does not match menu Applied (here) and in menu.xml
- FHIR-43703: Updated example in Concepts to include a code from another system
- FHIR-43666: Fixed incomplete sentence
- FHIR-43665: Clarified conformance requirement 1.1 (Applied here)
- FHIR-43582: Added -version to the CQL naming convention conformance requirement 2.18
- FHIR-43581: Clarified negation guidance
- FHIR-43480: Typo in Conformance Requirement 2.17
- FHIR-43479: Removed quotes from parameters in the example in 2.8
- FHIR-43439: Clarified human readable representation of codes
- FHIR-43436: Finished sentence on 2.1.2
- FHIR-43425: Fixed reference to CRMI
- FHIR-43418: Typo fixes on using CQL page
- FHIR-43340: Clarified modelInfoSettings
Initial STU 1 Ballot Changes (version 1.0.0-ballot)
This is the first ballot of this implementation guide in this form, but the content has been balloted and published in multiple prior implementation guides, including:
Change Summary
This ballot made the following major changes:
The following changes were made as a result of ballot comments received in the September 2023 ballot of the Canonical Resource Management Infrastructure IG. One of those comments was the suggestion to break this CQL-specific content out into its own implementation guide; this IG is the result of that change.
- FHIR-43076: Use a dataAbsentReason extension to indicate missing results
- FHIR-43075: Add guidance on missing information
- FHIR-42921: Consider requiring the use of a SignatureLevel higher than none
- FHIR-42574: Libraries are not required for CQL
- FHIR-42573: Explaing conformance requirement 4.12
- FHIR-42571: Representation in a Library needs clarification
- FHIR-42570: Code URI expectation inconsistent
- FHIR-42569: What is “knowledge artifact CQL”?
- FHIR-42568: Why so much discussion about VSAC in an international spec?
- FHIR-42567: Use a value set avoiding OIDs
- FHIR-42566: Update location of code system URIs
- FHIR-42565: How is the association between a namespace and URI established?
- FHIR-42562: Put versioning stuff together
- FHIR-42561: Explain identifier rules
- FHIR-42560: Better explain library declarations
- FHIR-42559: Clarify language around CQL artifacts
- FHIR-41869: No content in this ModelInfo section of Using CQL
- FHIR-41868: Provide more context in examples