| Pages and organization | Separate display of normative content | True | Pages: using-elm.html, profiles.html, extensions.html, using-modelinfo.html, operations.html, terminology.html, using-cql.html, patterns.html, artifacts.html, capabilities.html, conformance.html |
| Pages and organization | Separate display of non-normative content | True | Pages: toc.html, changes.html, downloads.html |
| Pages and organization | Presence of index page | True | Page: index.html |
| Pages and organization | Presence of toc page | True | Page: toc.html |
| Pages and organization | Presence of artifacts page | True | Page: artifacts.html |
| Pages and organization | Presence of background page | False | No background page |
| Pages and organization | Presence of downloads page | True | Page: downloads.html |
| Writing and narrative | Index page starts with a patient-friendly explanation of the purpose of the IG | True | Extract (page index.html): Clinical Quality Language (CQL) is a clinically-focused query language that can be used to express logic in a broad range of healthcare use cases, including clinical decision and cognitive support, public health and quality reporting, computable clinical guidelines, research trial eligibility, and many others. |
| Writing and narrative | Presence of a section that explains key information that needs to be understood prior to reading the IG | True |
- Extract (page index.html): Target Audiences
This implementation guide is targeted at two main audiences:
Authors: Persons involved in the development of CQL-based FHIR Knowledge Artifacts that are authoring CQL, either directly or with tooling assistance
Integrators: Persons involved in the development of systems that support authoring, publishing, distributing, and implementing CQL-based FHIR Knowledge Artifacts
- Extract (page using-cql.html): This topic specifies conformance requirements for the use of Clinical Quality Language (CQL) with Fast Healthcare Interoperability Resources (FHIR), whether that be as in-line expressions in expression-valued elements, or in CQL libraries contained in FHIR Library resources.
- Extract (page patterns.html): This topic provides general guidance and best-practices for authors building FHIR-based Knowledge Artifacts that make use of Clinical Quality Language (CQL). The topics provide informative guidance to facilitate authoring CQL directly with the FHIR data model, including support for primitives, choices, slices, and extensions, as well as guidance for dealing with missing information, negation, the use of terminologies in FHIR, and some discussion of profile-informed authoring.
- Extract (page using-modelinfo.html): To use CQL with FHIR, model information (ModelInfo) must be provided to the implementation environment.
- Extract (page downloads.html): Implementers will still need to be familiar with the content of the specification and profiles that apply in order to make a conformant implementation.
- Extract (page Library-USCore-ModelInfo.html): USCore Model Definition - Using CQL with FHIR v1.0.0
|
| Writing and narrative | Presence an explanation of what "mustSupport" means for different types of implementations of the IG | True |
- Extract (page conformance.html): Certain elements in the profiles defined in this implementation guide are marked as Must Support. This flag is used to indicate that the element plays a critical role in defining, sharing, and implementing artifacts, and implementations SHALL understand and process the element.
|
| Writing and narrative | Presence of information on how to engage with the community | True |
- Extract (page terminology.html): Propose a change
- Extract (page downloads.html): Propose a change
- Extract (page Library-ELMExample.html): Propose a change
- Extract (page Observation-negation-example.html): Propose a change
|
| Writing and narrative | Presence of an explanation of the relationship of the IG to any other guides | True |
- Extract (page index.html): This implementation guide is the result of extracting common aspects of that support to a universal realm, broadly applicable implementation guide that supports the use of CQL with Fast Healthcare Interoperability Resources (FHIR). Future versions of those implementation guides should consider referencing the conformance and guidance established here.
- Extract (page patterns.html): For common use cases, the CQF Common implementation guide provides a FHIRCommon library that defines many of these types of functions and declarations that are commonly used with CQL and FHIR.
- Extract (page conformance.html): For libraries included in FHIR implementation guides, the CQL namespace is defined by the implementation guide as follows:
CQL namespace name SHALL be IG.packageId
CQL namespace url SHALL be IG.canonicalBase
- Extract (page using-modelinfo.html): See the CQF Common implementation guide for a complete FHIR ModelInfo as well as FHIRHelpers library representing the FHIR specification.
- Extract (page changes.html): 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: Clinical Guidelines, Quality Measures, Canonical Resource Management Infrastructure.
- Extract (page Library-CQLExample.html): This page includes related artifacts that depend on the FHIR model information and the Library FHIRHelpers, indicating a relationship with these resources.
- Extract (page Library-ELMExample.html): Related Artifacts depends-on FHIR model information http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 depends-on Library FHIRHelpers http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1
- Extract (page Library-Example.html): Related Artifacts depends-on FHIR model information http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 depends-on Library FHIRHelpers http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1
- Extract (page Library-ParameterExample.html): Related Artifacts depends-on FHIR model information http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 depends-on Library FHIRHelpers http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1
- Extract (page Library-ANCCohort.html): Related Artifacts depends-on FHIR model information http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1 depends-on Library FHIRHelpers http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1 depends-on Code system ANCM Concept Codes CQL IG Example Code System
- Extract (page Library-module-example.html): This library is used as an example module definition in the Using FHIR with CQL Implementation Guide.
- Extract (page Library-TypeMappingExample.html): Related Artifacts depends-on FHIR model information http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1
|
| Security and privacy considerations | Presence of a section focused on security or privacy | True |
- Extract (page conformance.html): In the case that dynamic CQL construction is required, implementers should take care to sanitize inputs from any parameters used in the construction of dynamic CQL to avoid injection attacks.
- Extract (page Library-USCore-ModelInfo.html):
|