Add support for registering namespaces with the LibraryManager used by the CQL engine

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

@@ -94,6 +94,11 @@ private static Environment buildEnvironment(
                 .getNamespaceManager()
                 .ensureNamespaceRegistered(new NamespaceInfo("hl7.fhir.us.cql", "http://hl7.org/fhir/us/cql"));
 
+        // Register any namespaces added to the settings
+        settings.getRegisteredNamespaces()
+                .forEach((name, uri) ->
+                        libraryManager.getNamespaceManager().ensureNamespaceRegistered(new NamespaceInfo(name, uri)));
+
         return new Environment(libraryManager, dataProviders, terminologyProvider);
     }
 

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

@@ -20,6 +20,7 @@
     private Map<VersionedIdentifier, CompiledLibrary> libraryCache;
     private Map<String, List<Code>> valueSetCache;
     private List<LibrarySourceProvider> librarySourceProviders;
+    private Map<String, String> registeredNamespaces;
 
     private CqlOptions cqlOptions;
 
@@ -40,11 +41,12 @@
         this.retrieveSettings = new RetrieveSettings();
         this.terminologySettings = new TerminologySettings();
         this.npmProcessor = null;
+        this.registeredNamespaces = new ConcurrentHashMap<>();
     }
 
     /**
      * Copy constructor for EvaluationSettings
-     * @param settings
+     * @param settings The EvaluationSettings being copied
      */
     public EvaluationSettings(EvaluationSettings settings) {
         this.modelCache = new ConcurrentHashMap<>(settings.modelCache);
@@ -56,6 +58,7 @@
         this.librarySourceProviders = new ArrayList<>(settings.librarySourceProviders);
         this.npmProcessor =
                 settings.npmProcessor != null ? new NpmProcessor(settings.npmProcessor.getIgContext()) : null;
+        this.registeredNamespaces = new ConcurrentHashMap<>(settings.registeredNamespaces);
     }
 
     public Map<ModelIdentifier, Model> getModelCache() {
@@ -161,4 +164,28 @@
         setNpmProcessor(npmProcessor);
         return this;
     }
+
+    /***
+     * Returns a map of the registered namespaces with the key being the name and the value being the uri of the namespace
+     * @return The map of registered namespaces
+     */
+    public Map<String, String> getRegisteredNamespaces() {
+        return registeredNamespaces;
+    }
+
+    public void setRegisteredNamespaces(Map<String, String> namespaces) {
+        this.registeredNamespaces = new ConcurrentHashMap<>(namespaces);
+    }
+
+    public EvaluationSettings withRegisteredNamespaces(Map<String, String> namespaces) {
+        setRegisteredNamespaces(namespaces);
+        return this;
+    }
+
+    public EvaluationSettings addRegisteredNamespace(String name, String uri) {
+        if (!registeredNamespaces.containsKey(name)) {
+            registeredNamespaces.put(name, uri);
+        }
+        return this;
+    }
 }

cqf-fhir-cql/src/test/java/org/opencds/cqf/fhir/cql/EnginesTest.java

@@ -27,6 +27,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 import org.cqframework.cql.cql2elm.StringLibrarySourceProvider;
@@ -377,6 +378,31 @@ void getCqlFhirParametersConverter() {
         assertNotNull(Engines.getCqlFhirParametersConverter(FhirContext.forR4Cached()));
     }
 
+    @Test
+    void additionalNamespacesRegistered() {
+        var name = "com.organization.common";
+        var uri = "http://com.organization.common";
+        var namespaces = new ConcurrentHashMap<String, String>();
+        namespaces.put(name, uri);
+        var settings = new EvaluationSettings().withRegisteredNamespaces(namespaces);
+        var name2 = "com.smiledigitalhealth.greatreef";
+        var uri2 = "http://smile.org/greatreef";
+        settings.addRegisteredNamespace(name2, uri2);
+        var engine = getEngine(settings);
+        assertEquals(
+                uri,
+                engine.getEnvironment()
+                        .getLibraryManager()
+                        .getNamespaceManager()
+                        .resolveNamespaceUri(name));
+        assertEquals(
+                uri2,
+                engine.getEnvironment()
+                        .getLibraryManager()
+                        .getNamespaceManager()
+                        .resolveNamespaceUri(name2));
+    }
+
     /**
      * All created resources must have an SP that identifies
      * a field that *does not have* a date value between 2000-01-01 and 2000-12-31 eod
@@ -519,7 +545,7 @@ static List<Arguments> successfulParameters() {
 
     @ParameterizedTest
     @MethodSource("successfulParameters")
-    public void retrieve_withValidDatesInRange_succeeds(IBaseResource resource, String spName) {
+    void retrieve_withValidDatesInRange_succeeds(IBaseResource resource, String spName) {
         // test
         var results = retrieveResourcesWithin2000BySPName(resource, spName);
 
@@ -532,7 +558,7 @@ public void retrieve_withValidDatesInRange_succeeds(IBaseResource resource, Stri
 
     @ParameterizedTest
     @MethodSource("failureParameters")
-    public void retrieve_withValidDatesOutOfRange_failToRetrieve(IBaseResource resource, String spName) {
+    void retrieve_withValidDatesOutOfRange_failToRetrieve(IBaseResource resource, String spName) {
         // setup
         IParser parser = repository.fhirContext().newJsonParser();
 
@@ -574,7 +600,7 @@ private Iterable<Object> retrieveResourcesWithin2000BySPName(IBaseResource resou
         var dateRange = new Interval(start, true, end, true);
 
         // Retrieve resources with period overlapping 2000
-        var results = dataProvider.retrieve(
+        return dataProvider.retrieve(
                 resourceType, // context
                 null, // contextPath
                 "pat1", // contextValue
@@ -588,12 +614,10 @@ private Iterable<Object> retrieveResourcesWithin2000BySPName(IBaseResource resou
                 "period.end", // dateHighPath
                 dateRange // dateRange
                 );
-
-        return results;
     }
 
     @Test
-    public void dateFiltering() {
+    void dateFiltering() {
         // setup
         RetrieveSettings retrieveSettings = new RetrieveSettings();
         retrieveSettings.setSearchParameterMode(SEARCH_FILTER_MODE.FILTER_IN_MEMORY);