canvas 0.44.3__py3-none-any.whl → 0.46.0__py3-none-any.whl

canvas_sdk/v1/data/line_item_transaction.py

@@ -1,6 +1,8 @@
 from django.db import models
 from django.db.models import QuerySet
 
+from canvas_sdk.v1.data.base import Model
+
 
 class AbstractLineItemQuerySet(models.QuerySet):
     """AbstractLineItemQuerySet."""
@@ -10,7 +12,7 @@ class AbstractLineItemQuerySet(models.QuerySet):
         return self.filter(entered_in_error__isnull=True)
 
 
-class AbstractLineItemTransaction(models.Model):
+class AbstractLineItemTransaction(Model):
     """Abstract class with common properties for both payments and adjustments."""
 
     class Meta:
@@ -18,7 +20,6 @@ class AbstractLineItemTransaction(models.Model):
 
     objects = AbstractLineItemQuerySet.as_manager()
 
-    dbid = models.BigIntegerField(primary_key=True)
     posting = models.ForeignKey(
         "v1.BasePosting", related_name="%(class)ss", on_delete=models.PROTECT
     )
@@ -27,15 +28,14 @@ class AbstractLineItemTransaction(models.Model):
     )
     amount = models.DecimalField(max_digits=8, decimal_places=2)
 
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
 
 
 class NewLineItemPayment(AbstractLineItemTransaction):
     """Subclass that represents a payment on a billing line item."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_newlineitempayment_001"
 
     charged = models.DecimalField(max_digits=8, decimal_places=2)
@@ -47,8 +47,8 @@ class AbstractLineItemAdjustment(AbstractLineItemTransaction):
     class Meta:
         abstract = True
 
-    code = models.CharField()
-    group = models.CharField()
+    code = models.CharField(max_length=8)
+    group = models.CharField(max_length=8)
 
     deviated_from_posting_ruleset = models.BooleanField()
 
@@ -57,7 +57,6 @@ class NewLineItemAdjustment(AbstractLineItemAdjustment):
     """Subclass for billing line item adjustments."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_newlineitemadjustment_001"
 
     write_off = models.BooleanField()
@@ -67,7 +66,6 @@ class LineItemTransfer(AbstractLineItemAdjustment):
     """Subclass for billing line item balance transfer to other coverages or patient."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_lineitemtransfer_001"
 
     transfer_to = models.ForeignKey(

canvas_sdk/v1/data/medication.py

@@ -7,6 +7,8 @@ from canvas_sdk.v1.data.base import (
     BaseModelManager,
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
+    IdentifiableModel,
+    Model,
     ValueSetLookupQuerySet,
 )
 
@@ -29,17 +31,14 @@ class MedicationQuerySet(ValueSetLookupQuerySet, CommittableQuerySetMixin, ForPa
 MedicationManager = BaseModelManager.from_queryset(MedicationQuerySet)
 
 
-class Medication(models.Model):
+class Medication(IdentifiableModel):
     """Medication."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_medication_001"
 
     objects = cast(MedicationQuerySet, MedicationManager())
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="medications", null=True
     )
@@ -50,28 +49,26 @@ class Medication(models.Model):
     committer = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
     )
-    status = models.CharField(choices=Status.choices)
+    status = models.CharField(choices=Status.choices, max_length=20)
     start_date = models.DateTimeField()
     end_date = models.DateTimeField()
-    quantity_qualifier_description = models.CharField()
-    clinical_quantity_description = models.CharField()
-    potency_unit_code = models.CharField()
-    national_drug_code = models.CharField()
-    erx_quantity = models.CharField()
+    quantity_qualifier_description = models.TextField()
+    clinical_quantity_description = models.TextField()
+    potency_unit_code = models.CharField(max_length=20)
+    national_drug_code = models.CharField(max_length=20)
+    erx_quantity = models.FloatField()
 
 
-class MedicationCoding(models.Model):
+class MedicationCoding(Model):
     """MedicationCoding."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_medicationcoding_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField()
-    version = models.CharField()
-    code = models.CharField()
-    display = models.CharField()
+    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()
     medication = models.ForeignKey(
         Medication, on_delete=models.DO_NOTHING, related_name="codings", null=True

canvas_sdk/v1/data/message.py

@@ -1,5 +1,7 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel
+
 
 class TransmissionChannel(models.TextChoices):
     """Transmission channel."""
@@ -10,17 +12,14 @@ class TransmissionChannel(models.TextChoices):
     NOOP = "noop", "No-op"
 
 
-class Message(models.Model):
+class Message(IdentifiableModel):
     """Message."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_message_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    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
@@ -34,15 +33,12 @@ class Message(models.Model):
     read = models.BooleanField()
 
 
-class MessageAttachment(models.Model):
+class MessageAttachment(IdentifiableModel):
     """Message attachment."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_messageattachment_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
     file = models.TextField()
     content_type = models.CharField(max_length=255)
     message = models.ForeignKey(
@@ -50,24 +46,21 @@ class MessageAttachment(models.Model):
     )
 
 
-class MessageTransmission(models.Model):
+class MessageTransmission(IdentifiableModel):
     """Message Transmission."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_messagetransmission_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    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
     )
     delivered = models.BooleanField()
     failed = models.BooleanField()
 
-    contact_point_system = models.CharField(choices=TransmissionChannel.choices)
+    contact_point_system = models.CharField(choices=TransmissionChannel.choices, max_length=20)
     contact_point_value = models.CharField(max_length=255)
 
     comment = models.TextField()

canvas_sdk/v1/data/note.py

@@ -1,6 +1,8 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel
+
 
 class NoteTypeCategories(models.TextChoices):
     """Note type categories."""
@@ -87,35 +89,58 @@ class NoteTypes(models.TextChoices):
     CCDA = "ccda", "C-CDA Import"
 
 
-class NoteType(models.Model):
+class NoteStates(models.TextChoices):
+    """Note states."""
+
+    NEW = "NEW", "Created"
+    PUSHED = "PSH", "Pushed the charges for"
+    LOCKED = "LKD", "Locked"
+    UNLOCKED = "ULK", "Unlocked"
+    DELETED = "DLT", "Deleted"
+    RELOCKED = "RLK", "Relocked"
+    RESTORED = "RST", "Restored"
+    RECALLED = "RCL", "Recalled"
+    UNDELETED = "UND", "Undeleted"
+    DISCHARGED = "DSC", "Discharged"
+    # Appointment note
+    SCHEDULING = "SCH", "Scheduling"
+    BOOKED = "BKD", "Booked"
+    CONVERTED = "CVD", "Checked in"
+    CANCELLED = "CLD", "Canceled"
+    NOSHOW = "NSW", "No show"
+    REVERTED = "RVT", "Reverted"
+    # C-CDA Import note
+    CONFIRM_IMPORT = "CNF", "Confirmed"
+
+
+class NoteType(IdentifiableModel):
     """NoteType."""
 
     objects: models.Manager["NoteType"]
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_notetype_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
-    system = models.CharField()
-    version = models.CharField()
-    code = models.CharField()
-    display = models.CharField()
+    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()
-    icon = models.CharField()
-    category = models.CharField(choices=NoteTypeCategories.choices)
+    name = models.CharField(max_length=250)
+    icon = models.CharField(max_length=250)
+    category = models.CharField(choices=NoteTypeCategories.choices, max_length=50)
     rank = models.PositiveIntegerField()
     is_default_appointment_type = models.BooleanField()
     is_scheduleable = models.BooleanField()
     is_telehealth = models.BooleanField()
     is_billable = models.BooleanField()
     defer_place_of_service_to_practice_location = models.BooleanField()
-    available_places_of_service = ArrayField(models.CharField(choices=PracticeLocationPOS.choices))
-    default_place_of_service = models.CharField(choices=PracticeLocationPOS.choices)
+    available_places_of_service = ArrayField(
+        models.CharField(choices=PracticeLocationPOS.choices, max_length=5)
+    )
+    default_place_of_service = models.CharField(choices=PracticeLocationPOS.choices, max_length=5)
     is_system_managed = models.BooleanField()
     is_visible = models.BooleanField()
     is_active = models.BooleanField()
@@ -127,24 +152,21 @@ class NoteType(models.Model):
     online_duration = models.IntegerField()
 
 
-class Note(models.Model):
+class Note(IdentifiableModel):
     """Note."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_note_001"
 
-    id = models.CharField(max_length=32)
-    dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    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
     )
     provider = models.ForeignKey(
         "v1.Staff", on_delete=models.DO_NOTHING, related_name="notes", null=True
     )
-    note_type = models.CharField(choices=NoteTypes.choices, null=True)
+    note_type = models.CharField(choices=NoteTypes.choices, null=True, max_length=50)
     note_type_version = models.ForeignKey(
         "v1.NoteType", on_delete=models.DO_NOTHING, related_name="notes", null=True
     )
@@ -152,14 +174,52 @@ class Note(models.Model):
     body = models.JSONField()
     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()
+    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()
     location = models.ForeignKey("v1.PracticeLocation", on_delete=models.DO_NOTHING, null=True)
     datetime_of_service = models.DateTimeField()
-    place_of_service = models.CharField()
+    place_of_service = models.CharField(max_length=255)
+
+
+class NoteStateChangeEvent(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)
+    note_state_document = models.CharField(max_length=100, null=True)
+    note_state_html = models.TextField()
+
+
+class CurrentNoteStateEvent(IdentifiableModel):
+    """
+    CurrentNoteStateEvent is a special model backed by a view which only includes the latest
+    NoteStateChangeEvent for any given note_id.
+    """
+
+    class Meta:
+        db_table = "canvas_sdk_data_current_note_state_001"
+
+    state = models.CharField(choices=NoteStates.choices, max_length=3)
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="+")
+
+    def editable(self) -> bool:
+        """Returns a boolean to indicate if the related note can be edited."""
+        return self.state in [
+            NoteStates.NEW,
+            NoteStates.PUSHED,
+            NoteStates.UNLOCKED,
+            NoteStates.RESTORED,
+            NoteStates.UNDELETED,
+        ]
 
 
 __exports__ = (
@@ -168,4 +228,7 @@ __exports__ = (
     "NoteTypes",
     "NoteType",
     "Note",
+    "NoteStates",
+    "NoteStateChangeEvent",
+    "CurrentNoteStateEvent",
 )

canvas_sdk/v1/data/observation.py

@@ -6,6 +6,8 @@ from canvas_sdk.v1.data.base import (
     BaseModelManager,
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
+    IdentifiableModel,
+    Model,
     ValueSetLookupQuerySet,
 )
 
@@ -21,19 +23,16 @@ class ObservationQuerySet(
 ObservationManager = BaseModelManager.from_queryset(ObservationQuerySet)
 
 
-class Observation(models.Model):
+class Observation(IdentifiableModel):
     """Observation."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_observation_001"
 
     objects = cast(ObservationQuerySet, ObservationManager())
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    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="+"
     )
@@ -50,7 +49,7 @@ class Observation(models.Model):
     is_member_of = models.ForeignKey(
         "self", on_delete=models.DO_NOTHING, related_name="members", null=True
     )
-    category = models.CharField()
+    category = models.CharField(max_length=14)
     units = models.TextField()
     value = models.TextField()
     note_id = models.BigIntegerField()
@@ -58,34 +57,30 @@ class Observation(models.Model):
     effective_datetime = models.DateTimeField()
 
 
-class ObservationCoding(models.Model):
+class ObservationCoding(Model):
     """ObservationCoding."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_observationcoding_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField()
-    version = models.CharField()
-    code = models.CharField()
-    display = models.CharField()
+    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(models.Model):
+class ObservationComponent(Model):
     """ObservationComponent."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_observationcomponent_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    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
     )
@@ -94,36 +89,32 @@ class ObservationComponent(models.Model):
     name = models.TextField()
 
 
-class ObservationComponentCoding(models.Model):
+class ObservationComponentCoding(Model):
     """ObservationComponentCoding."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_observationcomponentcoding_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField()
-    version = models.CharField()
-    code = models.CharField()
-    display = models.CharField()
+    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(models.Model):
+class ObservationValueCoding(Model):
     """ObservationValueCoding."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_observationvaluecoding_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField()
-    version = models.CharField()
-    code = models.CharField()
-    display = models.CharField()
+    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,29 +1,28 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import Model
 from canvas_sdk.v1.data.common import TaxIDType
 
 
-class Organization(models.Model):
+class Organization(Model):
     """Organization."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_organization_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
-    full_name = models.CharField()
-    short_name = models.CharField()
-    subdomain = models.CharField()
-    logo_url = models.CharField()
-    background_image_url = models.CharField()
-    background_gradient = models.CharField()
+    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()
-    tax_id = models.CharField(null=True)
-    tax_id_type = models.CharField(choices=TaxIDType.choices)
-    group_npi_number = models.CharField()
-    group_taxonomy_number = models.CharField()
+    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()
     main_location = models.OneToOneField(
         "v1.PracticeLocation", on_delete=models.DO_NOTHING, related_name="+"