canvas 0.2.11__py3-none-any.whl → 0.3.0__py3-none-any.whl

canvas_generated/messages/events_pb2.pyi

@@ -62,6 +62,25 @@ class EventType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     VITAL_SIGN_CREATED: _ClassVar[EventType]
     VITAL_SIGN_UPDATED: _ClassVar[EventType]
     CRON: _ClassVar[EventType]
+    CARE_TEAM_MEMBERSHIP_CREATED: _ClassVar[EventType]
+    CARE_TEAM_MEMBERSHIP_UPDATED: _ClassVar[EventType]
+    CARE_TEAM_MEMBERSHIP_DELETED: _ClassVar[EventType]
+    NOTE_STATE_CHANGE_EVENT_CREATED: _ClassVar[EventType]
+    NOTE_STATE_CHANGE_EVENT_UPDATED: _ClassVar[EventType]
+    PATIENT_ADDRESS_CREATED: _ClassVar[EventType]
+    PATIENT_ADDRESS_UPDATED: _ClassVar[EventType]
+    PATIENT_ADDRESS_DELETED: _ClassVar[EventType]
+    PATIENT_CONTACT_PERSON_CREATED: _ClassVar[EventType]
+    PATIENT_CONTACT_PERSON_UPDATED: _ClassVar[EventType]
+    PATIENT_CONTACT_PERSON_DELETED: _ClassVar[EventType]
+    PATIENT_CONTACT_POINT_CREATED: _ClassVar[EventType]
+    PATIENT_CONTACT_POINT_UPDATED: _ClassVar[EventType]
+    PATIENT_CONTACT_POINT_DELETED: _ClassVar[EventType]
+    PROTOCOL_OVERRIDE_CREATED: _ClassVar[EventType]
+    PROTOCOL_OVERRIDE_UPDATED: _ClassVar[EventType]
+    PROTOCOL_OVERRIDE_DELETED: _ClassVar[EventType]
+    TASK_COMMENT_UPDATED: _ClassVar[EventType]
+    TASK_COMMENT_DELETED: _ClassVar[EventType]
     PRE_COMMAND_ORIGINATE: _ClassVar[EventType]
     POST_COMMAND_ORIGINATE: _ClassVar[EventType]
     PRE_COMMAND_UPDATE: _ClassVar[EventType]
@@ -106,6 +125,18 @@ class EventType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     ASSESS_COMMAND__POST_EXECUTE_ACTION: _ClassVar[EventType]
     ASSESS__CONDITION__POST_SEARCH: _ClassVar[EventType]
     ASSESS__CONDITION__PRE_SEARCH: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__PRE_ORIGINATE: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__POST_ORIGINATE: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__PRE_UPDATE: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__POST_UPDATE: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__PRE_COMMIT: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__POST_COMMIT: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__PRE_DELETE: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__POST_DELETE: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__PRE_ENTER_IN_ERROR: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__POST_ENTER_IN_ERROR: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__PRE_EXECUTE_ACTION: _ClassVar[EventType]
+    CLIPBOARD_COMMAND__POST_EXECUTE_ACTION: _ClassVar[EventType]
     CLOSE_GOAL_COMMAND__PRE_ORIGINATE: _ClassVar[EventType]
     CLOSE_GOAL_COMMAND__POST_ORIGINATE: _ClassVar[EventType]
     CLOSE_GOAL_COMMAND__PRE_UPDATE: _ClassVar[EventType]
@@ -578,6 +609,25 @@ TASK_UPDATED: EventType
 VITAL_SIGN_CREATED: EventType
 VITAL_SIGN_UPDATED: EventType
 CRON: EventType
+CARE_TEAM_MEMBERSHIP_CREATED: EventType
+CARE_TEAM_MEMBERSHIP_UPDATED: EventType
+CARE_TEAM_MEMBERSHIP_DELETED: EventType
+NOTE_STATE_CHANGE_EVENT_CREATED: EventType
+NOTE_STATE_CHANGE_EVENT_UPDATED: EventType
+PATIENT_ADDRESS_CREATED: EventType
+PATIENT_ADDRESS_UPDATED: EventType
+PATIENT_ADDRESS_DELETED: EventType
+PATIENT_CONTACT_PERSON_CREATED: EventType
+PATIENT_CONTACT_PERSON_UPDATED: EventType
+PATIENT_CONTACT_PERSON_DELETED: EventType
+PATIENT_CONTACT_POINT_CREATED: EventType
+PATIENT_CONTACT_POINT_UPDATED: EventType
+PATIENT_CONTACT_POINT_DELETED: EventType
+PROTOCOL_OVERRIDE_CREATED: EventType
+PROTOCOL_OVERRIDE_UPDATED: EventType
+PROTOCOL_OVERRIDE_DELETED: EventType
+TASK_COMMENT_UPDATED: EventType
+TASK_COMMENT_DELETED: EventType
 PRE_COMMAND_ORIGINATE: EventType
 POST_COMMAND_ORIGINATE: EventType
 PRE_COMMAND_UPDATE: EventType
@@ -622,6 +672,18 @@ ASSESS_COMMAND__PRE_EXECUTE_ACTION: EventType
 ASSESS_COMMAND__POST_EXECUTE_ACTION: EventType
 ASSESS__CONDITION__POST_SEARCH: EventType
 ASSESS__CONDITION__PRE_SEARCH: EventType
+CLIPBOARD_COMMAND__PRE_ORIGINATE: EventType
+CLIPBOARD_COMMAND__POST_ORIGINATE: EventType
+CLIPBOARD_COMMAND__PRE_UPDATE: EventType
+CLIPBOARD_COMMAND__POST_UPDATE: EventType
+CLIPBOARD_COMMAND__PRE_COMMIT: EventType
+CLIPBOARD_COMMAND__POST_COMMIT: EventType
+CLIPBOARD_COMMAND__PRE_DELETE: EventType
+CLIPBOARD_COMMAND__POST_DELETE: EventType
+CLIPBOARD_COMMAND__PRE_ENTER_IN_ERROR: EventType
+CLIPBOARD_COMMAND__POST_ENTER_IN_ERROR: EventType
+CLIPBOARD_COMMAND__PRE_EXECUTE_ACTION: EventType
+CLIPBOARD_COMMAND__POST_EXECUTE_ACTION: EventType
 CLOSE_GOAL_COMMAND__PRE_ORIGINATE: EventType
 CLOSE_GOAL_COMMAND__POST_ORIGINATE: EventType
 CLOSE_GOAL_COMMAND__PRE_UPDATE: EventType

canvas_generated/messages/plugins_pb2.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: canvas_generated/messages/plugins.proto
-# Protobuf Python Version: 4.25.0
+# Protobuf Python Version: 4.25.1
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool

canvas_generated/services/plugin_runner_pb2.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: canvas_generated/services/plugin_runner.proto
-# Protobuf Python Version: 4.25.0
+# Protobuf Python Version: 4.25.1
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool

canvas_sdk/base.py

@@ -23,13 +23,13 @@ class Model(BaseModel):
         },
     )
 
-    def _get_effect_method_required_fields(self, method: str) -> tuple[str] | tuple:
+    def _get_effect_method_required_fields(self, method: Any) -> tuple:
         return getattr(self.Meta, f"{method}_required_fields", tuple())
 
     def _create_error_detail(self, type: str, message: str, value: Any) -> InitErrorDetails:
         return InitErrorDetails({"type": PydanticCustomError(type, message), "input": value})
 
-    def _get_error_details(self, method: str) -> list[InitErrorDetails]:
+    def _get_error_details(self, method: Any) -> list[InitErrorDetails]:
         required_fields = self._get_effect_method_required_fields(method)
         class_name = self.__repr_name__()
         class_name_article = "an" if class_name.startswith(("A", "E", "I", "O", "U")) else "a"

canvas_sdk/commands/__init__.py

@@ -11,7 +11,9 @@ from canvas_sdk.commands.commands.instruct import InstructCommand
 from canvas_sdk.commands.commands.lab_order import LabOrderCommand
 from canvas_sdk.commands.commands.medical_history import MedicalHistoryCommand
 from canvas_sdk.commands.commands.medication_statement import MedicationStatementCommand
-from canvas_sdk.commands.commands.past_surgical_history import PastSurgicalHistoryCommand
+from canvas_sdk.commands.commands.past_surgical_history import (
+    PastSurgicalHistoryCommand,
+)
 from canvas_sdk.commands.commands.perform import PerformCommand
 from canvas_sdk.commands.commands.plan import PlanCommand
 from canvas_sdk.commands.commands.prescribe import PrescribeCommand

canvas_sdk/commands/base.py

@@ -2,7 +2,7 @@ import json
 import re
 from enum import EnumType
 from types import NoneType, UnionType
-from typing import Literal, get_args, get_origin, Union
+from typing import Any, Literal, Tuple, Union, get_args, get_origin
 
 from canvas_sdk.base import Model
 from canvas_sdk.commands.constants import Coding
@@ -27,7 +27,7 @@ class _BaseCommand(Model):
 
     def _get_effect_method_required_fields(
         self, method: Literal["originate", "edit", "delete", "commit", "enter_in_error"]
-    ) -> tuple[str]:
+    ) -> tuple:
         base_required_fields: tuple = getattr(
             _BaseCommand.Meta, f"{method}_required_fields", tuple()
         )

canvas_sdk/commands/commands/allergy.py

@@ -7,6 +7,8 @@ from canvas_sdk.commands.base import _BaseCommand as BaseCommand
 
 
 class AllergenType(IntEnum):
+    """An enum representing the type of allergen."""
+
     ALLERGEN_GROUP = 1
     MEDICATION = 2
     INGREDIENT = 6

canvas_sdk/commands/commands/close_goal.py

@@ -3,6 +3,8 @@ from canvas_sdk.commands.commands.goal import GoalCommand
 
 
 class CloseGoalCommand(BaseCommand):
+    """A class for managing a CloseGoal command within a specific note."""
+
     class Meta:
         key = "closeGoal"
         commit_required_fields = ("goal_id",)
@@ -13,6 +15,7 @@ class CloseGoalCommand(BaseCommand):
 
     @property
     def values(self) -> dict:
+        """The CloseGoal command's field values."""
         return {
             "goal_id": self.goal_id,
             "achievement_status": (

canvas_sdk/commands/commands/prescribe.py

@@ -29,9 +29,7 @@ class PrescribeCommand(_BaseCommand):
         NOT_ALLOWED = "not_allowed"
 
     fdb_code: str | None = Field(default=None, json_schema_extra={"commands_api_name": "prescribe"})
-    icd10_codes: conlist(str, max_length=2) = Field(
-        [], json_schema_extra={"commands_api_name": "indications"}
-    )
+    icd10_codes: conlist(str, max_length=2) = Field([], json_schema_extra={"commands_api_name": "indications"})  # type: ignore[valid-type]
     sig: str = ""
     days_supply: int | None = None
     quantity_to_dispense: Decimal | float | int | None = None

canvas_sdk/commands/commands/refill.py

@@ -2,6 +2,7 @@ from canvas_sdk.commands.commands.prescribe import PrescribeCommand
 
 
 class RefillCommand(PrescribeCommand):
+    """A class for managing a Refill command within a specific note."""
 
     class Meta:
         key = "refill"

canvas_sdk/commands/commands/task.py

@@ -1,7 +1,7 @@
 from datetime import date
 from enum import Enum, StrEnum
 
-from typing_extensions import TypedDict, NotRequired
+from typing_extensions import NotRequired, TypedDict
 
 from canvas_sdk.commands.base import _BaseCommand as BaseCommand
 

canvas_sdk/commands/commands/vitals.py

@@ -1,11 +1,13 @@
-from pydantic import conint, constr
-from typing import Optional
 from enum import Enum
+from typing import Optional
+
+from pydantic import conint, constr
 
 from canvas_sdk.commands.base import _BaseCommand as BaseCommand
 
 
 class VitalsCommand(BaseCommand):
+    """A class for managing a Vitals command within a specific note."""
 
     class Meta:
         key = "vitals"
@@ -37,23 +39,24 @@ class VitalsCommand(BaseCommand):
         IRREGULARLY_IRREGULAR = 1
         REGULARLY_IRREGULAR = 2
 
-    height: conint(ge=10, le=108) | None = None
-    weight_lbs: conint(ge=1, le=1500) | None = None
+    height: conint(ge=10, le=108) | None = None  # type: ignore[valid-type]
+    weight_lbs: conint(ge=1, le=1500) | None = None  # type: ignore[valid-type]
     weight_oz: int | None = None
-    waist_circumference: conint(ge=20, le=200) | None = None
-    body_temperature: conint(ge=85, le=107) | None = None
+    waist_circumference: conint(ge=20, le=200) | None = None  # type: ignore[valid-type]
+    body_temperature: conint(ge=85, le=107) | None = None  # type: ignore[valid-type]
     body_temperature_site: BodyTemperatureSite | None = None
-    blood_pressure_systole: conint(ge=30, le=305) | None = None
-    blood_pressure_diastole: conint(ge=20, le=180) | None = None
+    blood_pressure_systole: conint(ge=30, le=305) | None = None  # type: ignore[valid-type]
+    blood_pressure_diastole: conint(ge=20, le=180) | None = None  # type: ignore[valid-type]
     blood_pressure_position_and_site: BloodPressureSite | None = None
-    pulse: conint(ge=30, le=250) | None = None
+    pulse: conint(ge=30, le=250) | None = None  # type: ignore[valid-type]
     pulse_rhythm: PulseRhythm | None = None
-    respiration_rate: conint(ge=6, le=60) | None = None
-    oxygen_saturation: conint(ge=60, le=100) | None = None
-    note: constr(max_length=150) | None = None
+    respiration_rate: conint(ge=6, le=60) | None = None  # type: ignore[valid-type]
+    oxygen_saturation: conint(ge=60, le=100) | None = None  # type: ignore[valid-type]
+    note: constr(max_length=150) | None = None  # type: ignore[valid-type]
 
     @property
     def values(self) -> dict:
+        """The Vitals command's field values."""
         return {
             "height": self.height,
             "weight_lbs": self.weight_lbs,

canvas_sdk/commands/tests/schema/tests.py

@@ -7,7 +7,7 @@ import requests
 
 import settings
 from canvas_sdk.commands.base import _BaseCommand
-from canvas_sdk.commands.constants import Coding, ClinicalQuantity
+from canvas_sdk.commands.constants import ClinicalQuantity, Coding
 from canvas_sdk.commands.tests.test_utils import (
     COMMANDS,
     MaskedValue,

canvas_sdk/commands/tests/test_utils.py

@@ -29,7 +29,7 @@ from canvas_sdk.commands import (
     UpdateGoalCommand,
 )
 from canvas_sdk.commands.base import _BaseCommand
-from canvas_sdk.commands.constants import Coding, ClinicalQuantity
+from canvas_sdk.commands.constants import ClinicalQuantity, Coding
 
 runner = CliRunner()
 
@@ -188,7 +188,9 @@ def raises_none_error_for_effect_method(
         )
 
 
-def write_protocol_code(note_uuid: str, plugin_name: str, commands: list[_BaseCommand]) -> None:
+def write_protocol_code(
+    note_uuid: str, plugin_name: str, commands: list[type[_BaseCommand]]
+) -> None:
     imports = ", ".join([c.__name__ for c in commands])
     effects = ", ".join([f"{c.__name__}(note_uuid='{note_uuid}').originate()" for c in commands])
 

canvas_sdk/data/base.py

@@ -1,13 +1,17 @@
+from typing import Any
+
 from pydantic_core import ValidationError
 
 from canvas_sdk.base import Model
 
 
 class DataModel(Model):
+    """Base class for data models."""
+
     class Meta:
         update_required_fields = ("id",)
 
-    def model_dump_json_nested(self, *args, **kwargs) -> str:
+    def model_dump_json_nested(self, *args: Any, **kwargs: Any) -> str:
         """
         Returns the model's json representation nested in a {"data": {..}} key.
         """

canvas_sdk/data/client.py

@@ -65,7 +65,7 @@ class _CanvasGQLClient:
         self,
         gql_query: str,
         variables: dict[str, Any] | None = None,
-        extra_args: dict[str, Any] | None = None
+        extra_args: dict[str, Any] | None = None,
     ) -> dict[str, Any]:
         if variables is None:
             query_variables = {}

canvas_sdk/data/patient.py

@@ -2,5 +2,7 @@ from canvas_sdk.data import DataModel
 
 
 class Patient(DataModel):
+    """Data model for a patient."""
+
     id: str | None = None
     # TODO - populate more attributes

canvas_sdk/data/staff.py

@@ -2,5 +2,7 @@ from canvas_sdk.data import DataModel
 
 
 class Staff(DataModel):
+    """Data model for a staff member."""
+
     id: str | None = None
     # TODO - populate with first name, last name, additional attributes, etc.

canvas_sdk/data/task.py

@@ -8,6 +8,8 @@ from canvas_sdk.effects import Effect, EffectType
 
 
 class Task(DataModel):
+    """Data model for a task."""
+
     class Meta(DataModel.Meta):
         create_required_fields = ("title",)
 
@@ -26,15 +28,18 @@ class Task(DataModel):
     labels: list[str] | None = None
 
     def create(self) -> Effect:
+        """Return an effect to create the task."""
         self._validate_before_effect("create")
         return Effect(type=EffectType.CREATE_TASK, payload=self.model_dump_json_nested())
 
     def update(self) -> Effect:
+        """Return an effect to update the task."""
         self._validate_before_effect("update")
         payload = self.model_dump_json_nested(exclude_unset=True)
         return Effect(type=EffectType.UPDATE_TASK, payload=payload)
 
     def add_comment(self, comment: str) -> Effect:
+        """Return an effect to add a comment to the task."""
         if not self.id:
             raise ValueError("Cannot add a comment to a Task without an id")
         task_comment = TaskComment(task=self, body=comment)
@@ -46,6 +51,8 @@ class Task(DataModel):
 
 
 class TaskComment(DataModel):
+    """Data model for a task comment."""
+
     class Meta:
         create_required_fields = (
             "body",

canvas_sdk/effects/protocol_card/protocol_card.py

@@ -50,6 +50,7 @@ class ProtocolCard(_BaseEffect):
     narrative: str = ""
     recommendations: list[Recommendation] = []
     status: Status = Status.DUE  # type: ignore
+    feedback_enabled: bool = False
 
     @property
     def values(self) -> dict[str, Any]:
@@ -61,6 +62,7 @@ class ProtocolCard(_BaseEffect):
                 rec.values | {"key": i} for i, rec in enumerate(self.recommendations)
             ],
             "status": self.status.value,
+            "feedback_enabled": self.feedback_enabled,
         }
 
     @property

canvas_sdk/effects/protocol_card/tests.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 import pytest
 from pydantic import ValidationError
 
@@ -23,7 +25,7 @@ def test_apply_method_succeeds_with_patient_id_and_key() -> None:
     applied = p.apply()
     assert (
         applied.payload
-        == '{"patient": "uuid", "key": "something-unique", "data": {"title": "", "narrative": "", "recommendations": [], "status": "due"}}'
+        == '{"patient": "uuid", "key": "something-unique", "data": {"title": "", "narrative": "", "recommendations": [], "status": "due", "feedback_enabled": false}}'
     )
 
 
@@ -105,7 +107,7 @@ def test_apply_method_raises_error_without_patient_id_and_key() -> None:
     ],
 )
 def test_add_recommendations(
-    init_params: dict[str, str], rec1_params: dict[str, str], rec2_params: dict[str, str]
+    init_params: dict[str, str], rec1_params: dict[Any, Any], rec2_params: dict[str, str]
 ) -> None:
     p = ProtocolCard(**init_params)
     p.add_recommendation(**rec1_params)
@@ -133,6 +135,7 @@ def test_add_recommendations(
             },
         ],
         "status": "due",
+        "feedback_enabled": False,
     }
 
 

canvas_sdk/protocols/__init__.py

@@ -1 +1,2 @@
 from canvas_sdk.protocols.base import BaseProtocol
+from canvas_sdk.protocols.clinical_quality_measure import ClinicalQualityMeasure

canvas_sdk/protocols/clinical_quality_measure.py

@@ -14,6 +14,7 @@ class ClinicalQualityMeasure(BaseProtocol):
         description: str = ""
         information: str = ""
         references: list[str] = []
+        source_attributes: dict[str, str]
         types: list[str] = []
         authors: list[str] = []
         show_in_chart: bool = True

canvas_sdk/utils/http.py

@@ -1,6 +1,6 @@
 import time
 from functools import wraps
-from typing import Any, Callable, TypeVar
+from typing import Any, Callable, Mapping, TypeVar
 
 import requests
 import statsd
@@ -16,26 +16,27 @@ class Http:
         self.statsd_client = statsd.StatsClient()
 
     @staticmethod
-    def measure_time(fn: F | None = None) -> Callable[[F], F] | F:
+    def measure_time(fn: F) -> F:
         """A decorator to store timing of HTTP calls."""
 
-        def _decorator(fn: F) -> F:
-            @wraps(fn)
-            def wrapper(self: "Http", *args: Any, **kwargs: Any) -> Any:
-                start_time = time.time()
-                result = fn(self, *args, **kwargs)
-                end_time = time.time()
-                timing = int((end_time - start_time) * 1000)
-                self.statsd_client.timing(f"http_{fn.__name__}", timing)
-                return result
+        @wraps(fn)
+        def wrapper(self: "Http", *args: Any, **kwargs: Any) -> Any:
+            start_time = time.time()
+            result = fn(self, *args, **kwargs)
+            end_time = time.time()
+            timing = int((end_time - start_time) * 1000)
+            self.statsd_client.timing(f"http_{fn.__name__}", timing)
+            return result
 
-            return wrapper
-
-        return _decorator(fn) if fn else _decorator
+        return wrapper
 
     @measure_time
-    def get(self, url: str, headers: dict = {}) -> requests.Response:
+    def get(
+        self, url: str, headers: Mapping[str, str | bytes | None] | None = None
+    ) -> requests.Response:
         """Sends a GET request."""
+        if headers is None:
+            headers = {}
         return self.session.get(url, headers=headers)
 
     @measure_time
@@ -44,7 +45,7 @@ class Http:
         url: str,
         json: dict | None = None,
         data: dict | str | list | bytes | None = None,
-        headers: dict = {},
+        headers: Mapping[str, str | bytes | None] | None = None,
     ) -> requests.Response:
         """Sends a POST request."""
         return self.session.post(url, json=json, data=data, headers=headers)
@@ -55,7 +56,7 @@ class Http:
         url: str,
         json: dict | None = None,
         data: dict | str | list | bytes | None = None,
-        headers: dict = {},
+        headers: Mapping[str, str | bytes | None] | None = None,
     ) -> requests.Response:
         """Sends a PUT request."""
         return self.session.put(url, json=json, data=data, headers=headers)
@@ -66,7 +67,7 @@ class Http:
         url: str,
         json: dict | None = None,
         data: dict | str | list | bytes | None = None,
-        headers: dict = {},
+        headers: Mapping[str, str | bytes | None] | None = None,
     ) -> requests.Response:
         """Sends a PATCH request."""
         return self.session.patch(url, json=json, data=data, headers=headers)

canvas_sdk/utils/stats.py

@@ -2,7 +2,8 @@ from time import time
 from typing import Any
 
 
-def get_duration_ms(start_time: time) -> int:
+def get_duration_ms(start_time: float) -> int:
+    """Get the duration in milliseconds since the given start time."""
     return int((time() - start_time) * 1000)
 
 

canvas_sdk/v1/data/allergy_intolerance.py

@@ -1,7 +1,7 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
-from canvas_sdk.v1.data.base import CommittableModelManager
+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
 
@@ -14,13 +14,12 @@ class AllergyIntolerance(models.Model):
         app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_allergyintolerance_001"
 
-    objects = CommittableModelManager()
+    objects = CommittableModelManager().from_queryset(ValueSetLookupQuerySet)()
 
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()
     modified = models.DateTimeField()
-    editors = ArrayField(models.IntegerField())
     deleted = models.BooleanField()
     committer = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)
     entered_in_error = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)

canvas_sdk/v1/data/base.py

@@ -1,4 +1,5 @@
-from typing import TYPE_CHECKING, Type
+from collections.abc import Container
+from typing import TYPE_CHECKING, Type, cast
 
 from django.db import models
 from django.db.models import Q
@@ -8,19 +9,26 @@ if TYPE_CHECKING:
 
 
 class CommittableModelManager(models.Manager):
+    """A manager for commands that can be committed."""
+
     def get_queryset(self) -> "models.QuerySet":
+        """Return a queryset that filters out deleted objects."""
         # TODO: Should we just filter these out at the view level?
         return super().get_queryset().filter(deleted=False)
 
     def committed(self) -> "models.QuerySet":
+        """Return a queryset that filters for objects that have been committed."""
         # The committer_id IS set, and the entered_in_error_id IS NOT set
         return self.filter(committer_id__isnull=False, entered_in_error_id__isnull=True)
 
     def for_patient(self, patient_id: str) -> "models.QuerySet":
+        """Return a queryset that filters objects for a specific patient."""
         return self.filter(patient__id=patient_id)
 
 
 class ValueSetLookupQuerySet(models.QuerySet):
+    """A QuerySet that can filter objects based on a ValueSet."""
+
     def find(self, value_set: Type["ValueSet"]) -> models.QuerySet:
         """
         Filters conditions, medications, etc. to those found in the inherited ValueSet class that is passed.
@@ -35,13 +43,51 @@ class ValueSetLookupQuerySet(models.QuerySet):
 
         Condition.objects.find(MorbidObesity).find(AnaphylacticReactionToCommonBakersYeast)
         """
-        values_dict = value_set.values
-        uri_codes = [
-            (i[1], values_dict[i[0]])
-            for i in value_set.CODE_SYSTEM_MAPPING.items()
-            if i[0] in values_dict
-        ]
         q_filter = Q()
-        for system, codes in uri_codes:
-            q_filter |= Q(codings__system=system, codings__code__in=codes)
+        for system, codes in self.codings(value_set):
+            q_filter |= self.q_object(system, codes)
         return self.filter(q_filter).distinct()
+
+    @staticmethod
+    def codings(value_set: Type["ValueSet"]) -> tuple[tuple[str, set[str]]]:
+        """Provide a sequence of tuples where each tuple is a code system URL and a set of codes."""
+        values_dict = value_set.values
+        return cast(
+            tuple[tuple[str, set[str]]],
+            tuple(
+                (i[1], values_dict[i[0]])
+                for i in value_set.CODE_SYSTEM_MAPPING.items()
+                if i[0] in values_dict
+            ),
+        )
+
+    @staticmethod
+    def q_object(system: str, codes: Container[str]) -> Q:
+        """
+        This method can be overridden if a Q object with different filtering options is needed.
+        """
+        return Q(codings__system=system, codings_code_in=codes)
+
+
+class ValueSetLookupByNameQuerySet(ValueSetLookupQuerySet):
+    """
+    QuerySet for ValueSet lookups using code system name rather than URL.
+
+    Some models, like Questionnaire, store the code system by name (e.g. "LOINC") rather than by the
+    url (e.g. "http://loinc.org"). This subclass accommodates these models.
+    """
+
+    @staticmethod
+    def codings(value_set: Type["ValueSet"]) -> tuple[tuple[str, set[str]]]:
+        """
+        Provide a sequence of tuples where each tuple is a code system name and a set of codes.
+        """
+        values_dict = value_set.values
+        return cast(
+            tuple[tuple[str, set[str]]],
+            tuple(
+                (i[0], values_dict[i[0]])
+                for i in value_set.CODE_SYSTEM_MAPPING.items()
+                if i[0] in values_dict
+            ),
+        )