NRL-477 update model and error messages

Author: eesa456

api/consumer/swagger.yaml

@@ -788,7 +788,7 @@ components:
           description: The status of this document reference.
         docStatus:
           type: string
-          pattern: "^(entered-in-error|amended|preliminary|final)$"
+          enum: ["entered-in-error", "amended", "preliminary", "final"]
           description: The status of the underlying document.
         type:
           $ref: "#/components/schemas/CodeableConcept"

api/producer/createDocumentReference/tests/test_create_document_reference.py

@@ -445,7 +445,7 @@ def test_create_document_reference_with_invalid_docStatus():
                         }
                     ],
                 },
-                "diagnostics": "Request body could not be parsed (docStatus: String should match pattern '^(entered-in-error|amended|preliminary|final)$')",
+                "diagnostics": "Request body could not be parsed (docStatus: Input should be 'entered-in-error', 'amended', 'preliminary' or 'final')",
                 "expression": ["docStatus"],
             },
         ],

api/producer/swagger.yaml

@@ -1351,7 +1351,7 @@ components:
           description: The status of this document reference.
         docStatus:
           type: string
-          pattern: "^(entered-in-error|amended|preliminary|final)$"
+          enum: ["entered-in-error", "amended", "preliminary", "final"]
           description: The status of the underlying document.
         type:
           $ref: "#/components/schemas/CodeableConcept"

api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py

@@ -489,7 +489,7 @@ def test_upsert_document_reference_with_invalid_docStatus():
                         }
                     ],
                 },
-                "diagnostics": "Request body could not be parsed (docStatus: String should match pattern '^(entered-in-error|amended|preliminary|final)$')",
+                "diagnostics": "Request body could not be parsed (docStatus: Input should be 'entered-in-error', 'amended', 'preliminary' or 'final')",
                 "expression": ["docStatus"],
             },
         ],

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

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  swagger.yaml
-#   timestamp: 2024-12-05T01:41:57+00:00
+#   timestamp: 2024-12-11T14:01:43+00:00
 
 from __future__ import annotations
 
@@ -577,11 +577,8 @@ class DocumentReference(BaseModel):
         ),
     ]
     docStatus: Annotated[
-        Optional[str],
-        Field(
-            description="The status of the underlying document.",
-            pattern="^(entered-in-error|amended|preliminary|final)$",
-        ),
+        Optional[Literal["entered-in-error", "amended", "preliminary", "final"]],
+        Field(description="The status of the underlying document."),
     ] = None
     type: Annotated[
         Optional[CodeableConcept],

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

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  swagger.yaml
-#   timestamp: 2024-12-05T01:41:53+00:00
+#   timestamp: 2024-12-11T14:01:38+00:00
 
 from __future__ import annotations
 
@@ -561,11 +561,8 @@ class DocumentReference(BaseModel):
         ),
     ]
     docStatus: Annotated[
-        Optional[str],
-        Field(
-            description="The status of the underlying document.",
-            pattern="^(entered-in-error|amended|preliminary|final)$",
-        ),
+        Optional[Literal["entered-in-error", "amended", "preliminary", "final"]],
+        Field(description="The status of the underlying document."),
     ] = None
     type: Annotated[
         Optional[CodeableConcept],

layer/nrlf/producer/fhir/r4/strict_model.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  swagger.yaml
-#   timestamp: 2024-12-05T01:41:55+00:00
+#   timestamp: 2024-12-11T14:01:41+00:00
 
 from __future__ import annotations
 
@@ -491,7 +491,8 @@ class DocumentReference(BaseModel):
         StrictStr, Field(description="The status of this document reference.")
     ]
     docStatus: Annotated[
-        Optional[StrictStr], Field(description="The status of the underlying document.")
+        Optional[Literal["entered-in-error", "amended", "preliminary", "final"]],
+        Field(description="The status of the underlying document."),
     ] = None
     type: Annotated[
         Optional[CodeableConcept],

tests/features/producer/createDocumentReference-failure.feature

@@ -499,48 +499,6 @@ Feature: Producer - createDocumentReference - Failure Scenarios
       }
       """
 
-  # Invalid document reference - invalid Type
-  # NRL-769 Known issue: Type display is not validated
-  # Scenario: Invalid type (valid code but wrong display value)
-  # Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API
-  # And the organisation 'TSTCUS' is authorised to access pointer types:
-  # | system                 | value            |
-  # | http://snomed.info/sct | 1363501000000100 |
-  # | http://snomed.info/sct | 736253002        |
-  # When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'type' is:
-  # """
-  # "type": {
-  # "coding": [
-  # {
-  # "system": "http://snomed.info/sct",
-  # "code": "736253002",
-  # "display": "Emergency Healthcare Plan"
-  # }
-  # ]
-  # }
-  # """
-  # Then the response status code is 400
-  # And the response is an OperationOutcome with 1 issue
-  # And the OperationOutcome contains the issue:
-  # """
-  # {
-  # "severity": "error",
-  # "code": "invalid",
-  # "details": {
-  # "coding": [
-  # {
-  # "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
-  # "code": "BAD_REQUEST",
-  # "display": "Bad request"
-  # }
-  # ]
-  # },
-  # "diagnostics": "The display does not match the expected value for this type",
-  # "expression": [
-  # "type.coding.display"
-  # ]
-  # }
-  # """
   # Invalid document reference - empty content[0].attachment.url
   # Invalid document reference - create another producers document
   # Invalid document reference - bad JSON