canvas 0.51.0__py3-none-any.whl → 0.52.0__py3-none-any.whl

{canvas-0.51.0.dist-info → canvas-0.52.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: canvas
-Version: 0.51.0
+Version: 0.52.0
 Summary: SDK to customize event-driven actions in your Canvas instance
 Author-email: Canvas Team <engineering@canvasmedical.com>
 License-Expression: MIT

{canvas-0.51.0.dist-info → canvas-0.52.0.dist-info}/RECORD

@@ -192,7 +192,7 @@ canvas_sdk/effects/protocol_card/protocol_card.py,sha256=kYkyl0gUi147VJUm-mgrrtR
 canvas_sdk/effects/surescripts/__init__.py,sha256=vD-g2zW8HzGMfxcaure5ZhrQNP72iIDROAsCrzLH3y4,349
 canvas_sdk/effects/surescripts/surescripts_messages.py,sha256=7Cd_93SJVCgrneXadubUSjLQwS0N2lNp2ISH_6a24cs,2746
 canvas_sdk/effects/task/__init__.py,sha256=KlIinP5QbWMkoHGWPTg6Wi-TolPWW7TnEMVZ-h0Z3YE,168
-canvas_sdk/effects/task/task.py,sha256=Cbyaww6qja9RoYRHbBindgpRAGqYOLbL_FISu560XIY,3034
+canvas_sdk/effects/task/task.py,sha256=Q_MGMCNbNOJf9xf9upMhwwLNxlozGzDqtUI7gmyIiHw,4350
 canvas_sdk/effects/widgets/__init__.py,sha256=vuMvOTrHNC-6tiIpdJ3Ct59EeBd9RUFZeFN9-vMHr4c,83
 canvas_sdk/effects/widgets/portal_widget.py,sha256=5K8gqbS9OoF6P7oKvsWEOV9ij448VH3JEQu8YcIYwOQ,2441
 canvas_sdk/events/__init__.py,sha256=eIJeJL52DUc1It1Dm6E8TrLzW-p2buKrsxEsy1UhYpU,270
@@ -224,7 +224,7 @@ canvas_sdk/utils/plugins.py,sha256=xxJUeVJBzfQWhlD1kO7HlFWxDAl01kkvbsf07Z08dOM,1
 canvas_sdk/v1/__init__.py,sha256=YYXr5tEQlnwMgTXJbOG963tKSPiUOM4mUkX8wuiqp7U,17
 canvas_sdk/v1/apps.py,sha256=4MwQfQu78oX5bUVlyxYzbt4rZODi0ZesXe_3QOsEWO8,170
 canvas_sdk/v1/models.py,sha256=LqeHZ-Hz3EWyM9vYr9uZ9rBYdMXNuuvJqbmojV8EcEM,224
-canvas_sdk/v1/data/__init__.py,sha256=FL8sB_g-YgBv769YU10f1oy9xmwiXyG6J_RwQSyrO4k,5099
+canvas_sdk/v1/data/__init__.py,sha256=z2v3leRHvkPEjULJq2OxlTzURXI7-o9r1z2QokUUaP4,5281
 canvas_sdk/v1/data/allergy_intolerance.py,sha256=KXfU7UqTdRfHUFrP8yncQGMvlRPEt2K6TrC_y7JYgiE,2453
 canvas_sdk/v1/data/appointment.py,sha256=UXvn6wYEgsphhTQaFbFg-UE7Bumy_UR-AQFnsSrL5Dk,2658
 canvas_sdk/v1/data/assessment.py,sha256=vnVoaKWoJGCfaYn6WilxpI5cTgkvM647hFIuTyi_AgY,1663
@@ -236,7 +236,7 @@ canvas_sdk/v1/data/care_team.py,sha256=vQh2QS8T6JvYL8seMVpVFI9qQLpZRo6NT5lMgnSf0
 canvas_sdk/v1/data/charge_description_master.py,sha256=dyxa4Fiwts6wTyoDR-blbPZ_D95pojDLWPrNbmemx2Y,856
 canvas_sdk/v1/data/claim.py,sha256=xCuZ1SSiQ_LxUX-0GoxwKstEZwi87cnqjn8QB6m86S8,11530
 canvas_sdk/v1/data/claim_line_item.py,sha256=5WyTqlWSdQSDKyGWwRv5Dyn24_etyp8Zg_Q8aNgGL6o,5072
-canvas_sdk/v1/data/command.py,sha256=1_9CUk-KwUbrfXiaMjzedpouLbieSJigcIqTYiTMIuE,1848
+canvas_sdk/v1/data/command.py,sha256=G7qtNypiTK274QQExKLbnij4gM71HZMs8f79VFYvIiY,1944
 canvas_sdk/v1/data/common.py,sha256=u5W3_7kXAGPe7guEBwRouKp8FMRCx9iZL6ei8QMmtwU,4880
 canvas_sdk/v1/data/compound_medication.py,sha256=a_m_hlRyZyF_c6FIIEUuX34hSslikd7RueLmjbRC12s,2239
 canvas_sdk/v1/data/condition.py,sha256=u9Vgo8h5TYhof-GYPpezpP3YdN_lfCAw4jCN4QSqpfE,2376
@@ -245,13 +245,13 @@ canvas_sdk/v1/data/detected_issue.py,sha256=k-tOX6fpzfRf9WmG7neHPEeWrpZUdTiTEqYz
 canvas_sdk/v1/data/device.py,sha256=5YnCApQR3ZprGO9zCsSP-4spwo4HVRDSTY3QCNwqYlo,1932
 canvas_sdk/v1/data/discount.py,sha256=Bqa0PcytSdqZ0MJor9EShtRUmNWGcBKtivGCmjk9Pbw,618
 canvas_sdk/v1/data/fields.py,sha256=bI7mPI_3B36ntyoVQ6vuDq8eGLoUIkwZZr14lTC-4To,1104
-canvas_sdk/v1/data/imaging.py,sha256=IvbuPeZxaZXmPPxJmhk4mMTdrIiMyu2UogjWB6tk3gs,4649
+canvas_sdk/v1/data/imaging.py,sha256=N0OkJjmHI3jtv1w8RBhqGZGDGidNpf1ZwT0ypm1o60M,5246
 canvas_sdk/v1/data/invoice.py,sha256=F5j_Hvu-YwqhHFkp6FDui8vx6GumCAgj14YgDvfyeYU,1877
-canvas_sdk/v1/data/lab.py,sha256=sAfIvZfTDly-QUMVUfFDXoRjtNQbfLRJOJnL3tIjvIw,12902
+canvas_sdk/v1/data/lab.py,sha256=8FPnApgcEfZ5f62387EgY6RZd8za2wps5LMzCB0_x6U,12969
 canvas_sdk/v1/data/line_item_transaction.py,sha256=OJA_3DLA1RF0v8jCgQ8SHaoqij_Z97Iatfi5i6CVEis,2406
 canvas_sdk/v1/data/medication.py,sha256=QMAUqqldJeQK9IuaoO5mWFp3IEjbqcqrxkzIgFZ4O0U,2333
 canvas_sdk/v1/data/message.py,sha256=EKc2kkWGuzrgBH3sDUa9jiNpRP7J1ZdWE6BnPhY2gvs,2268
-canvas_sdk/v1/data/note.py,sha256=aYLa9Hh8jwwBTZlH5y62lWrCVv0295fWOXt9m39Gaz0,8989
+canvas_sdk/v1/data/note.py,sha256=ZZN0CoQbXmXxzo1cb7bpiXBcy7kLpTzZueGgdd6H95Q,9301
 canvas_sdk/v1/data/observation.py,sha256=l1EXGQ8FBBInxQthsmY1Oms9v73ni_J7SAP5M8Hmkvg,3881
 canvas_sdk/v1/data/organization.py,sha256=gt0KZC1hklwWf57vCxs2K0qPnLpMyyNFWNL7-WZ6AqI,1159
 canvas_sdk/v1/data/patient.py,sha256=g1y1Mq38obqYOMv8NaJ_WpzieO1XAjoqhGsCUG8GGBs,9183
@@ -263,7 +263,9 @@ canvas_sdk/v1/data/practicelocation.py,sha256=O-avErANUE3KwUB_vlRbTe9MywVj2jfBgc
 canvas_sdk/v1/data/protocol_override.py,sha256=zSDHngf9Pqz4irYN_BoX5wy-uJc83NFunPBJnUfS1OI,2259
 canvas_sdk/v1/data/questionnaire.py,sha256=4vQFbBjnvfXwvb73Q0ES64bnWME6P-Oy_9E9ioWAOg8,7209
 canvas_sdk/v1/data/reason_for_visit.py,sha256=diXbeGUUc_XBmIDpzubxesc6Nhj5F87zw2oYurPSE3M,669
-canvas_sdk/v1/data/staff.py,sha256=rHNv8Q3tX7LoNsxVrGphOSQYntxDbOaT0tBIDjnW_P0,5600
+canvas_sdk/v1/data/referral.py,sha256=qVPHWqDlJoBzrYsNhP6z2NQ2Wpus_OxW8LwHYpLlM-M,3589
+canvas_sdk/v1/data/service_provider.py,sha256=LQfQ0esg97NpmSYnftsWqYUJyJIQOZKmpZFNnGsxXoQ,1917
+canvas_sdk/v1/data/staff.py,sha256=iVqBXwANp1qYEL39DIpveKbuqd1nw1oSDQ917xw8xgk,8302
 canvas_sdk/v1/data/task.py,sha256=9jSqr7e7ODJTs4hanWsOD-1Rb8gByJOuLta90V9V_hY,3480
 canvas_sdk/v1/data/team.py,sha256=J4s98sS7UuUw9jJCe-_7eikr1dV4SQARDzK5oxmsO_o,2832
 canvas_sdk/v1/data/user.py,sha256=14_yDFXQ38DF7quZLY5pXmL90_0wfYUTZvEkfKEAgAY,477
@@ -293,7 +295,7 @@ canvas_sdk/views/__init__.py,sha256=YYXr5tEQlnwMgTXJbOG963tKSPiUOM4mUkX8wuiqp7U,
 logger/__init__.py,sha256=uMIOf1CDdKSmBKxKwO4CmDpvnJITci76IMXENOwSHEo,85
 logger/logger.py,sha256=l5W5jn3vGQt6TM7OxOpoMy-vC7RNNA2pGnQJJgHeXWA,2068
 plugin_runner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plugin_runner/allowed-module-imports.json,sha256=syhNOWRtHWHHI2pati_b1i9x7zTIXMm39qOPhpcMXuI,35108
+plugin_runner/allowed-module-imports.json,sha256=j6-KDxn9oJLZXfLwXBSg35znDOUPHqluxu5CcOC1bOA,35350
 plugin_runner/authentication.py,sha256=UyyhXajokVFH866dpDhoTlXS9Cg7y0sQltn0_LcwXrY,1131
 plugin_runner/aws_headers.py,sha256=wZ8584E1fTW0CdGxOCnLSF8alH27z-URcUyoc6y6ohg,2782
 plugin_runner/exceptions.py,sha256=YnRZiQVzbU3HrVlmEXLje_np99009YnhTRVHHyBCtqc,433
@@ -301,14 +303,14 @@ plugin_runner/generate_allowed_imports.py,sha256=LQuVxL_j5n0Sj-KgR4Q8D9mj0xfuDqz
 plugin_runner/installation.py,sha256=LLjtnzPk-w4go3UbXnBItJTKz1ajR_5kGQbFXTaWTFU,7693
 plugin_runner/load_all_plugins.py,sha256=4T2gW2YljhIx4xfwf1c0F_8oIbE1ubsLj0ShkHRtlVY,5847
 plugin_runner/plugin_runner.py,sha256=PqtvyUHOSvIHRW97zX_NKEjszJ1GVmETXxkZhzkZoe0,21975
-plugin_runner/sandbox.py,sha256=Stu_DBJNViFrwn44LuZOopXNEtt7w7YVWFcWi_P95kQ,29368
+plugin_runner/sandbox.py,sha256=uFVmKLMNkOEo3lZhAcfjxKYHzUpHzaRPxfFnAhlOb50,30189
 protobufs/canvas_generated/messages/effects.proto,sha256=zTCelFeZ2ajsQPadiWFPOfqqpEB2ekSiLrdqmSd6tbY,9316
 protobufs/canvas_generated/messages/events.proto,sha256=XBMsexTQb_4ZnvRF_u4ghEfKpuHN7eU6CJJmHGM-ThU,51507
 protobufs/canvas_generated/messages/plugins.proto,sha256=oNainUPWFYQjgCX7bJEPI9_VnHC5VZduzOqgR4Q7dNM,109
 protobufs/canvas_generated/services/plugin_runner.proto,sha256=doadBKn5k4xAtOgR-q_pEvW4yzxpUaHNOowMG6CL5GY,304
 pubsub/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pubsub/pubsub.py,sha256=PHIvJ5SD3M-jQSYeGGSj1FuG6CvP6BQffAoGax9Uudk,1423
-canvas-0.51.0.dist-info/METADATA,sha256=tldZBuG1DdHgxdl4w1JrmMCf3YVcjuZn6qhacznQTnU,4645
-canvas-0.51.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-canvas-0.51.0.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
-canvas-0.51.0.dist-info/RECORD,,
+canvas-0.52.0.dist-info/METADATA,sha256=YFNhTGJ5dcp-vkquOd6o9i3bk7ENveYs-LN6R_7yzdk,4645
+canvas-0.52.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+canvas-0.52.0.dist-info/entry_points.txt,sha256=0Vs_9GmTVUNniH6eDBlRPgofmADMV4BES6Ao26M4AbM,47
+canvas-0.52.0.dist-info/RECORD,,

canvas_sdk/effects/task/task.py

@@ -1,6 +1,9 @@
 from datetime import datetime
-from enum import Enum
-from typing import Any, cast
+from enum import Enum, StrEnum
+from typing import Any, Self, cast
+from uuid import UUID
+
+from pydantic import model_validator
 
 from canvas_sdk.effects.base import EffectType, _BaseEffect
 
@@ -18,10 +21,17 @@ class AddTask(_BaseEffect):
     An Effect that will create a Task in Canvas.
     """
 
+    class LinkableObjectType(StrEnum):
+        """Types of objects that can be linked to a Task."""
+
+        REFERRAL = "REFERRAL"
+        IMAGING = "IMAGING"
+
     class Meta:
         effect_type = EffectType.CREATE_TASK
         apply_required_fields = ("title",)
 
+    id: str | UUID | None = None
     assignee_id: str | None = None
     team_id: str | None = None
     patient_id: str | None = None
@@ -29,11 +39,28 @@ class AddTask(_BaseEffect):
     due: datetime | None = None
     status: TaskStatus = TaskStatus.OPEN
     labels: list[str] = []
+    linked_object_id: str | UUID | None = None
+    linked_object_type: LinkableObjectType | None = None
+
+    @model_validator(mode="after")
+    def check_needed_together_fields(self) -> Self:
+        """Check that linked_object_id and linked_object_type are set together."""
+        if self.linked_object_id is not None and self.linked_object_type is None:
+            raise ValueError(
+                "'linked_object_id' must be set with 'linked_object_type' if it is provided"
+            )
+        if self.linked_object_id is None and self.linked_object_type is not None:
+            raise ValueError(
+                "'linked_object_type' must be set with 'linked_object_id' if it is provided"
+            )
+
+        return self
 
     @property
     def values(self) -> dict[str, Any]:
         """The values for Task addition."""
         return {
+            "id": str(self.id) if self.id else None,
             "patient": {"id": self.patient_id},
             "due": self.due.isoformat() if self.due else None,
             "assignee": {"id": self.assignee_id},
@@ -41,6 +68,10 @@ class AddTask(_BaseEffect):
             "title": self.title,
             "status": self.status.value,
             "labels": self.labels,
+            "linked_object": {
+                "id": str(self.linked_object_id) if self.linked_object_id else None,
+                "type": self.linked_object_type.value if self.linked_object_type else None,
+            },
         }
 
 
@@ -57,12 +88,12 @@ class AddTaskComment(_BaseEffect):
         )
 
     body: str | None = None
-    task_id: str | None = None
+    task_id: str | UUID | None = None
 
     @property
     def values(self) -> dict[str, Any]:
         """The values for adding a task comment."""
-        return {"task": {"id": self.task_id}, "body": self.body}
+        return {"task": {"id": str(self.task_id) if self.task_id else None}, "body": self.body}
 
 
 class UpdateTask(_BaseEffect):

canvas_sdk/v1/data/__init__.py

@@ -80,7 +80,9 @@ from .questionnaire import (
     ResponseOptionSet,
 )
 from .reason_for_visit import ReasonForVisitSettingCoding
-from .staff import Staff, StaffAddress, StaffContactPoint, StaffPhoto
+from .referral import Referral, ReferralReport
+from .service_provider import ServiceProvider
+from .staff import Staff, StaffAddress, StaffContactPoint, StaffPhoto, StaffRole
 from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
 from .team import Team, TeamContactPoint
 from .user import CanvasUser
@@ -172,11 +174,15 @@ __all__ = __exports__ = (
     "Questionnaire",
     "QuestionnaireQuestionMap",
     "ReasonForVisitSettingCoding",
+    "Referral",
+    "ReferralReport",
     "ResponseOption",
     "ResponseOptionSet",
+    "ServiceProvider",
     "Staff",
     "StaffAddress",
     "StaffPhoto",
+    "StaffRole",
     "StaffContactPoint",
     "Task",
     "TaskComment",

canvas_sdk/v1/data/command.py

@@ -40,6 +40,9 @@ class Command(IdentifiableModel):
         """
         # TODO: Is the anchor object type enough here, or do we need a mapping? The home-app model
         #  names might not exactly match the plugins model names.
+        if not self.anchor_object_type or not self.anchor_object_dbid:
+            return None
+
         anchor_model = apps.get_model(
             app_label=self._meta.app_label, model_name=self.anchor_object_type
         )

canvas_sdk/v1/data/imaging.py

@@ -1,3 +1,5 @@
+import json
+
 from django.db import models
 
 from canvas_sdk.v1.data.base import IdentifiableModel
@@ -7,6 +9,7 @@ from canvas_sdk.v1.data.common import (
     ReviewPatientCommunicationMethod,
     ReviewStatus,
 )
+from canvas_sdk.v1.data.task import Task
 
 
 class ImagingOrder(IdentifiableModel):
@@ -30,20 +33,39 @@ class ImagingOrder(IdentifiableModel):
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True
     )
-    # TODO - uncomment when Note model is complete
-    #  note = models.ForeigneKey(Note, on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True)
+    note = models.ForeignKey(
+        "v1.Note", on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True
+    )
     imaging = models.CharField(max_length=1024)
-    # TODO - uncomment when ServiceProvider model is complete
-    # imaging_center = models.ForeignKey('v1.ServiceProvider', on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True)
+    imaging_center = models.ForeignKey(
+        "v1.ServiceProvider", on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True
+    )
     note_to_radiologist = models.CharField(max_length=1024)
     internal_comment = models.CharField(max_length=1024)
     status = models.CharField(choices=OrderStatus.choices, max_length=30)
     date_time_ordered = models.DateTimeField()
     priority = models.CharField(max_length=255)
-    # TODO - uncomment when Staff model is complete
-    # ordering_provider = models.ForeignKey('v1.Staff', on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True)
+    ordering_provider = models.ForeignKey(
+        "v1.Staff", on_delete=models.DO_NOTHING, related_name="imaging_orders", null=True
+    )
     delegated = models.BooleanField(default=False)
 
+    task_ids = models.CharField(max_length=1024)
+
+    def get_task_objects(self) -> "models.QuerySet[Task]":
+        """Convert task IDs to Task objects."""
+        if self.task_ids:
+            task_ids = (
+                json.loads(self.task_ids) if isinstance(self.task_ids, str) else self.task_ids
+            )
+            return Task.objects.filter(id__in=task_ids)
+        return Task.objects.none()
+
+    @property
+    def task_list(self) -> list[Task]:
+        """Convenience property to get task objects."""
+        return list(self.get_task_objects())
+
 
 class ImagingReview(IdentifiableModel):
     """Model to read ImagingReview data."""
@@ -97,7 +119,14 @@ class ImagingReport(IdentifiableModel):
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="imaging_results", null=True
     )
-    order = models.ForeignKey(ImagingOrder, on_delete=models.DO_NOTHING, null=True)
+    order = models.ForeignKey(
+        ImagingOrder,
+        on_delete=models.DO_NOTHING,
+        related_name="results",
+        default=None,
+        blank=True,
+        null=True,
+    )
     source = models.CharField(choices=ImagingReportSource.choices, max_length=18)
     name = models.CharField(max_length=255)
     result_date = models.DateField()

canvas_sdk/v1/data/lab.py

@@ -208,8 +208,8 @@ class LabOrder(IdentifiableModel):
         "v1.Patient", on_delete=models.DO_NOTHING, related_name="lab_orders", null=True
     )
     ontology_lab_partner = models.CharField(max_length=128)
-    # TODO - uncomment when the Note model is finished
-    # note = models.ForeignKey("Note", on_delete=models.DO_NOTHING, null=True)
+
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, null=True)
     comment = models.CharField(max_length=128)
     requisition_number = models.CharField(max_length=32)
     is_patient_bill = models.BooleanField(null=True)
@@ -224,8 +224,10 @@ class LabOrder(IdentifiableModel):
     )
     courtesy_copy_number = models.CharField(max_length=32)
     courtesy_copy_text = models.CharField(max_length=64)
-    ordering_provider = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, null=True)
-    parent_order = models.ForeignKey("LabOrder", on_delete=models.DO_NOTHING, null=True)
+    ordering_provider = models.ForeignKey(
+        Staff, on_delete=models.DO_NOTHING, related_name="lab_orders", null=True
+    )
+    parent_order = models.ForeignKey("v1.LabOrder", on_delete=models.DO_NOTHING, null=True)
     healthgorilla_id = models.CharField(max_length=40)
     manual_processing_status = models.CharField(
         choices=ManualProcessingStatus.choices, null=True, max_length=16
@@ -233,6 +235,8 @@ class LabOrder(IdentifiableModel):
     manual_processing_comment = models.TextField(null=True)
     labcorp_abn_url = models.URLField()
 
+    reports = models.ManyToManyField("v1.LabReport", through="v1.LabTest")
+
 
 class LabOrderReason(Model):
     """A class representing a lab order reason."""

canvas_sdk/v1/data/note.py

@@ -2,6 +2,7 @@ from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
 from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.claim import Claim
 
 
 class NoteTypeCategories(models.TextChoices):
@@ -183,6 +184,13 @@ class Note(IdentifiableModel):
     datetime_of_service = models.DateTimeField()
     place_of_service = models.CharField(max_length=255)
 
+    def get_claim(self) -> Claim | None:
+        """
+        Get the most recent claim for this note.
+        Returns the latest claim ordered by created date, or None if no claims exist.
+        """
+        return self.claims.order_by("-created").first()
+
 
 class NoteStateChangeEvent(IdentifiableModel):
     """NoteStateChangeEvent."""
@@ -209,7 +217,7 @@ class CurrentNoteStateEvent(IdentifiableModel):
         db_table = "canvas_sdk_data_current_note_state_001"
 
     state = models.CharField(choices=NoteStates.choices, max_length=3)
-    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="+")
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="current_state")
 
     def editable(self) -> bool:
         """Returns a boolean to indicate if the related note can be edited."""

canvas_sdk/v1/data/referral.py

@@ -0,0 +1,102 @@
+import json
+
+from django.db import models
+
+from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.task import Task
+
+
+class Referral(IdentifiableModel):
+    """Referral."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_referral_001"
+
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    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 = models.ForeignKey("v1.Patient", on_delete=models.DO_NOTHING)
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING)
+    service_provider = models.ForeignKey(
+        "v1.ServiceProvider",
+        on_delete=models.CASCADE,
+        related_name="referrals",
+        null=True,
+        blank=True,
+    )
+    assessments = models.ManyToManyField("v1.Assessment", related_name="referrals", blank=True)
+    clinical_question = models.CharField(max_length=50)
+    priority = models.CharField(max_length=255)
+    include_visit_note = models.BooleanField()
+    notes = models.TextField()
+    date_referred = models.DateTimeField()
+    forwarded = models.BooleanField()
+    internal_comment = models.TextField()
+    internal_task_comment = models.OneToOneField(
+        "v1.TaskComment", on_delete=models.SET_NULL, null=True, related_name="referral"
+    )
+    ignored = models.BooleanField()
+
+    task_ids = models.CharField(max_length=1024)
+
+    def get_task_objects(self) -> "models.QuerySet[Task]":
+        """Convert task IDs to Task objects."""
+        if self.task_ids:
+            task_ids = (
+                json.loads(self.task_ids) if isinstance(self.task_ids, str) else self.task_ids
+            )
+            return Task.objects.filter(id__in=task_ids)
+        return Task.objects.none()
+
+    @property
+    def task_list(self) -> list[Task]:
+        """Convenience property to get task objects."""
+        return list(self.get_task_objects())
+
+    def __str__(self) -> str:
+        return f"Referral {self.id}"
+
+
+class ReferralReport(IdentifiableModel):
+    """ReferralReport."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_referralreport_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="+"
+    )
+
+    review_mode = models.CharField(max_length=2)
+    assigned_by = models.ForeignKey(
+        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
+    )
+    junked = models.BooleanField()
+    requires_signature = models.BooleanField()
+    assigned_date = models.DateTimeField(null=True)
+    team_assigned_date = models.DateTimeField(null=True)
+    team = models.ForeignKey("v1.Team", on_delete=models.DO_NOTHING, null=True)
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="referral_reports"
+    )
+    referral = models.ForeignKey(
+        Referral, on_delete=models.DO_NOTHING, related_name="reports", null=True
+    )
+    specialty = models.CharField(max_length=250)
+    original_date = models.DateField(null=True)
+    comment = models.TextField()
+    priority = models.BooleanField(default=False)
+
+
+__exports__ = ("Referral", "ReferralReport")

canvas_sdk/v1/data/service_provider.py

@@ -0,0 +1,54 @@
+from functools import cached_property
+
+from django.db import models
+
+from canvas_sdk.v1.data.base import IdentifiableModel
+
+
+class ServiceProvider(IdentifiableModel):
+    """ServiceProvider."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_data_integration_serviceprovider_001"
+
+    first_name = models.CharField(max_length=512)
+    # organizations won't have a last name
+    last_name = models.CharField(max_length=512, default="", blank=True)
+    business_fax = models.CharField(max_length=512, null=True, blank=True)
+    business_phone = models.CharField(max_length=512, null=True, blank=True)
+    business_address = models.CharField(max_length=512, null=True, blank=True)
+    specialty = models.CharField(max_length=512)
+    practice_name = models.CharField(max_length=512, null=True, blank=True)
+    notes = models.TextField(default="", null=True, blank=True)
+
+    @property
+    def full_name(self) -> str:
+        """Service provider full name."""
+        return f"{self.first_name} {self.last_name}"
+
+    @cached_property
+    def full_name_and_specialty(self) -> str:
+        """Service provider full name and specialty."""
+        name_components: list[str] = []
+
+        # Note 1: if firstName is (TBD) then insert at the end instead of the beginning
+        if self.first_name != "(TBD)":
+            name_components.append(self.first_name)
+
+        if self.first_name != self.last_name:
+            name_components.append(self.last_name)
+
+        if self.practice_name and self.practice_name != "(TBD)":
+            name_components.append(f"({self.practice_name}),")
+
+        if self.specialty not in [self.first_name, self.last_name, self.practice_name]:
+            name_components.append(self.specialty)
+
+        # see Note 1
+        if self.first_name == "(TBD)":
+            name_components.append(self.first_name)
+
+        return " ".join(name_components)
+
+
+__exports__ = ("ServiceProvider",)

canvas_sdk/v1/data/staff.py

@@ -1,5 +1,8 @@
+from functools import cached_property
+
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
+from django.db.models.enums import TextChoices
 from timezone_utils.fields import TimeZoneField
 
 from canvas_sdk.v1.data.base import IdentifiableModel, Model
@@ -82,6 +85,47 @@ class Staff(Model):
         photo = self.photos.first()
         return photo.url if photo else "https://d3hn0m4rbsz438.cloudfront.net/avatar1.png"
 
+    @cached_property
+    def full_name(self) -> str:
+        """Return Staff's first + last name."""
+        return f"{self.first_name} {self.last_name}"
+
+    @cached_property
+    def top_clinical_role(self) -> "StaffRole | None":
+        """Returns the topmost clinical role to assist in determining privilege levels.
+
+        Returns:
+            StaffRole | None: the topmost clinical role of the staff member.
+        """
+        roles = [
+            role
+            for role in self.roles.all()
+            if role.domain in StaffRole.RoleDomain.clinical_domains()
+        ]
+
+        if not roles:
+            return None
+
+        return roles[0]
+
+    @cached_property
+    def top_role_abbreviation(self) -> str | None:
+        """Returns the abbreviation string for the topmost role that the Staff object has.
+
+        Returns:
+            Optional[str]: The abbreviation for the topmost role, if available.
+        """
+        return self.top_clinical_role.public_abbreviation if self.top_clinical_role else None
+
+    @cached_property
+    def credentialed_name(self) -> str:
+        """Returns the full name of the staff member, suffixed with their topmost credential.
+
+        Returns:
+            str: The credentialed full name of the staff member.
+        """
+        return " ".join(filter(bool, [self.full_name, self.top_role_abbreviation or ""]))
+
 
 class StaffContactPoint(IdentifiableModel):
     """StaffContactPoint."""
@@ -136,4 +180,35 @@ class StaffPhoto(Model):
     title = models.CharField(max_length=255, blank=True, default="")
 
 
-__exports__ = ("Staff", "StaffContactPoint", "StaffAddress", "StaffPhoto")
+class StaffRole(Model):
+    """StaffRole."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_staffrole_001"
+
+    class RoleDomain(TextChoices):
+        CLINICAL = "CLI", "Clinical"
+        ADMINISTRATIVE = "ADM", "Administrative"
+        HYBRID = "HYB", "Hybrid"
+
+        @staticmethod
+        def clinical_domains() -> list["StaffRole.RoleDomain"]:
+            """Return a list of clinical role domains."""
+            return [StaffRole.RoleDomain.CLINICAL, StaffRole.RoleDomain.HYBRID]
+
+    class RoleType(TextChoices):
+        NON_LICENSED = "NON-LICENSED", "Non-Licensed"
+        LICENSED = "LICENSED", "Licensed"
+        PROVIDER = "PROVIDER", "Provider"
+
+    staff = models.ForeignKey(Staff, on_delete=models.CASCADE, related_name="roles")
+    internal_code = models.CharField(max_length=10)
+    public_abbreviation = models.CharField(max_length=10, default="", blank=True)
+    domain = models.CharField(max_length=3, choices=RoleDomain.choices, db_index=True)
+    name = models.CharField(max_length=50)
+    domain_privilege_level = models.IntegerField(default=0)
+    permissions = models.JSONField(default=dict, blank=True, null=True)
+    role_type = models.CharField(max_length=50, choices=RoleType.choices, blank=True)
+
+
+__exports__ = ("Staff", "StaffContactPoint", "StaffAddress", "StaffPhoto", "StaffRole")

plugin_runner/allowed-module-imports.json

@@ -563,12 +563,16 @@
     "Questionnaire",
     "QuestionnaireQuestionMap",
     "ReasonForVisitSettingCoding",
+    "Referral",
+    "ReferralReport",
     "ResponseOption",
     "ResponseOptionSet",
+    "ServiceProvider",
     "Staff",
     "StaffAddress",
     "StaffContactPoint",
     "StaffPhoto",
+    "StaffRole",
     "Task",
     "TaskComment",
     "TaskLabel",
@@ -796,11 +800,19 @@
   "canvas_sdk.v1.data.reason_for_visit": [
     "ReasonForVisitSettingCoding"
   ],
+  "canvas_sdk.v1.data.referral": [
+    "Referral",
+    "ReferralReport"
+  ],
+  "canvas_sdk.v1.data.service_provider": [
+    "ServiceProvider"
+  ],
   "canvas_sdk.v1.data.staff": [
     "Staff",
     "StaffAddress",
     "StaffContactPoint",
-    "StaffPhoto"
+    "StaffPhoto",
+    "StaffRole"
   ],
   "canvas_sdk.v1.data.task": [
     "EventType",

plugin_runner/sandbox.py

@@ -4,6 +4,7 @@ import ast
 import builtins
 import importlib
 import json
+import operator
 import sys
 import types
 from _ast import AnnAssign
@@ -196,6 +197,8 @@ THIRD_PARTY_MODULES = {
         "BigIntegerField",
         "Case",
         "CharField",
+        "Count",
+        "F",
         "IntegerField",
         "Model",  # remove when hyperscribe no longer needs it
         "Q",
@@ -264,6 +267,34 @@ def _unrestricted(_ob: Any, *args: Any, **kwargs: Any) -> Any:
     return _ob
 
 
+def _inplacevar(op: Any, val: Any, expr: Any) -> Any:
+    """
+    Apply the specified operation to the value and expression.
+
+    NOTE: Does not yet support += concatenation for sequences.
+    """
+    ops = {
+        "-=": operator.isub,
+        "@=": operator.imatmul,
+        "**=": operator.ipow,
+        "*=": operator.imul,
+        "//=": operator.ifloordiv,
+        "/=": operator.itruediv,
+        "&=": operator.iand,
+        "%=": operator.imod,
+        "^=": operator.ixor,
+        "+=": operator.iadd,
+        "<<=": operator.ilshift,
+        ">>=": operator.irshift,
+        "|=": operator.ior,
+    }
+
+    if op not in ops:
+        raise ValueError(f"Invalid inplace operation: {op}")
+
+    return ops[op](val, expr)
+
+
 def _apply(_ob: Any, *args: Any, **kwargs: Any) -> Any:
     """Call the bound method with args, support calling super().__init__()."""
     return _ob(*args, **kwargs)
@@ -614,6 +645,7 @@ class Sandbox:
                 "dict": builtins.dict,
                 "enumerate": builtins.enumerate,
                 "filter": builtins.filter,
+                "getattr": self._safe_getattr,
                 "hasattr": builtins.hasattr,
                 "iter": builtins.iter,
                 "list": builtins.list,
@@ -634,7 +666,7 @@ class Sandbox:
             "_getattr_": self._safe_getattr,
             "_getitem_": self._safe_getitem,
             "_getiter_": _unrestricted,
-            "_inplacevar_": _unrestricted,
+            "_inplacevar_": _inplacevar,
             "_iter_unpack_sequence_": guarded_iter_unpack_sequence,
             "_print_": PrintCollector,
             "_unpack_sequence_": guarded_unpack_sequence,