canvas 0.21.0__py3-none-any.whl → 0.22.1__py3-none-any.whl

canvas_sdk/commands/commands/resolve_condition.py

@@ -0,0 +1,43 @@
+from typing import Literal
+from uuid import UUID
+
+from django.db.models.expressions import Subquery
+from pydantic import Field
+from pydantic_core import InitErrorDetails
+
+from canvas_sdk.commands.base import _BaseCommand as BaseCommand
+from canvas_sdk.v1.data import Condition, Note
+
+
+class ResolveConditionCommand(BaseCommand):
+    """A class for managing a ResolveCondition command within a specific note."""
+
+    class Meta:
+        key = "resolveCondition"
+        commit_required_fields = ("condition_id",)
+
+    condition_id: UUID | str | None = None
+    show_in_condition_list: bool = False
+    rationale: str | None = Field(max_length=1024, default=None)
+
+    def _get_error_details(
+        self, method: Literal["originate", "edit", "delete", "commit", "enter_in_error"]
+    ) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        if self.condition_id:
+            subquery = Subquery(Note.objects.filter(id=self.note_uuid).values("patient_id")[:1])
+            if (
+                not Condition.objects.active()
+                .filter(id=self.condition_id, patient=subquery)
+                .exists()
+            ):
+                errors.append(
+                    self._create_error_detail(
+                        "value",
+                        f"Condition with id {self.condition_id} does not exist.",
+                        self.condition_id,
+                    )
+                )
+
+        return errors

canvas_sdk/commands/constants.py

@@ -1,7 +1,28 @@
+from enum import StrEnum
 from typing import NotRequired
 
+from pydantic import Field
 from typing_extensions import TypedDict
 
+from canvas_sdk.base import Model
+
+
+class CodeSystems(StrEnum):
+    """A class representing different code systems and their URLs."""
+
+    SNOMED = "http://snomed.info/sct"
+    RXNORM = "http://www.nlm.nih.gov/research/umls/rxnorm"
+    LOINC = "http://loinc.org"
+    FDB = "http://www.fdbhealth.com/"
+    ICD10 = "ICD-10"
+    CVX = "http://hl7.org/fhir/sid/cvx"
+    CPT = "http://www.ama-assn.org/go/cpt"
+    NUCC = "http://www.nucc.org/"
+    NDC = "http://hl7.org/fhir/sid/ndc"
+    HCPCS = "http://www.cms.gov/medicare/coding/medhcpcsgeninfo"
+    UNITS_OF_MEASURE = "http://unitsofmeasure.org"
+    UNSTRUCTURED = "UNSTRUCTURED"
+
 
 class Coding(TypedDict):
     """Coding object in Canvas."""
@@ -16,3 +37,16 @@ class ClinicalQuantity(TypedDict):
 
     representative_ndc: str
     ncpdp_quantity_qualifier_code: str
+
+
+class ServiceProvider(Model):
+    """ServiceProvider model."""
+
+    first_name: str = Field(max_length=512)
+    last_name: str = Field(max_length=512)
+    specialty: str = Field(max_length=512)
+    practice_name: str = Field(max_length=512)
+    business_fax: str | None = Field(max_length=512, default=None)
+    business_phone: str | None = Field(max_length=512, default=None)
+    business_address: str | None = Field(max_length=512, default=None)
+    notes: str | None = Field(max_length=512, default=None)

canvas_sdk/commands/tests/protocol/tests.py

@@ -49,7 +49,16 @@ def write_and_install_protocol_and_clean_up(
         f"Loading plugin '{plugin_name}",
     )
     install_plugin(plugin_name, token)
-    message_received_event.wait(timeout=5.0)
+    message_received_event.wait(timeout=15.0)
+
+    # unfortunately sometimes the log websocket just doesn't return any
+    # messages, so asserting on the state of the timeout here causes failures
+    # even though the delay itself will cause the waiting test to pass (because
+    # the plugin has been loaded).
+    # timeout_not_hit = message_received_event.wait(timeout=15.0)
+    # if not timeout_not_hit:
+    #     ws.close()
+    # assert timeout_not_hit, f"plugin loading message timeout hit: Loading plugin '{plugin_name}"
 
     yield
 

canvas_sdk/commands/tests/test_utils.py

@@ -367,6 +367,9 @@ def wait_for_log(
     thread = threading.Thread(target=ws.run_forever)
     thread.start()
 
-    connected_event.wait(timeout=5.0)
+    timeout_not_hit = connected_event.wait(timeout=5.0)
+    if not timeout_not_hit:
+        ws.close()
+    assert timeout_not_hit, "connection timeout hit"
 
     return message_received_event, thread, ws

canvas_sdk/effects/banner_alert/tests.py

@@ -107,8 +107,16 @@ class Protocol(BaseProtocol):
         )
         response.raise_for_status()
 
-        message_received_event.wait(timeout=5.0)
-
+        message_received_event.wait(timeout=15.0)
+
+        # unfortunately sometimes the log websocket just doesn't return any
+        # messages, so asserting on the state of the timeout here causes failures
+        # even though the delay itself will cause the waiting test to pass (because
+        # the plugin has been loaded).
+        # timeout_not_hit = message_received_event.wait(timeout=15.0)
+        # if not timeout_not_hit:
+        #     ws.close()
+        # assert timeout_not_hit, f"plugin loading message timeout hit: Loading plugin '{plugin_name}"
     yield
 
     ws.close()

canvas_sdk/v1/data/condition.py

@@ -1,4 +1,4 @@
-from typing import cast
+from typing import Self, cast
 
 from django.db import models
 from django.db.models import TextChoices
@@ -30,7 +30,9 @@ class ConditionQuerySet(
 ):
     """ConditionQuerySet."""
 
-    pass
+    def active(self) -> Self:
+        """Return a queryset that filters for active conditions."""
+        return self.committed().filter(clinical_status=ClinicalStatus.ACTIVE)
 
 
 ConditionManager = BaseModelManager.from_queryset(ConditionQuerySet)

canvas_sdk/v1/data/medication.py

@@ -1,4 +1,4 @@
-from typing import cast
+from typing import Self, cast
 
 from django.db import models
 from django.db.models import TextChoices
@@ -21,7 +21,9 @@ class Status(TextChoices):
 class MedicationQuerySet(ValueSetLookupQuerySet, CommittableQuerySetMixin, ForPatientQuerySetMixin):
     """MedicationQuerySet."""
 
-    pass
+    def active(self) -> Self:
+        """Filter by active medications."""
+        return self.committed().filter(status=Status.ACTIVE)
 
 
 MedicationManager = BaseModelManager.from_queryset(MedicationQuerySet)

plugin_runner/installation.py

@@ -137,7 +137,7 @@ def download_plugin(plugin_package: str) -> Generator[Path, None, None]:
 def install_plugin(plugin_name: str, attributes: PluginAttributes) -> None:
     """Install the given Plugin's package into the runtime."""
     try:
-        log.info(f'Installing plugin "{plugin_name}"')
+        log.info(f'Installing plugin "{plugin_name}", version {attributes["version"]}')
 
         plugin_installation_path = Path(PLUGIN_DIRECTORY) / plugin_name
 
@@ -224,7 +224,6 @@ def install_plugins() -> None:
 
     for plugin_name, attributes in enabled_plugins().items():
         try:
-            log.info(f'Installing plugin "{plugin_name}", version {attributes["version"]}')
             install_plugin(plugin_name, attributes)
         except PluginInstallationError:
             disable_plugin(plugin_name)

plugin_runner/plugin_runner.py

@@ -13,6 +13,8 @@ from typing import Any, TypedDict
 
 import grpc
 import redis.asyncio as redis
+from asgiref.sync import sync_to_async
+from django.db import connections
 
 from canvas_generated.messages.effects_pb2 import EffectType
 from canvas_generated.messages.plugins_pb2 import ReloadPluginsRequest, ReloadPluginsResponse
@@ -30,6 +32,7 @@ from plugin_runner.installation import install_plugins
 from plugin_runner.sandbox import Sandbox
 from settings import (
     CHANNEL_NAME,
+    IS_TESTING,
     MANIFEST_FILE_NAME,
     PLUGIN_DIRECTORY,
     REDIS_ENDPOINT,
@@ -103,6 +106,25 @@ class PluginManifest(TypedDict):
     readme: str
 
 
+@sync_to_async
+def reconnect_if_needed() -> None:
+    """
+    Reconnect to the database if the connection has been closed.
+
+    NOTE: Django database functions are not async-safe and must be called
+    via e.g. sync_to_async. They will silently fail and block the handler
+    if called in an async context directly.
+    """
+    if IS_TESTING:
+        return
+
+    connection = connections["default"]
+
+    if not connection.is_usable():
+        log.debug("Connection was unusable, reconnecting...")
+        connection.connect()
+
+
 class PluginRunner(PluginRunnerServicer):
     """This process runs provided plugins that register interest in incoming events."""
 
@@ -118,6 +140,11 @@ class PluginRunner(PluginRunnerServicer):
         event_name = event.name
         relevant_plugins = EVENT_HANDLER_MAP[event_name]
 
+        log.debug(f"Processing {relevant_plugins} for {event_name}")
+
+        if relevant_plugins:
+            await reconnect_if_needed()
+
         if event_type in [EventType.PLUGIN_CREATED, EventType.PLUGIN_UPDATED]:
             plugin_name = event.target.id
             # filter only for the plugin(s) that were created/updated
@@ -126,6 +153,8 @@ class PluginRunner(PluginRunnerServicer):
         effect_list = []
 
         for plugin_name in relevant_plugins:
+            log.debug(f"Processing {plugin_name}")
+
             plugin = LOADED_PLUGINS[plugin_name]
             handler_class = plugin["class"]
             base_plugin_name = plugin_name.split(":")[0]
@@ -142,7 +171,7 @@ class PluginRunner(PluginRunnerServicer):
                 )
 
                 compute_start_time = time.time()
-                _effects = await asyncio.get_running_loop().run_in_executor(None, handler.compute)
+                _effects = await sync_to_async(handler.compute)()
                 effects = [
                     Effect(
                         type=effect.type,
@@ -166,9 +195,12 @@ class PluginRunner(PluginRunnerServicer):
                     tags={"plugin": plugin_name},
                 )
             except Exception as e:
+                log.error(f"Encountered exception in plugin {plugin_name}:")
+
                 for error_line_with_newlines in traceback.format_exception(e):
                     for error_line in error_line_with_newlines.split("\n"):
                         log.error(error_line)
+
                 continue
 
             effect_list += effects
@@ -204,7 +236,7 @@ async def synchronize_plugins(run_once: bool = False) -> None:
     """
     log.info(f'synchronize_plugins: listening for messages on pubsub channel "{CHANNEL_NAME}"')
 
-    client, pubsub = get_client()
+    _, pubsub = get_client()
     await pubsub.psubscribe(CHANNEL_NAME)
 
     while True:

protobufs/canvas_generated/messages/effects.proto

@@ -163,6 +163,12 @@ enum EffectType {
   COMMIT_CLOSE_GOAL_COMMAND = 131;
   ENTER_IN_ERROR_CLOSE_GOAL_COMMAND = 132;
 
+  ORIGINATE_REFER_COMMAND = 139;
+  EDIT_REFER_COMMAND = 140;
+  DELETE_REFER_COMMAND = 141;
+  COMMIT_REFER_COMMAND = 142;
+  ENTER_IN_ERROR_REFER_COMMAND = 143;
+
   CREATE_QUESTIONNAIRE_RESULT = 138;
 
   ANNOTATE_PATIENT_CHART_CONDITION_RESULTS = 200;
@@ -203,6 +209,24 @@ enum EffectType {
   COMMIT_FOLLOW_UP_COMMAND = 908;
   ENTER_IN_ERROR_FOLLOW_UP_COMMAND = 909;
 
+  ORIGINATE_IMAGING_ORDER_COMMAND = 1100;
+  EDIT_IMAGING_ORDER_COMMAND = 1101;
+  DELETE_IMAGING_ORDER_COMMAND = 1102;
+  COMMIT_IMAGING_ORDER_COMMAND = 1103;
+  ENTER_IN_ERROR_IMAGING_ORDER_COMMAND = 1104;
+
+  ORIGINATE_RESOLVE_CONDITION_COMMAND = 1200;
+  EDIT_RESOLVE_CONDITION_COMMAND = 1201;
+  DELETE_RESOLVE_CONDITION_COMMAND = 1202;
+  COMMIT_RESOLVE_CONDITION_COMMAND = 1203;
+  ENTER_IN_ERROR_RESOLVE_CONDITION_COMMAND = 1204;
+
+  ORIGINATE_ADJUST_PRESCRIPTION_COMMAND = 1300;
+  EDIT_ADJUST_PRESCRIPTION_COMMAND = 1301;
+  DELETE_ADJUST_PRESCRIPTION_COMMAND = 1302;
+  COMMIT_ADJUST_PRESCRIPTION_COMMAND = 1303;
+  ENTER_IN_ERROR_ADJUST_PRESCRIPTION_COMMAND = 1304;
+
   SHOW_ACTION_BUTTON = 1000;
 
   PATIENT_PORTAL__INTAKE_FORM_RESULTS = 2000;
@@ -232,4 +256,4 @@ message Effect {
   //Oneof effect_payload {
   //  ...
   //}
-}
+}

protobufs/canvas_generated/messages/events.proto

@@ -136,18 +136,26 @@ enum EventType {
   // ADJUST_DIAGNOSIS_COMMAND__PRE_EXECUTE_ACTION = 1010;
   // ADJUST_DIAGNOSIS_COMMAND__POST_EXECUTE_ACTION = 1011;
 
-  // ADJUST_PRESCRIPTION_COMMAND__PRE_ORIGINATE = 2000;
-  // ADJUST_PRESCRIPTION_COMMAND__POST_ORIGINATE = 2001;
-  // ADJUST_PRESCRIPTION_COMMAND__PRE_UPDATE = 2002;
-  // ADJUST_PRESCRIPTION_COMMAND__POST_UPDATE = 2003;
-  // ADJUST_PRESCRIPTION_COMMAND__PRE_COMMIT = 2004;
-  // ADJUST_PRESCRIPTION_COMMAND__POST_COMMIT = 2005;
-  // ADJUST_PRESCRIPTION_COMMAND__PRE_DELETE = 2006;
-  // ADJUST_PRESCRIPTION_COMMAND__POST_DELETE = 2007;
-  // ADJUST_PRESCRIPTION_COMMAND__PRE_ENTER_IN_ERROR = 2008;
-  // ADJUST_PRESCRIPTION_COMMAND__POST_ENTER_IN_ERROR = 2009;
-  // ADJUST_PRESCRIPTION_COMMAND__PRE_EXECUTE_ACTION = 2010;
-  // ADJUST_PRESCRIPTION_COMMAND__POST_EXECUTE_ACTION = 2011;
+   ADJUST_PRESCRIPTION_COMMAND__PRE_ORIGINATE = 2000;
+   ADJUST_PRESCRIPTION_COMMAND__POST_ORIGINATE = 2001;
+   ADJUST_PRESCRIPTION_COMMAND__PRE_UPDATE = 2002;
+   ADJUST_PRESCRIPTION_COMMAND__POST_UPDATE = 2003;
+   ADJUST_PRESCRIPTION_COMMAND__PRE_COMMIT = 2004;
+   ADJUST_PRESCRIPTION_COMMAND__POST_COMMIT = 2005;
+   ADJUST_PRESCRIPTION_COMMAND__PRE_DELETE = 2006;
+   ADJUST_PRESCRIPTION_COMMAND__POST_DELETE = 2007;
+   ADJUST_PRESCRIPTION_COMMAND__PRE_ENTER_IN_ERROR = 2008;
+   ADJUST_PRESCRIPTION_COMMAND__POST_ENTER_IN_ERROR = 2009;
+   ADJUST_PRESCRIPTION_COMMAND__PRE_EXECUTE_ACTION = 2010;
+   ADJUST_PRESCRIPTION_COMMAND__POST_EXECUTE_ACTION = 2011;
+   ADJUST_PRESCRIPTION__PRESCRIBE__POST_SEARCH = 2012;
+   ADJUST_PRESCRIPTION__PRESCRIBE__PRE_SEARCH = 2013;
+   ADJUST_PRESCRIPTION__INDICATIONS__PRE_SEARCH = 2014;
+   ADJUST_PRESCRIPTION__INDICATIONS__POST_SEARCH = 2015;
+   ADJUST_PRESCRIPTION__PHARMACY__PRE_SEARCH = 2016;
+   ADJUST_PRESCRIPTION__PHARMACY__POST_SEARCH = 2017;
+   ADJUST_PRESCRIPTION__CHANGE_MEDICATION_TO__PRE_SEARCH = 2018;
+   ADJUST_PRESCRIPTION__CHANGE_MEDICATION_TO__POST_SEARCH = 2019;
 
   // ADJUST_PROTOCOL_COMMAND__PRE_ORIGINATE = 3000;
   // ADJUST_PROTOCOL_COMMAND__POST_ORIGINATE = 3001;
@@ -683,18 +691,26 @@ enum EventType {
   REASON_FOR_VISIT__CODING__POST_SEARCH = 35012;
   REASON_FOR_VISIT__CODING__PRE_SEARCH = 35013;
 
-  // REFER_COMMAND__PRE_ORIGINATE = 36000;
-  // REFER_COMMAND__POST_ORIGINATE = 36001;
-  // REFER_COMMAND__PRE_UPDATE = 36002;
-  // REFER_COMMAND__POST_UPDATE = 36003;
-  // REFER_COMMAND__PRE_COMMIT = 36004;
-  // REFER_COMMAND__POST_COMMIT = 36005;
-  // REFER_COMMAND__PRE_DELETE = 36006;
-  // REFER_COMMAND__POST_DELETE = 36007;
-  // REFER_COMMAND__PRE_ENTER_IN_ERROR = 36008;
-  // REFER_COMMAND__POST_ENTER_IN_ERROR = 36009;
-  // REFER_COMMAND__PRE_EXECUTE_ACTION = 36010;
-  // REFER_COMMAND__POST_EXECUTE_ACTION = 36011;
+  REFER_COMMAND__PRE_ORIGINATE = 36000;
+  REFER_COMMAND__POST_ORIGINATE = 36001;
+  REFER_COMMAND__PRE_UPDATE = 36002;
+  REFER_COMMAND__POST_UPDATE = 36003;
+  REFER_COMMAND__PRE_COMMIT = 36004;
+  REFER_COMMAND__POST_COMMIT = 36005;
+  REFER_COMMAND__PRE_DELETE = 36006;
+  REFER_COMMAND__POST_DELETE = 36007;
+  REFER_COMMAND__PRE_ENTER_IN_ERROR = 36008;
+  REFER_COMMAND__POST_ENTER_IN_ERROR = 36009;
+  REFER_COMMAND__PRE_EXECUTE_ACTION = 36010;
+  REFER_COMMAND__POST_EXECUTE_ACTION = 36011;
+  REFER_COMMAND__REFER_TO__POST_SEARCH = 36012;
+  REFER_COMMAND__REFER_TO__PRE_SEARCH = 36013;
+  REFER_COMMAND__INDICATIONS__POST_SEARCH = 36014;
+  REFER_COMMAND__INDICATIONS__PRE_SEARCH = 36015;
+  REFER_COMMAND__DOCUMENTS_TO_INCLUDE__POST_SEARCH = 36016;
+  REFER_COMMAND__DOCUMENTS_TO_INCLUDE__PRE_SEARCH = 36017;
+  REFER_COMMAND__LINKED_ITEMS__POST_SEARCH = 36018;
+  REFER_COMMAND__LINKED_ITEMS_INCLUDE__PRE_SEARCH = 36019;
 
   // REFERENCE_COMMAND__PRE_ORIGINATE = 37000;
   // REFERENCE_COMMAND__POST_ORIGINATE = 37001;
@@ -758,18 +774,20 @@ enum EventType {
   REMOVE_ALLERGY__ALLERGY__PRE_SEARCH = 40012;
   REMOVE_ALLERGY__ALLERGY__POST_SEARCH = 40013;
 
-  // RESOLVE_CONDITION_COMMAND__PRE_ORIGINATE = 41000;
-  // RESOLVE_CONDITION_COMMAND__POST_ORIGINATE = 41001;
-  // RESOLVE_CONDITION_COMMAND__PRE_UPDATE = 41002;
-  // RESOLVE_CONDITION_COMMAND__POST_UPDATE = 41003;
-  // RESOLVE_CONDITION_COMMAND__PRE_COMMIT = 41004;
-  // RESOLVE_CONDITION_COMMAND__POST_COMMIT = 41005;
-  // RESOLVE_CONDITION_COMMAND__PRE_DELETE = 41006;
-  // RESOLVE_CONDITION_COMMAND__POST_DELETE = 41007;
-  // RESOLVE_CONDITION_COMMAND__PRE_ENTER_IN_ERROR = 41008;
-  // RESOLVE_CONDITION_COMMAND__POST_ENTER_IN_ERROR = 41009;
-  // RESOLVE_CONDITION_COMMAND__PRE_EXECUTE_ACTION = 41010;
-  // RESOLVE_CONDITION_COMMAND__POST_EXECUTE_ACTION = 41011;
+  RESOLVE_CONDITION_COMMAND__PRE_ORIGINATE = 41000;
+  RESOLVE_CONDITION_COMMAND__POST_ORIGINATE = 41001;
+  RESOLVE_CONDITION_COMMAND__PRE_UPDATE = 41002;
+  RESOLVE_CONDITION_COMMAND__POST_UPDATE = 41003;
+  RESOLVE_CONDITION_COMMAND__PRE_COMMIT = 41004;
+  RESOLVE_CONDITION_COMMAND__POST_COMMIT = 41005;
+  RESOLVE_CONDITION_COMMAND__PRE_DELETE = 41006;
+  RESOLVE_CONDITION_COMMAND__POST_DELETE = 41007;
+  RESOLVE_CONDITION_COMMAND__PRE_ENTER_IN_ERROR = 41008;
+  RESOLVE_CONDITION_COMMAND__POST_ENTER_IN_ERROR = 41009;
+  RESOLVE_CONDITION_COMMAND__PRE_EXECUTE_ACTION = 41010;
+  RESOLVE_CONDITION_COMMAND__POST_EXECUTE_ACTION = 41011;
+  RESOLVE_CONDITION__CONDITION__PRE_SEARCH = 41012;
+  RESOLVE_CONDITION__CONDITION__POST_SEARCH = 41013;
 
   ROS_COMMAND__PRE_ORIGINATE = 42000;
   ROS_COMMAND__POST_ORIGINATE = 42001;

canvas_sdk/commands/commands/questionnaire.py

@@ -1,16 +0,0 @@
-from pydantic import Field
-
-from canvas_sdk.commands.base import _BaseCommand
-
-
-class QuestionnaireCommand(_BaseCommand):
-    """A class for managing a Questionnaire command within a specific note."""
-
-    class Meta:
-        key = "questionnaire"
-        commit_required_fields = ("questionnaire_id",)
-
-    questionnaire_id: str | None = Field(
-        default=None, json_schema_extra={"commands_api_name": "questionnaire"}
-    )
-    result: str | None = None