canvas 0.14.0__py3-none-any.whl → 0.16.0__py3-none-any.whl

canvas_sdk/v1/data/patient.py

@@ -1,10 +1,22 @@
-from typing import Self
+from typing import TYPE_CHECKING, Any, Self
 
 import arrow
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from django.db.models import TextChoices
 
+from canvas_sdk.v1.data.common import (
+    AddressState,
+    AddressType,
+    AddressUse,
+    ContactPointState,
+    ContactPointSystem,
+    ContactPointUse,
+)
+
+if TYPE_CHECKING:
+    from django_stubs_ext.db.models.manager import RelatedManager
+
 
 class SexAtBirth(TextChoices):
     """SexAtBirth."""
@@ -16,12 +28,21 @@ class SexAtBirth(TextChoices):
     BLANK = "", ""
 
 
+class PatientSettingConstants:
+    """PatientSettingConstants."""
+
+    LAB = "lab"
+    PHARMACY = "pharmacy"
+    IMAGING_CENTER = "imagingCenter"
+    CONTACT_METHOD = "contactMethod"
+    PREFERRED_SCHEDULING_TIMEZONE = "preferredSchedulingTimezone"
+
+
 class Patient(models.Model):
     """A class representing a patient."""
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_patient_001"
 
     id = models.CharField(max_length=32, db_column="key")
@@ -60,6 +81,8 @@ class Patient(models.Model):
     default_location_id = models.BigIntegerField()
     default_provider_id = models.BigIntegerField()
 
+    settings: "RelatedManager[PatientSetting]"
+
     @classmethod
     def find(cls, id: str) -> Self:
         """Find a patient by id."""
@@ -84,3 +107,118 @@ class Patient(models.Model):
             next_year = birth_date.shift(years=age + 1)
             age += (time.date() - current_year.date()) / (next_year.date() - current_year.date())
         return age
+
+    def get_setting(self, name: str) -> Any:
+        """Returns a patient setting value by name."""
+        try:
+            return self.settings.get(name=name).value
+        except PatientSetting.DoesNotExist:
+            return None
+
+    @property
+    def preferred_pharmacy(self) -> dict[str, str] | None:
+        """Returns the patient's preferred pharmacy."""
+        pharmacy_setting = self.get_setting(PatientSettingConstants.PHARMACY) or {}
+        if isinstance(pharmacy_setting, list):
+            for pharmacy in pharmacy_setting:
+                if pharmacy.get("default", False):
+                    return pharmacy
+            return None
+        return pharmacy_setting
+
+
+class PatientContactPoint(models.Model):
+    """A class representing a patient contact point."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_patientcontactpoint_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    system = models.CharField(choices=ContactPointSystem.choices)
+    value = models.CharField()
+    use = models.CharField(choices=ContactPointUse.choices)
+    use_notes = models.CharField()
+    rank = models.IntegerField()
+    state = models.CharField(choices=ContactPointState.choices)
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="telecom", null=True
+    )
+    has_consent = models.BooleanField()
+    last_verified = models.DateTimeField
+    verification_token = models.CharField()
+    opted_out = models.BooleanField()
+
+
+class PatientAddress(models.Model):
+    """A class representing a patient address."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_patientaddress_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    line1 = models.CharField()
+    line2 = models.CharField()
+    city = models.CharField()
+    district = models.CharField()
+    state_code = models.CharField()
+    postal_code = models.CharField()
+    use = models.CharField(choices=AddressUse.choices)
+    type = models.CharField(choices=AddressType.choices)
+    longitude = models.FloatField()
+    latitude = models.FloatField()
+    start = models.DateField()
+    end = models.DateField()
+    country = models.CharField()
+    state = models.CharField(choices=AddressState.choices)
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="addresses", null=True
+    )
+
+    def __str__(self) -> str:
+        return f"id={self.id}"
+
+
+class PatientExternalIdentifier(models.Model):
+    """A class representing a patient external identifier."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_patientexternalidentifier_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    patient = models.ForeignKey(
+        "v1.Patient", related_name="external_identifiers", on_delete=models.DO_NOTHING, null=True
+    )
+    use = models.CharField()
+    identifier_type = models.CharField()
+    system = models.CharField()
+    value = models.CharField()
+    issued_date = models.DateField()
+    expiration_date = models.DateField()
+
+    def __str__(self) -> str:
+        return f"id={self.id}"
+
+
+class PatientSetting(models.Model):
+    """PatientSetting."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_patientsetting_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="settings", null=True
+    )
+    name = models.CharField()
+    value = models.JSONField()

canvas_sdk/v1/data/practicelocation.py

@@ -57,7 +57,6 @@ class PracticeLocation(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_practicelocation_001"
 
     id = models.UUIDField()
@@ -65,7 +64,7 @@ class PracticeLocation(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     organization = models.ForeignKey(
-        "Organization", on_delete=models.DO_NOTHING, related_name="practice_locations", null=True
+        "v1.Organization", on_delete=models.DO_NOTHING, related_name="practice_locations", null=True
     )
     place_of_service_code = models.CharField(choices=PracticeLocationPOS.choices)
     full_name = models.CharField()
@@ -91,12 +90,11 @@ class PracticeLocationSetting(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_practicelocationsetting_001"
 
     dbid = models.BigIntegerField(primary_key=True)
     practice_location = models.ForeignKey(
-        PracticeLocation, on_delete=models.DO_NOTHING, related_name="settings", null=True
+        "v1.PracticeLocation", on_delete=models.DO_NOTHING, related_name="settings", null=True
     )
     name = models.CharField()
     value = models.JSONField()

canvas_sdk/v1/data/protocol_override.py

@@ -1,8 +1,13 @@
+from typing import cast
+
 from django.db import models
 
-from canvas_sdk.v1.data.base import CommittableModelManager
-from canvas_sdk.v1.data.patient import Patient
-from canvas_sdk.v1.data.user import CanvasUser
+from canvas_sdk.v1.data.base import (
+    BaseModelManager,
+    BaseQuerySet,
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
+)
 
 
 class IntervalUnit(models.TextChoices):
@@ -20,25 +25,33 @@ class Status(models.TextChoices):
     INACTIVE = "inactive", "inactive"
 
 
+class ProtocolOverrideQuerySet(BaseQuerySet, ForPatientQuerySetMixin, CommittableQuerySetMixin):
+    """ProtocolOverrideQuerySet."""
+
+    pass
+
+
+ProtocolOverrideManager = BaseModelManager.from_queryset(ProtocolOverrideQuerySet)
+
+
 class ProtocolOverride(models.Model):
     """ProtocolOverride."""
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_protocoloverride_001"
 
-    objects = CommittableModelManager()
+    objects = cast(ProtocolOverrideQuerySet, ProtocolOverrideManager())
 
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
     deleted = models.BooleanField()
-    committer = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
+    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
     patient = models.ForeignKey(
-        Patient, on_delete=models.DO_NOTHING, related_name="protocol_overrides", null=True
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="protocol_overrides", null=True
     )
     protocol_key = models.CharField()
     is_adjustment = models.BooleanField()

canvas_sdk/v1/data/questionnaire.py

@@ -1,14 +1,16 @@
 from collections.abc import Container
+from typing import cast
 
 from django.db import models
 from django.db.models import Q
 
-from canvas_sdk.v1.data import Patient
 from canvas_sdk.v1.data.base import (
-    CommittableModelManager,
+    BaseModelManager,
+    BaseQuerySet,
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
     ValueSetLookupByNameQuerySet,
 )
-from canvas_sdk.v1.data.user import CanvasUser
 
 
 class ResponseOptionSet(models.Model):
@@ -16,7 +18,6 @@ class ResponseOptionSet(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_responseoptionset_001"
 
     dbid = models.BigIntegerField(primary_key=True)
@@ -35,7 +36,6 @@ class ResponseOption(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_responseoption_001"
 
     dbid = models.BigIntegerField(primary_key=True)
@@ -57,7 +57,6 @@ class Question(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_question_001"
 
     id = models.UUIDField()
@@ -89,7 +88,6 @@ class Questionnaire(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_questionnaire_001"
 
     objects = models.Manager.from_queryset(QuestionnaireValueSetLookupQuerySet)()
@@ -109,7 +107,7 @@ class Questionnaire(models.Model):
     code_system = models.CharField()
     code = models.CharField()
     search_tags = models.CharField()
-    questions = models.ManyToManyField(Question, through="canvas_sdk.QuestionnaireQuestionMap")  # type: ignore[misc, var-annotated]
+    questions = models.ManyToManyField(Question, through="v1.QuestionnaireQuestionMap")  # type: ignore[misc, var-annotated]
     use_in_shx = models.BooleanField()
     carry_forward = models.TextField()
 
@@ -119,7 +117,6 @@ class QuestionnaireQuestionMap(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_questionnairequestionmap_001"
 
     dbid = models.BigIntegerField(primary_key=True)
@@ -130,33 +127,41 @@ class QuestionnaireQuestionMap(models.Model):
     question = models.ForeignKey(Question, on_delete=models.DO_NOTHING, null=True)
 
 
+class InterviewQuerySet(BaseQuerySet, ForPatientQuerySetMixin, CommittableQuerySetMixin):
+    """InterviewQuerySet."""
+
+    pass
+
+
+InterviewManager = BaseModelManager.from_queryset(InterviewQuerySet)
+
+
 class Interview(models.Model):
     """Interview."""
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_interview_001"
 
-    objects = CommittableModelManager()
+    objects = cast(InterviewQuerySet, InterviewManager())
 
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
     deleted = models.BooleanField()
-    committer = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
+    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
     status = models.CharField()
     name = models.CharField()
     language_id = models.BigIntegerField()
     use_case_in_charting = models.CharField()
     patient = models.ForeignKey(
-        Patient, on_delete=models.DO_NOTHING, related_name="interviews", null=True
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="interviews", null=True
     )
     note_id = models.BigIntegerField()
     appointment_id = models.BigIntegerField()
     questionnaires = models.ManyToManyField(  # type: ignore[var-annotated]
         Questionnaire,
-        through="canvas_sdk.InterviewQuestionnaireMap",  # type: ignore[misc]
+        through="v1.InterviewQuestionnaireMap",  # type: ignore[misc]
     )
     progress_status = models.CharField()
     created = models.DateTimeField()
@@ -168,7 +173,6 @@ class InterviewQuestionnaireMap(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_interviewquestionnairemap_001"
 
     dbid = models.BigIntegerField(primary_key=True)
@@ -184,7 +188,6 @@ class InterviewQuestionResponse(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_interviewquestionresponse_001"
 
     dbid = models.BigIntegerField(primary_key=True)

canvas_sdk/v1/data/staff.py

@@ -3,7 +3,6 @@ from django.db import models
 from timezone_utils.fields import TimeZoneField
 
 from canvas_sdk.v1.data.common import PersonSex, TaxIDType
-from canvas_sdk.v1.data.user import CanvasUser
 
 
 class Staff(models.Model):
@@ -11,7 +10,6 @@ class Staff(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_staff_001"
 
     def __str__(self) -> str:
@@ -44,7 +42,7 @@ class Staff(models.Model):
     active = models.BooleanField()
     # TODO - uncomment when PracticeLocation field is developed
     # primary_practice_location = models.ForeignKey(
-    #     PracticeLocation, on_delete=models.DO_NOTHING, null=True
+    #     'v1.PracticeLocation', on_delete=models.DO_NOTHING, null=True
     # )
     npi_number = models.CharField()
     nadean_number = models.CharField()
@@ -54,12 +52,12 @@ class Staff(models.Model):
     tax_id_type = models.CharField(choices=TaxIDType.choices)
     spi_number = models.CharField()
     # TODO - uncomment when Language is developed
-    # language = models.ForeignKey(Language, on_delete=models.DO_NOTHING, related_name="staff_speakers", null=True)
-    # language_secondary = models.ForeignKey(Language, on_delete=models.DO_NOTHING, related_name="staff_secondary_speakers", null=True)
+    # language = models.ForeignKey('v1.Language', on_delete=models.DO_NOTHING, related_name="staff_speakers", null=True)
+    # language_secondary = models.ForeignKey('v1.Language', on_delete=models.DO_NOTHING, related_name="staff_secondary_speakers", null=True)
     personal_meeting_room_link = models.URLField(null=True)
     state = models.JSONField()
-    user = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
+    user = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
     schedule_column_ordering = models.IntegerField()
     default_supervising_provider = models.ForeignKey(
-        "Staff", on_delete=models.DO_NOTHING, related_name="supervising_team", null=True
+        "v1.Staff", on_delete=models.DO_NOTHING, related_name="supervising_team", null=True
     )

canvas_sdk/v1/data/task.py

@@ -2,8 +2,6 @@ from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
 from canvas_sdk.v1.data.common import ColorEnum, Origin
-from canvas_sdk.v1.data.patient import Patient
-from canvas_sdk.v1.data.staff import Staff
 
 
 class TaskType(models.TextChoices):
@@ -39,7 +37,6 @@ class Task(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_task_001"
 
     id = models.UUIDField()
@@ -47,15 +44,15 @@ class Task(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     creator = models.ForeignKey(
-        Staff, on_delete=models.DO_NOTHING, related_name="creator_tasks", null=True
+        "v1.Staff", on_delete=models.DO_NOTHING, related_name="creator_tasks", null=True
     )
     assignee = models.ForeignKey(
-        Staff, on_delete=models.DO_NOTHING, related_name="assignee_tasks", null=True
+        "v1.Staff", on_delete=models.DO_NOTHING, related_name="assignee_tasks", null=True
     )
     # TODO - uncomment when Team model is created
-    # team = models.ForeignKey(Team, on_delete=models.DO_NOTHING, related_name="tasks", null=True)
+    # team = models.ForeignKey('v1.Team', on_delete=models.DO_NOTHING, related_name="tasks", null=True)
     patient = models.ForeignKey(
-        Patient, on_delete=models.DO_NOTHING, blank=True, related_name="tasks", null=True
+        "v1.Patient", on_delete=models.DO_NOTHING, blank=True, related_name="tasks", null=True
     )
     task_type = models.CharField(choices=TaskType.choices)
     tag = models.CharField()
@@ -70,7 +67,6 @@ class TaskComment(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_taskcomment_001"
 
     id = models.UUIDField()
@@ -78,7 +74,7 @@ class TaskComment(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     creator = models.ForeignKey(
-        Staff, on_delete=models.DO_NOTHING, related_name="comments", null=True
+        "v1.Staff", on_delete=models.DO_NOTHING, related_name="comments", null=True
     )
     task = models.ForeignKey(Task, on_delete=models.DO_NOTHING, related_name="comments", null=True)
     body = models.TextField()
@@ -89,7 +85,6 @@ class TaskLabel(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_tasklabel_001"
 
     id = models.UUIDField()
@@ -108,7 +103,6 @@ class TaskTaskLabel(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_tasktasklabel_001"
 
     dbid = models.BigIntegerField(primary_key=True)

canvas_sdk/v1/data/user.py

@@ -6,7 +6,6 @@ class CanvasUser(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_auth_user_001"
 
     dbid = models.BigIntegerField(db_column="dbid", primary_key=True)

canvas_sdk/v1/models.py

@@ -0,0 +1,4 @@
+# Normally we would register Django models in the models module, but they are in "data" for legacy
+# reasons. For this reason, we import * from data to avoid duplication.
+
+from .data import *  # noqa: F403