Merge pull request #984 from FirelyTeam/feature/972/973-add-cql-packager-support-for-config-profiles

Feature/972/973 add cql packager support for config profiles

Author: baseTwo

Cql-Sdk-All.sln

@@ -144,6 +144,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CqlSdkExamples", "Examples\
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CqlSdkExamplesPreview", "Examples\CqlSdkExamplesPreview\CqlSdkExamplesPreview.csproj", "{A1234567-89AB-CDEF-1234-567890ABCDEF}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Measures.ecqm-content-cms-2025", "Demo\Measures.ecqm-content-cms-2025\Measures.ecqm-content-cms-2025.csproj", "{4125CA3B-A8E7-23C9-4E7B-DAA8D5226E9E}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Measures.ecqm-content-qicore-2025", "Demo\Measures.ecqm-content-qicore-2025\Measures.ecqm-content-qicore-2025.csproj", "{32AF150E-FA7A-DACF-B262-49754A42D628}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -270,6 +274,14 @@ Global
 		{A1234567-89AB-CDEF-1234-567890ABCDEF}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A1234567-89AB-CDEF-1234-567890ABCDEF}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{A1234567-89AB-CDEF-1234-567890ABCDEF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4125CA3B-A8E7-23C9-4E7B-DAA8D5226E9E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4125CA3B-A8E7-23C9-4E7B-DAA8D5226E9E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4125CA3B-A8E7-23C9-4E7B-DAA8D5226E9E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4125CA3B-A8E7-23C9-4E7B-DAA8D5226E9E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{32AF150E-FA7A-DACF-B262-49754A42D628}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{32AF150E-FA7A-DACF-B262-49754A42D628}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{32AF150E-FA7A-DACF-B262-49754A42D628}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{32AF150E-FA7A-DACF-B262-49754A42D628}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -316,6 +328,8 @@ Global
 		{BAEF695A-5581-B3EE-B352-CBF447240E55} = {1AF2E4B2-99C5-4678-B926-D224CC83A8F7}
 		{93532653-75AF-025F-00F7-1B34C75DF1C1} = {14ED22C5-F918-42DB-A301-04B3AED51EBC}
 		{A1234567-89AB-CDEF-1234-567890ABCDEF} = {14ED22C5-F918-42DB-A301-04B3AED51EBC}
+		{4125CA3B-A8E7-23C9-4E7B-DAA8D5226E9E} = {85401759-2C64-414D-9882-4DB1EA41C2ED}
+		{32AF150E-FA7A-DACF-B262-49754A42D628} = {85401759-2C64-414D-9882-4DB1EA41C2ED}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {366252DE-C2FB-4EAC-96EE-22210BD43DE2}

Cql-Sdk-Demos-Examples.slnf

@@ -22,8 +22,10 @@
       "Demo\\CLI\\CLI.csproj",
       "Demo\\Cql\\Cql.csproj",
       "Demo\\Measures.Authoring\\Measures.Authoring.csproj",
-      "Demo\\Measures.ecqm-content-qicore-2024\\Measures.ecqm-content-qicore-2024.csproj",
       "Demo\\Measures.Demo\\Measures.Demo.csproj",
+      "Demo\\Measures.ecqm-content-cms-2025\\Measures.ecqm-content-cms-2025.csproj",
+      "Demo\\Measures.ecqm-content-qicore-2024\\Measures.ecqm-content-qicore-2024.csproj",
+      "Demo\\Measures.ecqm-content-qicore-2025\\Measures.ecqm-content-qicore-2025.csproj",
       "Demo\\Test.Measures.Demo\\Test.Measures.Demo.csproj",
       "Examples\\CqlSdkExamplesPreview\\CqlSdkExamplesPreview.csproj",
       "Examples\\CqlSdkExamples\\CqlSdkExamples.csproj"

Cql/PackagerCLI/Commands.CqlToFhir/CqlToFhirProgram.cs

@@ -10,6 +10,7 @@
 using Hl7.Cql.CodeGeneration.NET.Toolkit.Extensions;
 using Hl7.Cql.CqlToElm.Toolkit;
 using Hl7.Cql.CqlToElm.Toolkit.Extensions;
+using Hl7.Cql.Packager.Commands.Global;
 using Hl7.Cql.Packager.Commands.Logging;
 using Hl7.Cql.Packager.Options;
 using Hl7.Cql.Packaging.Toolkit;
@@ -32,10 +33,12 @@ public class CqlToFhirProgram
     public static int CommandHandler(
         IConsole console,
         LoggingCommand loggingCommand,
+        GlobalCommand globalCommand,
         CqlToFhirCommand cqlToFhirCommand) =>
         RunProgram<CqlToFhirProgram>(
             console,
             loggingCommand,
+            globalCommand,
             cqlToFhirCommand.GetConfigMapping,
             (_, services) =>
                 services.AddAndBindOptions<CqlToFhirOptions>());

Cql/PackagerCLI/Commands.ElmToFhir/ElmToFhirProgram.cs

@@ -10,6 +10,7 @@
 using Hl7.Cql.CodeGeneration.NET.Toolkit.Extensions;
 using Hl7.Cql.CqlToElm.Toolkit;
 using Hl7.Cql.CqlToElm.Toolkit.Extensions;
+using Hl7.Cql.Packager.Commands.Global;
 using Hl7.Cql.Packager.Commands.Logging;
 using Hl7.Cql.Packager.Options;
 using Hl7.Cql.Packaging.Toolkit;
@@ -152,10 +153,12 @@ public int Run()
     internal static int CommandHandler(
         IConsole console,
         LoggingCommand loggingCommand,
+        GlobalCommand globalCommand,
         ElmToFhirCommand elmToFhirCommand) =>
         RunProgram<ElmToFhirProgram>(
             console,
             loggingCommand,
+            globalCommand,
             elmToFhirCommand.GetConfigMapping,
             (_, services) =>
                 services.AddAndBindOptions<ElmToFhirOptions>());

Cql/PackagerCLI/Commands.Global/GlobalCommand.cs

@@ -0,0 +1,31 @@
+/*
+ * Copyright(c) 2025, Firely, NCQA and contributors
+ * See the file CONTRIBUTORS for details.
+ *
+ * This file is licensed under the BSD 3-Clause license
+ * available at https://raw.githubusercontent.com/FirelyTeam/firely-cql-sdk/main/LICENSE
+ */
+
+namespace Hl7.Cql.Packager.Commands.Global;
+
+[UsedImplicitly]
+public sealed record GlobalCommand(string? Profile)
+{
+    public static readonly Option[] Options =
+        [
+            Option<string?>(
+                "--profile",
+                """
+                The name of the profile to use from the configuration file. e.g. {App}.{Profile}.appsettings.json.
+                This can be used to load different profiles, for example a name of a library set.
+                """
+            )
+        ];
+
+    public string Profile { get; init; } = CalcProfile(Profile);
+
+    private static string CalcProfile(string? profile) =>
+        profile
+        ?? Environment.GetEnvironmentVariable($"{PackagerCliServiceCollectionExtensions.EnvironmentVariablePrefix}_PROFILE")
+        ?? "";
+}

Cql/PackagerCLI/DependencyInjection/PackagerCliServiceCollectionExtensions.cs

@@ -6,6 +6,7 @@
  * available at https://raw.githubusercontent.com/FirelyTeam/firely-cql-sdk/main/LICENSE
  */
 
+using System.Collections;
 using Hl7.Cql.Packager;
 using Hl7.Cql.Packager.Commands.Logging;
 using Hl7.Cql.Packager.Options;
@@ -17,6 +18,8 @@ namespace Microsoft.Extensions.DependencyInjection;
 
 internal static class PackagerCliServiceCollectionExtensions
 {
+    public const string? EnvironmentVariablePrefix = "CQLPACKAGE";
+
     public static IServiceCollection AddPackagerCliOptions(
         this IServiceCollection services) =>
         services.AddAndBindOptions<CqlOptions>()
@@ -26,6 +29,7 @@ public static IServiceCollection AddPackagerCliOptions(
 
     public static IConfigurationBuilder AddPackagerCliAppSettings(
         this IConfigurationBuilder config,
+        string profile,
         Func<IEnumerable<(object? value, string[] sectionPath)>>? additionalConfiguration = null)
     {
         var buildConfiguration = typeof(Program).Assembly.GetCustomAttribute<AssemblyConfigurationAttribute>()?.Configuration?.ToLowerInvariant();
@@ -36,15 +40,24 @@ public static IConfigurationBuilder AddPackagerCliAppSettings(
         var asmDirName = asmFileInfo.DirectoryName!;
         var asmFileNameNoExt = asmFileInfo.Name[..^4]; // Trim ".dll"
 
-        config.AddEnvironmentVariables("CQLPACKAGE");
+        config.AddEnvironmentVariables(EnvironmentVariablePrefix);
 
         IEnumerable<string> files =
         [
             Path.Combine(asmDirName, $"{asmFileNameNoExt}.appsettings.json"),
             Path.Combine(curDirName, $"{asmFileNameNoExt}.appsettings.json"),
             Path.Combine(asmDirName, $"{asmFileNameNoExt}.appsettings.{buildConfiguration}.json"),
-            Path.Combine(curDirName, $"{asmFileNameNoExt}.appsettings.{buildConfiguration}.json")
+            Path.Combine(curDirName, $"{asmFileNameNoExt}.appsettings.{buildConfiguration}.json"),
         ];
+
+        if (profile.Trim() is { Length: > 0 } p)
+        {
+            files = files.Concat(
+                [
+                    Path.Combine(asmDirName, $"{asmFileNameNoExt}.{p}.appsettings.json"),
+                    Path.Combine(curDirName, $"{asmFileNameNoExt}.{p}.appsettings.json")
+                ]);
+        }
         files = files.Distinct();
         foreach (var file in files)
             config.AddJsonFile(file, optional: true, reloadOnChange: false);
@@ -54,7 +67,7 @@ public static IConfigurationBuilder AddPackagerCliAppSettings(
             ?.Invoke()
             .Where(ad => ad.value is not null)
             .Select(KeyValuePair!)
-            .ToArray() is { } additionalData)
+            .ToArray() is { Length: >= 0 } additionalData)
             config.Sources.Add(new MemoryConfigurationSource { InitialData = additionalData });
 
         return config;

Cql/PackagerCLI/GlobalMethods.cs

@@ -6,6 +6,7 @@
  * available at https://raw.githubusercontent.com/FirelyTeam/firely-cql-sdk/main/LICENSE
  */
 
+using Hl7.Cql.Packager.Commands.Global;
 using Hl7.Cql.Packager.Commands.Logging;
 using Hl7.Cql.Packager.Options;
 
@@ -17,36 +18,39 @@ internal static class GlobalMethods
 
     private static IHostBuilder CreateHostBuilder(
         IConsole console,
+        string profile,
         Func<IEnumerable<(object? value, string[] sectionPath)>>? additionalConfiguration = null) =>
         Host.CreateDefaultBuilder()
-            .ConfigureAppConfiguration(
-                (context, config) =>
-                    config.AddPackagerCliAppSettings(additionalConfiguration))
-            .ConfigureLogging(
-                (context, logging) =>
-                    logging.AddPackagerCLiLogging(context.Configuration))
-            .ConfigureServices(
-                (context, services) =>
-                    services
-                        .AddPackagerCliOptions()
-                        .AddSingleton<OptionsConsoleDumper>()
-                        .AddSingleton<PdbOptionsValidator>()
-                        .AddSingleton(console))
+            .ConfigureAppConfiguration((context, config) => config.AddPackagerCliAppSettings(profile, additionalConfiguration))
+            .ConfigureLogging((context, logging) => logging.AddPackagerCLiLogging(context.Configuration))
+            .ConfigureServices((context, services) =>
+                                   services
+                                       .AddPackagerCliOptions()
+                                       .AddSingleton<OptionsConsoleDumper>()
+                                       .AddSingleton<PdbOptionsValidator>()
+                                       .AddSingleton(console))
             .UseConsoleLifetime();
 
     internal static int RunProgram<TProgram>(
         IConsole console,
         LoggingCommand loggingCommand,
+        GlobalCommand globalCommand,
         Func<IEnumerable<(object? value, string[] sectionPath)>>? additionalConfiguration = null,
         Action<HostBuilderContext, IServiceCollection>? configureAdditionalServices = null)
         where TProgram : class, IProgram =>
-        CreateHostBuilder(console, () =>
-            {
-                var loggingConfig = loggingCommand.GetConfigMapping();
-                if (additionalConfiguration?.Invoke() is {} additionalConfig)
-                    loggingConfig = loggingConfig.Concat(additionalConfig);
-                return loggingConfig;
-            })
-          .ConfigureServices(configureAdditionalServices ?? delegate { })
-          .RunProgram<TProgram>();
+        CreateHostBuilder(
+                console,
+                globalCommand.Profile,
+                () =>
+                {
+                    IEnumerable<(object? value, string[] sectionPath)> config = [];
+                    config = config.Concat(loggingCommand.GetConfigMapping());
+
+                    if (additionalConfiguration?.Invoke() is { } additionalConfig)
+                        config = config.Concat(additionalConfig);
+
+                    return config;
+                })
+            .ConfigureServices(configureAdditionalServices ?? delegate { })
+            .RunProgram<TProgram>();
 }

Cql/PackagerCLI/Hl7.Cql.Packager.Demo.appsettings.json

@@ -0,0 +1,6 @@
+{
+  "Elm": {
+    "SkipFiles": [
+    ]
+  }
+}

Cql/PackagerCLI/Hl7.Cql.Packager.appsettings.json

@@ -23,40 +23,8 @@
     "JsonPretty": false, // --json-pretty
     "DebugSymbolsFormat": "None", // --debug-symbols : "None", "PortablePdb", "Embedded"
     "SkipFiles": [
-
-      // These contain a union between incompatible tuples,
-      // see https://chat.fhir.org/#narrow/stream/179220-cql/topic/Union.20of.20tuples.20with.20convertible.20types
-      "AntithromboticTherapyByEndofHospitalDay2FHIR.json",
-      "CMS72FHIRSTKAntithromboticDay2.json",
-
-      "IntensiveCareUnitVenousThromboembolismProphylaxisFHIR.json",
-      "CMS190VTEProphylaxisICUFHIR.json",
-
-
-      "VenousThromboembolismProphylaxisFHIR.json",
-      "CMS108VTEProphylaxisFHIR.json",
-      "CMS108FHIRVTEProphylaxis.json",
-
-      // These uses choice types, move into a property on such a choice, and then calls an
-      // overloaded function, so we cannot find out which overload to call.
-      // A solution is to either a) Introduce choice types in our system instead of object,
-      // b) introduce runtime resolution, based on the runtime types of the arguments when one of
-      // the arguments is a choice (=object).
-      "InitiationandEngagementofSubstanceUseDisorderTreatmentFHIR.json",
-      "CMS506FHIRSafeUseofOpioids.json",
-
-      "PCSBMIScreenAndFollowUpFHIR.json",
-      "CMS69FHIRPCSBMIScreenAndFollowUp",
-
-      // Tuple element value does not have a resultTypeSpecifier
-      "CADBetaBlockerTherapyPriorMIorLVSDFHIR.json",
-
-      "PCSDepressionScreenAndFollowUpFHIR.json",
-      "CMS2FHIRPCSDepressionScreenAndFollowUp.json",
-
-      // Multiple sort fields not supported yet
-      "HospitalHarmAcuteKidneyInjuryFHIR.json",
-      "CMS832HHAKIFHIR.json"
+      // JSON Files that are skipped during the packaging process.
+      // See the specific profile appsettings e.g. Hl7.Cql.Packager.appsettings.CMSMeasures.json
     ]
   },
   "Packaging": {

Cql/PackagerCLI/Hl7.Cql.Packager.ecqm-content-cms-2025.appsettings.json

@@ -0,0 +1,14 @@
+{
+  "Elm": {
+    "SkipFiles": [
+      // Tuple element value does not have a resultTypeSpecifier
+      "CMS2FHIRPCSDepressionScreenAndFollowUp.json",
+
+      // Exception: cannot convert from 'Hl7.Fhir.Model.Id' to 'Hl7.Fhir.Model.Code<Hl7.Fhir.Model.Account.AccountStatus>'
+      "NHSNHelpers.json",
+
+      // Exception: Cannot convert System.Collections.Generic.List`1[Hl7.Fhir.Model.ResourceReference] to Hl7.Fhir.Model.ResourceReference.
+      "NHSNGlycemicControlHypoglycemiaInitialPopulation.json"
+    ]
+  }
+}