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

canvas_sdk/v1/data/claim_line_item.py

@@ -0,0 +1,140 @@
+from decimal import Decimal
+from typing import Any, Self
+
+from django.db import models
+from django.db.models import Q, Sum
+from django.db.models.functions import Coalesce
+
+from canvas_sdk.v1.data.note import PracticeLocationPOS
+
+
+class ClaimLineItemStatus(models.TextChoices):
+    """ClaimLineItemStatus."""
+
+    ACTIVE = "active", "Active"
+    REMOVED = "removed", "Removed"
+
+
+class LineItemCodes(models.TextChoices):
+    """LineItemCodes."""
+
+    COPAY = "COPAY"
+    UNLINKED = "UNLINKED"
+
+
+class FamilyPlanningOptions(models.TextChoices):
+    """FamilyPlanningOptions."""
+
+    YES = ("Y", "Yes")
+    NO = ("N", "No")
+
+
+class ClaimLineItemQuerySet(models.QuerySet):
+    """ClaimLineItemQuerySet."""
+
+    def filter(self, *args: Any, **kwargs: Any) -> Self:
+        """Apply standard filtering to the QuerySet."""
+        return super().filter(*args, **kwargs)
+
+    def exclude(self, *args: Any, **kwargs: Any) -> Self:
+        """Apply standard exclusion to the QuerySet."""
+        return super().exclude(*args, **kwargs)
+
+    def apply_ordering(self) -> Self:
+        """Apply ordering to the QuerySet."""
+        return self.order_by("from_date", "-proc_code")
+
+    def active(self) -> Self:
+        """Return only active claim line items."""
+        return self.exclude(status=ClaimLineItemStatus.REMOVED).apply_ordering()
+
+    def exclude_removed_line_item_without_active_posting(self) -> Self:
+        """Exclude out any line items that are deleted without any active postings."""
+        return (
+            self.filter(
+                Q(status=ClaimLineItemStatus.ACTIVE)
+                | Q(
+                    newlineitempayments__isnull=False,
+                    newlineitempayments__entered_in_error__isnull=True,
+                )
+                | Q(
+                    newlineitemadjustments__isnull=False,
+                    newlineitemadjustments__entered_in_error__isnull=True,
+                )
+                | Q(
+                    lineitemtransfers__isnull=False,
+                    lineitemtransfers__entered_in_error__isnull=True,
+                )
+            )
+            .exclude_removed_line_items_without_balances()
+            .apply_ordering()
+            .distinct()
+        )
+
+    def exclude_removed_line_items_without_balances(self) -> Self:
+        """Exclude removed line items with zero balances."""
+        return (
+            self.annotate(
+                sum_of_all_payments=Coalesce(Sum("newlineitempayments__amount"), Decimal(0)),
+                sum_of_all_adjustments=Coalesce(Sum("newlineitemadjustments__amount"), Decimal(0)),
+                sum_of_all_transfers=Coalesce(Sum("lineitemtransfers__amount"), Decimal(0)),
+            )
+            .exclude(
+                Q(
+                    status=ClaimLineItemStatus.REMOVED,
+                    sum_of_all_payments=0,
+                    sum_of_all_adjustments=0,
+                    sum_of_all_transfers=0,
+                )
+            )
+            .distinct()
+        )
+
+    def exclude_copay_and_unlinked(self) -> Self:
+        """Exclude both co-pay and unlinked line items."""
+        return self.exclude(
+            proc_code__in=[LineItemCodes.UNLINKED.value, LineItemCodes.COPAY.value]
+        ).apply_ordering()
+
+    def exclude_copay(self) -> Self:
+        """Exclude only co-pay line items."""
+        return self.exclude(proc_code=LineItemCodes.COPAY.value).apply_ordering()
+
+    def exclude_unlinked(self) -> Self:
+        """Exclude only unlinked line items."""
+        return self.exclude(proc_code=LineItemCodes.UNLINKED.value).apply_ordering()
+
+
+class ClaimLineItem(models.Model):
+    """ClaimLineItem."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_quality_and_revenue_claimlineitem_001"
+
+    objects = ClaimLineItemQuerySet.as_manager()
+
+    dbid = models.BigIntegerField(primary_key=True)
+    billing_line_item = models.ForeignKey("v1.BillingLineItem", on_delete=models.CASCADE, null=True)
+    claim = models.ForeignKey("v1.Claim", on_delete=models.CASCADE, related_name="line_items")
+    status = models.CharField(choices=ClaimLineItemStatus.choices)
+    charge = models.DecimalField(max_digits=8, decimal_places=2)
+    from_date = models.CharField()
+    thru_date = models.CharField()
+    narrative = models.CharField()
+    ndc_code = models.CharField()
+    ndc_dosage = models.CharField()
+    ndc_measure = models.CharField()
+    place_of_service = models.CharField(choices=PracticeLocationPOS.choices)
+    proc_code = models.CharField()
+    display = models.CharField()
+    remote_chg_id = models.CharField()
+    units = models.IntegerField()
+    epsdt = models.CharField()
+    family_planning = models.CharField(choices=FamilyPlanningOptions.choices)
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+__exports__ = ("ClaimLineItem", "ClaimLineItemStatus", "LineItemCodes", "FamilyPlanningOptions")

canvas_sdk/v1/data/command.py

@@ -13,9 +13,18 @@ class Command(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="commands_originated"
+    )
+    committer = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="commands_committed"
+    )
+    entered_in_error = models.ForeignKey(
+        "v1.CanvasUser",
+        on_delete=models.DO_NOTHING,
+        null=True,
+        related_name="commands_entered_in_error",
+    )
     state = models.CharField()
     patient = models.ForeignKey("v1.Patient", on_delete=models.DO_NOTHING, null=True)
     note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="commands")

canvas_sdk/v1/data/condition.py

@@ -50,14 +50,19 @@ class Condition(models.Model):
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=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="+"
+    )
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="conditions", null=True
     )
     onset_date = models.DateField()
     resolution_date = models.DateField()
     clinical_status = models.CharField(choices=ClinicalStatus.choices)
+    surgical = models.BooleanField()
 
 
 class ConditionCoding(models.Model):

canvas_sdk/v1/data/detected_issue.py

@@ -14,9 +14,15 @@ class DetectedIssue(models.Model):
     modified = models.DateTimeField()
     identified = models.DateTimeField()
     deleted = models.BooleanField()
-    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="+"
+    )
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="detected_issues", null=True
     )

canvas_sdk/v1/data/device.py

@@ -12,9 +12,15 @@ class Device(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="+"
+    )
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="devices", null=True
     )

canvas_sdk/v1/data/discount.py

@@ -0,0 +1,21 @@
+from django.db import models
+
+
+class Discount(models.Model):
+    """Model to represent a discount applied to a claim or patient posting."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_quality_and_revenue_discount_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    name = models.CharField()
+    adjustment_group = models.CharField()
+    adjustment_code = models.CharField()
+    discount = models.DecimalField(max_digits=8, decimal_places=2)
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+__exports__ = ("Discount",)

canvas_sdk/v1/data/fields.py

@@ -0,0 +1,37 @@
+from typing import Any, cast
+
+from django import forms
+from django.contrib.postgres.fields import ArrayField
+from django.forms import SelectMultiple
+
+
+class ArraySelectMultiple(SelectMultiple):
+    """ArraySelectMultiple."""
+
+    def value_omitted_from_data(self, data: Any, files: Any, name: str) -> bool:
+        """Override to check if the value is omitted from data."""
+        return False
+
+
+class ChoiceArrayField(ArrayField):
+    """ChoiceArrayField."""
+
+    def formfield(
+        self,
+        form_class: type[forms.Field] | None = None,
+        choices_form_class: type[forms.ChoiceField] | None = None,
+        **kwargs: Any,
+    ) -> forms.Field:
+        """Override formfield to use a custom widget."""
+        defaults = {
+            "form_class": forms.TypedMultipleChoiceField,
+            "choices": self.base_field.choices,
+            "coerce": self.base_field.to_python,
+            "widget": ArraySelectMultiple,
+        }
+        defaults.update(kwargs)
+
+        return cast(forms.Field, super(ArrayField, self).formfield(**defaults))  # type: ignore[arg-type]
+
+
+__exports__ = ()

canvas_sdk/v1/data/imaging.py

@@ -19,10 +19,16 @@ class ImagingOrder(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)
+    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, related_name="+"
+    )
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True
     )
@@ -52,10 +58,16 @@ class ImagingReview(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_communication_method = models.CharField(choices=ReviewPatientCommunicationMethod)
     # TODO  - uncomment when Note model is complete
     # note = models.ForeignKey('v1.Note', on_delete=models.DO_NOTHING, related_name="imaging_reviews", null=True)

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/patient.py

@@ -52,6 +52,9 @@ class Patient(models.Model):
     first_name = models.CharField()
     last_name = models.CharField()
     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()
@@ -129,6 +132,16 @@ class Patient(models.Model):
             return None
         return pharmacy_setting
 
+    @property
+    def preferred_full_name(self) -> str:
+        """Returns the patient's preferred full name, taking nickname into consideration."""
+        return " ".join(n for n in (self.preferred_first_name, self.last_name, self.suffix) if n)
+
+    @property
+    def preferred_first_name(self) -> str:
+        """Returns the patient's preferred first name, taking nickname into consideration."""
+        return self.nickname or self.first_name
+
 
 class PatientContactPoint(models.Model):
     """A class representing a patient contact point."""
@@ -197,7 +210,10 @@ class PatientExternalIdentifier(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     patient = models.ForeignKey(
-        "v1.Patient", related_name="external_identifiers", on_delete=models.DO_NOTHING, null=True
+        "v1.Patient",
+        related_name="external_identifiers",
+        on_delete=models.DO_NOTHING,
+        null=True,
     )
     use = models.CharField()
     identifier_type = models.CharField()