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

canvas_sdk/v1/data/medication_statement.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 AuditedModel, IdentifiableModel
 
 
-class MedicationStatement(IdentifiableModel):
+class MedicationStatement(AuditedModel, IdentifiableModel):
     """MedicationStatement."""
 
     class Meta:
@@ -26,15 +26,6 @@ class MedicationStatement(IdentifiableModel):
         related_name="treatments_stated",
         db_table="canvas_sdk_data_api_medicationstatement_indications_001",
     )
-    entered_in_error = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+", null=True
-    )
-    committer = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+", null=True
-    )
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+")
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     start_date_original_input = models.CharField(max_length=255, default="")
     start_date = models.DateField(default=None, null=True)
     end_date_original_input = models.CharField(max_length=255, default="")

canvas_sdk/v1/data/message.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 TransmissionChannel(models.TextChoices):
@@ -12,14 +12,12 @@ class TransmissionChannel(models.TextChoices):
     NOOP = "noop", "No-op"
 
 
-class Message(IdentifiableModel):
+class Message(TimestampedModel, IdentifiableModel):
     """Message."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_message_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     content = models.TextField()
     sender = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="sent_messages", null=True
@@ -46,14 +44,12 @@ class MessageAttachment(IdentifiableModel):
     )
 
 
-class MessageTransmission(IdentifiableModel):
+class MessageTransmission(TimestampedModel, IdentifiableModel):
     """Message Transmission."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_messagetransmission_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     message = models.ForeignKey(
         "v1.Message", on_delete=models.DO_NOTHING, related_name="transmissions", null=True
     )

canvas_sdk/v1/data/note.py

@@ -1,8 +1,11 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
+from django.utils import timezone
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
 from canvas_sdk.v1.data.claim import Claim
+from canvas_sdk.v1.data.coding import Coding
+from canvas_sdk.v1.data.utils import empty_note_body
 
 
 class NoteTypeCategories(models.TextChoices):
@@ -114,7 +117,7 @@ class NoteStates(models.TextChoices):
     CONFIRM_IMPORT = "CNF", "Confirmed"
 
 
-class NoteType(IdentifiableModel):
+class NoteType(TimestampedModel, IdentifiableModel, Coding):
     """NoteType."""
 
     objects: models.Manager["NoteType"]
@@ -122,13 +125,6 @@ class NoteType(IdentifiableModel):
     class Meta:
         db_table = "canvas_sdk_data_api_notetype_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-    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()
     name = models.CharField(max_length=250)
     icon = models.CharField(max_length=250)
     category = models.CharField(choices=NoteTypeCategories.choices, max_length=50)
@@ -153,14 +149,12 @@ class NoteType(IdentifiableModel):
     online_duration = models.IntegerField()
 
 
-class Note(IdentifiableModel):
+class Note(TimestampedModel, IdentifiableModel):
     """Note."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_note_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="notes", null=True
     )
@@ -171,17 +165,17 @@ class Note(IdentifiableModel):
     note_type_version = models.ForeignKey(
         "v1.NoteType", on_delete=models.DO_NOTHING, related_name="notes", null=True
     )
-    title = models.TextField()
-    body = models.JSONField()
+    title = models.TextField(default="", blank=True)
+    body = models.JSONField(default=empty_note_body)
     originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
     last_modified_by_staff = models.ForeignKey("v1.Staff", on_delete=models.DO_NOTHING, null=True)
     checksum = models.CharField(max_length=32)
     billing_note = models.TextField()
     # TODO -implement InpatientStay model
     # inpatient_stay = models.ForeignKey("v1.InpatientStay", on_delete=models.DO_NOTHING, null=True)
-    related_data = models.JSONField()
+    related_data = models.JSONField(default=dict, blank=True)
     location = models.ForeignKey("v1.PracticeLocation", on_delete=models.DO_NOTHING, null=True)
-    datetime_of_service = models.DateTimeField()
+    datetime_of_service = models.DateTimeField(default=timezone.now)
     place_of_service = models.CharField(max_length=255)
 
     def get_claim(self) -> Claim | None:
@@ -192,14 +186,12 @@ class Note(IdentifiableModel):
         return self.claims.order_by("-created").first()
 
 
-class NoteStateChangeEvent(IdentifiableModel):
+class NoteStateChangeEvent(TimestampedModel, IdentifiableModel):
     """NoteStateChangeEvent."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_notestatechangeevent_001"
 
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
     note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="state_history")
     originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
     state = models.CharField(choices=NoteStates.choices, max_length=3)

canvas_sdk/v1/data/observation.py

@@ -3,13 +3,15 @@ from typing import cast
 from django.db import models
 
 from canvas_sdk.v1.data.base import (
+    AuditedModel,
     BaseModelManager,
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
     IdentifiableModel,
-    Model,
+    TimestampedModel,
     ValueSetLookupQuerySet,
 )
+from canvas_sdk.v1.data.coding import Coding
 
 
 class ObservationQuerySet(
@@ -23,7 +25,7 @@ class ObservationQuerySet(
 ObservationManager = BaseModelManager.from_queryset(ObservationQuerySet)
 
 
-class Observation(IdentifiableModel):
+class Observation(AuditedModel, IdentifiableModel):
     """Observation."""
 
     class Meta:
@@ -31,18 +33,6 @@ class Observation(IdentifiableModel):
 
     objects = cast(ObservationQuerySet, ObservationManager())
 
-    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="+"
-    )
-    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()
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="observations", null=True
     )
@@ -57,30 +47,23 @@ class Observation(IdentifiableModel):
     effective_datetime = models.DateTimeField()
 
 
-class ObservationCoding(Model):
+class ObservationCoding(Coding):
     """ObservationCoding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_observationcoding_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()
     observation = models.ForeignKey(
         Observation, on_delete=models.DO_NOTHING, related_name="codings", null=True
     )
 
 
-class ObservationComponent(Model):
+class ObservationComponent(TimestampedModel):
     """ObservationComponent."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_observationcomponent_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     observation = models.ForeignKey(
         Observation, on_delete=models.DO_NOTHING, related_name="components", null=True
     )
@@ -89,33 +72,23 @@ class ObservationComponent(Model):
     name = models.TextField()
 
 
-class ObservationComponentCoding(Model):
+class ObservationComponentCoding(Coding):
     """ObservationComponentCoding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_observationcomponentcoding_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()
     observation_component = models.ForeignKey(
         ObservationComponent, on_delete=models.DO_NOTHING, related_name="codings", null=True
     )
 
 
-class ObservationValueCoding(Model):
+class ObservationValueCoding(Coding):
     """ObservationValueCoding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_observationvaluecoding_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()
     observation = models.ForeignKey(
         Observation, on_delete=models.DO_NOTHING, related_name="value_codings", null=True
     )

canvas_sdk/v1/data/organization.py

@@ -1,31 +1,29 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import Model
+from canvas_sdk.v1.data.base import TimestampedModel
 from canvas_sdk.v1.data.common import TaxIDType
 
 
-class Organization(Model):
+class Organization(TimestampedModel):
     """Organization."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_organization_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     full_name = models.CharField(max_length=255)
     short_name = models.CharField(max_length=255)
     subdomain = models.CharField(max_length=100)
     logo_url = models.CharField(max_length=255)
     background_image_url = models.CharField(max_length=255)
     background_gradient = models.CharField(max_length=255)
-    active = models.BooleanField()
+    active = models.BooleanField(default=True)
     tax_id = models.CharField(null=True, max_length=25)
     tax_id_type = models.CharField(choices=TaxIDType.choices, max_length=1)
     group_npi_number = models.CharField(max_length=10)
     group_taxonomy_number = models.CharField(max_length=10)
-    include_zz_qualifier = models.BooleanField()
+    include_zz_qualifier = models.BooleanField(default=False)
     main_location = models.OneToOneField(
-        "v1.PracticeLocation", on_delete=models.DO_NOTHING, related_name="+"
+        "PracticeLocation", related_name="+", null=True, on_delete=models.PROTECT
     )
 
 

canvas_sdk/v1/data/patient.py

@@ -7,7 +7,7 @@ from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from django.db.models import TextChoices
 
-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 (
     AddressState,
     AddressType,
@@ -39,7 +39,7 @@ class PatientSettingConstants:
     PREFERRED_SCHEDULING_TIMEZONE = "preferredSchedulingTimezone"
 
 
-class Patient(Model):
+class Patient(TimestampedModel):
     """A class representing a patient."""
 
     class Meta:
@@ -108,9 +108,6 @@ class Patient(Model):
     )
     user = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
     @classmethod
     def find(cls, id: str) -> Patient:
         """Find a patient by id."""
@@ -243,14 +240,12 @@ class PatientAddress(IdentifiableModel):
         return f"id={self.id}"
 
 
-class PatientExternalIdentifier(IdentifiableModel):
+class PatientExternalIdentifier(TimestampedModel, IdentifiableModel):
     """A class representing a patient external identifier."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_patientexternalidentifier_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     patient = models.ForeignKey(
         "v1.Patient",
         related_name="external_identifiers",
@@ -268,14 +263,12 @@ class PatientExternalIdentifier(IdentifiableModel):
         return f"id={self.id}"
 
 
-class PatientSetting(Model):
+class PatientSetting(TimestampedModel):
     """PatientSetting."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_patientsetting_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="settings", null=True
     )

canvas_sdk/v1/data/patient_consent.py

@@ -1,20 +1,15 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel, Model
+from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.coding import Coding
 
 
-class PatientConsentRejectionCoding(Model):
+class PatientConsentRejectionCoding(Coding):
     """Patient Consent Rejection Coding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_patientconsentrejectioncoding_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()
-
 
 class PatientConsentExpirationRule(models.TextChoices):
     """PatientConsentExpirationRule."""
@@ -24,17 +19,12 @@ class PatientConsentExpirationRule(models.TextChoices):
     END_OF_YEAR = "end_of_year", "End of year"
 
 
-class PatientConsentCoding(Model):
+class PatientConsentCoding(Coding):
     """Patient Consent Coding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_patientconsentcoding_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()
     expiration_rule = models.CharField(choices=PatientConsentExpirationRule.choices, max_length=255)
     is_mandatory = models.BooleanField()
     is_proof_required = models.BooleanField()

canvas_sdk/v1/data/payment_collection.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 PostingMethods(models.TextChoices):
@@ -12,7 +12,7 @@ class PostingMethods(models.TextChoices):
     OTHER = "other", "Other"
 
 
-class PaymentCollection(IdentifiableModel):
+class PaymentCollection(TimestampedModel, IdentifiableModel):
     """Stores the total collected amount and the payment method."""
 
     class Meta:
@@ -27,8 +27,5 @@ class PaymentCollection(IdentifiableModel):
 
     description = models.TextField()
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 __exports__ = ("PaymentCollection", "PostingMethods")

canvas_sdk/v1/data/posting.py

@@ -3,7 +3,7 @@ from typing import 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.utils import quantize
 
 
@@ -15,7 +15,7 @@ class PostingQuerySet(models.QuerySet):
         return self.filter(entered_in_error__isnull=True)
 
 
-class BasePosting(Model):
+class BasePosting(TimestampedModel):
     """
     Base model to aggregate multiple line item transactions on a claim.
     """
@@ -40,9 +40,6 @@ class BasePosting(Model):
         "v1.CanvasUser", on_delete=models.PROTECT, null=True, blank=True
     )
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
     @property
     def paid_amount(self) -> Decimal:
         """Returns the total amount paid for this posting."""
@@ -149,7 +146,7 @@ class PatientPosting(BasePosting):
         return self.discounted_amount + self.paid_amount
 
 
-class AbstractBulkPosting(IdentifiableModel):
+class AbstractBulkPosting(TimestampedModel, IdentifiableModel):
     """Patient and Insurance bulk posting shared columns."""
 
     class Meta:
@@ -161,9 +158,6 @@ class AbstractBulkPosting(IdentifiableModel):
 
     total_paid = models.DecimalField(max_digits=8, decimal_places=2)
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 class BulkPatientPosting(AbstractBulkPosting):
     """Model to aggregate bulk patient payments on multiple claims."""

canvas_sdk/v1/data/practicelocation.py

@@ -1,6 +1,6 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel, Model
+from canvas_sdk.v1.data.base import IdentifiableModel, Model, TimestampedModel
 from canvas_sdk.v1.data.common import TaxIDType
 
 
@@ -53,14 +53,12 @@ class PracticeLocationPOS(models.TextChoices):
     OTHER = "99", "Other Place of Service"
 
 
-class PracticeLocation(IdentifiableModel):
+class PracticeLocation(TimestampedModel, IdentifiableModel):
     """PracticeLocation."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_practicelocation_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     organization = models.ForeignKey(
         "v1.Organization", on_delete=models.DO_NOTHING, related_name="practice_locations", null=True
     )
@@ -69,7 +67,7 @@ class PracticeLocation(IdentifiableModel):
     short_name = models.CharField(max_length=255)
     background_image_url = models.CharField(max_length=255)
     background_gradient = models.CharField(max_length=255)
-    active = models.BooleanField()
+    active = models.BooleanField(default=True)
     npi_number = models.CharField(max_length=10)
     bill_through_organization = models.BooleanField()
     tax_id = models.CharField(max_length=25)
@@ -77,7 +75,7 @@ class PracticeLocation(IdentifiableModel):
     billing_location_name = models.CharField(max_length=255)
     group_npi_number = models.CharField(max_length=10)
     taxonomy_number = models.CharField(max_length=10)
-    include_zz_qualifier = models.BooleanField()
+    include_zz_qualifier = models.BooleanField(default=False)
 
     def __str__(self) -> str:
         return self.full_name

canvas_sdk/v1/data/protocol_override.py

@@ -8,6 +8,7 @@ from canvas_sdk.v1.data.base import (
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
     IdentifiableModel,
+    TimestampedModel,
 )
 
 
@@ -35,7 +36,7 @@ class ProtocolOverrideQuerySet(BaseQuerySet, ForPatientQuerySetMixin, Committabl
 ProtocolOverrideManager = BaseModelManager.from_queryset(ProtocolOverrideQuerySet)
 
 
-class ProtocolOverride(IdentifiableModel):
+class ProtocolOverride(TimestampedModel, IdentifiableModel):
     """ProtocolOverride."""
 
     class Meta:
@@ -43,8 +44,6 @@ class ProtocolOverride(IdentifiableModel):
 
     objects = cast(ProtocolOverrideQuerySet, ProtocolOverrideManager())
 
-    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="+"

canvas_sdk/v1/data/protocol_result.py

@@ -1,6 +1,8 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
+from canvas_sdk.v1.data.base import TimestampedModel
+
 
 class ProtocolResultStatus(models.TextChoices):
     """Constants for ProtocolResultStatus."""
@@ -12,7 +14,7 @@ class ProtocolResultStatus(models.TextChoices):
     STATUS_NOT_RELEVANT = "not_relevant"
 
 
-class ProtocolResult(models.Model):
+class ProtocolResult(TimestampedModel):
     """ProtocolResult."""
 
     class Meta:
@@ -36,8 +38,6 @@ class ProtocolResult(models.Model):
     next_review = models.DateTimeField(null=True)
     feedback_enabled = models.BooleanField(default=False)
     plugin_can_be_snoozed = models.BooleanField(default=False)
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
 
 
 __exports__ = (