Merge pull request #614 from NHSDigital/feature/made14-NRL-718-ignore-date-on-update

[NRL-718] Always preserve original date field during pointer updates

Author: mattdean3-nhs

api/producer/updateDocumentReference/tests/test_update_document_reference.py

@@ -683,6 +683,65 @@ def test_update_document_reference_with_meta_lastupdated_ignored(
     assert updated_doc_pointer.created_on == existing_doc_pointer.created_on
 
 
+@mock_aws
+@mock_repository
+@freeze_time("2024-03-21T12:34:56.789")
+def test_update_document_reference_with_invalid_date_ignored(
+    repository: DocumentPointerRepository,
+):
+    doc_ref = load_document_reference("Y05868-736253002-Valid-with-date")
+    doc_pointer = DocumentPointer.from_document_reference(doc_ref)
+    repository.create(doc_pointer)
+
+    existing_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999")
+    assert existing_doc_pointer is not None
+
+    existing_doc_ref = DocumentReference.parse_raw(existing_doc_pointer.document)
+    assert existing_doc_ref.docStatus == "final"
+
+    doc_ref.date = "2024-05-04T11:11:10.111Z"
+    doc_ref.docStatus = "entered-in-error"
+
+    event = create_test_api_gateway_event(
+        headers=create_headers(),
+        path_parameters={"id": "Y05868-99999-99999-999999"},
+        body=doc_ref.json(),
+    )
+
+    result = handler(event, create_mock_context())
+
+    body = result.pop("body")
+
+    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    parsed_body = json.loads(body)
+    assert parsed_body == {
+        "resourceType": "OperationOutcome",
+        "issue": [
+            {
+                "severity": "information",
+                "code": "informational",
+                "details": {
+                    "coding": [
+                        {
+                            "code": "RESOURCE_UPDATED",
+                            "display": "Resource updated",
+                            "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode",
+                        }
+                    ]
+                },
+                "diagnostics": "The DocumentReference has been updated",
+            }
+        ],
+    }
+
+    updated_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999")
+    assert updated_doc_pointer is not None
+
+    updated_doc_ref = DocumentReference.parse_raw(updated_doc_pointer.document)
+    assert updated_doc_ref.docStatus == "entered-in-error"
+    assert updated_doc_ref.date == "2024-03-20T00:00:01.000Z"
+
+
 @mock_aws
 @mock_repository
 def test_update_document_reference_existing_invalid_json(

api/producer/updateDocumentReference/update_document_reference.py

@@ -90,19 +90,29 @@ def handler(
             diagnostics="An error occurred whilst parsing the existing document reference",
         )
 
+    preserved_fields = ["date"]
+    for field in preserved_fields:
+        provided_field = getattr(result.resource, field, None)
+        existing_field = getattr(existing_resource, field, None)
+        if provided_field and provided_field != existing_field:
+            logger.log(
+                LogReference.PROUPDATE007,
+                field=field,
+                provided=provided_field,
+            )
+        setattr(document_reference, field, existing_field)
+
     immutable_fields = [
         "masterIdentifier",
         "id",
         "identifier",
         "status",
         "type",
         "subject",
-        "date",
         "custodian",
         "relatesTo",
         "author",
     ]
-
     for field in immutable_fields:
         if getattr(result.resource, field) != getattr(existing_resource, field):
             logger.log(LogReference.PROUPDATE006, field=field)
@@ -111,10 +121,13 @@ def handler(
                 expression=field,
             )
 
-    core_model.created_on = existing_model.created_on
-    core_model.updated_on = update_time
+    document_pointer_update = DocumentPointer.from_document_reference(
+        document_reference
+    )
+    document_pointer_update.created_on = existing_model.created_on
+    document_pointer_update.updated_on = update_time
 
-    repository.update(core_model)
+    repository.update(document_pointer_update)
 
     logger.log(LogReference.PROUPDATE999)
     return NRLResponse.RESOURCE_UPDATED()

layer/nrlf/core/log_references.py

@@ -352,6 +352,10 @@ class LogReference(Enum):
     PROUPDATE006 = _Reference(
         "WARN", "Cannot update DocumentReference as immutable fields have changed"
     )
+    PROUPDATE007 = _Reference(
+        "WARN",
+        "Update provided for DocumentReference with invalid preserved field, ignoring",
+    )
     PROUPDATE999 = _Reference(
         "INFO", "Successfully completed producer updateDocumentReference"
     )