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

canvas_sdk/effects/protocol_card/__init__.py

@@ -1,3 +1,6 @@
 from canvas_sdk.effects.protocol_card.protocol_card import ProtocolCard, Recommendation
 
-__all__ = __exports__ = ("ProtocolCard", "Recommendation")
+__all__ = __exports__ = (
+    "ProtocolCard",
+    "Recommendation",
+)

canvas_sdk/effects/protocol_card/protocol_card.py

@@ -55,6 +55,7 @@ class ProtocolCard(_BaseEffect):
     status: Status = Status.DUE
     feedback_enabled: bool = False
     due_in: int = -1
+    can_be_snoozed: bool = False
 
     @property
     def values(self) -> dict[str, Any]:
@@ -68,6 +69,7 @@ class ProtocolCard(_BaseEffect):
             "status": self.status.value,
             "feedback_enabled": self.feedback_enabled,
             "due_in": self.due_in,
+            "can_be_snoozed": self.can_be_snoozed,
         }
 
     @property

canvas_sdk/utils/http.py

@@ -281,29 +281,73 @@ class OntologiesHttp(JsonOnlyHttp):
     """
 
     def __init__(self) -> None:
-        super().__init__(base_url="https://ontologies.canvasmedical.com")
+        super().__init__(
+            base_url=os.getenv("ONTOLOGIES_ENDPOINT", "https://ontologies.canvasmedical.com")
+        )
 
         self._session.headers.update({"Authorization": os.getenv("PRE_SHARED_KEY", "")})
 
 
+class PharmacyHttp:
+    """
+    An HTTP client for the pharmacy service.
+    """
+
+    def __init__(self) -> None:
+        self._http_client = JsonOnlyHttp(
+            base_url=os.getenv("PHARMACY_ENDPOINT", "https://pharmacy.canvasmedical.com")
+        )
+
+        self._http_client._session.headers.update(
+            {"Authorization": os.getenv("PRE_SHARED_KEY", "")}
+        )
+
+    def search_pharmacies(
+        self, search_term: str, latitude: str | None = None, longitude: str | None = None
+    ) -> list[dict]:
+        """Search for pharmacies by term and optional location."""
+        params = {"search": search_term}
+        if latitude and longitude:
+            params.update(
+                {
+                    "latitude": latitude,
+                    "longitude": longitude,
+                }
+            )
+
+        query_string = urllib.parse.urlencode(params)
+        response = self._http_client.get_json(f"/surescripts/pharmacy/?{query_string}")
+        response_json = response.json()
+        return response_json.get("results", []) if response_json else []
+
+    def get_pharmacy_by_ncpdp_id(self, ncpdp_id: str) -> dict[str, Any] | None:
+        """Lookup a pharmacy by its NCPDP ID."""
+        response = self._http_client.get_json(f"/surescripts/pharmacy/ncpdp_id/{ncpdp_id}/")
+        return response.json()
+
+
 class ScienceHttp(JsonOnlyHttp):
     """
     An HTTP client for the ontologies service.
     """
 
     def __init__(self) -> None:
-        super().__init__(base_url="https://science.canvasmedical.com")
+        super().__init__(
+            base_url=os.getenv("SCIENCE_ENDPOINT", "https://science.canvasmedical.com")
+        )
 
         self._session.headers.update({"Authorization": os.getenv("PRE_SHARED_KEY", "")})
 
 
 ontologies_http = OntologiesHttp()
 science_http = ScienceHttp()
+pharmacy_http = PharmacyHttp()
 
 __all__ = __exports__ = (
     "ThreadPoolExecutor",
     "Http",
     "ontologies_http",
+    "pharmacy_http",
     "science_http",
     "batch_get",
     "batch_post",

canvas_sdk/v1/data/__init__.py

@@ -3,13 +3,18 @@ from .appointment import Appointment, AppointmentExternalIdentifier
 from .assessment import Assessment
 from .banner_alert import BannerAlert
 from .billing import BillingLineItem, BillingLineItemModifier
+from .business_line import BusinessLine
 from .care_team import CareTeamMembership, CareTeamRole
+from .claim import Claim, ClaimCoverage, ClaimPatient, ClaimQueue
+from .claim_line_item import ClaimLineItem
 from .command import Command
 from .condition import Condition, ConditionCoding
 from .coverage import Coverage, Transactor, TransactorAddress, TransactorPhone
 from .detected_issue import DetectedIssue, DetectedIssueEvidence
 from .device import Device
+from .discount import Discount
 from .imaging import ImagingOrder, ImagingReport, ImagingReview
+from .invoice import Invoice
 from .lab import (
     LabOrder,
     LabOrderReason,
@@ -20,6 +25,11 @@ from .lab import (
     LabValue,
     LabValueCoding,
 )
+from .line_item_transaction import (
+    LineItemTransfer,
+    NewLineItemAdjustment,
+    NewLineItemPayment,
+)
 from .medication import Medication, MedicationCoding
 from .message import Message, MessageAttachment, MessageTransmission
 from .note import Note, NoteType
@@ -39,6 +49,20 @@ from .patient import (
     PatientMetadata,
     PatientSetting,
 )
+from .patient_consent import (
+    PatientConsent,
+    PatientConsentCoding,
+    PatientConsentRejectionCoding,
+)
+from .payment_collection import PaymentCollection
+from .payor_specific_charge import PayorSpecificCharge
+from .posting import (
+    BasePosting,
+    BaseRemittanceAdvice,
+    BulkPatientPosting,
+    CoveragePosting,
+    PatientPosting,
+)
 from .practicelocation import PracticeLocation, PracticeLocationSetting
 from .protocol_override import ProtocolOverride
 from .questionnaire import (
@@ -63,24 +87,36 @@ __all__ = __exports__ = (
     "AllergyIntoleranceCoding",
     "Assessment",
     "BannerAlert",
+    "BasePosting",
+    "BaseRemittanceAdvice",
     "BillingLineItem",
     "BillingLineItemModifier",
+    "BusinessLine",
+    "BulkPatientPosting",
     "CanvasUser",
     "CareTeamMembership",
     "CareTeamRole",
+    "Claim",
+    "ClaimCoverage",
+    "ClaimLineItem",
+    "ClaimPatient",
+    "ClaimQueue",
     "Command",
     "Condition",
     "ConditionCoding",
     "Coverage",
+    "CoveragePosting",
     "DetectedIssue",
     "DetectedIssueEvidence",
     "Device",
+    "Discount",
     "ImagingOrder",
     "ImagingReport",
     "ImagingReview",
     "Interview",
     "InterviewQuestionnaireMap",
     "InterviewQuestionResponse",
+    "Invoice",
     "LabOrder",
     "LabOrderReason",
     "LabOrderReasonCondition",
@@ -89,11 +125,14 @@ __all__ = __exports__ = (
     "LabTest",
     "LabValue",
     "LabValueCoding",
+    "LineItemTransfer",
     "Medication",
     "MedicationCoding",
     "Message",
     "MessageAttachment",
     "MessageTransmission",
+    "NewLineItemAdjustment",
+    "NewLineItemPayment",
     "Note",
     "NoteType",
     "Observation",
@@ -106,8 +145,14 @@ __all__ = __exports__ = (
     "PatientAddress",
     "PatientContactPoint",
     "PatientExternalIdentifier",
+    "PatientPosting",
     "PatientSetting",
     "PatientMetadata",
+    "PatientConsent",
+    "PatientConsentCoding",
+    "PatientConsentRejectionCoding",
+    "PayorSpecificCharge",
+    "PaymentCollection",
     "PracticeLocation",
     "PracticeLocationSetting",
     "ProtocolOverride",

canvas_sdk/v1/data/allergy_intolerance.py

@@ -37,8 +37,12 @@ class AllergyIntolerance(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,

canvas_sdk/v1/data/assessment.py

@@ -20,10 +20,14 @@ class Assessment(models.Model):
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING)
-    committer = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
+    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+")
+    committer = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
     deleted = models.BooleanField()
-    entered_in_error = 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="+"
+    )
     patient = models.ForeignKey(
         "v1.Patient",
         on_delete=models.DO_NOTHING,

canvas_sdk/v1/data/billing.py

@@ -56,7 +56,7 @@ class BillingLineItem(models.Model):
         null=True,
     )
     cpt = models.CharField()
-    charge = models.DecimalField()
+    charge = models.DecimalField(decimal_places=2, max_digits=8)
     description = models.CharField()
     units = models.IntegerField()
     command_type = models.CharField()

canvas_sdk/v1/data/business_line.py

@@ -0,0 +1,35 @@
+from django.db import models
+
+
+class BusinessLineState(models.TextChoices):
+    """BusinessLineStatus."""
+
+    STATE_SUCCESS = "success", "Success"
+    STATE_PENDING = "pending", "Pending"
+    STATE_ERROR = "error", "Deleted"
+
+
+class BusinessLine(models.Model):
+    """Business Line."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_businessline_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    name = models.CharField()
+    description = models.TextField()
+    area_code = models.CharField()
+    subdomain = models.CharField()
+    active = models.BooleanField()
+    state = models.CharField(max_length=20, choices=BusinessLineState)
+    organization = models.ForeignKey(
+        "v1.Organization", on_delete=models.DO_NOTHING, related_name="business_lines"
+    )
+
+
+__exports__ = (
+    "BusinessLineState",
+    "BusinessLine",
+)

canvas_sdk/v1/data/claim.py

@@ -0,0 +1,321 @@
+from decimal import Decimal
+from typing import TYPE_CHECKING, Self
+
+from django.db import models
+
+from canvas_sdk.v1.data.common import PersonSex
+from canvas_sdk.v1.data.coverage import CoverageRelationshipCode, CoverageType
+from canvas_sdk.v1.data.fields import ChoiceArrayField
+from canvas_sdk.v1.data.utils import quantize
+
+if TYPE_CHECKING:
+    from canvas_sdk.v1.data.claim_line_item import ClaimLineItemQuerySet
+
+
+class InstallmentPlanStatus(models.TextChoices):
+    """InstallmentPlanStatus."""
+
+    ACTIVE = "active", "Active"
+    COMPLETED = "completed", "Completed"
+    CANCELLED = "cancelled", "Cancelled"
+
+
+class InstallmentPlan(models.Model):
+    """InstallmentPlan."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_installmentplan_001"
+
+    creator = models.ForeignKey("v1.CanvasUser", on_delete=models.CASCADE)
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.CASCADE, related_name="installment_plans"
+    )
+    total_amount = models.DecimalField(max_digits=8, decimal_places=2)
+    status = models.CharField(choices=InstallmentPlanStatus.choices)
+    expected_payoff_date = models.DateField()
+    created_at = models.DateTimeField()
+    updated_at = models.DateTimeField()
+
+
+class ClaimQueueColumns(models.TextChoices):
+    """ClaimQueueColumns."""
+
+    NOTE_TYPE = "NoteType", "Note type"
+    CLAIM_ID = "ClaimID", "Claim ID"
+    DOS = "DateOfService", "Date of service"
+    PATIENT = "Patient", "Patient"
+    ACTIVE_INSURANCE = "ActiveInsurance", "Active insurance"
+    INSURANCE_BALANCE = "InsuranceBalance", "Insurance balance"
+    PATIENT_BALANCE = "PatientBalance", "Patient balance"
+    DAYS_IN_QUEUE = "DaysInQueue", "Days in queue"
+    PROVIDER = "Provider", "Provider"
+    GUARANTOR = "Guarantor", "Guarantor"
+    LATEST_REMIT = "LatestRemit", "Latest remit"
+    LAST_INVOICED = "LastInvoiced", "Last invoiced"
+    SNOOZED_UNTIL = "SnoozedUntil", "Snoozed until"
+    LABELS = "Labels", "Labels"
+
+
+class ClaimQueues(models.IntegerChoices):
+    """ClaimQueues."""
+
+    APPOINTMENT = 1, "Appointment"
+    NEEDS_CLINICIAN_REVIEW = 2, "NeedsClinicianReview"
+    NEEDS_CODING_REVIEW = 3, "NeedsCodingReview"
+    QUEUED_FOR_SUBMISSION = 4, "QueuedForSubmission"
+    FILED_AWAITING_RESPONSE = 5, "FiledAwaitingResponse"
+    REJECTED_NEEDS_REVIEW = 6, "RejectedNeedsReview"
+    ADJUDICATED_OPEN_BALANCE = 7, "AdjudicatedOpenBalance"
+    PATIENT_BALANCE = 8, "PatientBalance"
+    ZERO_BALANCE = 9, "ZeroBalance"
+    TRASH = 10, "Trash"
+
+
+class ClaimQueue(models.Model):
+    """ClaimQueue."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_quality_and_revenue_queue_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    queue_sort_ordering = models.IntegerField()
+    name = models.CharField()
+    display_name = models.CharField()
+    description = models.CharField()
+    show_in_revenue = models.BooleanField()
+    visible_columns = ChoiceArrayField(models.CharField(choices=ClaimQueueColumns.choices))
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+class ClaimPayerOrder(models.TextChoices):
+    """ClaimPayerOrder."""
+
+    PRIMARY = "Primary", "Primary"
+    SECONDARY = "Secondary", "Secondary"
+    TERTIARY = "Tertiary", "Tertiary"
+    QUATERNARY = "Quaternary", "Quaternary"
+    QUINARY = "Quinary", "Quinary"
+
+
+class ClaimTypeCode(models.TextChoices):
+    """ClaimTypeCode."""
+
+    WORKING_AGED = "12", "Working Aged (Age 65 or older)"
+    ESRD = "13", "End-Stage Renal Disease"
+    NO_FAULT = "14", "No-fault"
+    WORKERS_COMP = "15", "Workers Compensation"
+    BLACK_LUNG = "41", "Black Lung"
+    VA = "42", "Veterans Administration"
+    DISABLED = "43", "Disabled (Under Age 65)"
+    OTHER_LIABILITY = "47", "Other Liability Insurance is primary"
+    UNNECESSARY = "", "No Typecode necessary"
+
+
+class ClaimCoverageQuerySet(models.QuerySet):
+    """ClaimCoverageQuerySet."""
+
+    def active(self) -> Self:
+        """Filter active claim coverages."""
+        return self.filter(active=True)
+
+
+class ClaimCoverage(models.Model):
+    """A model that represents the link between a claim and a specific insurance coverage."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_quality_and_revenue_claimcoverage_001"
+
+    objects = ClaimCoverageQuerySet.as_manager()
+
+    dbid = models.BigIntegerField(primary_key=True)
+
+    claim = models.ForeignKey("Claim", on_delete=models.CASCADE, related_name="coverages")
+
+    coverage = models.ForeignKey(
+        "v1.Coverage", related_name="claim_coverages", on_delete=models.PROTECT
+    )
+
+    active = models.BooleanField()
+    payer_name = models.CharField()
+    payer_id = models.CharField()
+    payer_typecode = models.CharField()
+    payer_order = models.CharField(choices=ClaimPayerOrder.choices)
+    payer_addr1 = models.CharField()
+    payer_addr2 = models.CharField()
+    payer_city = models.CharField()
+    payer_state = models.CharField()
+    payer_zip = models.CharField()
+    payer_plan_type = models.CharField(choices=ClaimTypeCode.choices)
+    coverage_type = models.CharField(choices=CoverageType.choices)
+
+    subscriber_employer = models.CharField()
+    subscriber_group = models.CharField()
+    subscriber_number = models.CharField()
+    subscriber_plan = models.CharField()
+    subscriber_dob = models.CharField()
+    subscriber_first_name = models.CharField()
+    subscriber_last_name = models.CharField()
+    subscriber_middle_name = models.CharField()
+    subscriber_phone = models.CharField()
+    subscriber_sex = models.CharField(choices=PersonSex.choices)
+    subscriber_addr1 = models.CharField()
+    subscriber_addr2 = models.CharField()
+    subscriber_city = models.CharField()
+    subscriber_state = models.CharField()
+    subscriber_zip = models.CharField()
+    subscriber_country = models.CharField()
+    patient_relationship_to_subscriber = models.CharField(choices=CoverageRelationshipCode.choices)
+
+    pay_to_addr1 = models.CharField()
+    pay_to_addr2 = models.CharField()
+    pay_to_city = models.CharField()
+    pay_to_state = models.CharField()
+    pay_to_zip = models.CharField()
+
+    resubmission_code = models.CharField()
+    payer_icn = models.CharField()
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+class ClaimPatient(models.Model):
+    """ClaimPatient."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_quality_and_revenue_claimpatient_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    claim = models.OneToOneField("v1.Claim", on_delete=models.CASCADE, related_name="patient")
+    photo = models.CharField()
+    dob = models.CharField()
+    first_name = models.CharField()
+    last_name = models.CharField()
+    middle_name = models.CharField()
+    phone = models.CharField()
+    sex = models.CharField(choices=PersonSex.choices)
+    ssn = models.CharField()
+    addr1 = models.CharField()
+    addr2 = models.CharField()
+    city = models.CharField()
+    state = models.CharField()
+    zip = models.CharField()
+    country = models.CharField()
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+class ClaimQueryset(models.QuerySet):
+    """ClaimQueryset."""
+
+    def active(self) -> Self:
+        """Active claims."""
+        return self.exclude(current_queue__queue_sort_ordering=ClaimQueues.TRASH)
+
+
+class Claim(models.Model):
+    """Claim."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_quality_and_revenue_claim_001"
+
+    objects = ClaimQueryset.as_manager()
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    note = models.ForeignKey("v1.Note", on_delete=models.PROTECT, related_name="claims", null=True)
+    installment_plan = models.ForeignKey(
+        InstallmentPlan, on_delete=models.SET_NULL, related_name="claims", null=True
+    )
+    current_queue = models.ForeignKey(ClaimQueue, on_delete=models.PROTECT, related_name="claims")
+    latest_invoice = models.ForeignKey("v1.Invoice", on_delete=models.SET_NULL, null=True)
+    current_coverage = models.ForeignKey(
+        ClaimCoverage, related_name="claims", on_delete=models.SET_NULL, null=True
+    )
+
+    accept_assign = models.BooleanField()
+    auto_accident = models.BooleanField()
+    auto_accident_state = models.CharField()
+    employment_related = models.BooleanField()
+    other_accident = models.BooleanField()
+    accident_code = models.CharField()
+    illness_date = models.DateField()
+    remote_batch_id = models.CharField()
+    remote_file_id = models.CharField()
+    prior_auth = models.CharField()
+
+    narrative = models.CharField()
+    account_number = models.CharField()
+    snoozed_until = models.DateField()
+
+    patient_balance = models.DecimalField(max_digits=8, decimal_places=2)
+    aggregate_coverage_balance = models.DecimalField(max_digits=8, decimal_places=2)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+    @property
+    def total_charges(self) -> Decimal:
+        """Total charges for the claim."""
+        line_items = self.get_active_claim_line_items()
+        if line_items:
+            return quantize(sum(line_item.charge for line_item in line_items))
+        return Decimal("0.00")
+
+    @property
+    def total_paid(self) -> Decimal | int:
+        """Total paid amount for the claim."""
+        return sum(posting.paid_amount for posting in self.postings.active()) or Decimal("0.00")
+
+    @property
+    def total_adjusted(self) -> Decimal | int:
+        """Total adjusted amount for the claim."""
+        return sum(
+            posting.adjusted_and_transferred_amount for posting in self.postings.active()
+        ) or Decimal("0.00")
+
+    @property
+    def balance(self) -> Decimal:
+        """Balance for the claim."""
+        return self.aggregate_coverage_balance + self.patient_balance
+
+    @property
+    def total_patient_paid(self) -> Decimal | int:
+        """Total amount paid by the patient."""
+        return sum(posting.paid_amount for posting in self.patient.postings.active()) or Decimal(
+            "0.00"
+        )
+
+    @property
+    def total_payer_paid(self) -> Decimal | int:
+        """Total amount paid by the coverages."""
+        return sum(
+            posting.paid_amount
+            for coverage in self.coverages.active()
+            for posting in coverage.postings.active()
+        ) or Decimal("0.00")
+
+    def get_active_claim_line_items(self) -> "ClaimLineItemQuerySet":
+        """Return the active claim line items."""
+        return self.line_items.active().exclude_copay_and_unlinked()
+
+
+__exports__ = (
+    "Claim",
+    "ClaimQueue",
+    "ClaimCoverage",
+    "ClaimPatient",
+    "ClaimPayerOrder",
+    "ClaimQueues",
+    "ClaimQueueColumns",
+    "ClaimTypeCode",
+    "InstallmentPlan",
+    "InstallmentPlanStatus",
+)