canvas 0.15.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

canvas_sdk/v1/data/__init__.py

@@ -1,7 +1,11 @@
 from .allergy_intolerance import AllergyIntolerance, AllergyIntoleranceCoding
+from .appointment import Appointment
+from .assessment import Assessment
 from .billing import BillingLineItem
+from .care_team import CareTeamMembership, CareTeamRole
 from .command import Command
 from .condition import Condition, ConditionCoding
+from .coverage import Coverage, Transactor, TransactorAddress, TransactorPhone
 from .detected_issue import DetectedIssue, DetectedIssueEvidence
 from .device import Device
 from .imaging import ImagingOrder, ImagingReport, ImagingReview
@@ -25,7 +29,13 @@ from .observation import (
     ObservationValueCoding,
 )
 from .organization import Organization
-from .patient import Patient
+from .patient import (
+    Patient,
+    PatientAddress,
+    PatientContactPoint,
+    PatientExternalIdentifier,
+    PatientSetting,
+)
 from .practicelocation import PracticeLocation, PracticeLocationSetting
 from .protocol_override import ProtocolOverride
 from .questionnaire import (
@@ -43,13 +53,18 @@ from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
 from .user import CanvasUser
 
 __all__ = [
+    "Appointment",
     "AllergyIntolerance",
     "AllergyIntoleranceCoding",
+    "Assessment",
     "BillingLineItem",
     "CanvasUser",
+    "CareTeamMembership",
+    "CareTeamRole",
     "Command",
     "Condition",
     "ConditionCoding",
+    "Coverage",
     "DetectedIssue",
     "DetectedIssueEvidence",
     "Device",
@@ -78,6 +93,10 @@ __all__ = [
     "ObservationValueCoding",
     "Organization",
     "Patient",
+    "PatientAddress",
+    "PatientContactPoint",
+    "PatientExternalIdentifier",
+    "PatientSetting",
     "PracticeLocation",
     "PracticeLocationSetting",
     "ProtocolOverride",
@@ -91,4 +110,7 @@ __all__ = [
     "TaskComment",
     "TaskLabel",
     "TaskTaskLabel",
+    "Transactor",
+    "TransactorAddress",
+    "TransactorPhone",
 ]

canvas_sdk/v1/data/allergy_intolerance.py

@@ -1,6 +1,26 @@
+from typing import cast
+
 from django.db import models
 
-from canvas_sdk.v1.data.base import CommittableModelManager, ValueSetLookupQuerySet
+from canvas_sdk.v1.data.base import (
+    BaseModelManager,
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
+    ValueSetLookupQuerySet,
+)
+
+
+class AllergyIntoleranceQuerySet(
+    ValueSetLookupQuerySet,
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
+):
+    """AllergyIntoleranceQuerySet."""
+
+    pass
+
+
+AllergyIntoleranceManager = BaseModelManager.from_queryset(AllergyIntoleranceQuerySet)
 
 
 class AllergyIntolerance(models.Model):
@@ -10,7 +30,7 @@ class AllergyIntolerance(models.Model):
         managed = False
         db_table = "canvas_sdk_data_api_allergyintolerance_001"
 
-    objects = CommittableModelManager().from_queryset(ValueSetLookupQuerySet)()
+    objects = cast(AllergyIntoleranceQuerySet, AllergyIntoleranceManager())
 
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)

canvas_sdk/v1/data/appointment.py

@@ -0,0 +1,56 @@
+from django.db import models
+
+
+class AppointmentProgressStatus(models.TextChoices):
+    """AppointmentProgressStatus."""
+
+    UNCONFIRMED = "unconfirmed", "Unconfirmed"
+    ATTEMPTED = "attempted", "Attempted"
+    CONFIRMED = "confirmed", "Confirmed"
+    ARRIVED = "arrived", "Arrived"
+    ROOMED = "roomed", "Roomed"
+    EXITED = "exited", "Exited"
+    NOSHOWED = "noshowed", "No-showed"
+    CANCELLED = "cancelled", "Cancelled"
+
+
+class Appointment(models.Model):
+    """Appointment."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_appointment_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    patient = models.ForeignKey(
+        "v1.Patient",
+        on_delete=models.DO_NOTHING,
+        related_name="appointments",
+        null=True,
+    )
+    appointment_rescheduled_from = models.ForeignKey(
+        "self",
+        on_delete=models.DO_NOTHING,
+        related_name="appointment_rescheduled_to",
+        null=True,
+    )
+    provider = models.ForeignKey("v1.Staff", on_delete=models.DO_NOTHING, null=True)
+    start_time = models.DateTimeField()
+    duration_minutes = models.IntegerField()
+    comment = models.TextField(null=True)
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, null=True)
+
+    note_type = models.ForeignKey(
+        "v1.NoteType", on_delete=models.DO_NOTHING, related_name="appointments", null=True
+    )
+
+    status = models.CharField(
+        max_length=20,
+        choices=AppointmentProgressStatus,
+    )
+    meeting_link = models.URLField(null=True, blank=True)
+    telehealth_instructions_sent = models.BooleanField()
+    location = models.ForeignKey("v1.PracticeLocation", on_delete=models.DO_NOTHING, null=True)
+    description = models.TextField(null=True, blank=True)

canvas_sdk/v1/data/assessment.py

@@ -0,0 +1,40 @@
+from django.db import models
+
+
+class AssessmentStatus(models.TextChoices):
+    """AssessmentStatus."""
+
+    STATUS_IMPROVING = "improved", "Improved"
+    STATUS_STABLE = "stable", "Unchanged"
+    STATUS_DETERIORATING = "deteriorated", "Deteriorated"
+
+
+class Assessment(models.Model):
+    """Assessment."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_assessment_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING)
+    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    deleted = models.BooleanField()
+    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    patient = models.ForeignKey(
+        "v1.Patient",
+        on_delete=models.DO_NOTHING,
+        related_name="assessments",
+    )
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="assessments")
+    condition = models.ForeignKey(
+        "v1.Condition", on_delete=models.CASCADE, related_name="assessments", null=True
+    )
+    interview = models.ForeignKey("v1.Interview", on_delete=models.DO_NOTHING, null=True)
+    status = models.CharField(choices=AssessmentStatus.choices)
+    narrative = models.CharField()
+    background = models.CharField()
+    care_team = models.CharField()

canvas_sdk/v1/data/base.py

@@ -10,25 +10,12 @@ if TYPE_CHECKING:
     from canvas_sdk.value_set.value_set import ValueSet
 
 
-class CommittableModelManager(models.Manager):
-    """A manager for commands that can be committed."""
+class BaseModelManager(models.Manager):
+    """A base manager for models."""
 
-    def get_queryset(self) -> "CommittableQuerySet":
+    def get_queryset(self) -> models.QuerySet:
         """Return a queryset that filters out deleted objects."""
-        # TODO: Should we just filter these out at the view level?
-        return CommittableQuerySet(self.model, using=self._db).filter(deleted=False)
-
-
-class CommittableQuerySet(models.QuerySet):
-    """A queryset for committable objects."""
-
-    def committed(self) -> "Self":
-        """Return a queryset that filters for objects that have been committed."""
-        return self.filter(committer_id__isnull=False, entered_in_error_id__isnull=True)
-
-    def for_patient(self, patient_id: str) -> "Self":
-        """Return a queryset that filters objects for a specific patient."""
-        return self.filter(patient__id=patient_id)
+        return super().get_queryset().filter(deleted=False)
 
 
 class BaseQuerySet(models.QuerySet):
@@ -40,10 +27,14 @@ class BaseQuerySet(models.QuerySet):
 class QuerySetProtocol(Protocol):
     """A typing protocol for use in mixins into models.QuerySet-inherited classes."""
 
-    def filter(self, *args: Any, **kwargs: Any) -> models.QuerySet[Any]:
+    def filter(self, *args: Any, **kwargs: Any) -> Self:
         """Django's models.QuerySet filter method."""
         ...
 
+    def distinct(self) -> Self:
+        """Django's models.QuerySet distinct method."""
+        ...
+
 
 class ValueSetLookupQuerySetProtocol(QuerySetProtocol):
     """A typing protocol for use in mixins using value set lookup methods."""
@@ -61,10 +52,26 @@ class ValueSetLookupQuerySetProtocol(QuerySetProtocol):
         raise NotImplementedError
 
 
+class CommittableQuerySetMixin(QuerySetProtocol):
+    """A queryset for committable objects."""
+
+    def committed(self) -> Self:
+        """Return a queryset that filters for objects that have been committed."""
+        return self.filter(committer_id__isnull=False, entered_in_error_id__isnull=True)
+
+
+class ForPatientQuerySetMixin(QuerySetProtocol):
+    """A queryset for patient assets."""
+
+    def for_patient(self, patient_id: str) -> Self:
+        """Return a queryset that filters objects for a specific patient."""
+        return self.filter(patient__id=patient_id)
+
+
 class ValueSetLookupQuerySetMixin(ValueSetLookupQuerySetProtocol):
     """A QuerySet mixin that can filter objects based on a ValueSet."""
 
-    def find(self, value_set: type["ValueSet"]) -> models.QuerySet[Any]:
+    def find(self, value_set: type["ValueSet"]) -> Self:
         """
         Filters conditions, medications, etc. to those found in the inherited ValueSet class that is passed.
 
@@ -146,7 +153,7 @@ class TimeframeLookupQuerySetMixin(TimeframeLookupQuerySetProtocol):
         """Returns the field that should be filtered on. Can be overridden for different models."""
         return "note__datetime_of_service"
 
-    def within(self, timeframe: "Timeframe") -> models.QuerySet:
+    def within(self, timeframe: "Timeframe") -> Self:
         """A method to filter a queryset for datetimes within a timeframe."""
         return self.filter(
             **{
@@ -158,13 +165,19 @@ class TimeframeLookupQuerySetMixin(TimeframeLookupQuerySetProtocol):
         )
 
 
-class ValueSetLookupQuerySet(CommittableQuerySet, ValueSetLookupQuerySetMixin):
+class CommittableQuerySet(BaseQuerySet, CommittableQuerySetMixin):
+    """A queryset for committable objects."""
+
+    pass
+
+
+class ValueSetLookupQuerySet(BaseQuerySet, ValueSetLookupQuerySetMixin):
     """A class that includes methods for looking up value sets."""
 
     pass
 
 
-class ValueSetLookupByNameQuerySet(CommittableQuerySet, ValueSetLookupByNameQuerySetMixin):
+class ValueSetLookupByNameQuerySet(BaseQuerySet, ValueSetLookupByNameQuerySetMixin):
     """A class that includes methods for looking up value sets by name."""
 
     pass

canvas_sdk/v1/data/billing.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Self
 
 from django.db import models
 
@@ -12,7 +12,7 @@ if TYPE_CHECKING:
 class BillingLineItemQuerySet(ValueSetTimeframeLookupQuerySet):
     """A class that adds functionality to filter BillingLineItem objects."""
 
-    def find(self, value_set: type["ValueSet"]) -> models.QuerySet:
+    def find(self, value_set: type["ValueSet"]) -> Self:
         """
         This method is overridden to use for BillingLineItem CPT codes.
         The codes are saved as string values in the BillingLineItem.cpt field,

canvas_sdk/v1/data/care_team.py

@@ -0,0 +1,60 @@
+from django.db import models
+
+
+class CareTeamMembershipStatus(models.TextChoices):
+    """CareTeamMembershipStatus."""
+
+    PROPOSED = "proposed", "Proposed"
+    ACTIVE = "active", "Active"
+    SUSPENDED = "suspended", "Suspended"
+    INACTIVE = "inactive", "Inactive"
+    ENTERED_IN_ERROR = "entered-in-error", "Entered in Error"
+
+
+class CareTeamRole(models.Model):
+    """CareTeamRole."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_careteamrole_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    system = models.CharField()
+    version = models.CharField()
+    code = models.CharField()
+    display = models.CharField()
+    user_selected = models.BooleanField()
+    active = models.BooleanField()
+
+    def __str__(self) -> str:
+        return self.display
+
+
+class CareTeamMembership(models.Model):
+    """CareTeamMembership."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_careteammembership_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="care_team_memberships", null=True
+    )
+    staff = models.ForeignKey(
+        "v1.Staff", on_delete=models.DO_NOTHING, related_name="care_team_memberships", null=True
+    )
+    role = models.ForeignKey(
+        "v1.CareTeamRole", related_name="care_teams", on_delete=models.DO_NOTHING, null=True
+    )
+    status = models.CharField(choices=CareTeamMembershipStatus.choices)
+    lead = models.BooleanField()
+    role_code = models.CharField()
+    role_system = models.CharField()
+    role_display = models.CharField()
+
+    def __str__(self) -> str:
+        return f"id={self.id}"

canvas_sdk/v1/data/command.py

@@ -18,7 +18,7 @@ class Command(models.Model):
     entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
     state = models.CharField()
     patient = models.ForeignKey("v1.Patient", on_delete=models.DO_NOTHING, null=True)
-    note_id = models.BigIntegerField()
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="commands")
     schema_key = models.TextField()
     data = models.JSONField()
     origination_source = models.CharField()

canvas_sdk/v1/data/common.py

@@ -101,3 +101,56 @@ class Origin(models.TextChoices):
     FLAGGED_POSTING_REVIEW = ("FLG_PST_REV", "Flagged posting review")
     BATCH_PATIENT_STATEMENTS = ("BAT_PTN_STA", "Batch patient statements")
     INCOMPLETE_COVERAGE = ("INC_COV", "Incomplete Coverage")
+
+
+class ContactPointSystem(models.TextChoices):
+    """ContactPointSystem."""
+
+    PHONE = "phone", "phone"
+    FAX = "fax", "fax"
+    EMAIL = "email", "email"
+    PAGER = "pager", "pager"
+    OTHER = "other", "other"
+
+
+class ContactPointUse(models.TextChoices):
+    """ContactPointUse."""
+
+    HOME = "home", "Home"
+    WORK = "work", "Work"
+    TEMP = "temp", "Temp"
+    OLD = "old", "Old"
+    OTHER = "other", "Other"
+    MOBILE = "mobile", "Mobile"
+    AUTOMATION = "automation", "Automation"
+
+
+class ContactPointState(models.TextChoices):
+    """ContactPointState."""
+
+    ACTIVE = "active", "Active"
+    DELETED = "deleted", "Deleted"
+
+
+class AddressUse(models.TextChoices):
+    """AddressUse."""
+
+    HOME = "home", "Home"
+    WORK = "work", "Work"
+    TEMP = "temp", "Temp"
+    OLD = "old", "Old"
+
+
+class AddressType(models.TextChoices):
+    """AddressType."""
+
+    POSTAL = "postal", "Postal"
+    PHYSICAL = "physical", "Physical"
+    BOTH = "both", "Both"
+
+
+class AddressState(models.TextChoices):
+    """AddressState."""
+
+    ACTIVE = "active", "Active"
+    DELETED = "deleted", "Deleted"

canvas_sdk/v1/data/condition.py

@@ -1,7 +1,15 @@
+from typing import cast
+
 from django.db import models
 from django.db.models import TextChoices
 
-from canvas_sdk.v1.data.base import ValueSetLookupQuerySet
+from canvas_sdk.v1.data.base import (
+    BaseModelManager,
+    BaseQuerySet,
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
+    ValueSetLookupQuerySetMixin,
+)
 
 
 class ClinicalStatus(TextChoices):
@@ -14,12 +22,20 @@ class ClinicalStatus(TextChoices):
     INVESTIGATIVE = "investigative", "investigative"
 
 
-class ConditionQuerySet(ValueSetLookupQuerySet):
+class ConditionQuerySet(
+    BaseQuerySet,
+    ValueSetLookupQuerySetMixin,
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
+):
     """ConditionQuerySet."""
 
     pass
 
 
+ConditionManager = BaseModelManager.from_queryset(ConditionQuerySet)
+
+
 class Condition(models.Model):
     """Condition."""
 
@@ -27,7 +43,7 @@ class Condition(models.Model):
         managed = False
         db_table = "canvas_sdk_data_api_condition_001"
 
-    objects = ConditionQuerySet.as_manager()
+    objects = cast(ConditionQuerySet, ConditionManager())
 
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)