canvas 0.63.0__py3-none-any.whl → 0.89.0__py3-none-any.whl

canvas_sdk/v1/data/coverage.py

@@ -1,7 +1,9 @@
+from datetime import date
+
 from django.contrib.postgres.fields import ArrayField
 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 (
     AddressState,
     AddressType,
@@ -12,6 +14,16 @@ from canvas_sdk.v1.data.common import (
 )
 
 
+class CoverageRank(models.IntegerChoices):
+    """CoverageRank."""
+
+    PRIMARY = 1, "Primary"
+    SECONDARY = 2, "Secondary"
+    TERTIARY = 3, "Tertiary"
+    QUATERNARY = 4, "Quaternary"
+    QUINARY = 5, "Quinary"
+
+
 class CoverageStack(models.TextChoices):
     """CoverageStack."""
 
@@ -145,14 +157,12 @@ class TransactorType(models.TextChoices):
     BCBS = "bcbs", "Blue Cross Blue Shield"
 
 
-class Coverage(IdentifiableModel):
+class Coverage(TimestampedModel, IdentifiableModel):
     """Coverage."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_coverage_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="coverages", null=True
     )
@@ -163,34 +173,54 @@ class Coverage(IdentifiableModel):
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="subscribed_coverages", null=True
     )
     patient_relationship_to_subscriber = models.CharField(
-        choices=CoverageRelationshipCode.choices, max_length=2
+        choices=CoverageRelationshipCode.choices,
+        max_length=2,
+        default=CoverageRelationshipCode.SELF,
     )
     issuer = models.ForeignKey(
         "v1.Transactor", on_delete=models.DO_NOTHING, related_name="coverages", null=True
     )
-    id_number = models.CharField(max_length=100)
-    plan = models.CharField(max_length=255)
-    sub_plan = models.CharField(max_length=255)
-    group = models.CharField(max_length=255)
-    sub_group = models.CharField(max_length=255)
-    employer = models.CharField(max_length=255)
-    coverage_start_date = models.DateField()
-    coverage_end_date = models.DateField()
-    coverage_rank = models.IntegerField()
-    state = models.CharField(choices=CoverageState.choices, max_length=20)
-    plan_type = models.CharField(choices=CoverageType.choices, max_length=20)
-    coverage_type = models.CharField(choices=TransactorCoverageType.choices, max_length=64)
+    id_number = models.CharField(max_length=100, blank=True, default="")
+    plan = models.CharField(max_length=255, blank=True, default="")
+    sub_plan = models.CharField(max_length=255, blank=True, default="")
+    group = models.CharField(max_length=255, default="", blank=True)
+    sub_group = models.CharField(max_length=255, default="", blank=True)
+    employer = models.CharField(max_length=255, default="", blank=True)
+    coverage_start_date = models.DateField(default=date.today)
+    coverage_end_date = models.DateField(null=True)
+    coverage_rank = models.IntegerField(choices=CoverageRank.choices, default=CoverageRank.PRIMARY)
+    state = models.CharField(
+        choices=CoverageState.choices, max_length=20, default=CoverageState.ACTIVE
+    )
+    plan_type = models.CharField(
+        choices=CoverageType.choices, max_length=20, default=CoverageType.COMMERCIAL
+    )
+    coverage_type = models.CharField(
+        choices=TransactorCoverageType.choices, max_length=64, null=True, blank=True
+    )
     issuer_address = models.ForeignKey(
         "v1.TransactorAddress",
         on_delete=models.DO_NOTHING,
         related_name="coverages",
         null=True,
+        blank=True,
     )
     issuer_phone = models.ForeignKey(
-        "v1.TransactorPhone", on_delete=models.DO_NOTHING, related_name="coverages", null=True
+        "v1.TransactorPhone",
+        on_delete=models.DO_NOTHING,
+        related_name="coverages",
+        null=True,
+        blank=True,
+    )
+    comments = models.TextField(default="", blank=True)
+    stack = models.CharField(
+        choices=CoverageStack.choices,
+        default=CoverageStack.IN_USE,
+        max_length=8,
+        db_index=True,
     )
-    comments = models.TextField()
-    stack = models.CharField(choices=CoverageStack.choices, max_length=8)
+    comments = models.TextField(default="", blank=True)
+    subscriber_identifier = models.CharField(max_length=100, blank=True, default="")
 
     def __str__(self) -> str:
         return f"id={self.id}"
@@ -236,14 +266,12 @@ class Transactor(Model):
     )
 
 
-class TransactorAddress(IdentifiableModel):
+class TransactorAddress(TimestampedModel, IdentifiableModel):
     """TransactorAddress."""
 
     class Meta:
         db_table = "canvas_sdk_data_quality_and_revenue_transactoraddress_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     line1 = models.CharField(max_length=255)
     line2 = models.CharField(max_length=255)
     city = models.CharField(max_length=255)
@@ -266,14 +294,12 @@ class TransactorAddress(IdentifiableModel):
         return f"id={self.id}"
 
 
-class TransactorPhone(IdentifiableModel):
+class TransactorPhone(TimestampedModel, IdentifiableModel):
     """TransactorPhone."""
 
     class Meta:
         db_table = "canvas_sdk_data_quality_and_revenue_transactorphone_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     system = models.CharField(choices=ContactPointSystem.choices, max_length=20)
     value = models.CharField(max_length=100)
     use = models.CharField(choices=ContactPointUse.choices, max_length=20)
@@ -288,11 +314,25 @@ class TransactorPhone(IdentifiableModel):
         return f"id={self.id}"
 
 
+class EligibilitySummary(TimestampedModel, IdentifiableModel):
+    """EligibilitySummary."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_quality_and_revenue_eligibilitysummary_001"
+
+    coverage = models.OneToOneField(
+        "v1.Coverage", on_delete=models.CASCADE, related_name="eligibility_summary"
+    )
+    copay_cents = models.IntegerField(null=True)
+    coinsurance = models.IntegerField(null=True)
+
+
 __exports__ = (
     "CoverageStack",
     "CoverageState",
     "CoverageType",
     "CoverageRelationshipCode",
+    "EligibilitySummary",
     "TransactorCoverageType",
     "TransactorType",
     "Coverage",

canvas_sdk/v1/data/detected_issue.py

@@ -1,50 +1,50 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import AuditedModel, IdentifiableModel
+from canvas_sdk.v1.data.coding import Coding
 
 
-class DetectedIssue(IdentifiableModel):
+class DetectedIssue(AuditedModel, IdentifiableModel):
     """DetectedIssue."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_detectedissue_001"
 
+    class Status(models.TextChoices):
+        REGISTERED = "registered", "Registered"
+        PRELIMINARY = "preliminary", "Preliminary"
+        CANCELLED = "cancelled", "Cancelled"
+        AMENDED = "amended", "Amended"
+        FINAL = "final", "Final"
+        CORRECTED = "corrected", "Corrected"
+        ENTERED_IN_ERROR = "entered-in-error", "Entered in Error"
+
+    class Severity(models.TextChoices):
+        HIGH = "high", "High"
+        MODERATE = "moderate", "Moderate"
+        LOW = "low", "Low"
+
     created = models.DateTimeField(auto_now_add=True)
     modified = models.DateTimeField(auto_now=True)
     identified = models.DateTimeField()
-    deleted = models.BooleanField()
-    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
     )
     code = models.CharField(max_length=20)
-    status = models.CharField(max_length=16)
-    severity = models.CharField(max_length=10)
+    status = models.CharField(max_length=16, choices=Status.choices)
+    severity = models.CharField(max_length=10, choices=Severity.choices, blank=True, default="")
     reference = models.CharField(max_length=200)
     issue_identifier = models.CharField(max_length=255)
     issue_identifier_system = models.CharField(max_length=255)
     detail = models.TextField()
 
 
-class DetectedIssueEvidence(IdentifiableModel):
+class DetectedIssueEvidence(IdentifiableModel, Coding):
     """DetectedIssueEvidence."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_detectedissueevidence_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()
     detected_issue = models.ForeignKey(
         DetectedIssue,
         on_delete=models.DO_NOTHING,

canvas_sdk/v1/data/device.py

@@ -1,30 +1,18 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import AuditedModel, IdentifiableModel
 
 
-class Device(IdentifiableModel):
+class Device(AuditedModel, IdentifiableModel):
     """Device."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_device_001"
 
-    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="+"
-    )
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="devices", null=True
     )
     note_id = models.BigIntegerField()
-    deleted = models.BooleanField()
     labeled_contains_NRL = models.BooleanField()
     assigning_authority = models.CharField(max_length=255)
     scoping_entity = models.CharField(max_length=255)

canvas_sdk/v1/data/discount.py

@@ -1,9 +1,9 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import Model
+from canvas_sdk.v1.data.base import TimestampedModel
 
 
-class Discount(Model):
+class Discount(TimestampedModel):
     """Model to represent a discount applied to a claim or patient posting."""
 
     class Meta:
@@ -14,8 +14,5 @@ class Discount(Model):
     adjustment_code = models.CharField(max_length=3)
     discount = models.DecimalField(max_digits=8, decimal_places=2)
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
-
 
 __exports__ = ("Discount",)

canvas_sdk/v1/data/encounter.py

@@ -0,0 +1,44 @@
+from django.db import models
+from django.utils import timezone
+
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
+
+
+class EncounterMedium(models.TextChoices):
+    """Encounter medium."""
+
+    VOICE = "voice", "Telephone visit"
+    VIDEO = "video", "Video visit"
+    OFFICE = "office", "Office visit"
+    HOME = "home", "Home visit"
+    OFFSITE = "offsite", "Other offsite visit"
+    LAB = "lab", "Lab visit"
+
+
+class EncounterState(models.TextChoices):
+    """Encounter state."""
+
+    STARTED = "STA", "Started"
+    PLANNED = "PLA", "Planned"
+    CONCLUDED = "CON", "Concluded"
+    CANCELLED = "CAN", "Cancelled"
+
+
+class Encounter(TimestampedModel, IdentifiableModel):
+    """Encounter."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_encounter_001"
+
+    note = models.OneToOneField("v1.Note", on_delete=models.CASCADE, related_name="encounter")
+    medium = models.CharField(choices=EncounterMedium.choices, max_length=20)
+    state = models.CharField(max_length=3, choices=EncounterState.choices)
+    start_time = models.DateTimeField(default=timezone.now, null=True)
+    end_time = models.DateTimeField(default=None, null=True)
+
+
+__exports__ = (
+    "Encounter",
+    "EncounterMedium",
+    "EncounterState",
+)

canvas_sdk/v1/data/facility.py

@@ -12,6 +12,7 @@ class Facility(IdentifiableModel):
     name = models.CharField(max_length=255)
     npi_number = models.CharField(verbose_name="NPI number", max_length=10, blank=True)
     phone_number = models.CharField(max_length=10, blank=True, default="")
+    fax_number = models.CharField(max_length=10, blank=True, default="")
     active = models.BooleanField(default=True)
     line1 = models.CharField(max_length=255, default="", blank=True)
     line2 = models.CharField(max_length=255, default="", blank=True)

canvas_sdk/v1/data/goal.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 AuditedModel, IdentifiableModel
 
 
 class GoalLifecycleStatus(models.TextChoices):
@@ -38,24 +38,12 @@ class GoalPriority(models.TextChoices):
     LOW = "low-priority", "Low Priority"
 
 
-class Goal(IdentifiableModel):
+class Goal(AuditedModel, IdentifiableModel):
     """Goal."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_goal_001"
 
-    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="+"
-    )
-
     patient = models.ForeignKey("v1.Patient", on_delete=models.DO_NOTHING, related_name="goals")
     note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="goals")
     lifecycle_status = models.CharField(max_length=20, choices=GoalLifecycleStatus.choices)

canvas_sdk/v1/data/imaging.py

@@ -2,7 +2,7 @@ import json
 
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import AuditedModel, IdentifiableModel, TimestampedModel
 from canvas_sdk.v1.data.common import (
     DocumentReviewMode,
     OrderStatus,
@@ -12,24 +12,12 @@ from canvas_sdk.v1.data.common import (
 from canvas_sdk.v1.data.task import Task
 
 
-class ImagingOrder(IdentifiableModel):
+class ImagingOrder(AuditedModel, IdentifiableModel):
     """Model to read ImagingOrder data."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_imagingorder_001"
 
-    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="+"
-    )
-    deleted = models.BooleanField()
-    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
     )
@@ -67,24 +55,12 @@ class ImagingOrder(IdentifiableModel):
         return list(self.get_task_objects())
 
 
-class ImagingReview(IdentifiableModel):
+class ImagingReview(AuditedModel, IdentifiableModel):
     """Model to read ImagingReview data."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_imagingreview_001"
 
-    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="+"
-    )
-    deleted = models.BooleanField()
-    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.choices, max_length=30
     )
@@ -99,7 +75,7 @@ class ImagingReview(IdentifiableModel):
     )
 
 
-class ImagingReport(IdentifiableModel):
+class ImagingReport(TimestampedModel, IdentifiableModel):
     """Model to read ImagingReport data."""
 
     class ImagingReportSource(models.TextChoices):
@@ -110,8 +86,6 @@ class ImagingReport(IdentifiableModel):
     class Meta:
         db_table = "canvas_sdk_data_api_imagingreport_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     review_mode = models.CharField(choices=DocumentReviewMode.choices, max_length=2)
     junked = models.BooleanField()
     requires_signature = models.BooleanField()

canvas_sdk/v1/data/immunization.py

@@ -7,9 +7,9 @@ from canvas_sdk.v1.data.base import (
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
     IdentifiableModel,
-    Model,
     ValueSetLookupQuerySet,
 )
+from canvas_sdk.v1.data.coding import Coding
 
 
 class ImmunizationStatus(models.TextChoices):
@@ -32,7 +32,9 @@ class ImmunizationReasonsNotGiven(models.TextChoices):
 
 
 class ImmunizationQuerySet(
-    ValueSetLookupQuerySet, CommittableQuerySetMixin, ForPatientQuerySetMixin
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
+    ValueSetLookupQuerySet,
 ):
     """ImmunizationQuerySet."""
 
@@ -78,24 +80,19 @@ class Immunization(IdentifiableModel):
     deleted = models.BooleanField()
 
 
-class ImmunizationCoding(Model):
+class ImmunizationCoding(Coding):
     """ImmunizationCoding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_immunizationcoding_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()
     immunization = models.ForeignKey(
         Immunization, on_delete=models.DO_NOTHING, related_name="codings", null=True
     )
 
 
 class ImmunizationStatementQuerySet(
-    ValueSetLookupQuerySet, CommittableQuerySetMixin, ForPatientQuerySetMixin
+    CommittableQuerySetMixin, ForPatientQuerySetMixin, ValueSetLookupQuerySet
 ):
     """ImmunizationStatementQuerySet."""
 
@@ -133,17 +130,12 @@ class ImmunizationStatement(IdentifiableModel):
     deleted = models.BooleanField()
 
 
-class ImmunizationStatementCoding(Model):
+class ImmunizationStatementCoding(Coding):
     """ImmunizationStatementCoding."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_immunizationstatementcoding_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()
     immunization_statement = models.ForeignKey(
         ImmunizationStatement, on_delete=models.CASCADE, related_name="coding"
     )