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

canvas_sdk/v1/data/patient.py

@@ -7,6 +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.common import (
     AddressState,
     AddressType,
@@ -15,6 +16,7 @@ from canvas_sdk.v1.data.common import (
     ContactPointSystem,
     ContactPointUse,
 )
+from canvas_sdk.v1.data.utils import create_key
 
 if TYPE_CHECKING:
     from django_stubs_ext.db.models.manager import RelatedManager
@@ -40,47 +42,47 @@ class PatientSettingConstants:
     PREFERRED_SCHEDULING_TIMEZONE = "preferredSchedulingTimezone"
 
 
-class Patient(models.Model):
+class Patient(Model):
     """A class representing a patient."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patient_001"
 
-    id = models.CharField(max_length=32, db_column="key")
-    dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
-    first_name = models.CharField()
-    last_name = models.CharField()
+    id = models.CharField(
+        max_length=32, db_column="key", unique=True, editable=False, default=create_key
+    )
+    first_name = models.CharField(max_length=255)
+    last_name = models.CharField(max_length=255)
     birth_date = models.DateField()
     business_line = models.ForeignKey(
         "v1.BusinessLine", on_delete=models.DO_NOTHING, related_name="patients"
     )
-    sex_at_birth = models.CharField(choices=SexAtBirth.choices)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
-    prefix = models.CharField()
-    suffix = models.CharField()
-    middle_name = models.CharField()
-    maiden_name = models.CharField()
-    nickname = models.CharField()
-    sexual_orientation_term = models.CharField()
-    sexual_orientation_code = models.CharField()
-    gender_identity_term = models.CharField()
-    gender_identity_code = models.CharField()
-    preferred_pronouns = models.CharField()
-    biological_race_codes = ArrayField(models.CharField())
-    last_known_timezone = models.CharField()
-    mrn = models.CharField()
+    sex_at_birth = models.CharField(choices=SexAtBirth.choices, max_length=3)
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+    prefix = models.CharField(max_length=100)
+    suffix = models.CharField(max_length=100)
+    middle_name = models.CharField(max_length=255)
+    maiden_name = models.CharField(max_length=255)
+    nickname = models.CharField(max_length=255)
+    sexual_orientation_term = models.CharField(max_length=255)
+    sexual_orientation_code = models.CharField(max_length=255)
+    gender_identity_term = models.CharField(max_length=255)
+    gender_identity_code = models.CharField(max_length=255)
+    preferred_pronouns = models.CharField(max_length=255)
+    biological_race_codes = ArrayField(models.CharField(max_length=100))
+    last_known_timezone = models.CharField(max_length=32)
+    mrn = models.CharField(max_length=9)
     active = models.BooleanField()
     deceased = models.BooleanField()
     deceased_datetime = models.DateTimeField()
     deceased_cause = models.TextField()
     deceased_comment = models.TextField()
-    other_gender_description = models.CharField()
-    social_security_number = models.CharField()
+    other_gender_description = models.CharField(max_length=255)
+    social_security_number = models.CharField(max_length=9)
     administrative_note = models.TextField()
     clinical_note = models.TextField()
-    mothers_maiden_name = models.CharField()
+    mothers_maiden_name = models.CharField(max_length=255)
     multiple_birth_indicator = models.BooleanField()
     birth_order = models.BigIntegerField()
     default_location_id = models.BigIntegerField()
@@ -143,53 +145,47 @@ class Patient(models.Model):
         return self.nickname or self.first_name
 
 
-class PatientContactPoint(models.Model):
+class PatientContactPoint(IdentifiableModel):
     """A class representing a patient contact point."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientcontactpoint_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField(choices=ContactPointSystem.choices)
-    value = models.CharField()
-    use = models.CharField(choices=ContactPointUse.choices)
-    use_notes = models.CharField()
+    system = models.CharField(choices=ContactPointSystem.choices, max_length=20)
+    value = models.CharField(max_length=100)
+    use = models.CharField(choices=ContactPointUse.choices, max_length=20)
+    use_notes = models.CharField(max_length=255)
     rank = models.IntegerField()
-    state = models.CharField(choices=ContactPointState.choices)
+    state = models.CharField(choices=ContactPointState.choices, max_length=20)
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="telecom", null=True
     )
     has_consent = models.BooleanField()
     last_verified = models.DateTimeField
-    verification_token = models.CharField()
+    verification_token = models.CharField(max_length=32)
     opted_out = models.BooleanField()
 
 
-class PatientAddress(models.Model):
+class PatientAddress(IdentifiableModel):
     """A class representing a patient address."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientaddress_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    line1 = models.CharField()
-    line2 = models.CharField()
-    city = models.CharField()
-    district = models.CharField()
-    state_code = models.CharField()
-    postal_code = models.CharField()
-    use = models.CharField(choices=AddressUse.choices)
-    type = models.CharField(choices=AddressType.choices)
+    line1 = models.CharField(max_length=255)
+    line2 = models.CharField(max_length=255)
+    city = models.CharField(max_length=255)
+    district = models.CharField(max_length=255)
+    state_code = models.CharField(max_length=2)
+    postal_code = models.CharField(max_length=255)
+    use = models.CharField(choices=AddressUse.choices, max_length=10)
+    type = models.CharField(choices=AddressType.choices, max_length=10)
     longitude = models.FloatField()
     latitude = models.FloatField()
     start = models.DateField()
     end = models.DateField()
-    country = models.CharField()
-    state = models.CharField(choices=AddressState.choices)
+    country = models.CharField(max_length=255)
+    state = models.CharField(choices=AddressState.choices, max_length=20)
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="addresses", null=True
     )
@@ -198,27 +194,24 @@ class PatientAddress(models.Model):
         return f"id={self.id}"
 
 
-class PatientExternalIdentifier(models.Model):
+class PatientExternalIdentifier(IdentifiableModel):
     """A class representing a patient external identifier."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientexternalidentifier_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)
     patient = models.ForeignKey(
         "v1.Patient",
         related_name="external_identifiers",
         on_delete=models.DO_NOTHING,
         null=True,
     )
-    use = models.CharField()
-    identifier_type = models.CharField()
-    system = models.CharField()
-    value = models.CharField()
+    use = models.CharField(max_length=255)
+    identifier_type = models.CharField(max_length=255)
+    system = models.CharField(max_length=255)
+    value = models.CharField(max_length=255)
     issued_date = models.DateField()
     expiration_date = models.DateField()
 
@@ -226,31 +219,27 @@ class PatientExternalIdentifier(models.Model):
         return f"id={self.id}"
 
 
-class PatientSetting(models.Model):
+class PatientSetting(Model):
     """PatientSetting."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientsetting_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)
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="settings", null=True
     )
-    name = models.CharField()
+    name = models.CharField(max_length=100)
     value = models.JSONField()
 
 
-class PatientMetadata(models.Model):
+class PatientMetadata(IdentifiableModel):
     """A class representing Patient Metadata."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientmetadata_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="metadata", null=True
     )

canvas_sdk/v1/data/patient_consent.py

@@ -1,18 +1,18 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel, Model
 
-class PatientConsentRejectionCoding(models.Model):
+
+class PatientConsentRejectionCoding(Model):
     """Patient Consent Rejection Coding."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientconsentrejectioncoding_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()
 
 
@@ -24,20 +24,18 @@ class PatientConsentExpirationRule(models.TextChoices):
     END_OF_YEAR = "end_of_year", "End of year"
 
 
-class PatientConsentCoding(models.Model):
+class PatientConsentCoding(Model):
     """Patient Consent Coding."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientconsentcoding_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()
-    expiration_rule = models.CharField(choices=PatientConsentExpirationRule, max_length=255)
+    expiration_rule = models.CharField(choices=PatientConsentExpirationRule.choices, max_length=255)
     is_mandatory = models.BooleanField()
     is_proof_required = models.BooleanField()
     show_in_patient_portal = models.BooleanField()
@@ -56,15 +54,12 @@ class PatientConsentStatus(models.TextChoices):
     REJECTED_VIA_PORTAL = "rejected_via_patient_portal", "Rejected Via Patient Portal"
 
 
-class PatientConsent(models.Model):
+class PatientConsent(IdentifiableModel):
     """Patient Consent."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_patientconsent_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="patient_consent"
     )

canvas_sdk/v1/data/payment_collection.py

@@ -1,5 +1,7 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel
+
 
 class PostingMethods(models.TextChoices):
     """PostingMethods."""
@@ -10,26 +12,23 @@ class PostingMethods(models.TextChoices):
     OTHER = "other", "Other"
 
 
-class PaymentCollection(models.Model):
+class PaymentCollection(IdentifiableModel):
     """Stores the total collected amount and the payment method."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_paymentcollection_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
     total_collected = models.DecimalField(max_digits=8, decimal_places=2)
-    method = models.CharField(choices=PostingMethods.choices)
+    method = models.CharField(choices=PostingMethods.choices, max_length=10)
 
-    check_number = models.CharField()
+    check_number = models.CharField(max_length=250)
     check_date = models.DateField()
     deposit_date = models.DateField()
 
     description = models.TextField()
 
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
 
 
 __exports__ = ("PaymentCollection", "PostingMethods")

canvas_sdk/v1/data/payor_specific_charge.py

@@ -1,27 +1,25 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import Model
 
-class PayorSpecificCharge(models.Model):
+
+class PayorSpecificCharge(Model):
     """Payor Specific Charge."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_payorspecificcharge_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
     transactor = models.ForeignKey(
         "v1.Transactor", related_name="specific_charges", on_delete=models.DO_NOTHING
     )
-    # uncomment this when ChargeDescriptionMaster is added to data module
-    # charge = models.ForeignKey(
-    #     "v1.ChargeDescriptionMaster",
-    #     related_name="transactor_charges",
-    #     on_delete=models.DO_NOTHING,
-    # )
-
-    charge_amount = models.DecimalField()
+    charge = models.ForeignKey(
+        "v1.ChargeDescriptionMaster",
+        related_name="transactor_charges",
+        on_delete=models.DO_NOTHING,
+    )
+    charge_amount = models.DecimalField(max_digits=8, decimal_places=2)
     effective_date = models.DateField()
-    end_date = models.DateField()
+    end_date = models.DateField(null=True)
     part_of_capitated_set = models.BooleanField()
 
 

canvas_sdk/v1/data/posting.py

@@ -3,6 +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.utils import quantize
 
 
@@ -14,18 +15,16 @@ class PostingQuerySet(models.QuerySet):
         return self.filter(entered_in_error__isnull=True)
 
 
-class BasePosting(models.Model):
+class BasePosting(Model):
     """
     Base model to aggregate multiple line item transactions on a claim.
     """
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_baseposting_001"
 
     objects = PostingQuerySet.as_manager()
 
-    dbid = models.BigIntegerField(primary_key=True)
     corrected_posting = models.ForeignKey(
         "v1.BasePosting", related_name="correction_postings", on_delete=models.PROTECT, null=True
     )
@@ -41,8 +40,8 @@ class BasePosting(models.Model):
         "v1.CanvasUser", on_delete=models.PROTECT, null=True, blank=True
     )
 
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
 
     @property
     def paid_amount(self) -> Decimal:
@@ -93,7 +92,6 @@ class CoveragePosting(BasePosting):
     """Represents an insurance payment/adjustment on a claim level."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_coverageposting_001"
 
     remittance = models.ForeignKey(
@@ -103,9 +101,9 @@ class CoveragePosting(BasePosting):
         "v1.ClaimCoverage", related_name="postings", on_delete=models.PROTECT
     )
 
-    crossover_carrier = models.CharField()
-    crossover_id = models.CharField()
-    payer_icn = models.CharField()
+    crossover_carrier = models.CharField(max_length=255)
+    crossover_id = models.CharField(max_length=255)
+    payer_icn = models.CharField(max_length=255)
     position_in_era = models.PositiveIntegerField()
 
 
@@ -113,7 +111,6 @@ class PatientPosting(BasePosting):
     """A model that represents a patient payment/adjustment on a claim level."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_patientposting_001"
 
     claim_patient = models.ForeignKey(
@@ -152,30 +149,26 @@ class PatientPosting(BasePosting):
         return self.discounted_amount + self.paid_amount
 
 
-class AbstractBulkPosting(models.Model):
+class AbstractBulkPosting(IdentifiableModel):
     """Patient and Insurance bulk posting shared columns."""
 
     class Meta:
         abstract = True
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-
     payment_collection = models.OneToOneField(
         "v1.PaymentCollection", related_name="%(class)s", on_delete=models.PROTECT
     )
 
     total_paid = 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 BulkPatientPosting(AbstractBulkPosting):
     """Model to aggregate bulk patient payments on multiple claims."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_bulkpatientposting_001"
 
     discount = models.ForeignKey(
@@ -200,7 +193,6 @@ class BaseRemittanceAdvice(AbstractBulkPosting):
     """Manual and Electronic Shared columns."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_quality_and_revenue_baseremittanceadvice_001"
 
     transactor = models.ForeignKey(

canvas_sdk/v1/data/practicelocation.py

@@ -1,5 +1,6 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel, Model
 from canvas_sdk.v1.data.common import TaxIDType
 
 
@@ -52,51 +53,46 @@ class PracticeLocationPOS(models.TextChoices):
     OTHER = "99", "Other Place of Service"
 
 
-class PracticeLocation(models.Model):
+class PracticeLocation(IdentifiableModel):
     """PracticeLocation."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_practicelocation_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)
     organization = models.ForeignKey(
         "v1.Organization", on_delete=models.DO_NOTHING, related_name="practice_locations", null=True
     )
-    place_of_service_code = models.CharField(choices=PracticeLocationPOS.choices)
-    full_name = models.CharField()
-    short_name = models.CharField()
-    background_image_url = models.CharField()
-    background_gradient = models.CharField()
+    place_of_service_code = models.CharField(choices=PracticeLocationPOS.choices, max_length=2)
+    full_name = models.CharField(max_length=255)
+    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()
-    npi_number = models.CharField()
+    npi_number = models.CharField(max_length=10)
     bill_through_organization = models.BooleanField()
-    tax_id = models.CharField()
-    tax_id_type = models.CharField(choices=TaxIDType.choices)
-    billing_location_name = models.CharField()
-    group_npi_number = models.CharField()
-    taxonomy_number = models.CharField()
+    tax_id = models.CharField(max_length=25)
+    tax_id_type = models.CharField(choices=TaxIDType.choices, max_length=1)
+    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()
 
     def __str__(self) -> str:
         return self.full_name
 
 
-class PracticeLocationSetting(models.Model):
+class PracticeLocationSetting(Model):
     """PracticeLocationSetting."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_practicelocationsetting_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
     practice_location = models.ForeignKey(
         "v1.PracticeLocation", on_delete=models.DO_NOTHING, related_name="settings", null=True
     )
-    name = models.CharField()
+    name = models.CharField(max_length=100)
     value = models.JSONField()
 
     def __str__(self) -> str:

canvas_sdk/v1/data/protocol_override.py

@@ -7,6 +7,7 @@ from canvas_sdk.v1.data.base import (
     BaseQuerySet,
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
+    IdentifiableModel,
 )
 
 
@@ -34,19 +35,16 @@ class ProtocolOverrideQuerySet(BaseQuerySet, ForPatientQuerySetMixin, Committabl
 ProtocolOverrideManager = BaseModelManager.from_queryset(ProtocolOverrideQuerySet)
 
 
-class ProtocolOverride(models.Model):
+class ProtocolOverride(IdentifiableModel):
     """ProtocolOverride."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_protocoloverride_001"
 
     objects = cast(ProtocolOverrideQuerySet, ProtocolOverrideManager())
 
-    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)
     deleted = models.BooleanField()
     committer = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
@@ -57,7 +55,7 @@ class ProtocolOverride(models.Model):
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="protocol_overrides", null=True
     )
-    protocol_key = models.CharField()
+    protocol_key = models.CharField(max_length=250)
     is_adjustment = models.BooleanField()
     reference_date = models.DateTimeField()
     cycle_in_days = models.IntegerField()
@@ -66,11 +64,11 @@ class ProtocolOverride(models.Model):
     snoozed_days = models.IntegerField()
     # reason_id = models.BigIntegerField()
     snooze_comment = models.TextField()
-    narrative = models.CharField()
+    narrative = models.CharField(max_length=512)
     # note_id = models.BigIntegerField()
     cycle_quantity = models.IntegerField()
-    cycle_unit = models.CharField(choices=IntervalUnit.choices)
-    status = models.CharField(choices=Status.choices)
+    cycle_unit = models.CharField(choices=IntervalUnit.choices, max_length=20)
+    status = models.CharField(choices=Status.choices, max_length=20)
 
 
 __exports__ = (