nci-cidc-api-modules 1.2.34__py3-none-any.whl → 1.2.53__py3-none-any.whl

cidc_api/models/models.py

@@ -28,6 +28,7 @@ __all__ = [
     "JobFileCategories",
     "CategoryDataElements",
     "ValidationConfigs",
+    "MASTER_APPENDIX_A",
     "TRIAL_APPENDIX_A",
     "TRIAL_APPENDIX_A_CELL_THAT_ENDS_THE_HEADER",
     "REQUEST_LETTER",
@@ -35,7 +36,9 @@ __all__ = [
     "ADMIN_FILE_CATEGORIES",
     "FINAL_JOB_STATUS",
     "INGESTION_JOB_STATUSES",
-    "INGESTION_JOB_COLORS",
+    "INGESTION_PHASE_STATUSES",
+    "ASSAY_JOB_COLORS",
+    "CLINICAL_JOB_COLORS",
 ]
 
 import hashlib
@@ -1046,11 +1049,11 @@ class Permissions(CommonColumns):
             user_email_list.append(user.email)
             grant_lister_access(user.email)
 
-        if upload.upload_type in prism.SUPPORTED_SHIPPING_MANIFESTS:
+        if upload.upload_type in prism.SUPPORTED_MANIFESTS:
             # Passed with empty user email list because they will be queried for in CFn
             grant_download_access([], upload.trial_id, "participants info")
             grant_download_access([], upload.trial_id, "samples info")
-        elif upload.upload_type not in prism.SUPPORTED_WEIRD_MANIFESTS:
+        else:
             grant_download_access(user_email_list, upload.trial_id, upload.upload_type)
 
     @staticmethod
@@ -3261,6 +3264,7 @@ def upload_manifest_json(
     return manifest_upload.id
 
 
+MASTER_APPENDIX_A = "master_appendix_a"
 TRIAL_APPENDIX_A = "trial_appendix_a"
 REQUEST_LETTER = "request_letter"
 DETAILED_VALIDATION = "detailed_validation"
@@ -3360,6 +3364,16 @@ class PreprocessedFiles(CommonColumns):
         query = cls.add_job_filter(query, job_id)
         return query.all()
 
+    @classmethod
+    @with_default_session
+    def get_latest_current_file(
+        cls, file_category: str, job_id: int = None, session: Session = None
+    ) -> Optional["PreprocessedFiles"]:
+        """Return the latest 'current' file for the given category and job_id. Returns None if no file exists."""
+        query = session.query(cls).filter_by(file_category=file_category, status="current")
+        query = cls.add_job_filter(query, job_id)
+        return query.order_by(cls.version.desc()).first()
+
     @classmethod
     @with_default_session
     def get_file_by_category_and_version(
@@ -3435,8 +3449,10 @@ INGESTION_JOB_STATUSES = [
     "PUBLISHED",
 ]
 
+INGESTION_PHASE_STATUSES = ["NOT STARTED", "SUCCESS", "FAILED"]
+
 # Business decision to pass hex codes from the backend though that should be done by the front end...
-INGESTION_JOB_COLORS = {
+CLINICAL_JOB_COLORS = {
     "DRAFT": "",
     "INITIAL SUBMISSION": "#ACCAD7",
     "VALIDATION REVIEW": "#DABE90",
@@ -3444,6 +3460,13 @@ INGESTION_JOB_COLORS = {
     "INGESTION": "#8FCEC7",
     "PUBLISHED": "#90D9E6",
 }
+ASSAY_JOB_COLORS = {
+    "INITIAL SUBMISSION": "#43807E",
+    "VALIDATION REVIEW": "#906F3F",
+    "REVISION SUBMISSION": "#95358A",
+    "INGESTION": "#542C88",
+    "PUBLISHED": "#1C81A0",
+}
 # TODO If have "CANCELLED" concept or other final status, add here
 FINAL_JOB_STATUS = ["PUBLISHED"]
 TRIAL_APPENDIX_A_CELL_THAT_ENDS_THE_HEADER = "Data Category"
@@ -3465,11 +3488,54 @@ class IngestionJobs(CommonColumns):
     pending = Column(Boolean, nullable=False, default=False)
     start_date = Column(DateTime, nullable=True)
     error_status = Column(String, nullable=True)
+    job_type = Column(String, nullable=False, default="clinical")
+    assay_type = Column(String, nullable=True)
+    batch_id = Column(String, nullable=True)
+    submission_id = Column(String, nullable=True)
+    intake_path = Column(String, nullable=True)
+    uploader_email = Column(String, nullable=True)
+    is_template_downloaded = Column(Boolean, nullable=True)
+    master_aa_version = Column(Integer, nullable=True)
+    ingestion_phase_status = Column(
+        "ingestion_phase_status",
+        Enum(*INGESTION_PHASE_STATUSES, name="ingestion_phase_status"),
+        nullable=False,
+        default=INGESTION_PHASE_STATUSES[0],
+    )
 
     @staticmethod
     @with_default_session
-    def create(trial_id: str, status: str, version: int, pending: Boolean = False, session: Session = None):
-        new_job = IngestionJobs(trial_id=trial_id, status=status, version=version, pending=pending)
+    def create(
+        trial_id: str,
+        status: str,
+        version: int,
+        error_status: str = None,
+        pending: Boolean = False,
+        job_type: str = "clinical",
+        ingestion_phase_status=INGESTION_PHASE_STATUSES[0],
+        assay_type: str = None,
+        batch_id: str = None,
+        submission_id: str = None,
+        intake_path: str = None,
+        start_date: datetime = None,
+        uploader_email: str = None,
+        session: Session = None,
+    ):
+        new_job = IngestionJobs(
+            trial_id=trial_id,
+            status=status,
+            error_status=error_status,
+            version=version,
+            pending=pending,
+            job_type=job_type,
+            assay_type=assay_type,
+            batch_id=batch_id,
+            submission_id=submission_id,
+            intake_path=intake_path,
+            start_date=start_date,
+            uploader_email=uploader_email,
+            ingestion_phase_status=ingestion_phase_status,
+        )
         new_job.insert(session=session)
         return new_job
 
@@ -3494,29 +3560,43 @@ class IngestionJobs(CommonColumns):
 
     @classmethod
     @with_default_session
-    def get_jobs_by_trial(cls, trial_id: str, session: Session = None) -> list["IngestionJobs"]:
-        return session.query(cls).filter(cls.trial_id == trial_id).order_by(cls.version.desc()).all()
+    def get_jobs_by_trial(
+        cls, trial_id: str, job_type: str = "clinical", session: Session = None
+    ) -> list["IngestionJobs"]:
+        return (
+            session.query(cls)
+            .filter(cls.trial_id == trial_id, cls.job_type == job_type)
+            .order_by(cls.version.desc())
+            .all()
+        )
 
     @classmethod
     @with_default_session
-    def get_open_job_by_trial(cls, trial_id: str, session: Session = None) -> Optional["IngestionJobs"]:
+    def get_open_job_by_trial(
+        cls, trial_id: str, job_type: str = "clinical", session: Session = None
+    ) -> Optional["IngestionJobs"]:
         """Return the open job for a given trial if it exists."""
         return (
             session.query(cls)
             .filter(
                 cls.trial_id == trial_id,
+                cls.job_type == job_type,
                 cls.status.notin_(FINAL_JOB_STATUS),
             )
             .order_by(cls._created.desc())
             .first()
         )
 
+    @classmethod
+    def get_jobs_for_user(cls, user: Users, job_type: str = None) -> list["IngestionJobs"]:
+        return cls.get_assay_jobs_for_user(user) if job_type == "assay" else cls.get_clinical_jobs_for_user(user)
+
     @classmethod
     @with_default_session
-    def get_open_jobs_for_user(cls, user: Users, session: Session = None) -> list["IngestionJobs"]:
+    def get_clinical_jobs_for_user(cls, user: Users, session: Session = None) -> list["IngestionJobs"]:
         if user.role not in [CIDCRole.ADMIN.value, CIDCRole.CLINICAL_TRIAL_USER.value]:
             return []
-        job_query = session.query(cls).filter(cls.status.notin_(["DRAFT"]))
+        job_query = session.query(cls).filter(cls.status.notin_(["DRAFT"]), cls.job_type == "clinical")
         if (
             user.role != CIDCRole.ADMIN.value
             and not session.query(Permissions)
@@ -3539,6 +3619,81 @@ class IngestionJobs(CommonColumns):
             job_query = job_query.filter(cls.trial_id.in_(map(lambda x: x.trial_id, authorized_trials)))
         return job_query.order_by(cls._created.desc()).all()
 
+    @classmethod
+    @with_default_session
+    def get_assay_jobs_for_user(cls, user: Users, session: Session = None) -> list["IngestionJobs"]:
+        # TODO allow more than just Admin role and get authorized trials based on permissions
+        if user.role not in [CIDCRole.ADMIN.value]:
+            return []
+        return session.query(cls).filter(cls.job_type == "assay").order_by(cls._created.desc()).all()
+
+    @classmethod
+    @with_default_session
+    def get_unique_assay_job(
+        cls,
+        trial_id: str,
+        assay_type: str,
+        batch_id: str,
+        session: Session = None,
+    ) -> Optional["IngestionJobs"]:
+        """Look for unique assay job with matching trial_id/assay_type/batch_id combination."""
+        return (
+            session.query(cls)
+            .filter(
+                cls.job_type == "assay",
+                cls.trial_id == trial_id,
+                cls.assay_type == assay_type,
+                cls.batch_id == batch_id,
+            )
+            .first()
+        )
+
+    @classmethod
+    @with_default_session
+    def next_assay_submission_id(cls, trial_id: str, assay_type: str, session: Session = None) -> str:
+        """
+        Generate the next CIDC Submission ID for an assay job.
+
+        Format:
+          <trial_id>-<assay_type>-<yyyymmdd>        (first submission of the day)
+          <trial_id>-<assay_type>-<yyyymmdd>-<#>    (subsequent submissions on same day)
+
+        Uses only the most recent matching submission_id to determine the next suffix.
+        """
+        today_str = datetime.now().strftime("%Y%m%d")
+        base_submission_id = f"{trial_id}-{assay_type}-{today_str}"
+
+        # Get the most recent submission_id matching this prefix
+        latest = (
+            session.query(cls.submission_id)
+            .filter(
+                cls.trial_id == trial_id,
+                cls.assay_type == assay_type,
+                cls.submission_id.like(f"{base_submission_id}%"),
+            )
+            .order_by(cls._created.desc())
+            .first()
+        )
+
+        # No existing submission for this prefix -> start at 1
+        if not latest or not latest[0]:
+            return base_submission_id
+
+        last_id = latest[0]
+        # Case 1: the latest is exactly the prefix (i.e., first submission today)
+        if last_id == base_submission_id:
+            return f"{base_submission_id}-2"
+
+        # Case 2: latest already has a suffix
+        try:
+            _, last_suffix = last_id.rsplit("-", 1)
+            n = int(last_suffix)
+            return f"{base_submission_id}-{n + 1}"
+        except Exception as e:
+            # If malformed, restart numbering for safety
+            logger.error("Unexpected error parsing Submission ID in next_assay_submission_id: %s", e)
+            return f"{base_submission_id}-2"
+
 
 class JobFileCategories(CommonColumns):
     __tablename__ = "job_file_categories"
@@ -3613,6 +3768,7 @@ class CategoryDataElements(CommonColumns):
     name = Column(String, nullable=False)
     is_custom = Column(Boolean, nullable=False, default=False, server_default="false")
     element_type = Column(String, nullable=False)
+    data_type = Column(String, nullable=True)
     cardinality = Column(String, nullable=True)
 
     @classmethod

cidc_api/models/pydantic/base.py

@@ -0,0 +1,109 @@
+import copy
+from contextlib import contextmanager
+from typing import Self, ClassVar
+from pydantic import BaseModel, ConfigDict, model_validator, ValidationError
+from pydantic_core import InitErrorDetails
+
+from cidc_api.models.errors import ValueLocError
+from functools import wraps
+
+
+class Base(BaseModel):
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        from_attributes=True,
+        extra="allow",
+    )
+    forced_validators: ClassVar = []
+
+    # Validates the new state and updates the object if valid
+    def update(self, **kwargs):
+        self.model_validate(self.__dict__ | kwargs)
+        self.__dict__.update(kwargs)
+
+    # CM that delays validation until all fields are applied.
+    # If validation fails the original fields are restored and the ValidationError is raised.
+    @contextmanager
+    def delay_validation(self):
+        original_dict = copy.deepcopy(self.__dict__)
+        self.model_config["validate_assignment"] = False
+        try:
+            yield
+        finally:
+            self.model_config["validate_assignment"] = True
+        try:
+            self.model_validate(self.__dict__)
+        except:
+            self.__dict__.update(original_dict)
+            raise
+
+        # CM that delays validation until all fields are applied.
+
+    @classmethod
+    def split_list(cls, val):
+        """Listify fields that are multi-valued in input data, e.g. 'lung|kidney'"""
+        if type(val) == list:
+            return val
+        elif type(val) == str:
+            if not val:
+                return []
+            return val.split("|")
+        elif val == None:
+            return []
+        else:
+            raise ValueError("Field value must be string or list")
+
+    @model_validator(mode="wrap")
+    @classmethod
+    def check_all_forced_validators(cls, data, handler, info) -> Self:
+        """This base validator ensures all registered forced_validator(s) get called along with
+        normal model field validators no matter what the outcome of either is. Normal field_validator
+        and model_validator decorators don't guarantee this. We want to collect as many errors as we can.
+
+        Collects errors from both attempts and raises them in a combined ValidationError."""
+
+        validation_errors = []
+        # When assigning attributes to an already-hydrated model, data is an instance of the model
+        # instead of a dict and handler is an AssignmentValidatorCallable instead of a ValidatorCallable(!!)
+        extracted_data = data.model_dump() if not isinstance(data, dict) else data
+
+        for validator in cls.forced_validators:
+            try:
+                func_name = validator.__name__
+                func = getattr(cls, func_name)
+                func(extracted_data, info)
+            except (ValueError, ValueLocError) as e:
+                validation_errors.append(
+                    InitErrorDetails(
+                        type="value_error",
+                        loc=e.loc,
+                        input=extracted_data,
+                        ctx={"error": e},
+                    )
+                )
+        try:
+            # Instantiate the model to ensure all other normal field validations are called
+            retval = handler(data)
+        except ValidationError as e:
+            validation_errors.extend(e.errors())
+        if validation_errors:
+            raise ValidationError.from_exception_data(title=cls.__name__, line_errors=validation_errors)
+        return retval
+
+
+def forced_validator(func):
+    """A method marked with this decorator is added to the class list of forced_validators"""
+    func._is_forced_validator = True  # Tag the function object with a custom attribute
+    return func
+
+
+def forced_validators(cls):
+    """A class marked with this decorator accumulates its methods marked with force_validator into a list
+    for later invocation."""
+
+    cls.forced_validators = []
+    for obj in cls.__dict__.values():
+        if getattr(obj, "_is_forced_validator", False):
+            cls.forced_validators.append(obj)
+    return cls

cidc_api/models/pydantic/stage1/__init__.py

@@ -0,0 +1,56 @@
+from .additional_treatment import AdditionalTreatment
+from .adverse_event import AdverseEvent
+from .baseline_clinical_assessment import BaselineClinicalAssessment
+from .comorbidity import Comorbidity
+from .consent_group import ConsentGroup
+from .demographic import Demographic
+from .disease import Disease
+from .exposure import Exposure
+from .gvhd_diagnosis_acute import GVHDDiagnosisAcute
+from .gvhd_diagnosis_chronic import GVHDDiagnosisChronic
+from .gvhd_organ_acute import GVHDOrganAcute
+from .gvhd_organ_chronic import GVHDOrganChronic
+from .medical_history import MedicalHistory
+from .other_malignancy import OtherMalignancy
+from .participant import Participant
+from .prior_treatment import PriorTreatment
+from .radiotherapy_dose import RadiotherapyDose
+from .response import Response
+from .response_by_system import ResponseBySystem
+from .specimen import Specimen
+from .stem_cell_transplant import StemCellTransplant
+from .surgery import Surgery
+from .therapy_agent_dose import TherapyAgentDose
+from .treatment import Treatment
+from .trial import Trial
+
+
+__all__ = [
+    "AdditionalTreatment",
+    "AdverseEvent",
+    "BaselineClinicalAssessment",
+    "Comorbidity",
+    "ConsentGroup",
+    "Demographic",
+    "Disease",
+    "Exposure",
+    "GVHDDiagnosisAcute",
+    "GVHDOrganAcute",
+    "GVHDDiagnosisChronic",
+    "GVHDOrganChronic",
+    "MedicalHistory",
+    "OtherMalignancy",
+    "Participant",
+    "PriorTreatment",
+    "RadiotherapyDose",
+    "Response",
+    "ResponseBySystem",
+    "Specimen",
+    "StemCellTransplant",
+    "Surgery",
+    "TherapyAgentDose",
+    "Treatment",
+    "Trial",
+]
+
+all_models = [globals()[cls_name] for cls_name in __all__]

cidc_api/models/pydantic/stage1/additional_treatment.py

@@ -0,0 +1,23 @@
+from pydantic import NonNegativeInt
+from cidc_api.models.pydantic.base import Base
+
+
+class AdditionalTreatment(Base):
+    __data_category__ = "additional_treatment"
+    __cardinality__ = "many"
+
+    # The unique internal identifier for the AdditionalTreatment record
+    additional_treatment_id: int | None = None
+
+    # The unique internal identifier for the associated Participant record
+    participant_id: str | None = None
+
+    # Number of days from the enrollment date to the first recorded administration or occurrence of the treatment modality.
+    additional_treatment_days_to_start: NonNegativeInt | None = None
+
+    # Number of days from the enrollment date to the last recorded administration or occurrence of the treatment modality.
+    additional_treatment_days_to_end: NonNegativeInt | None = None
+
+    # Description of the prior treatment such as its full generic name if it is a type of therapy agent, radiotherapy procedure
+    # name and location, or surgical procedure name and location.
+    additional_treatment_description: str

cidc_api/models/pydantic/stage1/adverse_event.py

@@ -0,0 +1,127 @@
+from pydantic import NonNegativeInt
+
+from cidc_api.models.pydantic.base import Base
+from cidc_api.reference.ctcae import is_ctcae_other_term
+from cidc_api.models.pydantic.base import forced_validator, forced_validators
+from cidc_api.models.errors import ValueLocError
+from cidc_api.models.types import (
+    CTCAEEventTerm,
+    CTCAEEventCode,
+    SeverityGradeSystem,
+    SeverityGradeSystemVersion,
+    SeverityGrade,
+    SystemOrganClass,
+    AttributionCause,
+    AttributionLikelihood,
+    YNU,
+)
+
+
+@forced_validators
+class AdverseEvent(Base):
+    __data_category__ = "adverse_event"
+    __cardinality__ = "many"
+
+    # The unique internal identifier of the adverse event
+    adverse_event_id: int | None = None
+
+    # The unique internal identifier of the associated participant
+    participant_id: str | None = None
+
+    # The unique internal identifier of the attributed treatment, if any
+    treatment_id: int | None = None
+
+    # Text that represents the Common Terminology Criteria for Adverse Events low level term name for an adverse event.
+    event_term: CTCAEEventTerm | None = None
+
+    # A MedDRA code mapped to a CTCAE low level name for an adverse event.
+    event_code: CTCAEEventCode | None = None
+
+    # System used to define and report adverse event severity grade.
+    severity_grade_system: SeverityGradeSystem
+
+    # The version of the adverse event grading system.
+    severity_grade_system_version: SeverityGradeSystemVersion
+
+    # Numerical grade indicating the severity of an adverse event.
+    severity_grade: SeverityGrade
+
+    # A brief description that sufficiently details the event.
+    event_other_specify: str | None = None
+
+    # The highest level of the MedDRA hierarchy, distinguished by anatomical or physiological system, etiology (disease origin) or purpose.
+    system_organ_class: SystemOrganClass | None = None
+
+    # Indicator to identify whether a participant exited the study prematurely due to the adverse event being described.
+    discontinuation_due_to_event: bool
+
+    # Days from enrollment date to date of onset of the adverse event.
+    days_to_onset_of_event: NonNegativeInt
+
+    # Days from enrollment date to date of resolution of the adverse event.
+    days_to_resolution_of_event: NonNegativeInt | None = None
+
+    # Indicates whether the adverse event was a serious adverse event (SAE).
+    serious_adverse_event: YNU
+
+    # Indicates whether the adverse event was a dose-limiting toxicity (DLT).
+    dose_limiting_toxicity: YNU
+
+    # Indicates if the adverse was attributable to the protocol as a whole or to an individual treatment.
+    attribution_cause: AttributionCause
+
+    # The code that indicates whether the adverse event is related to the treatment/intervention.
+    attribution_likelihood: AttributionLikelihood
+
+    # The individual therapy (therapy agent, radiotherapy, surgery, stem cell transplant) in the treatment that is attributed to the adverse event.
+    individual_therapy: str | None = None
+
+    @forced_validator
+    @classmethod
+    def validate_term_and_code_cr(cls, data, info) -> None:
+        event_code = data.get("event_code", None)
+        event_term = data.get("event_term", None)
+
+        if not event_term and not event_code:
+            raise ValueLocError(
+                "Please provide event_term or event_code or both",
+                loc="event_term,event_code",
+            )
+
+    @forced_validator
+    @classmethod
+    def validate_event_other_specify_cr(cls, data, info) -> None:
+        event_other_specify = data.get("event_other_specify", None)
+        severity_grade_system = data.get("severity_grade_system", None)
+        event_term = data.get("event_term", None)
+
+        if severity_grade_system == "CTCAE" and is_ctcae_other_term(event_term) and not event_other_specify:
+            raise ValueLocError(
+                'If severity_grade_system is "CTCAE" and the event_code or event_term are of type '
+                '"Other, specify", please provide event_other_specify',
+                loc="event_other_specify",
+            )
+
+    @forced_validator
+    @classmethod
+    def validate_system_organ_class_cr(cls, data, info) -> None:
+        event_other_specify = data.get("event_other_specify", None)
+        system_organ_class = data.get("system_organ_class", None)
+
+        if event_other_specify and not system_organ_class:
+            raise ValueLocError(
+                "If event_other_specify is provided, please provide system_organ_class.", loc="system_organ_class"
+            )
+
+    @forced_validator
+    @classmethod
+    def validate_days_to_resolution_of_event_chronology(cls, data, info) -> None:
+        days_to_onset_of_event = data.get("days_to_onset_of_event", None)
+        days_to_resolution_of_event = data.get("days_to_resolution_of_event", None)
+
+        if days_to_resolution_of_event is not None and days_to_onset_of_event is not None:
+            if int(days_to_resolution_of_event) < int(days_to_onset_of_event):
+                raise ValueLocError(
+                    'Violate "days_to_onset_of_event" <= "days_to_resolution_of_event"',
+                    loc="days_to_resolution_of_event",
+                )

cidc_api/models/pydantic/stage1/baseline_clinical_assessment.py

@@ -0,0 +1,23 @@
+from cidc_api.models.pydantic.base import Base
+from cidc_api.models.types import ECOGScore, KarnofskyScore
+
+
+class BaselineClinicalAssessment(Base):
+    __data_category__ = "baseline_clinical_assessment"
+    __cardinality__ = "one"
+
+    # A unique internal identifier for the baseline clinical assessment
+    baseline_clinical_assessment_id: int | None = None
+
+    # The unique identifier for the associated participant
+    participant_id: str | None = None
+
+    # The numerical score that represents the functional capabilities of a participant at the
+    # enrollment date using the Eastern Cooperative Oncology Group Performance Status assessment.
+    # CDE: https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=88%20and%20ver_nr=5.1
+    ecog_score: ECOGScore | None = None
+
+    # Score from the Karnofsky Performance status scale, representing the functional capabilities of a participant
+    # at the enrollment date.
+    # CDE: 	https://cadsr.cancer.gov/onedata/dmdirect/NIH/NCI/CO/CDEDD?filter=CDEDD.ITEM_ID=2003853%20and%20ver_nr=4.2
+    karnofsky_score: KarnofskyScore | None = None

cidc_api/models/pydantic/stage1/comorbidity.py

@@ -0,0 +1,43 @@
+from typing import Any
+
+from cidc_api.models.pydantic.base import forced_validator, forced_validators
+
+from cidc_api.models.errors import ValueLocError
+from cidc_api.models.pydantic.base import Base
+from cidc_api.models.types import ICD10CMCode, ICD10CMTerm
+
+
+@forced_validators
+class Comorbidity(Base):
+    __data_category__ = "comorbidity"
+    __cardinality__ = "many"
+
+    # The unique internal identifier for the comorbidity record
+    comorbidity_id: int | None = None
+
+    # The unique internal identifier for the associated MedicalHistory record
+    medical_history_id: int | None = None
+
+    # The diagnosis, in humans, as captured in the tenth version of the
+    # International Classification of Disease (ICD-10-CM, the disease code subset of ICD-10).
+    comorbidity_code: ICD10CMCode | None = None
+
+    # The words from the tenth version of the International Classification of Disease (ICD-10-CM,
+    # the disease subset of ICD-10) used to identify the diagnosis in humans.
+    comorbidity_term: ICD10CMTerm | None = None
+
+    # A descriptive string that names or briefly describes the comorbidity.
+    comorbidity_other: str | None = None
+
+    @forced_validator
+    @classmethod
+    def validate_code_or_term_or_other_cr(cls, data, info) -> None:
+        comorbidity_term = data.get("comorbidity_term", None)
+        comorbidity_other = data.get("comorbidity_other", None)
+        comorbidity_code = data.get("comorbidity_code", None)
+
+        if not comorbidity_code and not comorbidity_term and not comorbidity_other:
+            raise ValueLocError(
+                'Please provide at least one of "comorbidity_code", "comorbidity_term" or "comorbidity_other".',
+                loc="comorbidity_code,comorbidity_term,comorbidity_other",
+            )