🐛 fixes business logic for xml serilizer, when summary mode is active. There was problem when summary mode is active, it worked in opposite way!

* tests coverages are added, fhir resources fixtures are updated.

Author: nazrulworld

HISTORY.rst

@@ -4,7 +4,7 @@ History
 1.1.3 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Fixes business logic for xml serializer, when summary move is active.
 
 
 1.1.2 (2025-07-09)

fhir_core/xml_utils.py

@@ -642,7 +642,14 @@ def add_fhir_element(
         ext_field=None,
         summary_only=False,
     ):
-        """"""
+        """ """
+        if summary_only and not field.json_schema_extra.get(  # type: ignore
+            "summary_element_property", False
+        ):
+            # we are not accepting the field, which is not the summary element, if summary mode is active.
+            return
+        if isinstance(value, dict):
+            value = value.items()
         child = Node.create(field.alias)
         if is_primitive_type(field):
             if isinstance(value, list):
@@ -673,7 +680,7 @@ def add_fhir_element(
                     )
             elif value is not None:
                 child.value = xml_represent(field, value)
-                if ext is not None:
+                if ext is not None and not summary_only:
                     Node.inject_comments(
                         parent, ext.__dict__.get("fhir_comments", None)
                     )
@@ -688,7 +695,7 @@ def add_fhir_element(
                 parent.children.append(child)
             else:
                 child.value = EMPTY_VALUE
-                if ext is not None:
+                if ext is not None and not summary_only:
                     exts = not isinstance(ext, list) and [ext] or ext
                     for ext_ in exts:
                         if ext_ is None:
@@ -745,14 +752,16 @@ def add_fhir_element(
                 summary_only=summary_only,
             )
             return
-        # working comments
-        comments = value.__dict__.get("fhir_comments", None)
-        Node.inject_comments(parent, comments)
+
+        if not summary_only:
+            # working comments on conditional
+            comments = value.__dict__.get("fhir_comments", None)
+            Node.inject_comments(parent, comments)
 
         alias_maps = value.__class__.get_alias_mapping()
         summery_elements_sequence = value.__class__.summary_elements_sequence()
         for prop_name in value.__class__.elements_sequence():
-            if prop_name in summery_elements_sequence and summary_only:
+            if prop_name not in summery_elements_sequence and summary_only:
                 # we filter non-summary field
                 continue
             field_ = value.__class__.model_fields[alias_maps[prop_name]]
@@ -805,10 +814,10 @@ def from_fhir_obj(cls, model: "FHIRAbstractModel"):
         summery_elements_sequence = model.__class__.summary_elements_sequence()
         for prop_name in model.__class__.elements_sequence():
             if (
-                prop_name in summery_elements_sequence
+                prop_name not in summery_elements_sequence
                 and model.__fhir_serialization_summary_only__
             ):
-                # we filter non-summary element
+                # we filter a non-summary element
                 continue
             field = model.__class__.model_fields[alias_maps[prop_name]]
             if typing.TYPE_CHECKING:

tests/fixtures/resources/address.py

@@ -33,7 +33,7 @@ class Address(datatype.DataType):
     __resource_type__ = "Address"
 
     city: fhirtypes.StringType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="city",
         title="Name of city, town etc.",
         description=(
@@ -42,40 +42,43 @@ class Address(datatype.DataType):
         ),
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
     city__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_city", title="Extension field for ``city``."
+        default=None, alias="_city", title="Extension field for ``city``."
     )
 
     country: fhirtypes.StringType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="country",
         title="Country (e.g. may be ISO 3166 2 or 3 letter code)",
         description="Country - a nation as commonly understood or generally accepted.",
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
     country__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_country", title="Extension field for ``country``."
+        default=None, alias="_country", title="Extension field for ``country``."
     )
 
     district: fhirtypes.StringType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="district",
         title="District name (aka county)",
         description="The name of the administrative area (county).",
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
     district__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_district", title="Extension field for ``district``."
+        default=None, alias="_district", title="Extension field for ``district``."
     )
 
     line: typing.List[fhirtypes.StringType | None] | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="line",
         title="Street name, number, direction & P.O. Box etc.",
         description=(
@@ -85,37 +88,40 @@ class Address(datatype.DataType):
         ),
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
     line__ext: typing.List[fhirtypes.FHIRPrimitiveExtensionType | None] | None = Field(  # type: ignore
-        None, alias="_line", title="Extension field for ``line``."
+        default=None, alias="_line", title="Extension field for ``line``."
     )
 
     period: fhirtypes.PeriodType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="period",
         title="Time period when address was/is in use",
         description=None,
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
 
     postalCode: fhirtypes.StringType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="postalCode",
         title="Postal code for area",
         description="A postal code designating a region defined by the postal service.",
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
     postalCode__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_postalCode", title="Extension field for ``postalCode``."
+        default=None, alias="_postalCode", title="Extension field for ``postalCode``."
     )
 
     state: fhirtypes.StringType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="state",
         title="Sub-unit of country (abbreviations ok)",
         description=(
@@ -125,14 +131,15 @@ class Address(datatype.DataType):
         ),
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
     state__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_state", title="Extension field for ``state``."
+        default=None, alias="_state", title="Extension field for ``state``."
     )
 
     text: fhirtypes.StringType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="text",
         title="Text representation of the address",
         description=(
@@ -142,14 +149,15 @@ class Address(datatype.DataType):
         ),
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
         },
     )
     text__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_text", title="Extension field for ``text``."
+        default=None, alias="_text", title="Extension field for ``text``."
     )
 
     type: fhirtypes.CodeType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="type",
         title="postal | physical | both",
         description=(
@@ -159,36 +167,38 @@ class Address(datatype.DataType):
         ),
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
             # note: Enum values can be used in validation,
             # but use in your own responsibilities, read official FHIR documentation.
             "enum_values": ["postal", "physical", "both"],
         },
     )
     type__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_type", title="Extension field for ``type``."
+        default=None, alias="_type", title="Extension field for ``type``."
     )
 
     use: fhirtypes.CodeType | None = Field(  # type: ignore
-        None,
+        default=None,
         alias="use",
         title="home | work | temp | old | billing - purpose of this address",
         description="The purpose of this address.",
         json_schema_extra={
             "element_property": True,
+            "summary_element_property": True,
             # note: Enum values can be used in validation,
             # but use in your own responsibilities, read official FHIR documentation.
             "enum_values": ["home", "work", "temp", "old", "billing"],
         },
     )
     use__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
-        None, alias="_use", title="Extension field for ``use``."
+        default=None, alias="_use", title="Extension field for ``use``."
     )
 
     @classmethod
     def elements_sequence(cls):
-        """returning all elements names from
-        ``Address`` according specification,
-        with preserving original sequence order.
+        """returning all element names from
+        ``Address`` according to specification,
+        with preserving the original sequence order.
         """
         return [
             "id",
@@ -204,3 +214,21 @@ def elements_sequence(cls):
             "country",
             "period",
         ]
+
+    @classmethod
+    def summary_elements_sequence(cls):
+        """returning all element names (those have summary mode are enabled) from ``Address`` according to specification,
+        with preserving the original sequence order.
+        """
+        return [
+            "use",
+            "type",
+            "text",
+            "line",
+            "city",
+            "district",
+            "state",
+            "postalCode",
+            "country",
+            "period",
+        ]

tests/fixtures/resources/age.py

@@ -1,13 +1,12 @@
-# -*- coding: utf-8 -*-
+from __future__ import annotations as _annotations
+
 """
 Profile: http://hl7.org/fhir/StructureDefinition/Age
 Release: R5
 Version: 5.0.0
 Build ID: 2aecd53
 Last updated: 2023-03-26T15:21:02.749+11:00
 """
-from pydantic import Field
-
 from . import quantity
 
 
@@ -23,8 +22,15 @@ class Age(quantity.Quantity):
 
     @classmethod
     def elements_sequence(cls):
-        """returning all elements names from
-        ``Age`` according specification,
-        with preserving original sequence order.
+        """returning all element names from
+        ``Age`` according to specification,
+        with preserving the original sequence order.
         """
         return ["id", "extension", "value", "comparator", "unit", "system", "code"]
+
+    @classmethod
+    def summary_elements_sequence(cls):
+        """returning all element names (those have summary mode are enabled) from ``Age`` according to specification,
+        with preserving the original sequence order.
+        """
+        return ["value", "comparator", "unit", "system", "code"]

tests/fixtures/resources/codeableconcept.py

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+from __future__ import annotations as _annotations
+
 """
 Profile: http://hl7.org/fhir/StructureDefinition/CodeableConcept
 Release: R5
@@ -25,43 +26,46 @@ class CodeableConcept(datatype.DataType):
 
     __resource_type__ = "CodeableConcept"
 
-    coding: typing.List[fhirtypes.CodingType] = Field(
-        None,
+    coding: typing.List[fhirtypes.CodingType] | None = Field(  # type: ignore
+        default=None,
         alias="coding",
         title="Code defined by a terminology system",
         description="A reference to a code defined by a terminology system.",
-        # if property is element of this resource.
-        json_schema_extra={"element_property": True},
+        json_schema_extra={
+            "element_property": True,
+            "summary_element_property": True,
+        },
     )
 
-    text: fhirtypes.StringType = Field(
-        None,
+    text: fhirtypes.StringType | None = Field(  # type: ignore
+        default=None,
         alias="text",
         title="Plain text representation of the concept",
         description=(
             "A human language representation of the concept as "
             "seen/selected/uttered by the user who entered the data and/or which "
             "represents the intended meaning of the user."
         ),
-        # if property is element of this resource.
-        json_schema_extra={"element_property": True},
+        json_schema_extra={
+            "element_property": True,
+            "summary_element_property": True,
+        },
     )
-    text__ext: fhirtypes.FHIRPrimitiveExtensionType = Field(
-        None, alias="_text", title="Extension field for ``text``."
+    text__ext: fhirtypes.FHIRPrimitiveExtensionType | None = Field(  # type: ignore
+        default=None, alias="_text", title="Extension field for ``text``."
     )
 
     @classmethod
     def elements_sequence(cls):
-        """returning all elements names from
-        ``CodeableConcept`` according specification,
-        with preserving original sequence order.
+        """returning all element names from
+        ``CodeableConcept`` according to specification,
+        with preserving the original sequence order.
         """
         return ["id", "extension", "coding", "text"]
 
     @classmethod
     def summary_elements_sequence(cls):
-        """returning all elements names from
-        ``CodeableConcept`` according specification,
-        with preserving original sequence order.
+        """returning all element names (those have summary mode are enabled) from ``CodeableConcept`` according to specification,
+        with preserving the original sequence order.
         """
         return ["coding", "text"]