NRL-518 Pydantic format validation, fix casing format display

axelkrastek1-nhs · axelkrastek1-nhs · commit f8663e782e71 · 2024-12-06T04:13:58.000Z
diff --git a/api/consumer/swagger.yaml b/api/consumer/swagger.yaml
@@ -1065,7 +1065,7 @@ components:
           $ref: "#/components/schemas/Attachment"
           description: The document or URL of the document along with critical metadata to prove content has integrity.
         format:
-          $ref: "#/components/schemas/Coding"
+          $ref: "#/components/schemas/NRLFormatCode"
           description: An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
         extension:
           type: array
@@ -1230,6 +1230,30 @@ components:
       required:
         - url
         - valueCodeableConcept
+    NRLFormatCode:
+      type: object
+      properties:
+        system:
+          type: string
+          enum:
+            - "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"
+          description: The system URL for the NRLF Format Code.
+        code:
+          type: string
+          enum:
+            - "urn:nhs-ic:record-contact"
+            - "urn:nhs-ic:unstructured"
+          description: The code representing the format of the document.
+        display:
+          type: string
+          enum:
+            - "Contact details (HTTP Unsecured)"
+            - "Unstructured Document"
+          description: The display text for the code.
+      required:
+        - system
+        - code
+        - display
     Identifier:
       type: object
       properties:
diff --git a/api/producer/swagger.yaml b/api/producer/swagger.yaml
@@ -334,7 +334,7 @@ paths:
             {
               "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
               "code": "urn:nhs-ic:unstructured"
-              "display": "Unstructured document"
+              "display": "Unstructured Document"
             }
           ]
           ```
@@ -1215,7 +1215,7 @@ components:
                 format:
                   system: https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode
                   code: "urn:nhs-ic:unstructured"
-                  display: Unstructured document
+                  display: Unstructured Document
             context:
               event:
                 - coding:
@@ -1630,7 +1630,7 @@ components:
           $ref: "#/components/schemas/Attachment"
           description: The document or URL of the document along with critical metadata to prove content has integrity.
         format:
-          $ref: "#/components/schemas/Coding"
+          $ref: "#/components/schemas/NRLFormatCode"
           description: An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
         extension:
           type: array
@@ -1796,6 +1796,30 @@ components:
       required:
         - url
         - valueCodeableConcept
+    NRLFormatCode:
+      type: object
+      properties:
+        system:
+          type: string
+          enum:
+            - "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"
+          description: The system URL for the NRLF Format Code.
+        code:
+          type: string
+          enum:
+            - "urn:nhs-ic:record-contact"
+            - "urn:nhs-ic:unstructured"
+          description: The code representing the format of the document.
+        display:
+          type: string
+          enum:
+            - "Contact details (HTTP Unsecured)"
+            - "Unstructured Document"
+          description: The display text for the code.
+      required:
+        - system
+        - code
+        - display
     Identifier:
       type: object
       properties:
diff --git a/layer/nrlf/consumer/fhir/r4/model.py b/layer/nrlf/consumer/fhir/r4/model.py
@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  swagger.yaml
-#   timestamp: 2024-12-06T02:57:59+00:00
+#   timestamp: 2024-12-06T04:10:37+00:00
 
 from __future__ import annotations
 
@@ -249,6 +249,21 @@ class ContentStabilityExtension(BaseModel):
     valueCodeableConcept: ValueCodeableConcept
 
 
+class NRLFormatCode(BaseModel):
+    system: Annotated[
+        Literal["https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"],
+        Field(description="The system URL for the NRLF Format Code."),
+    ]
+    code: Annotated[
+        Literal["urn:nhs-ic:record-contact", "urn:nhs-ic:unstructured"],
+        Field(description="The code representing the format of the document."),
+    ]
+    display: Annotated[
+        Literal["Contact details (HTTP Unsecured)", "Unstructured Document"],
+        Field(description="The display text for the code."),
+    ]
+
+
 class Period(BaseModel):
     id: Annotated[
         Optional[str],
@@ -461,7 +476,7 @@ class DocumentReferenceContent(BaseModel):
         ),
     ]
     format: Annotated[
-        Coding,
+        NRLFormatCode,
         Field(
             description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType."
         ),
diff --git a/layer/nrlf/producer/fhir/r4/model.py b/layer/nrlf/producer/fhir/r4/model.py
@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  swagger.yaml
-#   timestamp: 2024-12-06T02:57:56+00:00
+#   timestamp: 2024-12-06T04:10:35+00:00
 
 from __future__ import annotations
 
@@ -249,6 +249,21 @@ class ContentStabilityExtension(BaseModel):
     valueCodeableConcept: ValueCodeableConcept
 
 
+class NRLFormatCode(BaseModel):
+    system: Annotated[
+        Literal["https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"],
+        Field(description="The system URL for the NRLF Format Code."),
+    ]
+    code: Annotated[
+        Literal["urn:nhs-ic:record-contact", "urn:nhs-ic:unstructured"],
+        Field(description="The code representing the format of the document."),
+    ]
+    display: Annotated[
+        Literal["Contact details (HTTP Unsecured)", "Unstructured Document"],
+        Field(description="The display text for the code."),
+    ]
+
+
 class Period(BaseModel):
     id: Annotated[
         Optional[str],
@@ -451,7 +466,7 @@ class DocumentReferenceContent(BaseModel):
         ),
     ]
     format: Annotated[
-        Coding,
+        NRLFormatCode,
         Field(
             description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType."
         ),
diff --git a/layer/nrlf/producer/fhir/r4/strict_model.py b/layer/nrlf/producer/fhir/r4/strict_model.py
@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  swagger.yaml
-#   timestamp: 2024-12-06T02:57:58+00:00
+#   timestamp: 2024-12-06T04:10:36+00:00
 
 from __future__ import annotations
 
@@ -226,6 +226,21 @@ class ContentStabilityExtension(BaseModel):
     valueCodeableConcept: ValueCodeableConcept
 
 
+class NRLFormatCode(BaseModel):
+    system: Annotated[
+        Literal["https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"],
+        Field(description="The system URL for the NRLF Format Code."),
+    ]
+    code: Annotated[
+        Literal["urn:nhs-ic:record-contact", "urn:nhs-ic:unstructured"],
+        Field(description="The code representing the format of the document."),
+    ]
+    display: Annotated[
+        Literal["Contact details (HTTP Unsecured)", "Unstructured Document"],
+        Field(description="The display text for the code."),
+    ]
+
+
 class Period(BaseModel):
     id: Annotated[
         Optional[StrictStr],
@@ -398,7 +413,7 @@ class DocumentReferenceContent(BaseModel):
         ),
     ]
     format: Annotated[
-        Coding,
+        NRLFormatCode,
         Field(
             description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType."
         ),
diff --git a/swagger/producer-static/components.yaml b/swagger/producer-static/components.yaml
@@ -122,7 +122,7 @@ components:
                 format:
                   system: https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode
                   code: "urn:nhs-ic:unstructured"
-                  display: Unstructured document
+                  display: Unstructured Document
             context:
               practiceSetting:
                 coding:
diff --git a/swagger/producer-static/narrative.yaml b/swagger/producer-static/narrative.yaml
@@ -287,7 +287,7 @@ paths:
             {
               "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
               "code": "urn:nhs-ic:unstructured"
-              "display": "Unstructured document"
+              "display": "Unstructured Document"
             }
           ]
           ```
diff --git a/tests/data/DocumentReference/RQI-736253002-Valid.json b/tests/data/DocumentReference/RQI-736253002-Valid.json
@@ -69,7 +69,7 @@
       "format": {
         "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
         "code": "urn:nhs-ic:unstructured",
-        "display": "Unstructured document"
+        "display": "Unstructured Document"
       },
       "extension": [
         {
diff --git a/tests/data/DocumentReference/Y05868-736253002-Valid-with-date-and-meta-lastupdated.json b/tests/data/DocumentReference/Y05868-736253002-Valid-with-date-and-meta-lastupdated.json
@@ -73,7 +73,7 @@
       "format": {
         "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
         "code": "urn:nhs-ic:unstructured",
-        "display": "Unstructured document"
+        "display": "Unstructured Document"
       },
       "extension": [
         {
diff --git a/tests/data/DocumentReference/Y05868-736253002-Valid-with-date.json b/tests/data/DocumentReference/Y05868-736253002-Valid-with-date.json
@@ -70,7 +70,7 @@
       "format": {
         "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
         "code": "urn:nhs-ic:unstructured",
-        "display": "Unstructured document"
+        "display": "Unstructured Document"
       },
       "extension": [
         {
diff --git a/tests/data/DocumentReference/Y05868-736253002-Valid-with-meta-lastupdated.json b/tests/data/DocumentReference/Y05868-736253002-Valid-with-meta-lastupdated.json
@@ -72,7 +72,7 @@
       "format": {
         "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
         "code": "urn:nhs-ic:unstructured",
-        "display": "Unstructured document"
+        "display": "Unstructured Document"
       },
       "extension": [
         {
diff --git a/tests/data/DocumentReference/Y05868-736253002-Valid-with-ssp-content.json b/tests/data/DocumentReference/Y05868-736253002-Valid-with-ssp-content.json
@@ -69,7 +69,7 @@
       "format": {
         "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
         "code": "urn:nhs-ic:unstructured",
-        "display": "Unstructured document"
+        "display": "Unstructured Document"
       },
       "extension": [
         {
diff --git a/tests/data/DocumentReference/Y05868-736253002-Valid.json b/tests/data/DocumentReference/Y05868-736253002-Valid.json
@@ -69,7 +69,7 @@
       "format": {
         "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
         "code": "urn:nhs-ic:unstructured",
-        "display": "Unstructured document"
+        "display": "Unstructured Document"
       },
       "extension": [
         {
diff --git a/tests/features/consumer/readDocumentReference-success.feature b/tests/features/consumer/readDocumentReference-success.feature
@@ -73,7 +73,7 @@ Feature: Consumer - readDocumentReference - Success Scenarios
             "format": {
               "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
               "code": "urn:nhs-ic:unstructured",
-              "display": "Unstructured document"
+              "display": "Unstructured Document"
             }
           }
         ],
@@ -164,7 +164,7 @@ Feature: Consumer - readDocumentReference - Success Scenarios
             "format": {
               "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
               "code": "urn:nhs-ic:unstructured",
-              "display": "Unstructured document"
+              "display": "Unstructured Document"
             }
           }
         ],
diff --git a/tests/features/producer/createDocumentReference-failure.feature b/tests/features/producer/createDocumentReference-failure.feature
@@ -704,7 +704,7 @@ Feature: Producer - createDocumentReference - Failure Scenarios
           "format": {
               "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
               "code": "urn:nhs-ic:unstructured",
-              "display": "Unstructured document"
+              "display": "Unstructured Document"
           }
         }
       ]
diff --git a/tests/features/producer/readDocumentReference-success.feature b/tests/features/producer/readDocumentReference-success.feature
@@ -75,7 +75,7 @@ Feature: Producer - readDocumentReference - Success Scenarios
             "format": {
               "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
               "code": "urn:nhs-ic:unstructured",
-              "display": "Unstructured document"
+              "display": "Unstructured Document"
             }
           }
         ],
diff --git a/tests/features/producer/updateDocumentReference-failure.feature b/tests/features/producer/updateDocumentReference-failure.feature
@@ -122,7 +122,7 @@ Feature: Producer - updateDocumentReference - Failure Scenarios
             "format": {
                 "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
                 "code": "urn:nhs-ic:unstructured",
-                "display": "Unstructured document"
+                "display": "Unstructured Document"
             }
           }
         ]
@@ -179,7 +179,7 @@ Feature: Producer - updateDocumentReference - Failure Scenarios
             "format": {
                 "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
                 "code": "urn:nhs-ic:unstructured",
-                "display": "Unstructured document"
+                "display": "Unstructured Document"
             }
           }
         ]
diff --git a/tests/features/producer/upsertDocumentReference-failure.feature b/tests/features/producer/upsertDocumentReference-failure.feature
@@ -285,7 +285,7 @@ Feature: Producer - upsertDocumentReference - Failure Scenarios
           "format": {
               "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
               "code": "urn:nhs-ic:unstructured",
-              "display": "Unstructured document"
+              "display": "Unstructured Document"
           }
         }
       ]
diff --git a/tests/features/utils/constants.py b/tests/features/utils/constants.py
@@ -112,7 +112,7 @@
     "format": {
         "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
         "code": "urn:nhs-ic:unstructured",
-        "display": "Unstructured document"
+        "display": "Unstructured Document"
     }
   }
 ]
diff --git a/tests/features/utils/data.py b/tests/features/utils/data.py
@@ -42,7 +42,7 @@ def create_test_document_reference(items: dict) -> DocumentReference:
                             "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
                         ),
                         code=items.get("formatCode", "urn:nhs-ic:unstructured"),
-                        display=items.get("formatDisplay", "Unstructured document"),
+                        display=items.get("formatDisplay", "Unstructured Document"),
                     ),
                 )
             ],
diff --git a/tests/smoke/setup.py b/tests/smoke/setup.py
@@ -36,7 +36,7 @@ def build_document_reference(
                 format=Coding(
                     system="https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",
                     code="urn:nhs-ic:unstructured",
-                    display="Unstructured document",
+                    display="Unstructured Document",
                 ),
             )
         ],

Original file line number	Diff line number	Diff line change
`@@ -287,7 +287,7 @@ paths:`
`287`	`287`	`{`
`288`	`288`	`"system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",`
`289`	`289`	`"code": "urn:nhs-ic:unstructured"`
`290`		`- "display": "Unstructured document"`
	`290`	`+ "display": "Unstructured Document"`
`291`	`291`	`}`
`292`	`292`	`]`
`293`	`293`	```
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@`
`69`	`69`	`"format": {`
`70`	`70`	`"system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",`
`71`	`71`	`"code": "urn:nhs-ic:unstructured",`
`72`		`- "display": "Unstructured document"`
	`72`	`+ "display": "Unstructured Document"`
`73`	`73`	`},`
`74`	`74`	`"extension": [`
`75`	`75`	`{`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@`
`73`	`73`	`"format": {`
`74`	`74`	`"system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",`
`75`	`75`	`"code": "urn:nhs-ic:unstructured",`
`76`		`- "display": "Unstructured document"`
	`76`	`+ "display": "Unstructured Document"`
`77`	`77`	`},`
`78`	`78`	`"extension": [`
`79`	`79`	`{`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@`
`70`	`70`	`"format": {`
`71`	`71`	`"system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode",`
`72`	`72`	`"code": "urn:nhs-ic:unstructured",`
`73`		`- "display": "Unstructured document"`
	`73`	`+ "display": "Unstructured Document"`
`74`	`74`	`},`
`75`	`75`	`"extension": [`
`76`	`76`	`{`