Add new EvaluationSettings for client timezone. Default to UTC if this is not set.

cqf-fhir-cql/src/main/java/org/opencds/cqf/fhir/cql/EvaluationSettings.java

@@ -1,7 +1,11 @@
 package org.opencds.cqf.fhir.cql;
 
+import jakarta.annotation.Nonnull;
+import java.time.ZoneId;
+import java.time.ZoneOffset;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
 import org.cqframework.cql.cql2elm.model.CompiledLibrary;
 import org.cqframework.cql.cql2elm.model.Model;
@@ -21,6 +25,7 @@ public class EvaluationSettings {
 
     private RetrieveSettings retrieveSettings;
     private TerminologySettings terminologySettings;
+    private ZoneId clientTimezone;
 
     public static EvaluationSettings getDefault() {
         EvaluationSettings settings = new EvaluationSettings();
@@ -83,8 +88,9 @@ public EvaluationSettings withCqlOptions(CqlOptions cqlOptions) {
         return this;
     }
 
-    public void setCqlOptions(CqlOptions cqlOptions) {
+    public EvaluationSettings setCqlOptions(CqlOptions cqlOptions) {
         this.cqlOptions = cqlOptions;
+        return this;
     }
 
     public RetrieveSettings getRetrieveSettings() {
@@ -109,7 +115,18 @@ public EvaluationSettings withTerminologySettings(TerminologySettings terminolog
         return this;
     }
 
-    public void setTerminologySettings(TerminologySettings terminologySettings) {
+    public EvaluationSettings setTerminologySettings(TerminologySettings terminologySettings) {
         this.terminologySettings = terminologySettings;
+        return this;
+    }
+
+    @Nonnull
+    public ZoneId getClientTimezone() {
+        return Optional.ofNullable(clientTimezone).orElse(ZoneOffset.UTC);
+    }
+
+    public EvaluationSettings setClientTimezone(ZoneId clientTimezone) {
+        this.clientTimezone = clientTimezone;
+        return this;
     }
 }

cqf-fhir-cr/src/main/java/org/opencds/cqf/fhir/cr/measure/MeasureEvaluationOptions.java

@@ -21,20 +21,23 @@ public boolean isValidationEnabled() {
         return this.isValidationEnabled;
     }
 
-    public void setValidationEnabled(boolean enableValidation) {
+    public MeasureEvaluationOptions setValidationEnabled(boolean enableValidation) {
         this.isValidationEnabled = enableValidation;
+        return this;
     }
 
     public Map<String, ValidationProfile> getValidationProfiles() {
         return validationProfiles;
     }
 
-    public void setValidationProfiles(Map<String, ValidationProfile> validationProfiles) {
+    public MeasureEvaluationOptions setValidationProfiles(Map<String, ValidationProfile> validationProfiles) {
         this.validationProfiles = validationProfiles;
+        return this;
     }
 
-    public void setEvaluationSettings(EvaluationSettings evaluationSettings) {
+    public MeasureEvaluationOptions setEvaluationSettings(EvaluationSettings evaluationSettings) {
         this.evaluationSettings = evaluationSettings;
+        return this;
     }
 
     public EvaluationSettings getEvaluationSettings() {

cqf-fhir-cr/src/main/java/org/opencds/cqf/fhir/cr/measure/dstu3/Dstu3MeasureProcessor.java

@@ -30,7 +30,7 @@
 import org.opencds.cqf.fhir.cr.measure.common.MeasureEvalType;
 import org.opencds.cqf.fhir.cr.measure.common.MeasureReportType;
 import org.opencds.cqf.fhir.cr.measure.common.SubjectProvider;
-import org.opencds.cqf.fhir.cr.measure.helper.DateHelper;
+import org.opencds.cqf.fhir.cr.measure.helper.IntervalHelper;
 import org.opencds.cqf.fhir.utility.repository.FederatedRepository;
 import org.opencds.cqf.fhir.utility.repository.InMemoryFhirRepository;
 
@@ -83,7 +83,10 @@ protected MeasureReport evaluateMeasure(
 
         Interval measurementPeriod = null;
         if (StringUtils.isNotBlank(periodStart) && StringUtils.isNotBlank(periodEnd)) {
-            measurementPeriod = this.buildMeasurementPeriod(periodStart, periodEnd);
+            measurementPeriod = IntervalHelper.buildMeasurementPeriod(
+                    periodStart,
+                    periodEnd,
+                    measureEvaluationOptions.getEvaluationSettings().getClientTimezone());
         }
 
         var reference = measure.getLibrary().get(0);
@@ -172,15 +175,6 @@ protected MeasureReportType evalTypeToReportType(MeasureEvalType measureEvalType
         }
     }
 
-    private Interval buildMeasurementPeriod(String periodStart, String periodEnd) {
-        // resolve the measurement period
-        return new Interval(
-                DateHelper.resolveRequestDate(periodStart, true),
-                true,
-                DateHelper.resolveRequestDate(periodEnd, false),
-                true);
-    }
-
     private Map<String, Object> resolveParameterMap(Parameters parameters) {
         Map<String, Object> parameterMap = new HashMap<>();
         Dstu3FhirModelResolver modelResolver = new Dstu3FhirModelResolver();

cqf-fhir-cr/src/main/java/org/opencds/cqf/fhir/cr/measure/helper/DateHelper.java

@@ -9,16 +9,18 @@
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.List;
+import java.util.Objects;
 import java.util.TimeZone;
 import org.opencds.cqf.cql.engine.runtime.DateTime;
 
 /**
  * Helper class to resolve measurement period start and end dates. If a timezone
  * is specified in a
- * datetime, it's used. If not the timezone of the local system is used.
+ * datetime, it's used. If not the timezone specified in the ZoneId parameter is used.
  */
 public class DateHelper {
-    public static DateTime resolveRequestDate(String date, boolean start) {
+    public static DateTime resolveRequestDate(String date, boolean start, ZoneId fallbackTimezone) {
+        Objects.requireNonNull(fallbackTimezone);
         // ISO Instance Format
         if (date.contains("Z")) {
             var offset = Instant.parse(date).atOffset(ZoneOffset.UTC);
@@ -35,15 +37,15 @@ public static DateTime resolveRequestDate(String date, boolean start) {
         // Local DateTime
         if (date.contains("T")) {
             var offset = LocalDateTime.parse(date, DateTimeFormatter.ISO_LOCAL_DATE_TIME)
-                    .atZone(ZoneId.systemDefault())
+                    .atZone(fallbackTimezone)
                     .toOffsetDateTime();
             return new DateTime(offset);
         }
 
-        return resolveDate(start, date);
+        return resolveDate(start, date, fallbackTimezone);
     }
 
-    private static DateTime resolveDate(boolean start, String dateString) {
+    private static DateTime resolveDate(boolean start, String dateString, ZoneId fallbackTimezone) {
         Calendar calendar = Calendar.getInstance();
         calendar.clear();
 
@@ -57,7 +59,7 @@ private static DateTime resolveDate(boolean start, String dateString) {
             throw new IllegalArgumentException("Invalid date");
         }
 
-        calendar.setTimeZone(TimeZone.getDefault());
+        calendar.setTimeZone(TimeZone.getTimeZone(fallbackTimezone));
 
         // Set year
         calendar.set(Calendar.YEAR, dateVals.get(0));
@@ -102,7 +104,7 @@ private static DateTime resolveDate(boolean start, String dateString) {
         }
 
         // TODO: Seems like we might want set the precision appropriately here?
-        var offset = calendar.toInstant().atZone(ZoneId.systemDefault()).toOffsetDateTime();
+        var offset = calendar.toInstant().atZone(fallbackTimezone).toOffsetDateTime();
         return new DateTime(offset);
     }
 }

cqf-fhir-cr/src/main/java/org/opencds/cqf/fhir/cr/measure/helper/IntervalHelper.java

@@ -0,0 +1,20 @@
+package org.opencds.cqf.fhir.cr.measure.helper;
+
+import java.time.ZoneId;
+import org.opencds.cqf.cql.engine.runtime.Interval;
+
+/**
+ * Helper class that leverages {@link DateHelper} to resolve measurement period start and end dates.
+ * If a timezone is specified in a datetime, it's used. If not the timezone specified in the ZoneId
+ * parameter is used..
+ */
+public class IntervalHelper {
+    public static Interval buildMeasurementPeriod(String periodStart, String periodEnd, ZoneId clientTimezone) {
+        // resolve the measurement period
+        return new Interval(
+                DateHelper.resolveRequestDate(periodStart, true, clientTimezone),
+                true,
+                DateHelper.resolveRequestDate(periodEnd, false, clientTimezone),
+                true);
+    }
+}

cqf-fhir-cr/src/main/java/org/opencds/cqf/fhir/cr/measure/r4/R4DataRequirementsService.java

@@ -48,7 +48,7 @@
 import org.opencds.cqf.fhir.cql.cql2elm.util.LibraryVersionSelector;
 import org.opencds.cqf.fhir.cql.engine.terminology.RepositoryTerminologyProvider;
 import org.opencds.cqf.fhir.cr.measure.MeasureEvaluationOptions;
-import org.opencds.cqf.fhir.cr.measure.helper.DateHelper;
+import org.opencds.cqf.fhir.cr.measure.helper.IntervalHelper;
 import org.opencds.cqf.fhir.cr.measure.helper.SubjectContext;
 import org.opencds.cqf.fhir.utility.Canonicals;
 import org.opencds.cqf.fhir.utility.Canonicals.CanonicalParts;
@@ -85,11 +85,10 @@ public Library dataRequirements(IdType measureId, String periodStart, String per
 
         Interval measurementPeriod;
         if (StringUtils.isNotBlank(periodStart) && StringUtils.isNotBlank(periodEnd)) {
-            measurementPeriod = new Interval(
-                    DateHelper.resolveRequestDate(periodStart, true),
-                    true,
-                    DateHelper.resolveRequestDate(periodEnd, false),
-                    true);
+            measurementPeriod = IntervalHelper.buildMeasurementPeriod(
+                    periodStart,
+                    periodEnd,
+                    measureEvaluationOptions.getEvaluationSettings().getClientTimezone());
             parameters.put("MeasurementPeriod", measurementPeriod);
 
             return processDataRequirements(measure, library, parameters);

cqf-fhir-cr/src/main/java/org/opencds/cqf/fhir/cr/measure/r4/R4MeasureProcessor.java

@@ -110,7 +110,10 @@ protected MeasureReport evaluateMeasure(
         Interval measurementPeriod = null;
         if (StringUtils.isNotBlank(periodStart) && StringUtils.isNotBlank(periodEnd)) {
             var helper = new R4DateHelper();
-            measurementPeriod = helper.buildMeasurementPeriodInterval(periodStart, periodEnd);
+            measurementPeriod = helper.buildMeasurementPeriodInterval(
+                    periodStart,
+                    periodEnd,
+                    measureEvaluationOptions.getEvaluationSettings().getClientTimezone());
         }
 
         var url = measure.getLibrary().get(0).asStringValue();

cqf-fhir-cr/src/main/java/org/opencds/cqf/fhir/cr/measure/r4/utils/R4DateHelper.java

@@ -1,24 +1,21 @@
 package org.opencds.cqf.fhir.cr.measure.r4.utils;
 
+import java.time.ZoneId;
 import org.hl7.fhir.r4.model.Period;
 import org.opencds.cqf.cql.engine.runtime.Date;
 import org.opencds.cqf.cql.engine.runtime.DateTime;
 import org.opencds.cqf.cql.engine.runtime.Interval;
-import org.opencds.cqf.fhir.cr.measure.helper.DateHelper;
+import org.opencds.cqf.fhir.cr.measure.helper.IntervalHelper;
 
 public class R4DateHelper {
 
-    public Interval buildMeasurementPeriodInterval(String periodStart, String periodEnd) {
+    public Interval buildMeasurementPeriodInterval(String periodStart, String periodEnd, ZoneId timezone) {
         // resolve the measurement period
-        return new Interval(
-                DateHelper.resolveRequestDate(periodStart, true),
-                true,
-                DateHelper.resolveRequestDate(periodEnd, false),
-                true);
+        return IntervalHelper.buildMeasurementPeriod(periodStart, periodEnd, timezone);
     }
 
-    public Period buildMeasurementPeriod(String periodStart, String periodEnd) {
-        Interval measurementPeriod = buildMeasurementPeriodInterval(periodStart, periodEnd);
+    public Period buildMeasurementPeriod(String periodStart, String periodEnd, ZoneId timezone) {
+        Interval measurementPeriod = buildMeasurementPeriodInterval(periodStart, periodEnd, timezone);
         return buildMeasurementPeriod(measurementPeriod);
     }