canvas 0.13.3__py3-none-any.whl → 0.15.0__py3-none-any.whl

canvas_sdk/commands/tests/test_utils.py

@@ -1,14 +1,17 @@
 import random
 import shutil
 import string
+import threading
 from contextlib import chdir
 from datetime import datetime
 from decimal import Decimal
 from pathlib import Path
 from typing import Any, cast
+from urllib.parse import urlparse
 
 import pytest
 import requests
+import websocket
 from pydantic import ValidationError
 from typer.testing import CliRunner
 
@@ -187,17 +190,25 @@ class Protocol(BaseProtocol):
 def install_plugin(plugin_name: str, token: MaskedValue) -> None:
     """Install a plugin."""
     with open(_build_package(Path(f"./custom-plugins/{plugin_name}")), "rb") as package:
-        requests.post(
+        message_received_event = wait_for_log(
+            cast(str, settings.INTEGRATION_TEST_URL),
+            token.value,
+            f"Loading plugin '{plugin_name}",
+        )
+        response = requests.post(
             plugin_url(cast(str, settings.INTEGRATION_TEST_URL)),
             data={"is_enabled": True},
             files={"package": package},
             headers={"Authorization": f"Bearer {token.value}"},
         )
+        response.raise_for_status()
+
+        message_received_event.wait(timeout=5.0)
 
 
 def trigger_plugin_event(token: MaskedValue) -> None:
     """Trigger a plugin event."""
-    requests.post(
+    response = requests.post(
         f"{settings.INTEGRATION_TEST_URL}/api/Note/",
         headers={
             "Authorization": f"Bearer {token.value}",
@@ -212,18 +223,22 @@ def trigger_plugin_event(token: MaskedValue) -> None:
             "lastModifiedBySessionKey": "8fee3c03a525cebee1d8a6b8e63dd4dg",
         },
     )
+    response.raise_for_status()
 
 
 def get_original_note_body_commands(new_note_id: int, token: MaskedValue) -> list[str]:
     """Get the commands from the original note body."""
-    original_note = requests.get(
+    response = requests.get(
         f"{settings.INTEGRATION_TEST_URL}/api/Note/{new_note_id}",
         headers={
             "Authorization": f"Bearer {token.value}",
             "Content-Type": "application/json",
             "Accept": "application/json",
         },
-    ).json()
+    )
+    response.raise_for_status()
+
+    original_note = response.json()
 
     body = original_note["body"]
     return [
@@ -243,18 +258,21 @@ def clean_up_files_and_plugins(plugin_name: str, token: MaskedValue) -> None:
         shutil.rmtree(Path(f"./custom-plugins/{plugin_name}"))
 
     # disable
-    requests.patch(
+    response = requests.patch(
         plugin_url(cast(str, settings.INTEGRATION_TEST_URL), plugin_name),
         data={"is_enabled": False},
         headers={
             "Authorization": f"Bearer {token.value}",
         },
     )
+    response.raise_for_status()
+
     # delete
-    requests.delete(
+    response = requests.delete(
         plugin_url(cast(str, settings.INTEGRATION_TEST_URL), plugin_name),
         headers={"Authorization": f"Bearer {token.value}"},
     )
+    response.raise_for_status()
 
 
 # For reuse with the protocol code
@@ -287,21 +305,61 @@ def create_new_note(token: MaskedValue) -> dict:
         "note_type_version": 1,
         "lastModifiedBySessionKey": "8fee3c03a525cebee1d8a6b8e63dd4dg",
     }
-    return requests.post(
+    response = requests.post(
         f"{settings.INTEGRATION_TEST_URL}/api/Note/", headers=headers, json=data
-    ).json()
+    )
+    response.raise_for_status()
+    return response.json()
 
 
 def get_token() -> MaskedValue:
     """Get a valid token."""
-    return MaskedValue(
-        requests.post(
-            f"{settings.INTEGRATION_TEST_URL}/auth/token/",
-            headers={"Content-Type": "application/x-www-form-urlencoded"},
-            data={
-                "grant_type": "client_credentials",
-                "client_id": settings.INTEGRATION_TEST_CLIENT_ID,
-                "client_secret": settings.INTEGRATION_TEST_CLIENT_SECRET,
-            },
-        ).json()["access_token"]
+    response = requests.post(
+        f"{settings.INTEGRATION_TEST_URL}/auth/token/",
+        headers={"Content-Type": "application/x-www-form-urlencoded"},
+        data={
+            "grant_type": "client_credentials",
+            "client_id": settings.INTEGRATION_TEST_CLIENT_ID,
+            "client_secret": settings.INTEGRATION_TEST_CLIENT_SECRET,
+        },
     )
+    response.raise_for_status()
+
+    return MaskedValue(response.json()["access_token"])
+
+
+def wait_for_log(host: str, token: str, message: str) -> threading.Event:
+    """Wait for a specific log message."""
+    hostname = cast(str, urlparse(host).hostname)
+    instance = hostname.removesuffix(".canvasmedical.com")
+
+    websocket_uri = f"wss://logs.console.canvasmedical.com/{instance}?token={token}"
+
+    connected_event = threading.Event()
+    message_received_event = threading.Event()
+
+    def _on_message(ws: websocket.WebSocket, received_message: str) -> None:
+        try:
+            if "Log stream connected" in received_message:
+                connected_event.set()
+            if message.lower() in received_message.lower():
+                message_received_event.set()
+                ws.close()
+        except Exception as ex:
+            print(f"Error processing message: {ex}")
+
+    def _on_error(ws: websocket.WebSocket, error: str) -> None:
+        print(f"WebSocket error: {error}")
+
+    ws = websocket.WebSocketApp(
+        websocket_uri,
+        on_message=_on_message,
+        on_error=_on_error,
+    )
+
+    thread = threading.Thread(target=ws.run_forever)
+    thread.start()
+
+    connected_event.wait(timeout=5.0)
+
+    return message_received_event

canvas_sdk/effects/banner_alert/tests.py

@@ -14,7 +14,7 @@ from typer.testing import CliRunner
 import settings
 from canvas_cli.apps.plugin.plugin import _build_package, plugin_url
 from canvas_cli.main import app
-from canvas_sdk.commands.tests.test_utils import MaskedValue
+from canvas_sdk.commands.tests.test_utils import MaskedValue, wait_for_log
 from canvas_sdk.effects.banner_alert import AddBannerAlert, RemoveBannerAlert
 
 runner = CliRunner()
@@ -23,17 +23,18 @@ runner = CliRunner()
 @pytest.fixture(scope="session")
 def token() -> MaskedValue:
     """Get a valid token."""
-    return MaskedValue(
-        requests.post(
-            f"{settings.INTEGRATION_TEST_URL}/auth/token/",
-            headers={"Content-Type": "application/x-www-form-urlencoded"},
-            data={
-                "grant_type": "client_credentials",
-                "client_id": settings.INTEGRATION_TEST_CLIENT_ID,
-                "client_secret": settings.INTEGRATION_TEST_CLIENT_SECRET,
-            },
-        ).json()["access_token"]
+    response = requests.post(
+        f"{settings.INTEGRATION_TEST_URL}/auth/token/",
+        headers={"Content-Type": "application/x-www-form-urlencoded"},
+        data={
+            "grant_type": "client_credentials",
+            "client_id": settings.INTEGRATION_TEST_CLIENT_ID,
+            "client_secret": settings.INTEGRATION_TEST_CLIENT_SECRET,
+        },
     )
+    response.raise_for_status()
+
+    return MaskedValue(response.json()["access_token"])
 
 
 @pytest.fixture(scope="session")
@@ -44,7 +45,9 @@ def first_patient_id(token: MaskedValue) -> dict:
         "Content-Type": "application/json",
         "Accept": "application/json",
     }
-    patients = requests.get(f"{settings.INTEGRATION_TEST_URL}/api/Patient", headers=headers).json()
+    response = requests.get(f"{settings.INTEGRATION_TEST_URL}/api/Patient", headers=headers)
+    response.raise_for_status()
+    patients = response.json()
     return patients["entry"][0]["resource"]["key"]
 
 
@@ -89,13 +92,22 @@ class Protocol(BaseProtocol):
         protocol.write(protocol_code)
 
     with open(_build_package(Path(f"./custom-plugins/{plugin_name}")), "rb") as package:
+        message_received_event = wait_for_log(
+            settings.INTEGRATION_TEST_URL,
+            token.value,
+            f"Loading plugin '{plugin_name}:{plugin_name}.protocols.my_protocol:Protocol'",
+        )
+
         # install the plugin
-        requests.post(
+        response = requests.post(
             plugin_url(settings.INTEGRATION_TEST_URL),
             data={"is_enabled": True},
             files={"package": package},
             headers={"Authorization": f"Bearer {token.value}"},
         )
+        response.raise_for_status()
+
+        message_received_event.wait(timeout=5.0)
 
     yield
 
@@ -104,26 +116,31 @@ class Protocol(BaseProtocol):
         shutil.rmtree(Path(f"./custom-plugins/{plugin_name}"))
 
     # disable
-    requests.patch(
+    response = requests.patch(
         plugin_url(settings.INTEGRATION_TEST_URL, plugin_name),
         data={"is_enabled": False},
         headers={
             "Authorization": f"Bearer {token.value}",
         },
     )
+    response.raise_for_status()
+
     # delete
-    requests.delete(
+    response = requests.delete(
         plugin_url(settings.INTEGRATION_TEST_URL, plugin_name),
         headers={"Authorization": f"Bearer {token.value}"},
     )
+    response.raise_for_status()
 
     # confirm no more banner
-    patient_banners_none = requests.get(
+    response = requests.get(
         f"{settings.INTEGRATION_TEST_URL}/api/BannerAlert/?patient__key={first_patient_id}",
         headers={
             "Authorization": f"Bearer {token.value}",
         },
-    ).json()
+    )
+    response.raise_for_status()
+    patient_banners_none = response.json()
     patient_banner = next(
         (b for b in patient_banners_none["results"] if b["key"] == plugin_name), None
     )
@@ -139,7 +156,7 @@ def test_protocol_that_adds_banner_alert(
 ) -> None:
     """Test that the protocol adds a banner alert."""
     # trigger the event
-    requests.post(
+    response = requests.post(
         f"{settings.INTEGRATION_TEST_URL}/api/Note/",
         headers={
             "Authorization": f"Bearer {token.value}",
@@ -154,13 +171,17 @@ def test_protocol_that_adds_banner_alert(
             "lastModifiedBySessionKey": "8fee3c03a525cebee1d8a6b8e63dd4dg",
         },
     )
+    response.raise_for_status()
 
-    patient_banners = requests.get(
+    response = requests.get(
         f"{settings.INTEGRATION_TEST_URL}/api/BannerAlert/?patient__key={first_patient_id}",
         headers={
             "Authorization": f"Bearer {token.value}",
         },
-    ).json()
+    )
+    response.raise_for_status()
+
+    patient_banners = response.json()
     assert patient_banners["count"] > 0
 
     patient_banner = next(b for b in patient_banners["results"] if b["key"] == plugin_name)

canvas_sdk/effects/questionnaire_result.py

@@ -0,0 +1,29 @@
+from typing import Any
+
+from canvas_sdk.effects.base import EffectType, _BaseEffect
+
+
+class CreateQuestionnaireResult(_BaseEffect):
+    """CreateQuestionnaireResult effect."""
+
+    class Meta:
+        effect_type = EffectType.CREATE_QUESTIONNAIRE_RESULT
+
+    interview_id: str | None = None
+    score: float | None = None
+    abnormal: bool | None = None
+    narrative: str | None = None
+    code_system: str | None = None
+    code: str | None = None
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Make the payload."""
+        return {
+            "interview_id": self.interview_id,
+            "score": self.score,
+            "abnormal": self.abnormal or False,
+            "narrative": self.narrative or "",
+            "code_system": self.code_system,
+            "code": self.code,
+        }

canvas_sdk/events/base.py

@@ -33,9 +33,7 @@ class Event:
 
     def __init__(self, event_request: EventRequest) -> None:
         try:
-            target_model = apps.get_model(
-                app_label="canvas_sdk", model_name=event_request.target_type
-            )
+            target_model = apps.get_model(app_label="v1", model_name=event_request.target_type)
         except LookupError:
             target_model = None
 

canvas_sdk/handlers/action_button.py

@@ -42,13 +42,16 @@ class ActionButton(BaseHandler):
             EventType.SHOW_NOTE_HEADER_BUTTON,
             EventType.SHOW_NOTE_FOOTER_BUTTON,
         ):
-            if self.context["location"].lower() == self.BUTTON_LOCATION.value and self.visible():
+            if (
+                self.event.context["location"].lower() == self.BUTTON_LOCATION.value
+                and self.visible()
+            ):
                 return [ShowButtonEffect(key=self.BUTTON_KEY, title=self.BUTTON_TITLE).apply()]
             else:
                 return []
         elif (
             self.event.type == EventType.ACTION_BUTTON_CLICKED
-            and self.context["key"] == self.BUTTON_KEY
+            and self.event.context["key"] == self.BUTTON_KEY
         ):
             return self.handle()
 

canvas_sdk/handlers/application.py

@@ -14,7 +14,7 @@ class Application(BaseHandler, ABC):
         """Handle the application events."""
         match self.event.type:
             case EventType.APPLICATION__ON_OPEN:
-                return [self.on_open()] if self.target == self.identifier else []
+                return [self.on_open()] if self.event.target.id == self.identifier else []
             case _:
                 return []
 

canvas_sdk/handlers/cron_task.py

@@ -29,7 +29,7 @@ class CronTask(BaseHandler):
         """
         if not self.SCHEDULE:
             raise ValueError("You must set a SCHEDULE.")
-        datetime = arrow.get(self.target).datetime
+        datetime = arrow.get(self.event.target.id).datetime
         if datetime in Cron(self.SCHEDULE):
             return self.execute()
         return []

canvas_sdk/protocols/clinical_quality_measure.py

@@ -94,7 +94,7 @@ class ClinicalQualityMeasure(BaseProtocol):
 
         def patient_id(model: "type[Model]") -> str:
             if model == Patient:
-                return self.target
+                return self.event.target.id
             else:
                 return cast(
                     str,

canvas_sdk/v1/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class CanvasSdkV1Config(AppConfig):
+    """AppConfig for v1 of the SDK data module."""
+
+    name = "canvas_sdk.v1"

canvas_sdk/v1/data/__init__.py

@@ -1,23 +1,94 @@
+from .allergy_intolerance import AllergyIntolerance, AllergyIntoleranceCoding
 from .billing import BillingLineItem
+from .command import Command
 from .condition import Condition, ConditionCoding
+from .detected_issue import DetectedIssue, DetectedIssueEvidence
+from .device import Device
+from .imaging import ImagingOrder, ImagingReport, ImagingReview
+from .lab import (
+    LabOrder,
+    LabOrderReason,
+    LabOrderReasonCondition,
+    LabReport,
+    LabReview,
+    LabTest,
+    LabValue,
+    LabValueCoding,
+)
 from .medication import Medication, MedicationCoding
+from .note import Note, NoteType
+from .observation import (
+    Observation,
+    ObservationCoding,
+    ObservationComponent,
+    ObservationComponentCoding,
+    ObservationValueCoding,
+)
 from .organization import Organization
 from .patient import Patient
-from .practicelocation import PracticeLocation
+from .practicelocation import PracticeLocation, PracticeLocationSetting
+from .protocol_override import ProtocolOverride
+from .questionnaire import (
+    Interview,
+    InterviewQuestionnaireMap,
+    InterviewQuestionResponse,
+    Question,
+    Questionnaire,
+    QuestionnaireQuestionMap,
+    ResponseOption,
+    ResponseOptionSet,
+)
 from .staff import Staff
-from .task import Task, TaskComment, TaskLabel
+from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
+from .user import CanvasUser
 
-__all__ = (
+__all__ = [
+    "AllergyIntolerance",
+    "AllergyIntoleranceCoding",
     "BillingLineItem",
+    "CanvasUser",
+    "Command",
     "Condition",
     "ConditionCoding",
+    "DetectedIssue",
+    "DetectedIssueEvidence",
+    "Device",
+    "ImagingOrder",
+    "ImagingReport",
+    "ImagingReview",
+    "Interview",
+    "InterviewQuestionnaireMap",
+    "InterviewQuestionResponse",
+    "LabOrder",
+    "LabOrderReason",
+    "LabOrderReasonCondition",
+    "LabReport",
+    "LabReview",
+    "LabTest",
+    "LabValue",
+    "LabValueCoding",
     "Medication",
     "MedicationCoding",
+    "Note",
+    "NoteType",
+    "Observation",
+    "ObservationCoding",
+    "ObservationComponent",
+    "ObservationComponentCoding",
+    "ObservationValueCoding",
     "Organization",
     "Patient",
     "PracticeLocation",
+    "PracticeLocationSetting",
+    "ProtocolOverride",
+    "Question",
+    "Questionnaire",
+    "QuestionnaireQuestionMap",
+    "ResponseOption",
+    "ResponseOptionSet",
     "Staff",
     "Task",
     "TaskComment",
     "TaskLabel",
-)
+    "TaskTaskLabel",
+]

canvas_sdk/v1/data/allergy_intolerance.py

@@ -1,8 +1,6 @@
 from django.db import models
 
 from canvas_sdk.v1.data.base import CommittableModelManager, ValueSetLookupQuerySet
-from canvas_sdk.v1.data.patient import Patient
-from canvas_sdk.v1.data.user import CanvasUser
 
 
 class AllergyIntolerance(models.Model):
@@ -10,7 +8,6 @@ class AllergyIntolerance(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_allergyintolerance_001"
 
     objects = CommittableModelManager().from_queryset(ValueSetLookupQuerySet)()
@@ -20,10 +17,10 @@ class AllergyIntolerance(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     deleted = models.BooleanField()
-    committer = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey(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)
     patient = models.ForeignKey(
-        Patient,
+        "v1.Patient",
         on_delete=models.DO_NOTHING,
         related_name="allergy_intolerances",
         null=True,
@@ -46,7 +43,6 @@ class AllergyIntoleranceCoding(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_allergyintolerancecoding_001"
 
     dbid = models.BigIntegerField(primary_key=True)

canvas_sdk/v1/data/billing.py

@@ -3,8 +3,6 @@ from typing import TYPE_CHECKING
 from django.db import models
 
 from canvas_sdk.v1.data.base import ValueSetTimeframeLookupQuerySet
-from canvas_sdk.v1.data.note import Note
-from canvas_sdk.v1.data.patient import Patient
 from canvas_sdk.value_set.value_set import CodeConstants
 
 if TYPE_CHECKING:
@@ -36,7 +34,6 @@ class BillingLineItem(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_billinglineitem_001"
 
     # objects = BillingLineItemQuerySet.as_manager()
@@ -47,10 +44,10 @@ class BillingLineItem(models.Model):
     created = models.DateTimeField()
     modified = models.DateTimeField()
     note = models.ForeignKey(
-        Note, on_delete=models.DO_NOTHING, related_name="billing_line_items", null=True
+        "v1.Note", on_delete=models.DO_NOTHING, related_name="billing_line_items", null=True
     )
     patient = models.ForeignKey(
-        Patient, on_delete=models.DO_NOTHING, related_name="billing_line_items", null=True
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="billing_line_items", null=True
     )
     cpt = models.CharField()
     charge = models.DecimalField()

canvas_sdk/v1/data/command.py

@@ -1,27 +1,38 @@
+from django.apps import apps
 from django.db import models
 
-from canvas_sdk.v1.data.patient import Patient
-from canvas_sdk.v1.data.user import CanvasUser
-
 
 class Command(models.Model):
     """Command."""
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_commands_command_001"
 
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
-    originator = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
-    committer = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
-    entered_in_error = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
+    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)
     state = models.CharField()
-    patient = models.ForeignKey(Patient, on_delete=models.DO_NOTHING, null=True)
+    patient = models.ForeignKey("v1.Patient", on_delete=models.DO_NOTHING, null=True)
     note_id = models.BigIntegerField()
     schema_key = models.TextField()
     data = models.JSONField()
     origination_source = models.CharField()
+    anchor_object_type = models.CharField()
+    anchor_object_dbid = models.BigIntegerField()
+
+    @property
+    def anchor_object(self) -> models.Model | None:
+        """
+        Use the anchor_object_type and anchor_object_dbid to get the anchor object for the command.
+        """
+        # 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.
+        anchor_model = apps.get_model(
+            app_label=self._meta.app_label, model_name=self.anchor_object_type
+        )
+        return anchor_model.objects.get(dbid=self.anchor_object_dbid)

canvas_sdk/v1/data/condition.py

@@ -2,8 +2,6 @@ from django.db import models
 from django.db.models import TextChoices
 
 from canvas_sdk.v1.data.base import ValueSetLookupQuerySet
-from canvas_sdk.v1.data.patient import Patient
-from canvas_sdk.v1.data.user import CanvasUser
 
 
 class ClinicalStatus(TextChoices):
@@ -27,7 +25,6 @@ class Condition(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_condition_001"
 
     objects = ConditionQuerySet.as_manager()
@@ -35,10 +32,10 @@ class Condition(models.Model):
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
     deleted = models.BooleanField()
-    entered_in_error = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING, null=True)
-    committer = models.ForeignKey(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)
     patient = models.ForeignKey(
-        Patient, on_delete=models.DO_NOTHING, related_name="conditions", null=True
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="conditions", null=True
     )
     onset_date = models.DateField()
     resolution_date = models.DateField()
@@ -50,7 +47,6 @@ class ConditionCoding(models.Model):
 
     class Meta:
         managed = False
-        app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_conditioncoding_001"
 
     dbid = models.BigIntegerField(primary_key=True)