canvas 0.63.0__py3-none-any.whl → 0.89.0__py3-none-any.whl

canvas_sdk/test_utils/factories/task.py

@@ -0,0 +1,66 @@
+import factory
+
+from canvas_sdk.v1.data import Task, TaskComment, TaskLabel, TaskMetadata, TaskTaskLabel
+from canvas_sdk.v1.data.common import ColorEnum, Origin
+from canvas_sdk.v1.data.task import TaskLabelModule, TaskStatus, TaskType
+
+
+class TaskFactory(factory.django.DjangoModelFactory[Task]):
+    """Factory for creating Task."""
+
+    class Meta:
+        model = Task
+
+    patient = factory.SubFactory("canvas_sdk.test_utils.factories.PatientFactory")
+    creator = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+    assignee = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+    task_type = TaskType.TASK
+    tag = factory.Faker("word")
+    title = factory.Faker("sentence", nb_words=4)
+    status = TaskStatus.OPEN
+
+
+class TaskMetadataFactory(factory.django.DjangoModelFactory[TaskMetadata]):
+    """Factory for creating TaskMetadata."""
+
+    class Meta:
+        model = TaskMetadata
+
+    task = factory.SubFactory(TaskFactory)
+    key = factory.Faker("word")
+    value = factory.Faker("word")
+
+
+class TaskCommentFactory(factory.django.DjangoModelFactory[TaskComment]):
+    """Factory for creating TaskComment."""
+
+    class Meta:
+        model = TaskComment
+
+    creator = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+    task = factory.SubFactory(TaskFactory)
+    body = factory.Faker("sentence", nb_words=10)
+
+
+class TaskLabelFactory(factory.django.DjangoModelFactory[TaskLabel]):
+    """Factory for creating TaskLabel."""
+
+    class Meta:
+        model = TaskLabel
+
+    position = factory.Sequence(lambda n: n)
+    color = ColorEnum.BLUE
+    task_association = [Origin.REFERAL]
+    name = factory.Faker("word")
+    active = True
+    modules = [TaskLabelModule.TASKS]
+
+
+class TaskTaskLabelFactory(factory.django.DjangoModelFactory[TaskTaskLabel]):
+    """Factory for creating TaskTaskLabel."""
+
+    class Meta:
+        model = TaskTaskLabel
+
+    task = factory.SubFactory(TaskFactory)
+    task_label = factory.SubFactory(TaskLabelFactory)

canvas_sdk/test_utils/factories/uncategorized_clinical_document.py

@@ -0,0 +1,48 @@
+import datetime
+
+import factory
+from django.utils import timezone
+from factory.fuzzy import FuzzyDate
+
+from canvas_sdk.v1.data import UncategorizedClinicalDocument, UncategorizedClinicalDocumentReview
+
+
+class UncategorizedClinicalDocumentReviewFactory(
+    factory.django.DjangoModelFactory[UncategorizedClinicalDocumentReview]
+):
+    """Factory for creating UncategorizedClinicalDocumentReview."""
+
+    class Meta:
+        model = UncategorizedClinicalDocumentReview
+
+    internal_comment = factory.Faker("paragraph")
+    message_to_patient = factory.Faker("sentence", nb_words=20)
+    status = factory.Faker("random_element", elements=["pending", "reviewed", "completed"])
+    patient = factory.SubFactory("canvas_sdk.test_utils.factories.PatientFactory")
+    patient_communication_method = factory.Faker(
+        "random_element", elements=["email", "phone", "portal", "mail"]
+    )
+
+
+class UncategorizedClinicalDocumentFactory(
+    factory.django.DjangoModelFactory[UncategorizedClinicalDocument]
+):
+    """Factory for creating UncategorizedClinicalDocument."""
+
+    class Meta:
+        model = UncategorizedClinicalDocument
+
+    originator = factory.SubFactory("canvas_sdk.test_utils.factories.CanvasUserFactory")
+    patient = factory.SubFactory("canvas_sdk.test_utils.factories.PatientFactory")
+    review = factory.SubFactory(UncategorizedClinicalDocumentReviewFactory)
+    assigned_by = factory.SubFactory("canvas_sdk.test_utils.factories.CanvasUserFactory")
+
+    name = factory.Faker("sentence", nb_words=3)
+    review_mode = factory.Faker("random_element", elements=["IN", "OT"])
+    requires_signature = factory.Faker("boolean")
+    assigned_date = factory.LazyFunction(lambda: timezone.now())
+    original_date = FuzzyDate(
+        start_date=datetime.date.today() - datetime.timedelta(days=365),
+        end_date=datetime.date.today(),
+    )
+    comment = factory.Faker("paragraph")

canvas_sdk/utils/metrics.py

@@ -137,7 +137,10 @@ def measure(
             extra_tags["plugin"] = caller.split(".")[0]
             extra_tags["handler"] = caller
 
-    tags = {"name": name, **(extra_tags or {})}
+    tags = {
+        "name": name,
+        **(extra_tags or {}),
+    }
 
     pipeline = client.pipeline()
     timing_start = time.perf_counter_ns()

canvas_sdk/v1/data/__init__.py

@@ -1,20 +1,38 @@
 from .allergy_intolerance import AllergyIntolerance, AllergyIntoleranceCoding
-from .appointment import Appointment, AppointmentExternalIdentifier, AppointmentMetadata
+from .appointment import (
+    Appointment,
+    AppointmentExternalIdentifier,
+    AppointmentLabel,
+    AppointmentMetadata,
+)
 from .assessment import Assessment
 from .banner_alert import BannerAlert
 from .billing import BillingLineItem, BillingLineItemModifier
 from .business_line import BusinessLine
+from .calendar import Calendar, Event
 from .care_team import CareTeamMembership, CareTeamRole
 from .charge_description_master import ChargeDescriptionMaster
-from .claim import Claim, ClaimCoverage, ClaimPatient, ClaimQueue, InstallmentPlan
+from .claim import (
+    Claim,
+    ClaimComment,
+    ClaimCoverage,
+    ClaimLabel,
+    ClaimPatient,
+    ClaimProvider,
+    ClaimQueue,
+    ClaimSubmission,
+    InstallmentPlan,
+)
+from .claim_diagnosis_code import ClaimDiagnosisCode
 from .claim_line_item import ClaimLineItem
 from .command import Command
 from .compound_medication import CompoundMedication
 from .condition import Condition, ConditionCoding
-from .coverage import Coverage, Transactor, TransactorAddress, TransactorPhone
+from .coverage import Coverage, EligibilitySummary, Transactor, TransactorAddress, TransactorPhone
 from .detected_issue import DetectedIssue, DetectedIssueEvidence
 from .device import Device
 from .discount import Discount
+from .encounter import Encounter
 from .facility import Facility
 from .goal import Goal
 from .imaging import ImagingOrder, ImagingReport, ImagingReview
@@ -43,6 +61,13 @@ from .line_item_transaction import (
     NewLineItemPayment,
 )
 from .medication import Medication, MedicationCoding
+from .medication_history import (
+    MedicationHistoryMedication,
+    MedicationHistoryMedicationCoding,
+    MedicationHistoryResponse,
+    MedicationHistoryResponseStatus,
+)
+from .medication_statement import MedicationStatement
 from .message import Message, MessageAttachment, MessageTransmission
 from .note import CurrentNoteStateEvent, Note, NoteStateChangeEvent, NoteType
 from .observation import (
@@ -52,7 +77,7 @@ from .observation import (
     ObservationComponentCoding,
     ObservationValueCoding,
 )
-from .organization import Organization
+from .organization import Organization, OrganizationAddress, OrganizationContactPoint
 from .patient import (
     Patient,
     PatientAddress,
@@ -76,7 +101,12 @@ from .posting import (
     CoveragePosting,
     PatientPosting,
 )
-from .practicelocation import PracticeLocation, PracticeLocationSetting
+from .practicelocation import (
+    PracticeLocation,
+    PracticeLocationAddress,
+    PracticeLocationContactPoint,
+    PracticeLocationSetting,
+)
 from .protocol_current import ProtocolCurrent
 from .protocol_override import ProtocolOverride
 from .questionnaire import (
@@ -90,17 +120,23 @@ from .questionnaire import (
     ResponseOptionSet,
 )
 from .reason_for_visit import ReasonForVisitSettingCoding
-from .referral import Referral, ReferralReport
+from .referral import Referral, ReferralReport, ReferralReview
 from .service_provider import ServiceProvider
 from .staff import Staff, StaffAddress, StaffContactPoint, StaffLicense, StaffPhoto, StaffRole
-from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
+from .stop_medication_event import StopMedicationEvent
+from .task import Task, TaskComment, TaskLabel, TaskMetadata, TaskTaskLabel
 from .team import Team, TeamContactPoint
+from .uncategorized_clinical_document import (
+    UncategorizedClinicalDocument,
+    UncategorizedClinicalDocumentReview,
+)
 from .user import CanvasUser
 
 __all__ = __exports__ = (
     "Appointment",
     "AppointmentMetadata",
     "AppointmentExternalIdentifier",
+    "AppointmentLabel",
     "AllergyIntolerance",
     "AllergyIntoleranceCoding",
     "Assessment",
@@ -111,15 +147,21 @@ __all__ = __exports__ = (
     "BillingLineItemModifier",
     "BusinessLine",
     "BulkPatientPosting",
+    "Calendar",
     "CanvasUser",
     "CareTeamMembership",
     "CareTeamRole",
     "ChargeDescriptionMaster",
     "Claim",
+    "ClaimComment",
     "ClaimCoverage",
+    "ClaimDiagnosisCode",
+    "ClaimLabel",
     "ClaimLineItem",
     "ClaimPatient",
+    "ClaimProvider",
     "ClaimQueue",
+    "ClaimSubmission",
     "Command",
     "CompoundMedication",
     "Condition",
@@ -131,6 +173,9 @@ __all__ = __exports__ = (
     "DetectedIssueEvidence",
     "Device",
     "Discount",
+    "EligibilitySummary",
+    "Encounter",
+    "Event",
     "Facility",
     "Goal",
     "ImagingOrder",
@@ -158,6 +203,11 @@ __all__ = __exports__ = (
     "LineItemTransfer",
     "Medication",
     "MedicationCoding",
+    "MedicationHistoryMedication",
+    "MedicationHistoryMedicationCoding",
+    "MedicationHistoryResponseStatus",
+    "MedicationHistoryResponse",
+    "MedicationStatement",
     "Message",
     "MessageAttachment",
     "MessageTransmission",
@@ -172,6 +222,8 @@ __all__ = __exports__ = (
     "ObservationComponentCoding",
     "ObservationValueCoding",
     "Organization",
+    "OrganizationAddress",
+    "OrganizationContactPoint",
     "Patient",
     "PatientAddress",
     "PatientContactPoint",
@@ -186,6 +238,8 @@ __all__ = __exports__ = (
     "PayorSpecificCharge",
     "PaymentCollection",
     "PracticeLocation",
+    "PracticeLocationAddress",
+    "PracticeLocationContactPoint",
     "PracticeLocationSetting",
     "ProtocolCurrent",
     "ProtocolOverride",
@@ -195,6 +249,7 @@ __all__ = __exports__ = (
     "ReasonForVisitSettingCoding",
     "Referral",
     "ReferralReport",
+    "ReferralReview",
     "ResponseOption",
     "ResponseOptionSet",
     "ServiceProvider",
@@ -204,13 +259,17 @@ __all__ = __exports__ = (
     "StaffPhoto",
     "StaffRole",
     "StaffContactPoint",
+    "StopMedicationEvent",
     "Task",
     "TaskComment",
     "TaskLabel",
     "TaskTaskLabel",
+    "TaskMetadata",
     "Team",
     "TeamContactPoint",
     "Transactor",
     "TransactorAddress",
     "TransactorPhone",
+    "UncategorizedClinicalDocumentReview",
+    "UncategorizedClinicalDocument",
 )

canvas_sdk/v1/data/allergy_intolerance.py

@@ -7,15 +7,16 @@ from canvas_sdk.v1.data.base import (
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
     IdentifiableModel,
-    Model,
+    TimestampedModel,
     ValueSetLookupQuerySet,
 )
+from canvas_sdk.v1.data.coding import Coding
 
 
 class AllergyIntoleranceQuerySet(
-    ValueSetLookupQuerySet,
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
+    ValueSetLookupQuerySet,
 ):
     """AllergyIntoleranceQuerySet."""
 
@@ -25,7 +26,7 @@ class AllergyIntoleranceQuerySet(
 AllergyIntoleranceManager = BaseModelManager.from_queryset(AllergyIntoleranceQuerySet)
 
 
-class AllergyIntolerance(IdentifiableModel):
+class AllergyIntolerance(TimestampedModel, IdentifiableModel):
     """AllergyIntolerance."""
 
     class Meta:
@@ -33,8 +34,6 @@ class AllergyIntolerance(IdentifiableModel):
 
     objects = cast(AllergyIntoleranceQuerySet, AllergyIntoleranceManager())
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     deleted = models.BooleanField()
     committer = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
@@ -61,17 +60,12 @@ class AllergyIntolerance(IdentifiableModel):
     narrative = models.CharField(max_length=512)
 
 
-class AllergyIntoleranceCoding(Model):
+class AllergyIntoleranceCoding(Coding):
     """AllergyIntoleranceCoding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_allergyintolerancecoding_001"
 
-    system = models.CharField(max_length=255)
-    version = models.CharField(max_length=255)
-    code = models.CharField(max_length=255)
-    display = models.CharField(max_length=1000)
-    user_selected = models.BooleanField()
     allergy_intolerance = models.ForeignKey(
         AllergyIntolerance,
         on_delete=models.DO_NOTHING,

canvas_sdk/v1/data/appointment.py

@@ -1,6 +1,6 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import IdentifiableModel, Model, TimestampedModel
 
 
 class AppointmentProgressStatus(models.TextChoices):
@@ -60,14 +60,12 @@ class Appointment(IdentifiableModel):
     description = models.TextField(null=True, blank=True)
 
 
-class AppointmentExternalIdentifier(IdentifiableModel):
+class AppointmentExternalIdentifier(TimestampedModel, IdentifiableModel):
     """AppointmentExternalIdentifier."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_appointmentexternalidentifier_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     use = models.CharField(max_length=255)
     identifier_type = models.CharField(max_length=255)
     system = models.CharField(max_length=255)
@@ -79,6 +77,21 @@ class AppointmentExternalIdentifier(IdentifiableModel):
     )
 
 
+class AppointmentLabel(Model):
+    """M2M for Appointment -> TaskLabels."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_appointment_labels_001"
+
+    appointment = models.ForeignKey(Appointment, on_delete=models.DO_NOTHING, null=True)
+    task_label = models.ForeignKey(
+        "v1.TaskLabel",
+        on_delete=models.DO_NOTHING,
+        null=True,
+        db_column="userselectedtasklabel_id",
+    )
+
+
 class AppointmentMetadata(IdentifiableModel):
     """A class representing Appointment Metadata."""
 
@@ -97,4 +110,5 @@ __exports__ = (
     "Appointment",
     "AppointmentMetadata",
     "AppointmentExternalIdentifier",
+    "AppointmentLabel",
 )

canvas_sdk/v1/data/assessment.py

@@ -1,6 +1,6 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import AuditedModel, IdentifiableModel
 
 
 class AssessmentStatus(models.TextChoices):
@@ -11,22 +11,12 @@ class AssessmentStatus(models.TextChoices):
     STATUS_DETERIORATING = "deteriorated", "Deteriorated"
 
 
-class Assessment(IdentifiableModel):
+class Assessment(AuditedModel, IdentifiableModel):
     """Assessment."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_assessment_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+")
-    committer = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
-    )
-    deleted = models.BooleanField()
-    entered_in_error = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
-    )
     patient = models.ForeignKey(
         "v1.Patient",
         on_delete=models.DO_NOTHING,

canvas_sdk/v1/data/banner_alert.py

@@ -1,17 +1,15 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
-from canvas_sdk.v1.data.base import Model
+from canvas_sdk.v1.data.base import TimestampedModel
 
 
-class BannerAlert(Model):
+class BannerAlert(TimestampedModel):
     """BannerAlert."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_banneralert_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     patient = models.ForeignKey(
         "v1.Patient",
         on_delete=models.DO_NOTHING,

canvas_sdk/v1/data/base.py

@@ -54,6 +54,34 @@ class IdentifiableModel(Model):
     id = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)
 
 
+class TimestampedModel(Model):
+    """A model that includes created and modified timestamps."""
+
+    class Meta:
+        abstract = True
+
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+
+
+class AuditedModel(TimestampedModel):
+    """A model that includes auditing fields."""
+
+    class Meta:
+        abstract = True
+
+    originator = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
+    committer = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
+    entered_in_error = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
+    deleted = models.BooleanField(default=False)
+
+
 class BaseModelManager(models.Manager):
     """A base manager for models."""
 
@@ -68,16 +96,27 @@ class BaseQuerySet(models.QuerySet):
     pass
 
 
-class QuerySetProtocol(Protocol):
-    """A typing protocol for use in mixins into models.QuerySet-inherited classes."""
-
-    def filter(self, *args: Any, **kwargs: Any) -> Self:
-        """Django's models.QuerySet filter method."""
-        ...
-
-    def distinct(self) -> Self:
-        """Django's models.QuerySet distinct method."""
-        ...
+if TYPE_CHECKING:
+    # For type checking: Define the Protocol with method signatures
+    class QuerySetProtocol(Protocol):
+        """A typing protocol for use in mixins into models.QuerySet-inherited classes."""
+
+        def filter(self, *args: Any, **kwargs: Any) -> Self:
+            """Django's models.QuerySet filter method."""
+            ...
+
+        def distinct(self) -> Self:
+            """Django's models.QuerySet distinct method."""
+            ...
+else:
+    # At runtime: Empty class that doesn't shadow Django's methods
+    class QuerySetProtocol:
+        """A typing protocol for use in mixins into models.QuerySet-inherited classes.
+
+        This Protocol is intentionally empty at runtime to avoid shadowing Django's
+        QuerySet methods in the MRO. The method signatures are only defined when
+        type checking (see TYPE_CHECKING block above).
+        """
 
 
 class ValueSetLookupQuerySetProtocol(QuerySetProtocol):
@@ -209,25 +248,25 @@ class TimeframeLookupQuerySetMixin(TimeframeLookupQuerySetProtocol):
         )
 
 
-class CommittableQuerySet(BaseQuerySet, CommittableQuerySetMixin):
+class CommittableQuerySet(CommittableQuerySetMixin, BaseQuerySet):
     """A queryset for committable objects."""
 
     pass
 
 
-class ValueSetLookupQuerySet(BaseQuerySet, ValueSetLookupQuerySetMixin):
+class ValueSetLookupQuerySet(ValueSetLookupQuerySetMixin, BaseQuerySet):
     """A class that includes methods for looking up value sets."""
 
     pass
 
 
-class ValueSetLookupByNameQuerySet(BaseQuerySet, ValueSetLookupByNameQuerySetMixin):
+class ValueSetLookupByNameQuerySet(ValueSetLookupByNameQuerySetMixin, BaseQuerySet):
     """A class that includes methods for looking up value sets by name."""
 
     pass
 
 
-class ValueSetTimeframeLookupQuerySet(ValueSetLookupQuerySet, TimeframeLookupQuerySetMixin):
+class ValueSetTimeframeLookupQuerySet(TimeframeLookupQuerySetMixin, ValueSetLookupQuerySet):
     """A class that includes methods for looking up value sets and using timeframes."""
 
     pass

canvas_sdk/v1/data/billing.py

@@ -2,7 +2,12 @@ from typing import TYPE_CHECKING, Self
 
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel, Model, ValueSetTimeframeLookupQuerySet
+from canvas_sdk.v1.data.base import (
+    IdentifiableModel,
+    TimestampedModel,
+    ValueSetTimeframeLookupQuerySet,
+)
+from canvas_sdk.v1.data.coding import Coding
 from canvas_sdk.value_set.value_set import CodeConstants
 
 if TYPE_CHECKING:
@@ -29,17 +34,14 @@ class BillingLineItemStatus(models.TextChoices):
     REMOVED = "removed", "Removed"
 
 
-class BillingLineItem(IdentifiableModel):
+class BillingLineItem(TimestampedModel, IdentifiableModel):
     """BillingLineItem."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_billinglineitem_001"
 
-    # objects = BillingLineItemQuerySet.as_manager()
     objects = models.Manager().from_queryset(BillingLineItemQuerySet)()
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     note = models.ForeignKey(
         "v1.Note",
         on_delete=models.DO_NOTHING,
@@ -61,17 +63,12 @@ class BillingLineItem(IdentifiableModel):
     status = models.CharField(choices=BillingLineItemStatus.choices, max_length=20)
 
 
-class BillingLineItemModifier(Model):
+class BillingLineItemModifier(Coding):
     """BillingLineItemModifier."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_billinglineitemmodifier_001"
 
-    system = models.CharField(max_length=255)
-    version = models.CharField(max_length=255)
-    code = models.CharField(max_length=255)
-    display = models.CharField(max_length=1000)
-    user_selected = models.BooleanField()
     line_item = models.ForeignKey(
         "v1.BillingLineItem",
         on_delete=models.DO_NOTHING,