Fixing and adding new methods / classes

Author: adrianoaru-nhs

classes/asa_grade_type.py

@@ -0,0 +1,83 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class ASAGradeType(Enum):
+    """
+    Enum representing ASA grades for colonoscopy assessment scenarios,
+    with valid value IDs and descriptions.
+    """
+
+    IFIT = (17009, "I - Fit")
+    II_RELEVANT_DISEASE = (17010, "II - Relevant disease")
+    III_RESTRICTIVE_DISEASE = (17011, "III - Restrictive disease")
+    IV_LIFE_THREATENING_DISEASE = (17012, "IV - Life threatening disease")
+    V_MORIBUND = (17013, "V - Moribund")
+    NOT_APPLICABLE = (17014, "Not Applicable")
+    NOT_KNOWN = (17015, "Not Known")
+    NULL = (None, "")
+
+    def __init__(self, valid_value_id: Optional[int], description: str):
+        self._valid_value_id: Optional[int] = valid_value_id
+        self._description: str = description
+
+    @property
+    def valid_value_id(self) -> Optional[int]:
+        """Returns the valid value ID for the ASA grade."""
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """Returns the description for the ASA grade."""
+        return self._description
+
+    @classmethod
+    def _build_maps(cls) -> None:
+        if not hasattr(cls, "_descriptions"):
+            cls._descriptions: Dict[str, ASAGradeType] = {}
+            cls._lowercase_descriptions: Dict[str, ASAGradeType] = {}
+            cls._valid_value_ids: Dict[Optional[int], ASAGradeType] = {}
+            for item in cls:
+                cls._descriptions[item.description] = item
+                cls._lowercase_descriptions[item.description.lower()] = item
+                cls._valid_value_ids[item.valid_value_id] = item
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["ASAGradeType"]:
+        """
+        Returns the ASAGradeType matching the given description.
+        """
+        cls._build_maps()
+        return cls._descriptions.get(description)
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["ASAGradeType"]:
+        """
+        Returns the ASAGradeType matching the given description (case-insensitive).
+        """
+        cls._build_maps()
+        return cls._lowercase_descriptions.get(description.lower())
+
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: Optional[int]
+    ) -> Optional["ASAGradeType"]:
+        """
+        Returns the ASAGradeType matching the given valid value ID.
+        """
+        cls._build_maps()
+        return cls._valid_value_ids.get(valid_value_id)
+
+    def get_valid_value_id(self) -> Optional[int]:
+        """
+        Returns the valid value ID for the ASA grade.
+        """
+        return self._valid_value_id
+
+    def get_description(self) -> str:
+        """
+        Returns the description for the ASA grade.
+        """
+        return self._description

classes/cancer_treatment_intent.py

@@ -0,0 +1,75 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class CancerTreatmentIntent(Enum):
+    """
+    Enum representing types of cancer treatment intent with associated valid value IDs and descriptions.
+    Provides utility methods to retrieve enum instances by description or ID.
+    """
+
+    CURATIVE = (17370, "Curative")
+    PALLIATIVE = (17371, "Palliative")
+    UNCERTAIN = (17372, "Uncertain")
+    NOT_KNOWN = (17373, "Not Known")
+
+    def __init__(self, valid_value_id: int, description: str):
+        self._valid_value_id = valid_value_id
+        self._description = description
+
+    @property
+    def valid_value_id(self) -> int:
+        """Returns the valid value ID for the treatment given."""
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """Returns the description for the treatment given."""
+        return self._description
+
+    @classmethod
+    def _build_maps(cls) -> None:
+        if not hasattr(cls, "_descriptions"):
+            cls._descriptions: Dict[str, CancerTreatmentIntent] = {}
+            cls._lowercase_descriptions: Dict[str, CancerTreatmentIntent] = {}
+            cls._valid_value_ids: Dict[int, CancerTreatmentIntent] = {}
+            for item in cls:
+                cls._descriptions[item.description] = item
+                cls._lowercase_descriptions[item.description.lower()] = item
+                cls._valid_value_ids[item.valid_value_id] = item
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["CancerTreatmentIntent"]:
+        """
+        Returns the CancerTreatmentIntent matching the given description.
+        """
+        cls._build_maps()
+        return cls._descriptions.get(description)
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["CancerTreatmentIntent"]:
+        """
+        Returns the CancerTreatmentIntent matching the given description (case-insensitive).
+        """
+        cls._build_maps()
+        return cls._lowercase_descriptions.get(description.lower())
+
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: int
+    ) -> Optional["CancerTreatmentIntent"]:
+        """
+        Returns the CancerTreatmentIntent matching the given valid value ID.
+        """
+        cls._build_maps()
+        return cls._valid_value_ids.get(valid_value_id)
+
+    def get_id(self) -> int:
+        """Returns the valid value ID for the CancerTreatmentIntent given."""
+        return self._valid_value_id
+
+    def get_description(self) -> str:
+        """Returns the description for the CancerTreatmentIntent given."""
+        return self._description

classes/diagnostic_test_referral_type.py

@@ -0,0 +1,76 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class DiagnosticTestReferralType(Enum):
+    """
+    Enum representing diagnostic test referral types with valid value IDs and descriptions.
+    """
+
+    ENDOSCOPIC = (20356, "Endoscopic")
+    RADIOLOGICAL = (20357, "Radiological")
+
+    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:
+        """Returns the valid value ID for the diagnostic test referral type."""
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """Returns the description for the diagnostic test referral type."""
+        return self._description
+
+    @classmethod
+    def _build_maps(cls) -> None:
+        if not hasattr(cls, "_descriptions"):
+            cls._descriptions: Dict[str, DiagnosticTestReferralType] = {}
+            cls._lowercase_descriptions: Dict[str, DiagnosticTestReferralType] = {}
+            cls._valid_value_ids: Dict[int, DiagnosticTestReferralType] = {}
+            for item in cls:
+                cls._descriptions[item.description] = item
+                cls._lowercase_descriptions[item.description.lower()] = item
+                cls._valid_value_ids[item.valid_value_id] = item
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["DiagnosticTestReferralType"]:
+        """
+        Returns the DiagnosticTestReferralType matching the given description.
+        """
+        cls._build_maps()
+        return cls._descriptions.get(description)
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["DiagnosticTestReferralType"]:
+        """
+        Returns the DiagnosticTestReferralType matching the given description (case-insensitive).
+        """
+        cls._build_maps()
+        return cls._lowercase_descriptions.get(description.lower())
+
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: int
+    ) -> Optional["DiagnosticTestReferralType"]:
+        """
+        Returns the DiagnosticTestReferralType matching the given valid value ID.
+        """
+        cls._build_maps()
+        return cls._valid_value_ids.get(valid_value_id)
+
+    def get_id(self) -> int:
+        """
+        Returns the valid value ID for the diagnostic test referral type.
+        """
+        return self._valid_value_id
+
+    def get_description(self) -> str:
+        """
+        Returns the description for the diagnostic test referral type.
+        """
+        return self._description

classes/final_pretreatment_m_category_type.py

@@ -0,0 +1,76 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class FinalPretreatmentMCategoryType(Enum):
+    """
+    Enum representing final pretreatment M categories for cancer audit datasets,
+    with valid value IDs and descriptions.
+    """
+
+    CM1 = (17248, "Metastases (cM1)")
+    CM0 = (17247, "No Metastases (cM0)")
+    NOT_REPORTED = (202140, "Not Reported")
+
+    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:
+        """Returns the valid value ID for the M category."""
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """Returns the description for the M category."""
+        return self._description
+
+    @classmethod
+    def _build_maps(cls) -> None:
+        if not hasattr(cls, "_descriptions"):
+            cls._descriptions: Dict[str, FinalPretreatmentMCategoryType] = {}
+            cls._lowercase_descriptions: Dict[str, FinalPretreatmentMCategoryType] = {}
+            cls._valid_value_ids: Dict[int, FinalPretreatmentMCategoryType] = {}
+            for item in cls:
+                cls._descriptions[item.description] = item
+                cls._lowercase_descriptions[item.description.lower()] = item
+                cls._valid_value_ids[item.valid_value_id] = item
+
+    @classmethod
+    def by_description(
+        cls, description: str
+    ) -> Optional["FinalPretreatmentMCategoryType"]:
+        """
+        Returns the FinalPretreatmentMCategoryType matching the given description.
+        """
+        cls._build_maps()
+        return cls._descriptions.get(description)
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["FinalPretreatmentMCategoryType"]:
+        """
+        Returns the FinalPretreatmentMCategoryType matching the given description (case-insensitive).
+        """
+        cls._build_maps()
+        return cls._lowercase_descriptions.get(description.lower())
+
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: int
+    ) -> Optional["FinalPretreatmentMCategoryType"]:
+        """
+        Returns the FinalPretreatmentMCategoryType matching the given valid value ID.
+        """
+        cls._build_maps()
+        return cls._valid_value_ids.get(valid_value_id)
+
+    def get_id(self) -> int:
+        """Returns the valid value ID for the M category."""
+        return self._valid_value_id
+
+    def get_description(self) -> str:
+        """Returns the description for the M category."""
+        return self._description

classes/final_pretreatment_n_category_type.py

@@ -0,0 +1,78 @@
+from enum import Enum
+from typing import Optional, Dict
+
+
+class FinalPretreatmentNCategoryType(Enum):
+    """
+    Enum representing final pretreatment N categories for cancer audit datasets,
+    with valid value IDs and descriptions.
+    """
+
+    CNX = (202201, "Regional lymph nodes cannot be assessed (cNX)")
+    CN0 = (17256, "No regional lymph node metastasis (cN0)")
+    CN1 = (17257, "Metastasis in 1 to 3 regional lymph nodes (cN1)")
+    CN2 = (17258, "Metastasis in 4 or more regional lymph nodes (cN2)")
+    NOT_REPORTED = (202140, "Not Reported")
+
+    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:
+        """Returns the valid value ID for the N category."""
+        return self._valid_value_id
+
+    @property
+    def description(self) -> str:
+        """Returns the description for the N category."""
+        return self._description
+
+    @classmethod
+    def _build_maps(cls) -> None:
+        if not hasattr(cls, "_descriptions"):
+            cls._descriptions: Dict[str, FinalPretreatmentNCategoryType] = {}
+            cls._lowercase_descriptions: Dict[str, FinalPretreatmentNCategoryType] = {}
+            cls._valid_value_ids: Dict[int, FinalPretreatmentNCategoryType] = {}
+            for item in cls:
+                cls._descriptions[item.description] = item
+                cls._lowercase_descriptions[item.description.lower()] = item
+                cls._valid_value_ids[item.valid_value_id] = item
+
+    @classmethod
+    def by_description(
+        cls, description: str
+    ) -> Optional["FinalPretreatmentNCategoryType"]:
+        """
+        Returns the FinalPretreatmentNCategoryType matching the given description.
+        """
+        cls._build_maps()
+        return cls._descriptions.get(description)
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["FinalPretreatmentNCategoryType"]:
+        """
+        Returns the FinalPretreatmentNCategoryType matching the given description (case-insensitive).
+        """
+        cls._build_maps()
+        return cls._lowercase_descriptions.get(description.lower())
+
+    @classmethod
+    def by_valid_value_id(
+        cls, valid_value_id: int
+    ) -> Optional["FinalPretreatmentNCategoryType"]:
+        """
+        Returns the FinalPretreatmentNCategoryType matching the given valid value ID.
+        """
+        cls._build_maps()
+        return cls._valid_value_ids.get(valid_value_id)
+
+    def get_id(self) -> int:
+        """Returns the valid value ID for the N category."""
+        return self._valid_value_id
+
+    def get_description(self) -> str:
+        """Returns the description for the N category."""
+        return self._description