Added more match cases, classes and methods. Updated markdown doc

Author: adrianoaru-nhs

classes/bowel_scope_dd_reason_for_change_type.py

@@ -0,0 +1,57 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class BowelScopeDDReasonForChangeType(Enum):
+    Ceased = (200669, "Ceased")
+    DateOfBirthAmendment = (205266, "Date of birth amendment")
+    EligibleToBeInvitedForFsScreening = (
+        200685,
+        "Eligible to be invited for FS Screening",
+    )
+    FsScreeningEpisodeOpened = (205002, "FS Screening episode opened")
+    MultipleDateOfBirthChanges = (202426, "Multiple Date of Birth Changes")
+    NoLongerEligibleToBeInvitedForFsScreening = (
+        200668,
+        "No longer eligible to be invited for FS Screening",
+    )
+    ReopenedFsEpisode = (205012, "Reopened FS Episode")
+    SeekingFurtherData = (200670, "Seeking further data")
+
+    def __init__(self, valid_value_id: int, description: str):
+        self._valid_value_id: int = valid_value_id
+        self._description: str = description
+
+    @property
+    def valid_value_id(self) -> int:
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        return self._description
+
+    @classmethod
+    def _descriptions(cls) -> Dict[str, "BowelScopeDDReasonForChangeType"]:
+        return {item.description: item for item in cls}
+
+    @classmethod
+    def _lowercase_descriptions(cls) -> Dict[str, "BowelScopeDDReasonForChangeType"]:
+        return {item.description.lower(): item for item in cls}
+
+    @classmethod
+    def _valid_value_ids(cls) -> Dict[int, "BowelScopeDDReasonForChangeType"]:
+        return {item.valid_value_id: item for item in cls}
+
+    @classmethod
+    def by_description(
+        cls, description: Optional[str]
+    ) -> Optional["BowelScopeDDReasonForChangeType"]:
+        if description is None:
+            return None
+        return cls._lowercase_descriptions().get(description.lower())
+
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: int
+    ) -> Optional["BowelScopeDDReasonForChangeType"]:
+        return cls._valid_value_ids().get(valid_value_id)

classes/ceased_confirmation_details.py

@@ -0,0 +1,17 @@
+from enum import Enum
+from typing import Optional
+
+
+class CeasedConfirmationDetails(Enum):
+    NULL = "null"
+    NOT_NULL = "not null"
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["CeasedConfirmationDetails"]:
+        for item in cls:
+            if item.value == description:
+                return item
+        return None
+
+    def get_description(self) -> str:
+        return self.value

classes/ceased_confirmation_user_id.py

@@ -0,0 +1,19 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class CeasedConfirmationUserId(Enum):
+    AUTOMATED_PROCESS_ID = "automated process id"
+    NULL = "null"
+    NOT_NULL = "not null"
+    USER_ID = "user's id"
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["CeasedConfirmationUserId"]:
+        for item in cls:
+            if item.value == description:
+                return item
+        return None
+
+    def get_description(self) -> str:
+        return self.value

classes/clinical_cease_reason_type.py

@@ -0,0 +1,75 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class ClinicalCeaseReasonType(Enum):
+    # BCSS values
+    ALREADY_INVOLVED_IN_SURVEILLANCE_PROGRAMME_OUTSIDE_BCSP = (
+        11369,
+        "Already involved in Surveillance Programme outside BCSP",
+    )
+    CLINICAL_ASSESSMENT_INDICATES_CEASE_SURVEILLANCE_AND_SCREENING = (
+        20066,
+        "Clinical Assessment indicates Cease Surveillance and Screening",
+    )
+    CURRENTLY_UNDER_TREATMENT = (11371, "Currently under treatment")
+    NO_FUNCTIONING_COLON = (11366, "No functioning colon")
+    RECENT_COLONOSCOPY = (11372, "Recent colonoscopy")
+    REFER_TO_SYMPTOMATIC_SERVICE = (205274, "Refer to Symptomatic Service")
+    TERMINAL_ILLNESS = (11367, "Terminal Illness")
+    UNDER_TREATMENT_FOR_ULCERATIVE_COLITIS_CROHNS_DISEASE_BOWEL_CANCER_OR_OTHER_RESULTING_IN_CEASE = (
+        11368,
+        "Under treatment for ulcerative colitis, Crohn's disease, bowel cancer or other, resulting in cease",
+    )
+    UNFIT_FOR_FURTHER_INVESTIGATION = (11373, "Unfit for further investigation")
+
+    # Extra subject selection criteria values
+    NULL = (None, "Null")
+    NOT_NULL = (None, "Not Null")
+
+    def __init__(self, valid_value_id: Optional[int], description: str):
+        self._valid_value_id = valid_value_id
+        self._description = description
+
+    @property
+    def valid_value_id(self) -> Optional[int]:
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        return self._description
+
+    @classmethod
+    def _build_lookup_maps(cls):
+        cls._descriptions: Dict[str, "ClinicalCeaseReasonType"] = {}
+        cls._lowercase_descriptions: Dict[str, "ClinicalCeaseReasonType"] = {}
+        cls._valid_value_ids: Dict[int, "ClinicalCeaseReasonType"] = {}
+
+        for member in cls:
+            if member.description:
+                cls._descriptions[member.description] = member
+                cls._lowercase_descriptions[member.description.lower()] = member
+            if member.valid_value_id is not None:
+                cls._valid_value_ids[member.valid_value_id] = member
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["ClinicalCeaseReasonType"]:
+        if not hasattr(cls, "_descriptions"):
+            cls._build_lookup_maps()
+        return cls._descriptions.get(description)
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["ClinicalCeaseReasonType"]:
+        if not hasattr(cls, "_lowercase_descriptions"):
+            cls._build_lookup_maps()
+        return cls._lowercase_descriptions.get(description.lower())
+
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: int
+    ) -> Optional["ClinicalCeaseReasonType"]:
+        if not hasattr(cls, "_valid_value_ids"):
+            cls._build_lookup_maps()
+        return cls._valid_value_ids.get(valid_value_id)

classes/has_unprocessed_sspi_updates.py

@@ -0,0 +1,17 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class HasUnprocessedSSPIUpdates(Enum):
+    NO = "no"
+    YES = "yes"
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["HasUnprocessedSSPIUpdates"]:
+        for item in cls:
+            if item.value == description:
+                return item
+        return None
+
+    def get_description(self) -> str:
+        return self.value

classes/has_user_dob_update.py

@@ -0,0 +1,17 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class HasUserDobUpdate(Enum):
+    NO = "no"
+    YES = "yes"
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["HasUserDobUpdate"]:
+        for item in cls:
+            if item.value == description:
+                return item
+        return None
+
+    def get_description(self) -> str:
+        return self.value

classes/manual_cease_requested.py

@@ -0,0 +1,34 @@
+from enum import Enum
+from typing import Optional
+
+
+class ManualCeaseRequested(Enum):
+    NO = "no"
+    DISCLAIMER_LETTER_REQUIRED = "yes - disclaimer letter required (c1)"
+    DISCLAIMER_LETTER_SENT = "yes - disclaimer letter sent (c2)"
+    YES = "yes"
+
+    def __init__(self, description: str) -> None:
+        self._description: str = description
+
+    @property
+    def description(self) -> str:
+        return self._description
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["ManualCeaseRequested"]:
+        for item in cls:
+            if item.description == description:
+                return item
+        return None
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["ManualCeaseRequested"]:
+        if description is None:
+            return None
+        for item in cls:
+            if item.description.lower() == description.lower():
+                return item
+        return None

utils/oracle/TEMP_subject_selection_query_builder.md

@@ -144,6 +144,42 @@ Adds a date-based filter, supporting a wide range of date logic, including speci
 
 Handles special date criteria such as "last birthday", "calculated due date", "unchanged", and various event-based offsets.
 
+#### `_add_criteria_screening_due_date_reason(self, subject)`
+
+Adds a filter for the screening due date reason, handling null, not null, unchanged, and specific value logic.
+
+#### `_add_criteria_surveillance_due_date_reason(self, subject)`
+
+Adds a filter for the surveillance due date reason, handling null, not null, unchanged, and specific value logic.
+
+#### `_add_criteria_bowel_scope_due_date_reason(self, subject)`
+
+Adds a filter for the bowel scope due date reason, handling null, not null, unchanged, and specific value logic.
+
+#### `_add_criteria_ceased_confirmation_details(self)`
+
+Adds a filter for ceased confirmation details, handling null, not null, and string matching.
+
+#### `_add_criteria_ceased_confirmation_user_id(self, user)`
+
+Adds a filter for ceased confirmation user ID, handling numeric IDs, enum values, and special cases.
+
+#### `_add_criteria_clinical_reason_for_cease(self)`
+
+Adds a filter for clinical reason for cease, supporting string and enum-based logic.
+
+#### `_add_criteria_subject_has_event_status(self)`
+
+Adds a filter for subjects with or without a specific event status.
+
+#### `_add_criteria_has_unprocessed_sspi_updates(self)`
+
+Adds a filter for subjects with unprocessed SSPI updates.
+
+#### `_add_criteria_has_user_dob_update(self)`
+
+Adds a filter for subjects with user date of birth updates.
+
 ---
 
 ### SQL Helper Methods
@@ -250,6 +286,62 @@ Returns a `SelectionBuilderException` for invalid use of "unchanged".
 
 ---
 
+### Classes Used in This Module
+
+#### `Subject`
+
+Represents a screening subject, encapsulating all relevant subject data and providing methods to access screening status, due dates, and other subject-specific information.
+
+#### `User`
+
+Represents a user of the system, including their associated organisation and permissions.
+
+#### `Organisation`
+
+Represents an organisation (such as a hub or screening centre) with an organisation ID and related metadata.
+
+#### `SubjectSelectionCriteriaKey`
+
+An enum representing all possible criteria keys that can be used for subject selection. Each key includes metadata such as whether it allows the "NOT:" modifier or multiple values.
+
+#### `ScreeningStatusType`
+
+An enum representing possible screening statuses for a subject, with methods for lookup by description and value.
+
+#### `SSReasonForChangeType`
+
+An enum for reasons a subject's screening status was changed, with lookup methods.
+
+#### `SDDReasonForChangeType`
+
+An enum for reasons a subject's screening due date was changed, with lookup methods.
+
+#### `SSDDReasonForChangeType`
+
+An enum for reasons a subject's surveillance due date was changed, with lookup methods.
+
+#### `BowelScopeDDReasonForChangeType`
+
+An enum for reasons a subject's bowel scope due date was changed, with lookup methods.
+
+#### `CeasedConfirmationDetails`
+
+An enum for ceased confirmation details, supporting null/not-null and string matching.
+
+#### `CeasedConfirmationUserId`
+
+An enum for ceased confirmation user IDs, supporting special values and user lookups.
+
+#### `ManualCeaseRequested`
+
+An enum for manual cease request statuses, with case-insensitive lookup.
+
+#### `HasGPPractice`
+
+An enum for GP practice status (yes/no/active/inactive), with description-based lookup.
+
+---
+
 ## ToDo
 
 ### Selenium Copy
@@ -266,3 +358,8 @@ Returns a `SelectionBuilderException` for invalid use of "unchanged".
 - [ ] Add logging for all major decision points in query construction.
 - [ ] Review and update doc strings for clarity and completeness.
 - [ ] Double check `_add_criteria_date_field` against `addCriteriaDateField` to see if functionality ported over correctly. This included looking at any methods referenced in this method.
+
+### May Require Another Jira Ticket
+
+- [ ] Create tests around this utility to prove it works as intended. See if there is a current selenium test that does this.
+- [ ] Create a new utility around populating the Subject and User class objects. This will be beneficial as these two objects are passed into this utility.