NRL-518 ContentStability validation mostly on pydantic

Author: axelkrastek1-nhs

api/consumer/swagger.yaml

@@ -1070,11 +1070,14 @@ components:
         extension:
           type: array
           items:
-            $ref: "#/components/schemas/Extension"
-            description: Additional content defined by implementations.
+            $ref: "#/components/schemas/ContentStabilityExtension"
+            description: Additional extension for content stability.
+          minItems: 1
+          maxItems: 1
       required:
         - attachment
         - format
+        - extension
     DocumentReferenceRelatesTo:
       type: object
       properties:
@@ -1191,6 +1194,46 @@ components:
           type: string
           pattern: \S*
           description: The reference details for the link.
+    ContentStabilityExtension:
+      type: object
+      properties:
+        url:
+          type: string
+          enum:
+            [
+              "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability",
+            ]
+        valueCodeableConcept:
+          type: object
+          properties:
+            coding:
+              type: array
+              items:
+                type: object
+                properties:
+                  system:
+                    type: string
+                    enum:
+                      [
+                        "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability",
+                      ]
+                  code:
+                    type: string
+                    enum: ["static", "dynamic"]
+                  display:
+                    type: string
+                    enum: ["Static", "Dynamic"]
+                required:
+                  - system
+                  - code
+                  - display
+              minItems: 1
+              maxItems: 1
+          required:
+            - coding
+      required:
+        - url
+        - valueCodeableConcept
     Identifier:
       type: object
       properties:

api/producer/swagger.yaml

@@ -1635,11 +1635,14 @@ components:
         extension:
           type: array
           items:
-            $ref: "#/components/schemas/Extension"
-            description: Additional content defined by implementations.
+            $ref: "#/components/schemas/ContentStabilityExtension"
+            description: Additional extension for content stability.
+          minItems: 1
+          maxItems: 1
       required:
         - attachment
         - format
+        - extension
     DocumentReferenceRelatesTo:
       type: object
       properties:
@@ -1757,6 +1760,46 @@ components:
           type: string
           pattern: \S*
           description: The reference details for the link.
+    ContentStabilityExtension:
+      type: object
+      properties:
+        url:
+          type: string
+          enum:
+            [
+              "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability",
+            ]
+        valueCodeableConcept:
+          type: object
+          properties:
+            coding:
+              type: array
+              items:
+                type: object
+                properties:
+                  system:
+                    type: string
+                    enum:
+                      [
+                        "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability",
+                      ]
+                  code:
+                    type: string
+                    enum: ["static", "dynamic"]
+                  display:
+                    type: string
+                    enum: ["Static", "Dynamic"]
+                required:
+                  - system
+                  - code
+                  - display
+              minItems: 1
+              maxItems: 1
+          required:
+            - coding
+      required:
+        - url
+        - valueCodeableConcept
     Identifier:
       type: object
       properties:

layer/nrlf/consumer/fhir/r4/model.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  swagger.yaml
-#   timestamp: 2024-12-05T16:54:49+00:00
+#   timestamp: 2024-12-06T02:57:59+00:00
 
 from __future__ import annotations
 
@@ -230,6 +230,25 @@ class Coding(BaseModel):
     ] = None
 
 
+class CodingItem(BaseModel):
+    system: Literal[
+        "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability"
+    ]
+    code: Literal["static", "dynamic"]
+    display: Literal["Static", "Dynamic"]
+
+
+class ValueCodeableConcept(BaseModel):
+    coding: Annotated[List[CodingItem], Field(max_length=1, min_length=1)]
+
+
+class ContentStabilityExtension(BaseModel):
+    url: Literal[
+        "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability"
+    ]
+    valueCodeableConcept: ValueCodeableConcept
+
+
 class Period(BaseModel):
     id: Annotated[
         Optional[str],
@@ -427,6 +446,31 @@ class RequestHeaderCorrelationId(RootModel[str]):
     root: Annotated[str, Field(examples=["11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"])]
 
 
+class DocumentReferenceContent(BaseModel):
+    id: Annotated[
+        Optional[str],
+        Field(
+            description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
+            pattern="[A-Za-z0-9\\-\\.]{1,64}",
+        ),
+    ] = None
+    attachment: Annotated[
+        Attachment,
+        Field(
+            description="The document or URL of the document along with critical metadata to prove content has integrity."
+        ),
+    ]
+    format: Annotated[
+        Coding,
+        Field(
+            description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType."
+        ),
+    ]
+    extension: Annotated[
+        List[ContentStabilityExtension], Field(max_length=1, min_length=1)
+    ]
+
+
 class RequestHeader(BaseModel):
     odsCode: RequestHeaderOdsCode
 
@@ -818,29 +862,6 @@ class DocumentReferenceContext(BaseModel):
     related: Optional[List[Reference]] = None
 
 
-class DocumentReferenceContent(BaseModel):
-    id: Annotated[
-        Optional[str],
-        Field(
-            description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
-            pattern="[A-Za-z0-9\\-\\.]{1,64}",
-        ),
-    ] = None
-    attachment: Annotated[
-        Attachment,
-        Field(
-            description="The document or URL of the document along with critical metadata to prove content has integrity."
-        ),
-    ]
-    format: Annotated[
-        Coding,
-        Field(
-            description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType."
-        ),
-    ]
-    extension: Optional[List[Extension]] = None
-
-
 class DocumentReferenceRelatesTo(BaseModel):
     id: Annotated[
         Optional[str],
@@ -1032,7 +1053,6 @@ class Signature(BaseModel):
 Bundle.model_rebuild()
 BundleEntry.model_rebuild()
 DocumentReferenceContext.model_rebuild()
-DocumentReferenceContent.model_rebuild()
 DocumentReferenceRelatesTo.model_rebuild()
 CodeableConcept.model_rebuild()
 Identifier.model_rebuild()

layer/nrlf/core/errors.py

@@ -21,7 +21,7 @@ def format_error_location(loc: List) -> str:
 
 def diag_for_error(error: ErrorDetails) -> str:
     loc_string = format_error_location(error["loc"])
-    return f"{loc_string}: {error['msg']}" if loc_string else f"root: {error['msg']}"
+    return f"{loc_string or 'root'}: {error['msg']}"
 
 
 def expression_for_error(error: ErrorDetails) -> Optional[str]: