endoreg-db 0.3.4__py3-none-any.whl → 0.3.5__py3-none-any.whl

endoreg_db/migrations/0065_rename__date_value_distribution_casetemplaterule_date_value_distribution_and_more.py

@@ -0,0 +1,58 @@
+# Generated by Django 5.0.4 on 2024-06-24 10:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('endoreg_db', '0064_casetemplaterule_extra_parameters_and_more'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='casetemplaterule',
+            old_name='_date_value_distribution',
+            new_name='date_value_distribution',
+        ),
+        migrations.RenameField(
+            model_name='casetemplaterule',
+            old_name='_multiple_categorical_value_distribution',
+            new_name='multiple_categorical_value_distribution',
+        ),
+        migrations.RenameField(
+            model_name='casetemplaterule',
+            old_name='_numerical_value_distribution',
+            new_name='numerical_value_distribution',
+        ),
+        migrations.RenameField(
+            model_name='casetemplaterule',
+            old_name='_single_categorical_value_distribution',
+            new_name='single_categorical_value_distribution',
+        ),
+        migrations.RenameField(
+            model_name='labvalue',
+            old_name='_default_date_value_distribution',
+            new_name='default_date_value_distribution',
+        ),
+        migrations.RenameField(
+            model_name='labvalue',
+            old_name='_default_multiple_categorical_value_distribution',
+            new_name='default_multiple_categorical_value_distribution',
+        ),
+        migrations.RenameField(
+            model_name='labvalue',
+            old_name='_default_numerical_value_distribution',
+            new_name='default_numerical_value_distribution',
+        ),
+        migrations.RenameField(
+            model_name='labvalue',
+            old_name='_default_single_categorical_value_distribution',
+            new_name='default_single_categorical_value_distribution',
+        ),
+        migrations.AlterField(
+            model_name='casetemplate',
+            name='name',
+            field=models.CharField(max_length=255, unique=True),
+        ),
+    ]

endoreg_db/migrations/0066_alter_patientlabvalue_patient_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.0.4 on 2024-06-24 15:36
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('endoreg_db', '0065_rename__date_value_distribution_casetemplaterule_date_value_distribution_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='patientlabvalue',
+            name='patient',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='lab_values', to='endoreg_db.patient'),
+        ),
+        migrations.CreateModel(
+            name='PatientMedicationSchedule',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('medication', models.ManyToManyField(related_name='patient_medication_schedules', to='endoreg_db.patientmedication')),
+                ('patient', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='endoreg_db.patient')),
+            ],
+        ),
+    ]

endoreg_db/migrations/0067_alter_medicationindication_indication_type.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.4 on 2024-06-24 15:49
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('endoreg_db', '0066_alter_patientlabvalue_patient_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='medicationindication',
+            name='indication_type',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='medication_indications', to='endoreg_db.medicationindicationtype'),
+        ),
+    ]

endoreg_db/models/__init__.py

@@ -1,25 +1,36 @@
 from .unit import Unit
 from .information_source import InformationSource
-from .center import Center
+from .center import *
 from .report_reader import ReportReaderConfig, ReportReaderFlag
-from .persons import (
-    Person,
-    Patient,
-    PatientForm,
-    Examiner,
-    ExaminerSerializer,
-    PortalUserInfo,
-    Profession,
-    FirstName, LastName
+from .emission import *
+from .persons import *
+
+from .case_template import *
+# from .other.distribution import (
+#     SingleCategoricalValueDistribution,
+#     NumericValueDistribution,
+#     MultipleCategoricalValueDistribution,
+#     DateValueDistribution,
+# )
+from .rules import (
+    Rule,
+    RuleType,
+    Ruleset,
+    RuleApplicator,
+    Rule
 )
 
+from .disease import Disease, DiseaseClassification, DiseaseClassificationChoice
+from .event import Event
+from .laboratory import LabValue
+from .medication import *
+
 from .examination import (
     Examination,
     ExaminationType,
     ExaminationTime,
     ExaminationTimeType,
 )
-
 from .data_file import *
 
 from .patient_examination import PatientExamination
@@ -36,12 +47,18 @@ from .legacy_data import (
     LegacyImage,
 )
 
+from .other import *
+
+from .product import *
+
 from .ai_model import (
     ModelMeta,
     ModelType,
     ActiveModel,
 )
 
+from .quiz import *
+
 from .prediction import (
     ImageClassificationPrediction,
     LegacyVideoPredictionMeta,

endoreg_db/models/case_template/__init__.py

@@ -0,0 +1,6 @@
+# Django models to define CaseTemplate and CaseTemplateType models 
+# (each with "name" field which acts as a natural key)
+from .case_template_rule import CaseTemplateRule, CaseTemplateRuleType
+from .case_template_rule_value import CaseTemplateRuleValue, CaseTemplateRuleValueType
+from .case_template_type import CaseTemplateType
+from .case_template import CaseTemplate

endoreg_db/models/case_template/case_template.py

@@ -0,0 +1,81 @@
+from django.db import models
+
+class CaseTemplateManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+class CaseTemplate(models.Model):
+    """
+    A class representing a case template.
+
+    Attributes:
+        name (str): The name of the case template. This is the natural key.
+        case_template_type (CaseTemplateType): The type of the case template.
+        description (str): A description of the case template.
+
+    """
+    name = models.CharField(max_length=255, unique=True)
+    template_type = models.ForeignKey("CaseTemplateType", on_delete=models.CASCADE, related_name="case_templates")
+    description = models.TextField(blank=True, null=True)
+
+    rules = models.ManyToManyField(
+        "CaseTemplateRule",
+    )
+
+    secondary_rules = models.ManyToManyField(
+        "CaseTemplateRule",
+        related_name="secondary_rules"
+    )
+
+    objects = CaseTemplateManager()
+
+    def natural_key(self):
+        return (self.name,)
+    
+    def __str__(self):
+        return self.name
+    
+    def get_rules(self):
+        rules = self.rules.all()
+        return rules
+    
+    def get_secondary_rules(self):
+        rules = self.secondary_rules.all()
+        return rules
+    
+    def _assert_max_one_create_patient_rule(self):
+        """Asserts that there is at most one rule with the rule_type__name "create-object" and target_model__name "Patient"."""
+        create_patient_rules = self.rules.filter(rule_type__name="create-object", target_model__name="Patient")
+        if len(create_patient_rules) > 1:
+            raise ValueError("There can be at most one rule with the rule_type__name 'create-object' and target_model__name 'Patient'.")
+
+    # custom save method which runs the _assert_max_one_create_patient_rule method and others
+    def save(self, *args, **kwargs):
+        # self._assert_max_one_create_patient_rule() #TODO Fails on first save since many to many can only be used if object has an id
+        super().save(*args, **kwargs)
+
+    def get_create_patient_rule(self):
+        """Filter the rules for the rule which has the rule_type__name "create-object" and target_model__name "Patient".
+        Also makes sure, that only 1 is returned. If there is no such rule, get default create patient rule.
+        """
+        from endoreg_db.models.case_template.case_template_rule import CaseTemplateRule
+        create_patient_rules = self.rules.filter(rule_type__name="create-object", target_model="Patient")
+        if len(create_patient_rules) > 1:
+            raise ValueError("There can be at most one rule with the rule_type__name 'create-object' and target_model__name 'Patient'.")
+        elif len(create_patient_rules) == 0:
+            create_patient_rules = CaseTemplateRule.objects.get_default_create_patient_rule()
+        return create_patient_rules[0]
+    
+    def get_create_patient_medication_schedule_rule(self):
+        """Filter the rules for the rule which has the rule_type__name "create-object" and target_model__name "PatientMedicationSchedule".
+        Also makes sure, that only 1 is returned. If there is no such rule, get default create patient medication schedule rule.
+        """
+        from endoreg_db.models.case_template.case_template_rule import CaseTemplateRule
+        create_patient_medication_schedule_rules = self.rules.filter(rule_type__name="create-object", target_model="PatientMedicationSchedule")
+        if len(create_patient_medication_schedule_rules) > 1:
+            raise ValueError("There can be at most one rule with the rule_type__name 'create-object' and target_model__name 'PatientMedicationSchedule'.")
+        elif len(create_patient_medication_schedule_rules) == 0:
+            from warnings import warn
+            warn("No create patient medication schedule rule found. Using default create patient medication schedule rule.")
+            create_patient_medication_schedule_rules = CaseTemplateRule.objects.get_default_create_patient_medication_schedule_rule()
+        return create_patient_medication_schedule_rules[0]

endoreg_db/models/case_template/case_template_rule.py

@@ -0,0 +1,276 @@
+from django.db import models
+
+class CaseTemplateRuleTypeManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+class CaseTemplateRuleType(models.Model):
+    """
+    A class representing a case template rule type.
+
+    Attributes:
+        name (str): The name of the case template rule type.
+        description (str): A description of the case template rule type.
+
+    """
+    name = models.CharField(max_length=255)
+    name_de = models.CharField(max_length=255, null=True)
+    name_en = models.CharField(max_length=255, null=True)
+    description = models.TextField(blank=True, null=True)
+
+    objects = CaseTemplateRuleTypeManager()
+
+    def natural_key(self):
+        return (self.name,)
+    
+    def __str__(self):
+        return self.name
+
+class CaseTemplateRuleManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+    def get_default_create_patient_rule(self):
+        """Get the default create patient rule."""
+        return self.get(name="create-patient-default")
+    
+    def get_default_create_patient_lab_sample_rules(self):
+        """Get the default create patient lab sample rules."""
+        return self.get(name="create-patient_lab_sample-default")
+    
+    def get_default_create_patient_medication_schedule_rule(self):
+        """Get the create patient medication schedule rule."""
+        r = self.get(name="create-patient_medication_schedule")
+        assert r, "No create patient medication schedule rule found"
+        return r
+    
+class CaseTemplateRule(models.Model):
+    """
+    A class representing a case template rule.
+
+    Attributes:
+        name (str): The name of the case template rule.
+        case_template (CaseTemplate): The case template to which the rule belongs.
+        description (str): A description of the case template rule.
+        name_de (str): The name of the case template rule in German.
+        name_en (str): The name of the case template rule in English.
+        rule_type (CaseTemplateRuleType): The type of the rule.
+        parent_model (str): The model on which the rule is applied.
+        target_field (str): The field of the parent model on which the rule is applied.
+        target_model (str): The model to which the foreign key points (used for foreign key and many-to-many rules).
+        rule_values (list): A list of string values for the rule.
+        extra_parameters (dict): A dictionary of extra parameters for the rule.
+        value_type (CaseTemplateRuleValueType): The type of the rule value.
+        chained_rules (QuerySet): The chained rules associated with the current rule.
+        single_categorical_value_distribution (SingleCategoricalValueDistribution): The single categorical value distribution for the rule.
+        numerical_value_distribution (NumericValueDistribution): The numerical value distribution for the rule.
+        multiple_categorical_value_distribution (MultipleCategoricalValueDistribution): The multiple categorical value distribution for the rule.
+        date_value_distribution (DateValueDistribution): The date value distribution for the rule.
+        objects (CaseTemplateRuleManager): The manager for the CaseTemplateRule model.
+
+    Methods:
+        natural_key(): Returns the natural key of the rule.
+        __str__(): Returns a string representation of the rule.
+        get_rule_type(): Returns the name of the rule type.
+        get_chained_rules(): Returns all the chained rules associated with the current rule.
+        get_all_downward_chained_rules(): Returns all the chained rules of the current rule, including indirectly chained rules.
+        chained_rules_has_self_reference(): Checks if any directly or indirectly chained rules reference this rule, creating a non-terminating loop.
+        save(*args, **kwargs): Customizes the save method to check for self-references.
+
+    """
+    name = models.CharField(max_length=255)
+    name_de = models.CharField(max_length=255, null=True)
+    name_en = models.CharField(max_length=255, null=True)
+    description = models.TextField(blank=True, null=True)
+    rule_type = models.ForeignKey(
+        "CaseTemplateRuleType", on_delete=models.CASCADE
+    )
+    parent_model = models.CharField(max_length=255, blank=True, null=True)
+    parent_field = models.CharField(max_length=255, blank=True, null=True)
+    target_field = models.CharField(max_length=255, blank=True, null=True)
+    target_model = models.CharField(max_length=255, blank=True, null=True)
+    rule_values = models.JSONField(blank=True, null=True)
+    extra_parameters = models.JSONField(blank=True, null=True)
+    value_type = models.ForeignKey("CaseTemplateRuleValueType", on_delete=models.SET_NULL, null=True)
+    chained_rules = models.ManyToManyField(
+        "CaseTemplateRule",
+        related_name="calling_rules"
+    )
+    single_categorical_value_distribution = models.ForeignKey(
+        "SingleCategoricalValueDistribution", on_delete=models.SET_NULL, null=True
+    )
+    numerical_value_distribution = models.ForeignKey(
+        "NumericValueDistribution", on_delete=models.SET_NULL, null=True
+    )
+    multiple_categorical_value_distribution = models.ForeignKey(
+        "MultipleCategoricalValueDistribution", on_delete=models.SET_NULL, null=True
+    )
+    date_value_distribution = models.ForeignKey(
+        "DateValueDistribution", on_delete=models.SET_NULL, null=True
+    )
+    objects = CaseTemplateRuleManager()
+
+    def natural_key(self):
+        """
+        Returns the natural key of the rule.
+
+        :return: A tuple representing the natural key of the rule.
+        """
+        return (self.name,)
+
+    def __str__(self):
+        """
+        Returns a string representation of the rule.
+
+        :return: A string representation of the rule.
+        """
+        return self.name
+
+    def get_rule_type(self):
+        """
+        Returns the name of the rule type.
+
+        :return: The name of the rule type.
+        """
+        return self.rule_type.name
+
+    def get_chained_rules(self):
+        """
+        Returns all the chained rules associated with the current rule.
+
+        :return: A queryset of all the chained rules associated with the current rule.
+        """
+        return self.chained_rules.all()
+    
+    def get_distribution(self):
+        """
+        Returns the value distribution of the rule.
+
+        :return: The value distribution of the rule.
+        """
+        DEBUG = True
+        if DEBUG:
+            print("Rule: ", self.name)
+            print(f"single_categorical_value_distribution: {self.single_categorical_value_distribution}")
+            print(f"numerical_value_distribution: {self.numerical_value_distribution}")
+            print(f"multiple_categorical_value_distribution: {self.multiple_categorical_value_distribution}")
+            print(f"date_value_distribution: {self.date_value_distribution}")
+
+
+        if self.single_categorical_value_distribution:
+            return self.single_categorical_value_distribution
+        elif self.numerical_value_distribution:
+            return self.numerical_value_distribution
+        elif self.multiple_categorical_value_distribution:
+            return self.multiple_categorical_value_distribution
+        elif self.date_value_distribution:
+            return self.date_value_distribution
+        return None
+
+    def get_all_downward_chained_rules(self):
+        """
+        Get all chained rules of the current rule, including indirectly chained rules.
+
+        :return: A set of all chained rules of the current rule.
+        """
+        all_chained_rules = set()
+
+        def traverse_chained_rules(rule):
+            """
+            Helper function to recursively traverse chained rules.
+
+            :param rule: The current CaseTemplateRule being checked.
+            :return: None
+            """
+            for chained_rule in rule.chained_rules.all():
+                if chained_rule not in all_chained_rules:
+                    all_chained_rules.add(chained_rule)
+                    traverse_chained_rules(chained_rule)
+
+        # Initialize the traversal starting with the current rule
+        traverse_chained_rules(self)
+        return all_chained_rules
+
+    def chained_rules_has_self_reference(self):
+        """
+        Check if any directly or indirectly chained rules reference this rule, creating a non-terminating loop.
+        Return a list containing a tuple (first_rule, self_referencing_rule) for each self-reference.
+        first_rule is the most upward rule in the chain that references the rule.
+        self_referencing_rule is the rule that references the current rule itself.
+
+        :return: A list of tuples representing the self-referencing rules.
+        """
+        result_list = []
+
+        def traverse_chained_rules(rule, visited_rules):
+            """
+            Helper function to recursively traverse chained rules and check for self-references.
+
+            :param rule: The current CaseTemplateRule being checked.
+            :param visited_rules: A list of tuples representing the path of rules visited so far.
+            :return: None
+            """
+            for chained_rule in rule.chained_rules.all():
+                if chained_rule == self:
+                    # A self-reference is detected
+                    first_rule = visited_rules[0][0]
+                    self_referencing_rule = visited_rules[-1][1]
+                    result_list.append((first_rule, self_referencing_rule))
+                elif chained_rule not in [r[1] for r in visited_rules]:
+                    # Continue to check chained rules of the current chained rule
+                    traverse_chained_rules(chained_rule, visited_rules + [(rule, chained_rule)])
+
+        # Initialize the traversal starting with the current rule
+        traverse_chained_rules(self, [(self, self)])
+        return result_list
+    
+    def get_target_model(self):
+        """
+        Returns the target model of the rule.
+
+        :return: The target model of the rule.
+        """
+        from django.apps import apps
+
+        if not self.target_model:
+            return None
+
+        try:
+            target_model = apps.get_model("endoreg_db", self.target_model)
+        except LookupError:
+            raise ValueError(f"Model {self.target_model} not found.")
+        return target_model
+    
+    def get_target_field(self):
+        """
+        Returns the target field of the rule.
+
+        :return: The target field of the rule.
+        """
+        return self.target_field
+    
+    def get_parent_model(self):
+        """
+        Returns the parent model of the rule.
+
+        :return: The parent model of the rule.
+        """
+        from django.apps import apps
+
+        if not self.parent_model:
+            return None
+
+        try:
+            self.parent_model = apps.get_model("endoreg_db", self.parent_model)
+        except LookupError:
+            raise ValueError(f"Model {self.parent_model} not found.")
+        return self.parent_model
+
+    # customize the save method to check for self-references
+    # def save(self, *args, **kwargs):
+    #     # Check for self-references
+    #     self_referencing_rules = self.chained_rules_has_self_reference()
+    #     if self_referencing_rules:
+    #         raise ValueError(f"Self-references detected: {self_referencing_rules}")
+    #     super().save(*args, **kwargs)
+

endoreg_db/models/case_template/case_template_rule_value.py

@@ -0,0 +1,73 @@
+from django.db import models
+
+class CaseTemplateRuleValueTypeManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+
+class CaseTemplateRuleValueType(models.Model):
+    """
+    A class representing a case template rule value type.
+
+    Attributes:
+        name (str): The name of the case template rule value type.
+        distribution_type: One of "single_categorical", "multiple_categorical", "numeric"
+        description (str): A description of the case template rule value type.
+    """
+    DISTRIBUTION_TYPES = [
+        ("single_categorical", "single_categorical"),
+        ("multiple_categorical", "multiple_categorical"),
+        ("numeric", "numeric")
+    ]
+    objects = CaseTemplateRuleValueTypeManager()
+
+    name = models.CharField(max_length=255)
+    name_de = models.CharField(max_length=255, null=True)
+    name_en = models.CharField(max_length=255, null=True)
+    description = models.TextField(blank=True, null=True)
+
+    distribution_type = models.CharField(max_length=255, choices=DISTRIBUTION_TYPES)
+
+
+    def natural_key(self):
+        return (self.name,)
+
+    def __str__(self):
+        return self.name
+
+class CaseTemplateRuleValueManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+class CaseTemplateRuleValue(models.Model):
+    """
+    A class representing a case template rule value.
+
+    Attributes:
+        value (str): The value of the case template rule value.
+        case_template_rule (CaseTemplateRule): The case template rule of the case template rule value.
+        case_template (CaseTemplate): The case template of the case template rule value.
+    """
+    objects = CaseTemplateRuleValueManager()
+
+    name = models.CharField(max_length=255)
+    description = models.TextField(blank=True, null=True)
+
+    fk_value = models.CharField(max_length=255, null=True, blank=True)
+    numeric_value = models.FloatField(null=True, blank=True)
+    text_value = models.CharField(max_length=255, null=True, blank=True)
+
+    def natural_key(self):
+        return (self.name,)
+    
+    def __str__(self):
+        return self.name
+    
+    def get_value(self):
+        if self.fk_value:
+            return self.fk_value
+        elif self.numeric_value:
+            return self.numeric_value
+        elif self.text_value:
+            return self.text_value
+        else:
+            return None

endoreg_db/models/case_template/case_template_type.py

@@ -0,0 +1,28 @@
+from django.db import models
+
+
+class CaseTemplateTypeManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+class CaseTemplateType(models.Model):
+    """
+    A class representing a case template type.
+
+    Attributes:
+        name (str): The name of the case template type.
+        description (str): A description of the case template type.
+
+    """
+    name = models.CharField(max_length=255)
+    name_de = models.CharField(max_length=255, null=True)
+    name_en = models.CharField(max_length=255, null=True)
+    description = models.TextField(blank=True, null=True)
+
+    objects = CaseTemplateTypeManager()
+
+    def natural_key(self):
+        return (self.name,)
+
+    def __str__(self):
+        return self.name

endoreg_db/models/center/__init__.py

@@ -0,0 +1,4 @@
+from .center import Center
+from .center_product import CenterProduct
+from .center_resource import CenterResource
+from .center_waste import CenterWaste

endoreg_db/models/center/center_product.py

@@ -0,0 +1,34 @@
+from itertools import product
+from django.db import models
+
+class CenterProduct(models.Model):
+    product = models.ForeignKey("Product", on_delete=models.CASCADE)
+    date_used = models.DateField()
+    center = models.ForeignKey("Center", on_delete=models.CASCADE)
+
+
+    def get_product_group(self):
+        product = self.product
+        product_group = product.product_group
+
+        return product_group
+    
+    def get_reference_product(self):
+        product_group = self.get_product_group()
+        reference_product = product_group.reference_product
+
+        return reference_product
+    
+    def get_product_weight(self):
+        product = self.product
+        weight, unit = product.get_product_weight()
+
+        return weight, unit
+    
+    def get_package_weight(self):
+        product = self.product
+        weight, unit = product.get_package_weight()
+
+        return weight, unit
+    
+