Common CQL Artifacts for FHIR (US-Based)
1.0.0-ballot - STU 1 Ballot
Common CQL Artifacts for FHIR (US-Based), published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/us-cql-ig/ and changes regularly. See the Directory of published versions
Page standards status: Informative |
US Core defines US Core Laboratory Result Observation to record laboratory observations.
Observation codes will be LOINC. Result values will generally be represented in different ways, according to the type of lab result. The LOINC code itself will often describe the expected representation of possible values for a given observation or test result.
The Observation resource defines the following modifier elements:
In addition to being a modifier, this element is required with a required binding. The USCoreCommon library defines several functions for determining the status of an observation, as discussed in the Status section below.
USCore defines the following mandatory search parameters:
In addition, the following optional search parameters are described:
NOTE: For discussion on how to manage search parameters with terminology, see the Terminology Considerations discussion in the Architectural Guidance topic.
NOTE: For discussion on how to manage optional search parameters, see the Performant Data Access discussion in the Architectural Guidance topic.
Generally, new versions of USCore since 3.1.1 have introduced additional profiles, but have not impacted representation of existing profiles. As of 7.0.0, there are generally:
The USCoreCommon library defines functions and terminology declarations to support determining status of an observation:
isResulted()
: returns true if the status is final
, amended
, or corrected
isFinal()
isAmended()
isCorrected()
In addition, the USCoreElements library defines expressions for accessing the various USCore profiles, such as:
"All Laboratory Results"
"Resulted Laboratory Results"
"Pediatric BMI for Age"
In general, the expressions to retrieve observations for a particular profile include the .resulted()
function to ensure only final, amended, or corrected observations are returned.
NOTE: Content for this page was adapted from the QICore Authoring Patterns - Laboratory Result topic.