canvas 0.42.0__py3-none-any.whl → 0.43.0__py3-none-any.whl

canvas_sdk/v1/data/invoice.py

@@ -0,0 +1,62 @@
+from django.db import models
+
+
+class InvoiceRecipients(models.TextChoices):
+    """Choices for invoice recipients."""
+
+    PATIENT = "patient", "Patient"
+    GUARANTOR = "guarantor", "Guarantor"
+
+
+class InvoiceStatus(models.TextChoices):
+    """Choices for invoice status."""
+
+    ACTIVE = "active", "Active"
+    ERROR = "error", "Error"
+    ARCHIVED = "archived", "Archived"
+
+
+class InvoiceWorkflow(models.TextChoices):
+    """Choices for invoice workflow."""
+
+    AUTOMATED = "automated", "Automated"
+    ADHOC = "adhoc", "Adhoc"
+    BATCH = "batch", "Batch"
+
+
+class InvoiceSentMeans(models.TextChoices):
+    """Choices for how the invoice was sent."""
+
+    MAIL = "mail", "Mail"
+    EMAIL = "e-mail", "E-mail"
+
+
+class Invoice(models.Model):
+    """Represents a full invoice for a patient."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_quality_and_revenue_invoicefull_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    originator = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.PROTECT, related_name="generated_invoices"
+    )
+    recipient = models.ForeignKey("v1.Patient", on_delete=models.CASCADE, related_name="invoices")
+    recipient_type = models.CharField(max_length=10, choices=InvoiceRecipients.choices)
+    total_amount = models.DecimalField(max_digits=8, decimal_places=2)
+    # invoice_pdf = models.FileField(blank=True, null=True, upload_to=invoice_upload)
+    status = models.CharField(max_length=10, choices=InvoiceStatus.choices)
+    workflow = models.CharField(max_length=10, choices=InvoiceWorkflow.choices)
+    # claims = models.ManyToManyField("v1.Claim", related_name="full_invoices")
+    error_message = models.TextField()
+    sent_mean = models.CharField(max_length=6, choices=InvoiceSentMeans.choices)
+
+
+__exports__ = (
+    "Invoice",
+    "InvoiceRecipients",
+    "InvoiceStatus",
+    "InvoiceWorkflow",
+    "InvoiceSentMeans",
+)

canvas_sdk/v1/data/lab.py

@@ -61,9 +61,15 @@ class LabReport(models.Model):
     original_date = models.DateTimeField()
     date_performed = models.DateTimeField()
     custom_document_name = models.CharField()
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=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()
 
 
@@ -89,10 +95,16 @@ class LabReview(models.Model):
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    originator = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
     deleted = models.BooleanField()
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    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="+"
+    )
     internal_comment = models.TextField()
     message_to_patient = models.CharField()
     status = models.CharField()
@@ -194,10 +206,16 @@ class LabOrder(models.Model):
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    originator = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
     deleted = models.BooleanField()
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    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="+"
+    )
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="lab_orders", null=True
     )
@@ -240,10 +258,16 @@ class LabOrderReason(models.Model):
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    originator = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
     deleted = models.BooleanField()
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    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="+"
+    )
     order = models.ForeignKey(
         LabOrder, on_delete=models.DO_NOTHING, related_name="reasons", null=True
     )

canvas_sdk/v1/data/line_item_transaction.py

@@ -0,0 +1,83 @@
+from django.db import models
+from django.db.models import QuerySet
+
+
+class AbstractLineItemQuerySet(models.QuerySet):
+    """AbstractLineItemQuerySet."""
+
+    def active(self) -> QuerySet:
+        """Filter out line items that have been entered in error."""
+        return self.filter(entered_in_error__isnull=True)
+
+
+class AbstractLineItemTransaction(models.Model):
+    """Abstract class with common properties for both payments and adjustments."""
+
+    class Meta:
+        abstract = True
+
+    objects = AbstractLineItemQuerySet.as_manager()
+
+    dbid = models.BigIntegerField(primary_key=True)
+    posting = models.ForeignKey(
+        "v1.BasePosting", related_name="%(class)ss", on_delete=models.PROTECT
+    )
+    billing_line_item = models.ForeignKey(
+        "v1.BillingLineItem", related_name="%(class)ss", on_delete=models.PROTECT
+    )
+    amount = models.DecimalField(max_digits=8, decimal_places=2)
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+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)
+
+
+class AbstractLineItemAdjustment(AbstractLineItemTransaction):
+    """Abstract subclass with common fields for both adjustment and transfer."""
+
+    class Meta:
+        abstract = True
+
+    code = models.CharField()
+    group = models.CharField()
+
+    deviated_from_posting_ruleset = models.BooleanField()
+
+
+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()
+
+
+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(
+        "v1.ClaimCoverage", related_name="transfers", on_delete=models.PROTECT, null=True
+    )
+    transfer_to_patient = models.BooleanField(default=False)
+
+
+__exports__ = (
+    "NewLineItemPayment",
+    "NewLineItemAdjustment",
+    "LineItemTransfer",
+)

canvas_sdk/v1/data/medication.py

@@ -44,8 +44,12 @@ class Medication(models.Model):
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="medications", null=True
     )
     deleted = models.BooleanField()
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    entered_in_error = 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="+"
+    )
     status = models.CharField(choices=Status.choices)
     start_date = models.DateTimeField()
     end_date = models.DateTimeField()

canvas_sdk/v1/data/observation.py

@@ -34,9 +34,15 @@ class Observation(models.Model):
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=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

canvas_sdk/v1/data/organization.py

@@ -25,7 +25,9 @@ class Organization(models.Model):
     group_npi_number = models.CharField()
     group_taxonomy_number = models.CharField()
     include_zz_qualifier = models.BooleanField()
-    main_location = models.OneToOneField("v1.PracticeLocation", on_delete=models.DO_NOTHING)
+    main_location = models.OneToOneField(
+        "v1.PracticeLocation", on_delete=models.DO_NOTHING, related_name="+"
+    )
 
 
 __exports__ = ("Organization",)

canvas_sdk/v1/data/payment_collection.py

@@ -0,0 +1,35 @@
+from django.db import models
+
+
+class PostingMethods(models.TextChoices):
+    """PostingMethods."""
+
+    CASH = "cash", "Cash"
+    CHECK = "check", "Check"
+    CARD = "card", "Card"
+    OTHER = "other", "Other"
+
+
+class PaymentCollection(models.Model):
+    """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)
+
+    check_number = models.CharField()
+    check_date = models.DateField()
+    deposit_date = models.DateField()
+
+    description = models.TextField()
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+__exports__ = ("PaymentCollection", "PostingMethods")

canvas_sdk/v1/data/posting.py

@@ -0,0 +1,225 @@
+from decimal import Decimal
+from typing import Self
+
+from django.db import models
+
+from canvas_sdk.v1.data.utils import quantize
+
+
+class PostingQuerySet(models.QuerySet):
+    """A queryset for CoveragePosting objects."""
+
+    def active(self) -> Self:
+        """Return a queryset that filters for active postings."""
+        return self.filter(entered_in_error__isnull=True)
+
+
+class BasePosting(models.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
+    )
+
+    claim = models.ForeignKey("v1.Claim", related_name="postings", on_delete=models.PROTECT)
+    payment_collection = models.ForeignKey(
+        "v1.PaymentCollection", related_name="postings", null=True, on_delete=models.PROTECT
+    )
+
+    description = models.TextField(default="")
+
+    entered_in_error = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.PROTECT, null=True, blank=True
+    )
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+    @property
+    def paid_amount(self) -> Decimal:
+        """Returns the total amount paid for this posting."""
+        return quantize(sum(lip.amount for lip in self.newlineitempayments.all()))
+
+    @property
+    def contractual_adjusted_amount(self) -> Decimal:
+        """Returns the total amount of contractual adjustments for this posting."""
+        return quantize(
+            sum(lia.amount for lia in self.newlineitemadjustments.all() if lia.write_off)
+        )
+
+    @property
+    def non_write_off_adjusted_amount(self) -> Decimal | int:
+        """Returns the total amount of non-write-off adjustments for this posting."""
+        return sum(lia.amount for lia in self.newlineitemadjustments.all() if not lia.write_off)
+
+    @property
+    def transferred_amount(self) -> Decimal:
+        """Returns the total amount transferred for this posting."""
+        return quantize(sum(lit.amount for lit in self.lineitemtransfers.all()))
+
+    @property
+    def transferred_to_patient_amount(self) -> Decimal | int:
+        """Returns the total amount transferred to the patient."""
+        transfers = [trans for trans in self.lineitemtransfers.all() if trans.transfer_to_patient]
+        return sum(lit.amount for lit in transfers)
+
+    @property
+    def transferred_to_coverage_amount(self) -> Decimal | int:
+        """Returns the total amount transferred to another coverage."""
+        transfers = [trans for trans in self.lineitemtransfers.all() if trans.transfer_to]
+        return sum(lit.amount for lit in transfers)
+
+    @property
+    def adjusted_and_transferred_amount(self) -> Decimal:
+        """Returns the charges amount per claim for a patient posting."""
+        return self.contractual_adjusted_amount + self.transferred_amount
+
+    @property
+    def posted_amount(self) -> Decimal:
+        """Property to compute how much was posted with this posting: sums all payments and write-off adjustments."""
+        return self.paid_amount + self.contractual_adjusted_amount + self.transferred_amount
+
+
+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(
+        "v1.BaseRemittanceAdvice", related_name="postings", on_delete=models.PROTECT, null=True
+    )
+    claim_coverage = models.ForeignKey(
+        "v1.ClaimCoverage", related_name="postings", on_delete=models.PROTECT
+    )
+
+    crossover_carrier = models.CharField()
+    crossover_id = models.CharField()
+    payer_icn = models.CharField()
+    position_in_era = models.PositiveIntegerField()
+
+
+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(
+        "v1.ClaimPatient", related_name="postings", on_delete=models.PROTECT
+    )
+    patient_payment = models.ForeignKey(
+        "v1.BulkPatientPosting", related_name="postings", on_delete=models.PROTECT, null=True
+    )
+
+    copay = models.ForeignKey(
+        "v1.BulkPatientPosting", related_name="copays", on_delete=models.PROTECT, null=True
+    )
+
+    @property
+    def discounted_amount(self) -> Decimal:
+        """Returns the discounted amount per claim for a patient bulk posting."""
+        if not self.patient_payment or not self.patient_payment.discount:
+            return Decimal("0")
+
+        discount = self.patient_payment.discount
+        return quantize(
+            sum(
+                lia.amount
+                for lia in self.newlineitemadjustments.all()
+                if (
+                    lia.write_off
+                    and (lia.group, lia.code)
+                    == (discount.adjustment_group, discount.adjustment_code)
+                )
+            )
+        )
+
+    @property
+    def charges_amount(self) -> Decimal:
+        """Returns the charges amount per claim for a patient posting."""
+        return self.discounted_amount + self.paid_amount
+
+
+class AbstractBulkPosting(models.Model):
+    """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()
+
+
+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(
+        "v1.Discount", related_name="patient_postings", null=True, on_delete=models.SET_NULL
+    )
+    payer = models.ForeignKey("v1.Patient", related_name="payments", on_delete=models.PROTECT)
+
+    @property
+    def total_posted_amount(self) -> Decimal:
+        """Property to compute how much was posted with all associated postings."""
+        postings = self.postings.active()
+        return quantize(sum(posting.posted_amount for posting in postings))
+
+    @property
+    def discounted_amount(self) -> Decimal:
+        """Returns the sum of discounted amounts for every posting created with this collection."""
+        postings = self.postings.active()
+        return quantize(sum(posting.discounted_amount for posting in postings))
+
+
+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(
+        "v1.Transactor", related_name="remits", null=True, on_delete=models.PROTECT
+    )
+
+    era_id = models.CharField(max_length=255, null=True, blank=True, db_index=True)
+
+    @property
+    def total_posted_amount(self) -> Decimal:
+        """Property to compute how much was posted with all associated postings."""
+        postings = self.postings.active()
+        return quantize(sum(posting.posted_amount for posting in postings))
+
+
+__exports__ = (
+    "BasePosting",
+    "CoveragePosting",
+    "PatientPosting",
+    "BulkPatientPosting",
+    "BaseRemittanceAdvice",
+)

canvas_sdk/v1/data/protocol_override.py

@@ -48,8 +48,12 @@ class ProtocolOverride(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     deleted = models.BooleanField()
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    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="+"
+    )
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="protocol_overrides", null=True
     )

canvas_sdk/v1/data/questionnaire.py

@@ -148,8 +148,12 @@ class Interview(models.Model):
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
     deleted = models.BooleanField()
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    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="+"
+    )
     status = models.CharField()
     name = models.CharField()
     language_id = models.BigIntegerField()

canvas_sdk/v1/data/utils.py

@@ -0,0 +1,10 @@
+from collections.abc import Sequence
+from decimal import Decimal
+
+
+def quantize(deci: Decimal | float | str | tuple[int, Sequence[int], int]) -> Decimal:
+    """Rounds a Decimal value to two decimal places."""
+    return Decimal(deci).quantize(Decimal(".01"))
+
+
+__exports__ = ()

protobufs/canvas_generated/messages/effects.proto

@@ -281,6 +281,7 @@ enum EffectType {
 
   PATIENT_METADATA__CREATE_ADDITIONAL_FIELDS = 6010;
   UPSERT_PATIENT_METADATA = 6011;
+  CREATE_PATIENT_EXTERNAL_IDENTIFIER = 6012;
 }
 
 message Effect {