canvas 0.67.0__py3-none-any.whl → 0.68.0__py3-none-any.whl

canvas_sdk/test_utils/factories/staff.py

@@ -0,0 +1,111 @@
+import datetime
+
+import factory
+from dateutil.relativedelta import relativedelta
+
+from canvas_sdk.v1.data import (
+    Staff,
+    StaffAddress,
+    StaffContactPoint,
+    StaffLicense,
+    StaffPhoto,
+    StaffRole,
+)
+from canvas_sdk.v1.data.common import ContactPointSystem, ContactPointUse
+
+
+class StaffAddressFactory(factory.django.DjangoModelFactory[StaffAddress]):
+    """Factory for creating StaffAddress."""
+
+    class Meta:
+        model = StaffAddress
+
+    line1 = "1234 Main Street"
+    line2 = "Apt 3"
+    city = "San Francisco"
+    district = "Sunset"
+    state_code = "CA"
+    postal_code = "94112"
+    country = "USA"
+    staff = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+
+
+class StaffPhotoFactory(factory.django.DjangoModelFactory[StaffPhoto]):
+    """Factory for creating StaffPhoto."""
+
+    class Meta:
+        model = StaffPhoto
+
+    url = ""
+    staff = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+
+
+class StaffRoleFactory(factory.django.DjangoModelFactory[StaffRole]):
+    """Factory for creating StaffRole."""
+
+    class Meta:
+        model = StaffRole
+        django_get_or_create = ("internal_code", "staff")
+
+    internal_code = "MD"
+    name = "Physician"
+    public_abbreviation = "MD"
+    domain = StaffRole.RoleDomain.CLINICAL
+    domain_privilege_level = 100000
+    permissions = factory.LazyFunction(lambda: {})
+    staff = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+
+
+class StaffLicenseFactory(factory.django.DjangoModelFactory[StaffLicense]):
+    """Factory for creating StaffLicense."""
+
+    class Meta:
+        model = StaffLicense
+
+    issuing_authority_long_name = "MEDICAL BOARD OF CALIFORNIA"
+    issuing_authority_url = "http://www.mbc.ca.gov/"
+    license_or_certification_identifier = "A60695"
+    issuance_date = factory.LazyFunction(datetime.date.today)
+    expiration_date = factory.LazyFunction(lambda: datetime.date.today() + relativedelta(years=2))
+    staff = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+
+
+class StaffContactPointFactory(factory.django.DjangoModelFactory[StaffContactPoint]):
+    """Factory for creating StaffContactPoint."""
+
+    class Meta:
+        model = StaffContactPoint
+
+    value = "8883331212"
+    system = ContactPointSystem.PHONE
+    use = ContactPointUse.HOME
+    staff = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+
+
+class StaffFactory(factory.django.DjangoModelFactory[Staff]):
+    """Factory for creating Staff."""
+
+    class Meta:
+        model = Staff
+        django_get_or_create = ("user",)
+
+    first_name = factory.Faker("first_name")
+    middle_name = factory.Faker("first_name")
+    last_name = factory.Faker("last_name")
+    npi_number = "1111155556"
+    group_npi_number = "123456789"
+    tax_id = "98711111"
+    spi_number = 5630156655001
+    address = factory.RelatedFactory(StaffAddressFactory, "staff")
+    telecom = factory.RelatedFactory(StaffContactPointFactory, "staff")
+    primary_practice_location = factory.SubFactory(
+        "canvas_sdk.test_utils.factories.PracticeLocationFactory"
+    )
+    photos = factory.RelatedFactory(StaffPhotoFactory, "staff")
+    role = factory.RelatedFactory(StaffRoleFactory, "staff")
+    license = factory.RelatedFactory(StaffLicenseFactory, "staff")
+    birth_date = factory.Faker("date_object")
+
+    user = factory.SubFactory(
+        "canvas_sdk.test_utils.factories.user.CanvasUserFactory",
+    )

canvas_sdk/v1/data/allergy_intolerance.py

@@ -7,9 +7,10 @@ from canvas_sdk.v1.data.base import (
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
     IdentifiableModel,
-    Model,
+    TimestampedModel,
     ValueSetLookupQuerySet,
 )
+from canvas_sdk.v1.data.coding import Coding
 
 
 class 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, 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)

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."""
 

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,

canvas_sdk/v1/data/care_team.py

@@ -1,6 +1,7 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel, Model
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
+from canvas_sdk.v1.data.coding import Coding
 
 
 class CareTeamMembershipStatus(models.TextChoices):
@@ -13,31 +14,24 @@ class CareTeamMembershipStatus(models.TextChoices):
     ENTERED_IN_ERROR = "entered-in-error", "Entered in Error"
 
 
-class CareTeamRole(Model):
+class CareTeamRole(Coding):
     """CareTeamRole."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_careteamrole_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()
     active = models.BooleanField()
 
     def __str__(self) -> str:
         return self.display
 
 
-class CareTeamMembership(IdentifiableModel):
+class CareTeamMembership(TimestampedModel, IdentifiableModel):
     """CareTeamMembership."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_careteammembership_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="care_team_memberships", null=True
     )

canvas_sdk/v1/data/claim.py

@@ -3,7 +3,7 @@ from typing import TYPE_CHECKING, Self
 
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel, Model
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
 from canvas_sdk.v1.data.common import PersonSex
 from canvas_sdk.v1.data.coverage import CoverageRelationshipCode, CoverageType
 from canvas_sdk.v1.data.fields import ChoiceArrayField
@@ -21,7 +21,7 @@ class InstallmentPlanStatus(models.TextChoices):
     CANCELLED = "cancelled", "Cancelled"
 
 
-class InstallmentPlan(Model):
+class InstallmentPlan(TimestampedModel):
     """InstallmentPlan."""
 
     class Meta:
@@ -35,9 +35,6 @@ class InstallmentPlan(Model):
     status = models.CharField(choices=InstallmentPlanStatus.choices, max_length=10)
     expected_payoff_date = models.DateField()
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 class ClaimQueueColumns(models.TextChoices):
     """ClaimQueueColumns."""
@@ -73,7 +70,7 @@ class ClaimQueues(models.IntegerChoices):
     TRASH = 10, "Trash"
 
 
-class ClaimQueue(Model):
+class ClaimQueue(TimestampedModel):
     """ClaimQueue."""
 
     class Meta:
@@ -83,14 +80,11 @@ class ClaimQueue(Model):
     name = models.CharField(max_length=100)
     display_name = models.CharField(max_length=100)
     description = models.CharField(max_length=500)
-    show_in_revenue = models.BooleanField()
+    show_in_revenue = models.BooleanField(default=True)
     visible_columns = ChoiceArrayField(
         models.CharField(choices=ClaimQueueColumns.choices, max_length=64)
     )
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 class ClaimPayerOrder(models.TextChoices):
     """ClaimPayerOrder."""
@@ -124,7 +118,7 @@ class ClaimCoverageQuerySet(models.QuerySet):
         return self.filter(active=True)
 
 
-class ClaimCoverage(Model):
+class ClaimCoverage(TimestampedModel):
     """A model that represents the link between a claim and a specific insurance coverage."""
 
     class Meta:
@@ -180,11 +174,8 @@ class ClaimCoverage(Model):
     resubmission_code = models.CharField(max_length=1)
     payer_icn = models.CharField(max_length=250)
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
 
-
-class ClaimPatient(Model):
+class ClaimPatient(TimestampedModel):
     """ClaimPatient."""
 
     class Meta:
@@ -206,9 +197,6 @@ class ClaimPatient(Model):
     zip = models.CharField(max_length=255)
     country = models.CharField(max_length=50)
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 class ClaimQueryset(models.QuerySet):
     """ClaimQueryset."""
@@ -218,7 +206,7 @@ class ClaimQueryset(models.QuerySet):
         return self.exclude(current_queue__queue_sort_ordering=ClaimQueues.TRASH)
 
 
-class Claim(IdentifiableModel):
+class Claim(TimestampedModel, IdentifiableModel):
     """Claim."""
 
     class Meta:
@@ -236,25 +224,23 @@ class Claim(IdentifiableModel):
         ClaimCoverage, related_name="claims", on_delete=models.SET_NULL, null=True
     )
 
-    accept_assign = models.BooleanField()
-    auto_accident = models.BooleanField()
+    accept_assign = models.BooleanField(default=True)
+    auto_accident = models.BooleanField(default=False)
     auto_accident_state = models.CharField(max_length=2)
-    employment_related = models.BooleanField()
-    other_accident = models.BooleanField()
+    employment_related = models.BooleanField(default=False)
+    other_accident = models.BooleanField(default=False)
     accident_code = models.CharField(max_length=10)
-    illness_date = models.DateField()
+    illness_date = models.DateField(blank=True, null=True)
     remote_batch_id = models.CharField(max_length=100)
     remote_file_id = models.CharField(max_length=100)
     prior_auth = models.CharField(max_length=100)
 
     narrative = models.CharField(max_length=2500)
     account_number = models.CharField(max_length=255)
-    snoozed_until = models.DateField()
+    snoozed_until = models.DateField(null=True)
 
-    patient_balance = models.DecimalField(max_digits=8, decimal_places=2)
-    aggregate_coverage_balance = models.DecimalField(max_digits=8, decimal_places=2)
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
+    patient_balance = models.DecimalField(max_digits=8, decimal_places=2, default=0.00)
+    aggregate_coverage_balance = models.DecimalField(max_digits=8, decimal_places=2, default=0.00)
 
     @property
     def total_charges(self) -> Decimal:

canvas_sdk/v1/data/claim_diagnosis_code.py

@@ -1,9 +1,9 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
 
 
-class ClaimDiagnosisCode(IdentifiableModel):
+class ClaimDiagnosisCode(TimestampedModel, IdentifiableModel):
     """ClaimDiagnosisCode model for claim diagnosis codes."""
 
     class Meta:
@@ -15,8 +15,5 @@ class ClaimDiagnosisCode(IdentifiableModel):
     code = models.CharField(max_length=20, blank=True)
     display = models.CharField(max_length=1000, blank=True)
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 __exports__ = ("ClaimDiagnosisCode",)

canvas_sdk/v1/data/claim_line_item.py

@@ -5,7 +5,7 @@ from django.db import models
 from django.db.models import Q, Sum
 from django.db.models.functions import Coalesce
 
-from canvas_sdk.v1.data.base import Model
+from canvas_sdk.v1.data.base import TimestampedModel
 from canvas_sdk.v1.data.note import PracticeLocationPOS
 
 
@@ -106,7 +106,7 @@ class ClaimLineItemQuerySet(models.QuerySet):
         return self.exclude(proc_code=LineItemCodes.UNLINKED.value).apply_ordering()
 
 
-class ClaimLineItem(Model):
+class ClaimLineItem(TimestampedModel):
     """ClaimLineItem."""
 
     class Meta:
@@ -132,8 +132,5 @@ class ClaimLineItem(Model):
     epsdt = models.CharField(max_length=2)
     family_planning = models.CharField(choices=FamilyPlanningOptions.choices, max_length=1)
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 __exports__ = ("ClaimLineItem", "ClaimLineItemStatus", "LineItemCodes", "FamilyPlanningOptions")

canvas_sdk/v1/data/coding.py

@@ -0,0 +1,19 @@
+from django.db import models
+
+from canvas_sdk.v1.data.base import Model
+
+
+class Coding(Model):
+    """A representation of a coding from a terminology system."""
+
+    class Meta:
+        abstract = True
+
+    code = models.CharField(max_length=255, blank=True, default="")
+    display = models.CharField(max_length=1000)
+    system = models.CharField(max_length=255)
+    version = models.CharField(max_length=255, blank=True, default="")
+    user_selected = models.BooleanField(default=False)
+
+
+__exports__ = ()

canvas_sdk/v1/data/command.py

@@ -1,17 +1,15 @@
 from django.apps import apps
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
 
 
-class Command(IdentifiableModel):
+class Command(TimestampedModel, IdentifiableModel):
     """Command."""
 
     class Meta:
         db_table = "canvas_sdk_data_commands_command_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     originator = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="commands_originated"
     )

canvas_sdk/v1/data/compound_medication.py

@@ -1,8 +1,10 @@
 from django.db import models
 from django.db.models import TextChoices
 
+from canvas_sdk.v1.data.base import IdentifiableModel
 
-class CompoundMedication(models.Model):
+
+class CompoundMedication(IdentifiableModel):
     """CompoundMedication."""
 
     class Meta:
@@ -49,8 +51,6 @@ class CompoundMedication(models.Model):
         SCHEDULE_IV = "IV", "Schedule IV"
         SCHEDULE_V = "V", "Schedule V"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
     active = models.BooleanField(default=True)
     formulation = models.CharField(max_length=105)
     potency_unit_code = models.CharField(max_length=20, choices=PotencyUnits.choices)

canvas_sdk/v1/data/condition.py

@@ -9,9 +9,9 @@ from canvas_sdk.v1.data.base import (
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
     IdentifiableModel,
-    Model,
     ValueSetLookupQuerySetMixin,
 )
+from canvas_sdk.v1.data.coding import Coding
 
 
 class ClinicalStatus(TextChoices):
@@ -64,17 +64,12 @@ class Condition(IdentifiableModel):
     surgical = models.BooleanField()
 
 
-class ConditionCoding(Model):
+class ConditionCoding(Coding):
     """ConditionCoding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_conditioncoding_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()
     condition = models.ForeignKey(
         Condition, on_delete=models.DO_NOTHING, related_name="codings", null=True
     )