Merge pull request #970 from NHSDigital/feature/eema1-NRL-791-removeSuffixCustodians

NRL-791 remove ods code extension header and custodian suffix logic

Author: eesa456

api/consumer/swagger.yaml

@@ -260,7 +260,6 @@ paths:
         - $ref: "#/components/parameters/category"
         - $ref: "#/components/parameters/nextPageToken"
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       responses:
@@ -516,7 +515,6 @@ paths:
       parameters:
         - $ref: "#/components/parameters/id"
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       responses:
@@ -1644,12 +1642,6 @@ components:
         invalid:
           summary: Unknown
           value: XYZ
-    odsCodeExtension:
-      name: NHSD-End-User-Organisation
-      description: Organisation extension code
-      in: header
-      schema:
-        $ref: "#/components/schemas/RequestHeaderOrganisationExtensionCode"
     requestId:
       name: X-Request-ID
       description: |

api/producer/createDocumentReference/create_document_reference.py

@@ -64,14 +64,11 @@ def _check_permissions(
     """
     Check the requester has permissions to create the DocumentReference
     """
-    custodian_parts = tuple(
-        filter(None, (core_model.custodian, core_model.custodian_suffix))
-    )
-    if metadata.ods_code_parts != custodian_parts:
+    if metadata.ods_code != core_model.custodian:
         logger.log(
             LogReference.PROCREATE004,
-            ods_code_parts=metadata.ods_code_parts,
-            custodian_parts=custodian_parts,
+            ods_code=metadata.ods_code,
+            custodian=core_model.custodian,
         )
         return SpineErrorResponse.UNPROCESSABLE_ENTITY(
             diagnostics="The custodian of the provided DocumentReference does not match the expected ODS code for this organisation",
@@ -138,11 +135,11 @@ def _validate_producer_id(identifier, metadata, idx):
     Validate that there is an ODS code in the relatesTo target identifier
     """
     producer_id = identifier.split("-", 1)[0]
-    if metadata.ods_code_parts != tuple(producer_id.split("|")):
+    if metadata.ods_code != producer_id:
         logger.log(
             LogReference.PROCREATE007b,
             related_identifier=identifier,
-            ods_code_parts=metadata.ods_code_parts,
+            ods_code=metadata.ods_code,
         )
         _raise_operation_outcome_error(
             "The relatesTo target identifier value does not include the expected ODS code for this organisation",
@@ -229,8 +226,7 @@ def handler(
     logger.log(LogReference.PROCREATE000)
     logger.log(LogReference.PROCREATE001, resource=body)
 
-    id_prefix = "|".join(metadata.ods_code_parts)
-    body.id = f"{id_prefix}-{uuid4()}"
+    body.id = f"{metadata.ods_code}-{uuid4()}"
 
     validator = DocumentReferenceValidator()
     result = validator.validate(body)

api/producer/deleteDocumentReference/delete_document_reference.py

@@ -28,10 +28,10 @@ def handler(
     pointer_id = urllib.parse.unquote(path.id)
     producer_id, _ = pointer_id.split("-", 1)
 
-    if metadata.ods_code_parts != tuple(producer_id.split(".")):
+    if metadata.ods_code != producer_id:
         logger.log(
             LogReference.PRODELETE001,
-            ods_code_parts=metadata.ods_code_parts,
+            ods_code=metadata.ods_code,
             producer_id=producer_id,
         )
         return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR(

api/producer/readDocumentReference/read_document_reference.py

@@ -38,10 +38,10 @@ def handler(
     parsed_id = urllib.parse.unquote(path.id)
 
     producer_id = parsed_id.split("-", maxsplit=1)[0]
-    if metadata.ods_code_parts != tuple(producer_id.split(".")):
+    if metadata.ods_code != producer_id:
         logger.log(
             LogReference.PROREAD001,
-            ods_code_parts=metadata.ods_code_parts,
+            ods_code=metadata.ods_code,
             producer_id=producer_id,
         )
         return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR(

api/producer/searchDocumentReference/search_document_reference.py

@@ -80,15 +80,13 @@ def handler(
     logger.log(
         LogReference.PROSEARCH003,
         custodian=metadata.ods_code,
-        custodian_suffix=metadata.ods_code_extension,
         nhs_number=params.nhs_number,
         pointer_types=pointer_types,
         categories=params.category.root.split(",") if params.category else [],
     )
 
     for result in repository.search(
         custodian=metadata.ods_code,
-        custodian_suffix=metadata.ods_code_extension,
         nhs_number=params.nhs_number,
         pointer_types=pointer_types,
         categories=params.category.root.split(",") if params.category else [],

api/producer/searchPostDocumentReference/search_post_document_reference.py

@@ -74,15 +74,13 @@ def handler(
     logger.log(
         LogReference.PROPOSTSEARCH003,
         custodian=metadata.ods_code,
-        custodian_suffix=metadata.ods_code_extension,
         nhs_number=body.nhs_number,
         pointer_types=pointer_types,
         categories=categories,
     )
 
     for result in repository.search(
         custodian=metadata.ods_code,
-        custodian_suffix=metadata.ods_code_extension,
         nhs_number=body.nhs_number,
         pointer_types=pointer_types,
         categories=categories,

api/producer/swagger.yaml

@@ -267,7 +267,6 @@ paths:
         $ref: "#/components/requestBodies/DocumentReference"
       parameters:
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       x-amazon-apigateway-integration:
@@ -408,7 +407,6 @@ paths:
         - $ref: "#/components/parameters/category"
         - $ref: "#/components/parameters/nextPageToken"
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       responses:
@@ -610,7 +608,6 @@ paths:
       operationId: upsertDocumentReference
       parameters:
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       responses:
@@ -687,7 +684,6 @@ paths:
       operationId: searchPostDocumentReference
       parameters:
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       requestBody:
@@ -902,7 +898,6 @@ paths:
       parameters:
         - $ref: "#/components/parameters/id"
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       responses:
@@ -1005,7 +1000,6 @@ paths:
       parameters:
         - $ref: "#/components/parameters/id"
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       responses:
@@ -1084,7 +1078,6 @@ paths:
       parameters:
         - $ref: "#/components/parameters/id"
         - $ref: "#/components/parameters/odsCode"
-        - $ref: "#/components/parameters/odsCodeExtension"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
       responses:
@@ -2247,12 +2240,6 @@ components:
         invalid:
           summary: Unknown
           value: XYZ
-    odsCodeExtension:
-      name: NHSD-End-User-Organisation
-      description: Organisation extension code
-      in: header
-      schema:
-        $ref: "#/components/schemas/RequestHeaderOrganisationExtensionCode"
     requestId:
       name: X-Request-ID
       description: |

api/producer/updateDocumentReference/tests/test_update_document_reference.py

@@ -30,7 +30,6 @@ def test_update_document_reference_happy_path(repository: DocumentPointerReposit
 
     existing_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999")
     assert existing_doc_pointer is not None
-
     existing_doc_ref = DocumentReference.model_validate_json(
         existing_doc_pointer.document
     )

api/producer/updateDocumentReference/update_document_reference.py

@@ -61,10 +61,10 @@ def handler(
 
     core_model = DocumentPointer.from_document_reference(document_reference)
 
-    if metadata.ods_code_parts != tuple(core_model.producer_id.split("|")):
+    if metadata.ods_code != core_model.producer_id:
         logger.log(
             LogReference.PROUPDATE004,
-            metadata_ods_code_parts=metadata.ods_code_parts,
+            metadata_ods_code=metadata.ods_code,
             producer_id=core_model.producer_id,
         )
         return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR(

api/producer/upsertDocumentReference/upsert_document_reference.py

@@ -62,14 +62,11 @@ def _check_permissions(
     """
     Check the requester has permissions to create the DocumentReference
     """
-    custodian_parts = tuple(
-        filter(None, (core_model.custodian, core_model.custodian_suffix))
-    )
-    if metadata.ods_code_parts != custodian_parts:
+    if metadata.ods_code != core_model.custodian:
         logger.log(
             LogReference.PROUPSERT004,
-            ods_code_parts=metadata.ods_code_parts,
-            custodian_parts=custodian_parts,
+            ods_code=metadata.ods_code,
+            custodian=core_model.custodian,
         )
         return SpineErrorResponse.UNPROCESSABLE_ENTITY(
             diagnostics="The custodian of the provided DocumentReference does not match the expected ODS code for this organisation",
@@ -141,11 +138,11 @@ def _validate_producer_id(identifier, metadata, idx):
     Validate that there is an ODS code in the relatesTo target identifier
     """
     producer_id = identifier.split("-", 1)[0]
-    if metadata.ods_code_parts != tuple(producer_id.split("|")):
+    if metadata.ods_code != producer_id:
         logger.log(
             LogReference.PROUPSERT007b,
             related_identifier=identifier,
-            ods_code_parts=metadata.ods_code_parts,
+            ods_code=metadata.ods_code,
         )
         _raise_operation_outcome_error(
             "The relatesTo target identifier value does not include the expected ODS code for this organisation",
@@ -233,10 +230,10 @@ def handler(
 
     core_model = _create_core_model(result.resource, metadata)
 
-    if metadata.ods_code_parts != tuple(core_model.producer_id.split("|")):
+    if metadata.ods_code != core_model.producer_id:
         logger.log(
             LogReference.PROUPSERT003,
-            ods_code_parts=metadata.ods_code_parts,
+            ods_code=metadata.ods_code,
             producer_id=core_model.producer_id,
         )
         return SpineErrorResponse.UNPROCESSABLE_ENTITY(