Forward SDK 5 changes to SDK 6

release-notes.md

@@ -1,3 +1,4 @@
-## Intro:
+## Breaking changes:
 
-Hotfix: Fixed an incorrect string concatenation and subsequent argument exception when the Id of a contained resource was not set.
+- EvaluationContext.WithResourceOverrides() introduced in 5.10 is refactored to now be an extension method instead of a static construction method. It should now be called on an instance of EvaluationContext, and will mutate and return that instance.
+- We changed the datatype of the Attachment.Url from FhirUrl to FhirUri. The type of this element was changed with the introduction of R4. (FhirUrl doesn't exist in STU3). When we moved Attachment to base, we wrongfully put FhirUrl here, which is the more specific datatype of the two. We have corrected this.

src/Hl7.Fhir.Base/CompatibilitySuppressions.xml

@@ -239,13 +239,6 @@
     <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>
   </Suppression>
-  <Suppression>
-    <DiagnosticId>CP0002</DiagnosticId>
-    <Target>M:Hl7.Fhir.FhirPath.FhirEvaluationContext.WithResourceOverrides(Hl7.Fhir.ElementModel.ITypedElement,Hl7.Fhir.ElementModel.ITypedElement)</Target>
-    <Left>lib/net8.0/Hl7.Fhir.Base.dll</Left>
-    <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
-    <IsBaselineSuppression>true</IsBaselineSuppression>
-  </Suppression>
   <Suppression>
     <DiagnosticId>CP0002</DiagnosticId>
     <Target>M:Hl7.Fhir.Introspection.ClassMapping.get_DefinitionPath</Target>
@@ -372,20 +365,6 @@
     <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>
   </Suppression>
-  <Suppression>
-    <DiagnosticId>CP0002</DiagnosticId>
-    <Target>M:Hl7.Fhir.Rest.ContentType.BuildContentType(Hl7.Fhir.Rest.ResourceFormat,System.String)</Target>
-    <Left>lib/net8.0/Hl7.Fhir.Base.dll</Left>
-    <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
-    <IsBaselineSuppression>true</IsBaselineSuppression>
-  </Suppression>
-  <Suppression>
-    <DiagnosticId>CP0002</DiagnosticId>
-    <Target>M:Hl7.Fhir.Rest.ContentType.BuildMediaType(Hl7.Fhir.Rest.ResourceFormat,System.String)</Target>
-    <Left>lib/net8.0/Hl7.Fhir.Base.dll</Left>
-    <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
-    <IsBaselineSuppression>true</IsBaselineSuppression>
-  </Suppression>
   <Suppression>
     <DiagnosticId>CP0002</DiagnosticId>
     <Target>M:Hl7.Fhir.Serialization.BaseFhirJsonPocoSerializer.Serialize(System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Text.Json.Utf8JsonWriter)</Target>
@@ -456,6 +435,13 @@
     <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>
   </Suppression>
+  <Suppression>
+    <DiagnosticId>CP0002</DiagnosticId>
+    <Target>M:Hl7.Fhir.Specification.Snapshot.SnapshotGeneratorExtensions.RemoveAllNonInheritableExtensions(Hl7.Fhir.Model.Element)</Target>
+    <Left>lib/net8.0/Hl7.Fhir.Base.dll</Left>
+    <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
+    <IsBaselineSuppression>true</IsBaselineSuppression>
+  </Suppression>
   <Suppression>
     <DiagnosticId>CP0002</DiagnosticId>
     <Target>M:Hl7.Fhir.Utility.AnnotatableExtensions.RemoveAnnotations``1(Hl7.Fhir.Utility.IAnnotatable)</Target>
@@ -570,7 +556,7 @@
   </Suppression>
   <Suppression>
     <DiagnosticId>CP0002</DiagnosticId>
-    <Target>M:Hl7.FhirPath.EvaluationContext.WithResourceOverrides(Hl7.Fhir.ElementModel.ITypedElement,Hl7.Fhir.ElementModel.ITypedElement)</Target>
+    <Target>M:Hl7.FhirPath.EvaluationContextExtensions.WithResourceOverrides``1(``0,Hl7.Fhir.ElementModel.ITypedElement,Hl7.Fhir.ElementModel.ITypedElement)</Target>
     <Left>lib/net8.0/Hl7.Fhir.Base.dll</Left>
     <Right>lib/net8.0/Hl7.Fhir.Base.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>

src/Hl7.Fhir.Base/Hl7.Fhir.Base.csproj

@@ -12,7 +12,7 @@
 
 	<ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.1'">
 		<PackageReference Include="System.Buffers" Version="4.5.1" />
-		<PackageReference Include="System.Text.Json" Version="8.0.5" />
+		<PackageReference Include="System.Text.Json" Version="9.0.0" />
 	</ItemGroup>
 
 	<ItemGroup>

src/Hl7.Fhir.Base/Model/Generated/Attachment.cs

@@ -209,7 +209,7 @@ public string Url
         if (value == null)
           UrlElement = null;
         else
-          UrlElement = new Hl7.Fhir.Model.FhirUrl(value);
+          UrlElement = new Hl7.Fhir.Model.FhirUri(value);
         OnPropertyChanged("Url");
       }
     }

src/Hl7.Fhir.Base/Model/ParametersExtensions.cs

@@ -9,6 +9,7 @@ namespace Hl7.Fhir.Model
     public static class ParametersExtensions
     {
         private const string CODEATTRIBUTE = "code";
+        private const string URLATTRIBUTE = "url";
         private const string SYSTEMATTRIBUTE = "system";
         private const string CONTEXTATTRIBUTE = "context";
 
@@ -39,12 +40,13 @@ internal static void CheckForValidityOfValidateCodeParams(this Parameters parame
         {
             parameters.NoDuplicates();
 
-            //If a code is provided, a system or a context must be provided (http://hl7.org/fhir/valueset-operation-validate-code.html)
-            if (parameters.Parameter.Any(p => p.Name == CODEATTRIBUTE) && !(parameters.Parameter.Any(p => p.Name == SYSTEMATTRIBUTE) ||
+            //This error was changed from system to url. See: https://chat.fhir.org/#narrow/channel/179202-terminology/topic/Required.20.24validate-code.20parameters/near/482250225
+            //If a code is provided, a url or a context must be provided (http://hl7.org/fhir/valueset-operation-validate-code.html)
+            if (parameters.Parameter.Any(p => p.Name == CODEATTRIBUTE) && !(parameters.Parameter.Any(p => p.Name == URLATTRIBUTE) ||
                                                                                     parameters.Parameter.Any(p => p.Name == CONTEXTATTRIBUTE)))
             {
                 //422 Unproccesable Entity
-                throw new FhirOperationException($"If a code is provided, a system or a context must be provided", (HttpStatusCode)422);
+                throw new FhirOperationException($"If a code is provided, a url or a context must be provided", (HttpStatusCode)422);
             }
         }
     }

src/Hl7.Fhir.Base/Specification/Snapshot/SnapshotGeneratorExtensions.cs

@@ -76,7 +76,11 @@ public static void RemoveAllConstrainedByDiffExtensions<T>(this IEnumerable<T> e
             }
         }
 
-
+        /// <summary>
+        /// This extension removes all non-inheritable extensions from the specified element definition and all it's child objects.
+        /// Non-inheritable extensions are extensions that should not be inherited by derived profiles.
+        /// </summary>
+        /// <param name="element"></param>
         internal static void RemoveAllNonInheritableExtensions(this Element element)
         {
             if (element == null) { throw Error.ArgumentNull(nameof(element)); }

src/Hl7.Fhir.Base/Specification/Terminology/ValidateCodeParameters.cs

@@ -25,6 +25,7 @@ public class ValidateCodeParameters
         private readonly string _dateAttribute = "date";
         private readonly string _abstractAttribute = "abstract";
         private readonly string _displayLanguageAttribute = "displayLanguage";
+        private readonly string _inferSystemAttribute = "inferSystem";
 
         public ValidateCodeParameters(Parameters parameters)
         {
@@ -41,6 +42,7 @@ public ValidateCodeParameters(Parameters parameters)
             Date = parameters.GetSingleValue<FhirDateTime>(_dateAttribute);
             Abstract = parameters.GetSingleValue<FhirBoolean>(_abstractAttribute);
             DisplayLanguage = parameters.GetSingleValue<Code>(_displayLanguageAttribute);
+            InferSystem = parameters.GetSingleValue<FhirBoolean>(_inferSystemAttribute);
         }
 
 
@@ -58,14 +60,15 @@ public ValidateCodeParameters WithValueSet(string url, string context = null, Re
             return this;
         }
 
-        public ValidateCodeParameters WithCode(string code = null, string system = null, string systemVersion = null, string display = null, string displayLanguage = null, string context = null)
+        public ValidateCodeParameters WithCode(string code = null, string system = null, string systemVersion = null, string display = null, string displayLanguage = null, string context = null, bool? inferSystem = null)
         {
             if (!string.IsNullOrWhiteSpace(code)) Code = new Code(code);
             if (!string.IsNullOrWhiteSpace(system)) System = new FhirUri(system);
             if (!string.IsNullOrWhiteSpace(systemVersion)) SystemVersion = new FhirString(systemVersion);
             if (!string.IsNullOrWhiteSpace(display)) Display = new FhirString(display);
             if (!string.IsNullOrWhiteSpace(displayLanguage)) DisplayLanguage = new Code(displayLanguage);
             if (!string.IsNullOrWhiteSpace(context)) Context = new FhirUri(context);
+            if (inferSystem is { }) InferSystem = new FhirBoolean(inferSystem);
             return this;
         }
 
@@ -151,6 +154,8 @@ public ValidateCodeParameters WithAbstract(bool? @abstract)
         /// </summary>
         public Code DisplayLanguage { get; private set; }
 
+        public FhirBoolean InferSystem { get; private set; }
+
         /// <summary>
         /// 
         /// </summary>
@@ -160,8 +165,8 @@ public Parameters Build()
             var result = new Parameters();
 
             if (Url is { }) result.Add(_urlAttribute, Url);
-            if (Context is { }) result.Add(_contextAttribute, Context);
             if (ValueSet is { }) result.Add(_valueSetAttribute, ValueSet);
+            if (Context is { }) result.Add(_contextAttribute, Context);
             if (ValueSetVersion is { }) result.Add(_valueSetVersionAttribute, ValueSetVersion);
             if (Code is { }) result.Add(_codeAttribute, Code);
             if (System is { }) result.Add(_systemAttribute, System);
@@ -171,8 +176,8 @@ public Parameters Build()
             if (CodeableConcept is { }) result.Add(_codeableConceptAttribute, CodeableConcept);
             if (Date is { }) result.Add(_dateAttribute, Date);
             if (Abstract is { }) result.Add(_abstractAttribute, Abstract);
-            if (DisplayLanguage is { }) result.Add(_displayAttribute, DisplayLanguage);
-
+            if (DisplayLanguage is { }) result.Add(_displayLanguageAttribute, DisplayLanguage);
+            if (InferSystem is { }) result.Add(_inferSystemAttribute, InferSystem);
             return result;
         }
     }

src/Hl7.Fhir.Conformance/CompatibilitySuppressions.xml

@@ -8,13 +8,6 @@
     <Right>lib/net8.0/Hl7.Fhir.Conformance.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>
   </Suppression>
-  <Suppression>
-    <DiagnosticId>CP0001</DiagnosticId>
-    <Target>T:Hl7.Fhir.Specification.Snapshot.SnapshotGeneratorExtensions</Target>
-    <Left>lib/net8.0/Hl7.Fhir.Conformance.dll</Left>
-    <Right>lib/net8.0/Hl7.Fhir.Conformance.dll</Right>
-    <IsBaselineSuppression>true</IsBaselineSuppression>
-  </Suppression>
   <Suppression>
     <DiagnosticId>CP0002</DiagnosticId>
     <Target>M:Hl7.Fhir.Model.CapabilityStatement.ImplementationComponent.get_DescriptionElement</Target>

src/Hl7.Fhir.Conformance/Specification/Snapshot/SnapshotGenerator.cs

@@ -2224,17 +2224,9 @@ private async Tasks.Task<bool> ensureSnapshot(StructureDefinition sd, string pro
 
             try
             {
-                var shouldGenerate = _settings.RegenerationBehaviour switch
-                {
-                    RegenerationSettings.TRY_USE_EXISTING => !sd.HasSnapshot,
-                    RegenerationSettings.REGENERATE_ONCE => !sd.HasSnapshot || !sd.Snapshot.IsCreatedBySnapshotGenerator(),
-#pragma warning disable CS0618 // Type or member is obsolete
-                    RegenerationSettings.FORCE_REGENERATE => true, // possible infinite recursion
-#pragma warning restore CS0618 // Type or member is obsolete
-                    _ => throw new InvalidOperationException($"Invalid RegenerationSettings value {_settings.RegenerationBehaviour}")
-                };
-
-                if (_settings.GenerateSnapshotForExternalProfiles && shouldGenerate)
+                if (_settings.GenerateSnapshotForExternalProfiles
+                && (!sd.HasSnapshot || (_settings.ForceRegenerateSnapshots && !sd.Snapshot.IsCreatedBySnapshotGenerator()))
+                )
                 {
                     // Automatically expand external profiles on demand
                     // Debug.Print($"[{nameof(SnapshotGenerator)}.{nameof(ensureSnapshot)}] Recursively generate snapshot for type profile with url: '{sd.Url}' ...");
@@ -2316,18 +2308,9 @@ private async Tasks.Task<ElementDefinition> getSnapshotRootElement(StructureDefi
             var cachedRoot = sd.GetSnapshotRootElementAnnotation();
             if (cachedRoot != null) { return cachedRoot; }
 #endif
-            var hasValidRoot = _settings.RegenerationBehaviour switch
-            {
-                RegenerationSettings.TRY_USE_EXISTING => sd.HasSnapshot,
-                RegenerationSettings.REGENERATE_ONCE => sd.HasSnapshot && sd.Snapshot.IsCreatedBySnapshotGenerator(),
-#pragma warning disable CS0618 // Type or member is obsolete
-                RegenerationSettings.FORCE_REGENERATE => false,
-#pragma warning restore CS0618 // Type or member is obsolete
-                _ => throw new InvalidOperationException($"Invalid RegenerationSettings value {_settings.RegenerationBehaviour}")
-            };
-
+
             // 2. Return root element definition from existing (pre-generated) snapshot, if it exists
-            if (hasValidRoot)
+            if (sd.HasSnapshot && (sd.Snapshot.IsCreatedBySnapshotGenerator() || !_settings.ForceRegenerateSnapshots))
             {
                 // Debug.Print($"[{nameof(SnapshotGenerator)}.{nameof(getSnapshotRootElement)}] {nameof(profileUri)} = '{profileUri}' - use existing root element definition from snapshot: #{sd.Snapshot.Element[0].GetHashCode()}");
                 // No need to save root ElemDef annotation, as the snapshot has already been fully expanded

src/Hl7.Fhir.STU3/CompatibilitySuppressions.xml

@@ -22,13 +22,6 @@
     <Right>lib/net8.0/Hl7.Fhir.STU3.dll</Right>
     <IsBaselineSuppression>true</IsBaselineSuppression>
   </Suppression>
-  <Suppression>
-    <DiagnosticId>CP0001</DiagnosticId>
-    <Target>T:Hl7.Fhir.Specification.Snapshot.SnapshotGeneratorExtensions</Target>
-    <Left>lib/net8.0/Hl7.Fhir.STU3.dll</Left>
-    <Right>lib/net8.0/Hl7.Fhir.STU3.dll</Right>
-    <IsBaselineSuppression>true</IsBaselineSuppression>
-  </Suppression>
   <Suppression>
     <DiagnosticId>CP0002</DiagnosticId>
     <Target>F:Hl7.Fhir.Model.ExplanationOfBenefit.ActInvoiceGroupCode.ActInvoiceInterGroupCode</Target>

src/Hl7.Fhir.STU3/Specification/Snapshot/SnapshotGenerator.cs

@@ -1941,17 +1941,9 @@ private async Tasks.Task<bool> ensureSnapshot(StructureDefinition sd, string pro
 
             try
             {
-                var shouldGenerate = _settings.RegenerationBehaviour switch
-                {
-                    RegenerationSettings.TRY_USE_EXISTING => !sd.HasSnapshot,
-                    RegenerationSettings.REGENERATE_ONCE => !sd.HasSnapshot || !sd.Snapshot.IsCreatedBySnapshotGenerator(),
-#pragma warning disable CS0618 // Type or member is obsolete
-                    RegenerationSettings.FORCE_REGENERATE => true,
-#pragma warning restore CS0618 // Type or member is obsolete
-                    _ => throw new InvalidOperationException($"Invalid RegenerationSettings value {_settings.RegenerationBehaviour}")
-                };
-
-                if (_settings.GenerateSnapshotForExternalProfiles && shouldGenerate)
+                if (_settings.GenerateSnapshotForExternalProfiles
+                && (!sd.HasSnapshot || (_settings.ForceRegenerateSnapshots && !sd.Snapshot.IsCreatedBySnapshotGenerator()))
+                )
                 {
                     // Automatically expand external profiles on demand
                     // Debug.Print($"[{nameof(SnapshotGenerator)}.{nameof(ensureSnapshot)}] Recursively generate snapshot for type profile with url: '{sd.Url}' ...");
@@ -2033,18 +2025,9 @@ private async Tasks.Task<ElementDefinition> getSnapshotRootElement(StructureDefi
             var cachedRoot = sd.GetSnapshotRootElementAnnotation();
             if (cachedRoot != null) { return cachedRoot; }
 #endif
-            var hasValidRoot = _settings.RegenerationBehaviour switch
-            {
-                RegenerationSettings.TRY_USE_EXISTING => sd.HasSnapshot,
-                RegenerationSettings.REGENERATE_ONCE => sd.HasSnapshot && sd.Snapshot.IsCreatedBySnapshotGenerator(),
-#pragma warning disable CS0618 // Type or member is obsolete
-                RegenerationSettings.FORCE_REGENERATE => false,
-#pragma warning restore CS0618 // Type or member is obsolete
-                _ => throw new InvalidOperationException($"Invalid RegenerationSettings value {_settings.RegenerationBehaviour}")
-            };
-
+
             // 2. Return root element definition from existing (pre-generated) snapshot, if it exists
-            if (hasValidRoot)
+            if (sd.HasSnapshot && (sd.Snapshot.IsCreatedBySnapshotGenerator() || !_settings.ForceRegenerateSnapshots))
             {
                 // Debug.Print($"[{nameof(SnapshotGenerator)}.{nameof(getSnapshotRootElement)}] {nameof(profileUri)} = '{profileUri}' - use existing root element definition from snapshot: #{sd.Snapshot.Element[0].GetHashCode()}");
                 // No need to save root ElemDef annotation, as the snapshot has already been fully expanded