CQL v5

Src/java/elm-fhir/src/main/kotlin/org/cqframework/cql/elm/evaluation/ElmEvaluationHelper.kt

@@ -7,15 +7,16 @@ import org.hl7.elm.r1.Expression
 import org.hl7.elm.r1.Library
 import org.opencds.cqf.cql.engine.execution.CqlEngine
 import org.opencds.cqf.cql.engine.execution.Environment
+import org.opencds.cqf.cql.engine.runtime.Value
 
 object ElmEvaluationHelper {
     @JvmStatic
     fun evaluate(
         library: Library?,
         value: Expression?,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
         evaluationDateTime: ZonedDateTime?,
-    ): Any? {
+    ): Value? {
         // NOTE: Consider caching for libraries in the future.
 
         val engine = getEngine(library, parameters, evaluationDateTime)
@@ -24,7 +25,7 @@ object ElmEvaluationHelper {
 
     private fun getEngine(
         library: Library?,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
         evaluationDateTime: ZonedDateTime?,
     ): CqlEngine {
         val environment = Environment(libraryManager)

Src/java/elm-fhir/src/main/kotlin/org/cqframework/cql/elm/requirements/ElmRequirementsContext.kt

@@ -44,19 +44,20 @@ import org.hl7.elm.r1.UsingDef
 import org.hl7.elm.r1.ValueSetDef
 import org.hl7.elm.r1.ValueSetRef
 import org.hl7.elm.r1.VersionedIdentifier
+import org.opencds.cqf.cql.engine.runtime.Value
 
 class ElmRequirementsContext(
     libraryManager: LibraryManager,
     options: CqlCompilerOptions?,
     visitor: ElmRequirementsVisitor,
-    parameters: MutableMap<String, Any?>?,
+    parameters: MutableMap<String, Value?>?,
     evaluationDateTime: ZonedDateTime?,
 ) {
     var options: CqlCompilerOptions?
 
     val libraryManager: LibraryManager
 
-    val parameters: MutableMap<String, Any?>?
+    val parameters: MutableMap<String, Value?>?
 
     val evaluationDateTime: ZonedDateTime?
 

Src/java/elm-fhir/src/main/kotlin/org/cqframework/cql/elm/requirements/fhir/DataRequirementsProcessor.kt

@@ -3,7 +3,6 @@ package org.cqframework.cql.elm.requirements.fhir
 import ca.uhn.fhir.context.FhirVersionEnum
 import java.time.ZonedDateTime
 import java.util.concurrent.atomic.AtomicBoolean
-import kotlin.Any
 import kotlin.Boolean
 import kotlin.Exception
 import kotlin.IllegalArgumentException
@@ -88,6 +87,7 @@ import org.hl7.fhir.r5.model.RelatedArtifact
 import org.hl7.fhir.r5.model.StringType
 import org.hl7.fhir.utilities.validation.ValidationMessage
 import org.opencds.cqf.cql.engine.fhir.converter.FhirTypeConverterFactory
+import org.opencds.cqf.cql.engine.runtime.Value
 
 @Suppress("MaxLineLength", "ReturnCount", "ForbiddenComment", "NestedBlockDepth", "UnusedParameter")
 class DataRequirementsProcessor {
@@ -127,7 +127,7 @@ class DataRequirementsProcessor {
         translatedLibrary: CompiledLibrary,
         options: CqlCompilerOptions,
         expressions: Set<String>?,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
         includeLogicDefinitions: Boolean,
         recursive: Boolean,
     ): Library {
@@ -169,7 +169,7 @@ class DataRequirementsProcessor {
         translatedLibrary: CompiledLibrary,
         options: CqlCompilerOptions,
         expressions: Set<String>?,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
         evaluationDateTime: ZonedDateTime?,
         includeLogicDefinitions: Boolean,
         recursive: Boolean,
@@ -400,7 +400,7 @@ class DataRequirementsProcessor {
         requirements: ElmRequirements,
         libraryIdentifier: VersionedIdentifier,
         expressionDefs: Iterable<ExpressionDef?>,
-        parameters: Map<String, Any?>?,
+        parameters: Map<String, Value?>?,
         evaluationDateTime: ZonedDateTime?,
         includeLogicDefinitions: Boolean,
     ): Library {

Src/java/elm-fhir/src/main/kotlin/org/cqframework/cql/elm/requirements/fhir/utilities/constants/CqfConstants.kt

@@ -1,12 +1,12 @@
 package org.cqframework.cql.elm.requirements.fhir.utilities.constants
 
 object CqfConstants {
-    const val DIRECT_REF_CODE_EXT_URL: String =
+    const val DIRECT_REF_CODE_EXT_URL =
         "http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode"
-    const val LOGIC_DEFINITION_EXT_URL: String =
+    const val LOGIC_DEFINITION_EXT_URL =
         "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
-    const val RELATED_REQUIREMENT_EXT_URL: String =
+    const val RELATED_REQUIREMENT_EXT_URL =
         "http://hl7.org/fhir/StructureDefinition/cqf-relatedRequirement"
-    const val PERTINENCE_EXT_URL: String = "http://hl7.org/fhir/StructureDefinition/cqf-pertinence"
-    const val CQF_TOOLING_DEVICE_NAME: String = "cqf-tooling"
+    const val PERTINENCE_EXT_URL = "http://hl7.org/fhir/StructureDefinition/cqf-pertinence"
+    const val CQF_TOOLING_DEVICE_NAME = "cqf-tooling"
 }

Src/java/elm-fhir/src/main/kotlin/org/cqframework/cql/elm/requirements/fhir/utilities/constants/CqfmConstants.kt

@@ -3,22 +3,22 @@ package org.cqframework.cql.elm.requirements.fhir.utilities.constants
 // constants defined in the Quality Measures IG: http://hl7.org/fhir/us/cqfmeasures
 object CqfmConstants {
     // Extensions
-    const val PARAMETERS_EXT_URL: String =
+    const val PARAMETERS_EXT_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-parameter"
-    const val DATA_REQUIREMENT_EXT_URL: String =
+    const val DATA_REQUIREMENT_EXT_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-dataRequirement"
-    const val RELATED_REQUIREMENT_EXT_URL: String =
+    const val RELATED_REQUIREMENT_EXT_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-relatedRequirement"
-    const val DIRECT_REF_CODE_EXT_URL: String =
+    const val DIRECT_REF_CODE_EXT_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-directReferenceCode"
-    const val LOGIC_DEFINITION_EXT_URL: String =
+    const val LOGIC_DEFINITION_EXT_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-logicDefinition"
-    const val PERTINENCE_EXT_URL: String =
+    const val PERTINENCE_EXT_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-pertinence"
-    const val EFFECTIVE_DATA_REQS_EXT_URL: String =
+    const val EFFECTIVE_DATA_REQS_EXT_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-effectiveDataRequirements"
 
     // Profiles
-    const val COMPUTABLE_MEASURE_PROFILE_URL: String =
+    const val COMPUTABLE_MEASURE_PROFILE_URL =
         "http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/computable-measure-cqfm"
 }

Src/java/elm-fhir/src/main/kotlin/org/cqframework/cql/elm/requirements/fhir/utilities/constants/CrmiConstants.kt

@@ -1,14 +1,14 @@
 package org.cqframework.cql.elm.requirements.fhir.utilities.constants
 
 object CrmiConstants {
-    const val EFFECTIVE_DATA_REQUIREMENTS_EXT_URL: String =
+    const val EFFECTIVE_DATA_REQUIREMENTS_EXT_URL =
         "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-effectiveDataRequirements"
-    const val EFFECTIVE_DATA_REQUIREMENTS_IDENTIFIER: String = "effective-data-requirements"
+    const val EFFECTIVE_DATA_REQUIREMENTS_IDENTIFIER = "effective-data-requirements"
 
-    const val SOFTWARE_SYSTEM_EXT_URL: String =
+    const val SOFTWARE_SYSTEM_EXT_URL =
         "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystem"
-    const val SOFTWARE_SYSTEM_DEVICE_PROFILE_URL: String =
+    const val SOFTWARE_SYSTEM_DEVICE_PROFILE_URL =
         "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-softwaresystemdevice"
-    const val SOFTWARE_SYSTEM_DEVICE_TYPE_SYSTEM_URL: String =
+    const val SOFTWARE_SYSTEM_DEVICE_TYPE_SYSTEM_URL =
         "http://terminology.hl7.org/CodeSystem/software-system-type"
 }

Src/java/elm-fhir/src/test/kotlin/org/cqframework/cql/elm/requirements/fhir/DataRequirementsProcessorTest.kt

@@ -46,6 +46,7 @@ import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Test
+import org.opencds.cqf.cql.engine.runtime.Value
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 
@@ -1069,7 +1070,7 @@ class DataRequirementsProcessorTest {
     private fun getModuleDefinitionLibrary(
         setup: Setup,
         cqlTranslatorOptions: CqlCompilerOptions,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
     ): Library {
         val dqReqTrans = DataRequirementsProcessor()
         val moduleDefinitionLibrary =
@@ -1094,7 +1095,7 @@ class DataRequirementsProcessorTest {
     private fun getModuleDefinitionLibrary(
         setup: Setup,
         cqlTranslatorOptions: CqlCompilerOptions,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
         evaluationDateTime: ZonedDateTime?,
     ): Library {
         val dqReqTrans = DataRequirementsProcessor()
@@ -1122,7 +1123,7 @@ class DataRequirementsProcessorTest {
     private fun getModuleDefinitionLibrary(
         setup: Setup,
         cqlTranslatorOptions: CqlCompilerOptions,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
         evaluationDateTime: ZonedDateTime?,
         includeLogicDefinitions: Boolean,
     ): Library {
@@ -1151,7 +1152,7 @@ class DataRequirementsProcessorTest {
     private fun getModuleDefinitionLibrary(
         setup: Setup,
         cqlTranslatorOptions: CqlCompilerOptions,
-        parameters: MutableMap<String, Any?>?,
+        parameters: MutableMap<String, Value?>?,
         evaluationDateTime: ZonedDateTime?,
         includeLogicDefinitions: Boolean,
         recursive: Boolean,

Src/java/engine-fhir/README.md

@@ -0,0 +1,16 @@
+# engine-fhir
+
+This module contains the implementation of the FHIR model resolvers and retrieve providers for the CQL engine, based on the HAPI FHIR library.
+
+
+## Converting from HAPI FHIR structures to engine value types
+
+The `FhirModelResolver.toCqlValue()` helper method converts HAPI FHIR structures (resources and individual elements) to appropriate `ClassInstance`s, which can then be used as inputs to the engine. Given a FHIR structure, the method:
+
+- walks all child elements of the FHIR structure (using introspection methods and reflections on HAPI FHIR classes) and adds an entry for every child in the named tuple being built,
+- checks max cardinality to determine if a CQL list or a singleton to use as the value,
+- if the child FHIR element has no values, sets the element value to `null` in the tuple.
+
+In general, the least nested structure is chosen for the value of an element, e.g.:
+- when the element is List-typed but has no values, `null` is chosen instead of an empty list
+- when an element is FHIR primitive-typed (e.g. `FHIR.string` or `FHIR.code`-typed) and does not have value/id/extensions, `null` is chosen instead of a blank structure like `FHIR.string { id: null, extension: null, value: null }`