canvas 0.32.0__py3-none-any.whl → 0.33.1__py3-none-any.whl

canvas_sdk/v1/data/patient.py

@@ -1,4 +1,6 @@
-from typing import TYPE_CHECKING, Any, Self
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
 
 import arrow
 from django.contrib.postgres.fields import ArrayField
@@ -80,11 +82,12 @@ class Patient(models.Model):
     birth_order = models.BigIntegerField()
     default_location_id = models.BigIntegerField()
     default_provider_id = models.BigIntegerField()
+    user = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
 
-    settings: "RelatedManager[PatientSetting]"
+    settings: RelatedManager[PatientSetting]
 
     @classmethod
-    def find(cls, id: str) -> Self:
+    def find(cls, id: str) -> Patient:
         """Find a patient by id."""
         return cls._default_manager.get(id=id)
 
@@ -222,3 +225,17 @@ class PatientSetting(models.Model):
     )
     name = models.CharField()
     value = models.JSONField()
+
+
+__exports__ = (
+    "SexAtBirth",
+    "PatientSettingConstants",
+    "Patient",
+    "PatientContactPoint",
+    "PatientAddress",
+    "PatientExternalIdentifier",
+    "PatientSetting",
+    # not defined here but used by current plugins
+    "ContactPointState",
+    "ContactPointSystem",
+)

canvas_sdk/v1/data/practicelocation.py

@@ -101,3 +101,10 @@ class PracticeLocationSetting(models.Model):
 
     def __str__(self) -> str:
         return self.name
+
+
+__exports__ = (
+    "PracticeLocationPOS",
+    "PracticeLocation",
+    "PracticeLocationSetting",
+)

canvas_sdk/v1/data/protocol_override.py

@@ -67,3 +67,10 @@ class ProtocolOverride(models.Model):
     cycle_quantity = models.IntegerField()
     cycle_unit = models.CharField(choices=IntervalUnit.choices)
     status = models.CharField(choices=Status.choices)
+
+
+__exports__ = (
+    "IntervalUnit",
+    "Status",
+    "ProtocolOverride",
+)

canvas_sdk/v1/data/questionnaire.py

@@ -107,7 +107,7 @@ class Questionnaire(models.Model):
     code_system = models.CharField()
     code = models.CharField()
     search_tags = models.CharField()
-    questions = models.ManyToManyField(Question, through="v1.QuestionnaireQuestionMap")  # type: ignore[misc, var-annotated]
+    questions = models.ManyToManyField(Question, through="v1.QuestionnaireQuestionMap")
     use_in_shx = models.BooleanField()
     carry_forward = models.TextField()
 
@@ -159,9 +159,9 @@ class Interview(models.Model):
     )
     note_id = models.BigIntegerField()
     appointment_id = models.BigIntegerField()
-    questionnaires = models.ManyToManyField(  # type: ignore[var-annotated]
+    questionnaires = models.ManyToManyField(
         Questionnaire,
-        through="v1.InterviewQuestionnaireMap",  # type: ignore[misc]
+        through="v1.InterviewQuestionnaireMap",
     )
     progress_status = models.CharField()
     created = models.DateTimeField()
@@ -210,3 +210,16 @@ class InterviewQuestionResponse(models.Model):
     questionnaire_state = models.TextField()
     interview_state = models.TextField()
     comment = models.CharField()
+
+
+__exports__ = (
+    "ResponseOptionSet",
+    "ResponseOption",
+    "Question",
+    "Questionnaire",
+    "QuestionnaireQuestionMap",
+    "InterviewQuerySet",
+    "Interview",
+    "InterviewQuestionnaireMap",
+    "InterviewQuestionResponse",
+)

canvas_sdk/v1/data/reason_for_visit.py

@@ -20,3 +20,6 @@ class ReasonForVisitSettingCoding(models.Model):
     version = models.CharField()
 
     duration = ArrayField(models.DurationField())
+
+
+__exports__ = ("ReasonForVisitSettingCoding",)

canvas_sdk/v1/data/staff.py

@@ -84,3 +84,6 @@ class StaffContactPoint(models.Model):
     rank = models.IntegerField()
     state = models.CharField(choices=ContactPointState.choices)
     staff = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, related_name="telecom")
+
+
+__exports__ = ("Staff", "StaffContactPoint")

canvas_sdk/v1/data/task.py

@@ -108,3 +108,15 @@ class TaskTaskLabel(models.Model):
     dbid = models.BigIntegerField(primary_key=True)
     task_label = models.ForeignKey(TaskLabel, on_delete=models.DO_NOTHING, null=True)
     task = models.ForeignKey(Task, on_delete=models.DO_NOTHING, null=True)
+
+
+__exports__ = (
+    "TaskType",
+    "EventType",
+    "TaskStatus",
+    "TaskLabelModule",
+    "Task",
+    "TaskComment",
+    "TaskLabel",
+    "TaskTaskLabel",
+)

canvas_sdk/v1/data/team.py

@@ -52,7 +52,7 @@ class Team(models.Model):
     name = models.CharField()
     responsibilities = ArrayField(models.CharField(choices=TeamResponsibility.choices))
     members = models.ManyToManyField(  # type: ignore[var-annotated]
-        "v1.Staff",  # type: ignore[misc]
+        "v1.Staff",
         related_name="teams",
         db_table="canvas_sdk_data_api_team_members_001",
     )
@@ -74,3 +74,10 @@ class TeamContactPoint(models.Model):
     rank = models.IntegerField()
     state = models.CharField(choices=ContactPointState.choices)
     team = models.ForeignKey(Team, on_delete=models.DO_NOTHING, related_name="telecom")
+
+
+__exports__ = (
+    "TeamResponsibility",
+    "Team",
+    "TeamContactPoint",
+)

canvas_sdk/v1/data/user.py

@@ -9,4 +9,8 @@ class CanvasUser(models.Model):
         db_table = "canvas_sdk_data_api_auth_user_001"
 
     dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
-    email = models.CharField()
+    email = models.EmailField(db_column="email")
+    phone_number = models.CharField(db_column="phone_number", max_length=255)
+
+
+__exports__ = ("CanvasUser",)

canvas_sdk/v1/models.py

@@ -2,3 +2,5 @@
 # reasons. For this reason, we import * from data to avoid duplication.
 
 from .data import *  # noqa: F403
+
+__exports__ = ()

canvas_sdk/value_set/__init__.py

@@ -0,0 +1 @@
+__exports__ = ()

canvas_sdk/value_set/_utilities.py

@@ -0,0 +1,16 @@
+from inspect import isclass
+from typing import Any
+
+from canvas_sdk.value_set.value_set import ValueSet
+
+
+def get_overrides(dictionary: dict[str, Any]) -> tuple:
+    """
+    Return the keys that are ValueSets.
+    """
+    return tuple(
+        key for key, value in dictionary.items() if isclass(value) and issubclass(value, ValueSet)
+    )
+
+
+__exports__ = ()

canvas_sdk/value_set/custom.py

@@ -1,3 +1,4 @@
+from canvas_sdk.value_set._utilities import get_overrides
 from canvas_sdk.value_set.value_set import ValueSet
 
 
@@ -1055,3 +1056,6 @@ class DiabetesOtherClassConditionSuspect(ValueSet):
         "L98498",
         "L98499",
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/hcc2018.py

@@ -55367,3 +55367,6 @@ class HCCConditions(ValueSet):
         if icd10 in HCCConditions.LABELS:
             return cast(float, HCCConditions.LABELS[icd10]["CommunityRAF"])
         return 0
+
+
+__exports__ = ("HCCConditions",)

canvas_sdk/value_set/v2022/__init__.py

@@ -0,0 +1 @@
+__exports__ = ()

canvas_sdk/value_set/v2022/adverse_event.py

@@ -31,3 +31,6 @@ class StatinAllergen(ValueSet):
     SNOMEDCT = {
         "372912004",  # Substance with 3-hydroxy-3-methylglutaryl-coenzyme A reductase inhibitor mechanism of action (substance)
     }
+
+
+__exports__ = ("StatinAllergen",)

canvas_sdk/value_set/v2022/allergy.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -230,3 +232,6 @@ class StatinAllergen(ValueSet):
     SNOMEDCT = {
         "372912004",  # Substance with 3-hydroxy-3-methylglutaryl-coenzyme A reductase inhibitor mechanism of action (substance)
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/assessment.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -213,3 +215,6 @@ class HistoryOfHipFractureInParent(ValueSet):
         "445121000124105",  # Family history of paternal hip fracture (situation)
         "445501000124107",  # Family history of hip fracture in parent (situation)
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/communication.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -323,3 +325,6 @@ class ConsultantReport(ValueSet):
         "371531000",  # Report of clinical encounter (record artifact)
         "371545006",  # Confirmatory consultation report (record artifact)
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/condition.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -40652,3 +40654,6 @@ class UrinaryRetention(ValueSet):
         "267064002",  # Retention of urine (disorder)
         "12245681000119103",  # Postprocedural retention of urine (disorder)
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/device.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -172,3 +174,6 @@ class CardiacPacer(ValueSet):
         "360128001",  # Intravenous triggered cardiac pacemaker system (physical object)
         "424921004",  # Permanent cardiac pacemaker, device (physical object)
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/diagnostic_study.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -4965,3 +4967,6 @@ class DexaDualEnergyXrayAbsorptiometry_BoneDensityForUrologyCare(ValueSet):
         "38265-5",  # DXA Radius and Ulna [T-score] Bone density
         "38268-9",  # DXA Skeletal system Views for bone density
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/encounter.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -2562,3 +2564,6 @@ class HospitalServicesForUrologyCare(ValueSet):
         "99283",  # Emergency department visit for the evaluation and management of a patient, which requires these 3 key components: An expanded problem focused history; An expanded problem focused examination; and Medical decision making of moderate complexity. Counseling and/or coordination of care with other physicians, other qualified health care professionals, or agencies are provided consistent with the nature of the problem(s) and the patient's and/or family's needs. Usually, the presenting problem(s) are of moderate severity.
         "99284",  # Emergency department visit for the evaluation and management of a patient, which requires these 3 key components: A detailed history; A detailed examination; and Medical decision making of moderate complexity. Counseling and/or coordination of care with other physicians, other qualified health care professionals, or agencies are provided consistent with the nature of the problem(s) and the patient's and/or family's needs. Usually, the presenting problem(s) are of high severity, and require urgent evaluation by the physician, or other qualified health care professionals but do not pose an immediate significant threat to life or physiologic function.
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/immunization.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -339,3 +341,6 @@ class PneumococcalPolysaccharide23Vaccine(ValueSet):
         "33",  # pneumococcal polysaccharide vaccine, 23 valent
         "109",  # pneumococcal vaccine, unspecified formulation
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/individual_characteristic.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -311,3 +313,6 @@ class White(ValueSet):
     CDCREC = {
         "2106-3",  # White
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/intervention.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -1330,3 +1332,6 @@ class ReferralsWhereWeightAssessmentMayOccur(ValueSet):
         "408289007",  # Refer to weight management program (procedure)
         "416790000",  # Referral for home physical therapy (procedure)
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/laboratory_test.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -1248,3 +1250,6 @@ class HumanImmunodeficiencyVirusHivLaboratoryTestCodesAbAndAg(ValueSet):
         "9669-3",  # HIV 1 p66 Ab [Presence] in Serum by Immunoblot
         "9821-0",  # HIV 1 p24 Ag [Presence] in Serum
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/medication.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -5128,3 +5130,6 @@ class MedicationsForBelowNormalBmi(ValueSet):
         "860221",  # megestrol acetate 40 MG Oral Tablet
         "860225",  # megestrol acetate 40 MG/ML Oral Suspension
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/physical_exam.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -199,3 +201,6 @@ class BmiRatio(ValueSet):
     LOINC = {
         "39156-5",  # Body mass index (BMI) [Ratio]
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/procedure.py

@@ -1,3 +1,5 @@
+from canvas_sdk.value_set._utilities import get_overrides
+
 from ..value_set import ValueSet
 
 
@@ -4037,3 +4039,6 @@ class FluorideVarnishApplicationForChildren(ValueSet):
         "234723000",  # Topical application of fluoride - tooth (procedure)
         "313042009",  # Application of dental fluoride varnish (procedure)
     }
+
+
+__exports__ = get_overrides(locals().copy())

canvas_sdk/value_set/v2022/symptom.py

@@ -174,3 +174,6 @@ class FrailtySymptom(ValueSet):
         "16018431000119109",  # Paresis of right lower limb (finding)
         "16419651000119103",  # Dependence on biphasic positive airway pressure ventilation due to central sleep apnea syndrome (finding)
     }
+
+
+__exports__ = ("FrailtySymptom",)

canvas_sdk/value_set/value_set.py

@@ -110,3 +110,12 @@ class ValueSet(CodeConstantsURLMappingMixin, metaclass=ValueSystems):
             for system in cls.CODE_SYSTEM_MAPPING
             if hasattr(cls, system)
         }
+
+
+__exports__ = (
+    "CodeConstants",
+    "CodeConstantsURLMappingMixin",
+    "CombinedValueSet",
+    "ValueSystems",
+    "ValueSet",
+)

canvas_sdk/views/__init__.py

@@ -0,0 +1 @@
+__exports__ = ()

logger/__init__.py

@@ -1,3 +1,5 @@
 from logger.logger import PluginLogger
 
 log = PluginLogger()
+
+__exports__ = ("log",)

logger/logger.py

@@ -70,3 +70,6 @@ class PluginLogger:
     def critical(self, message: Any) -> None:
         """Logs a critical message."""
         self.logger.critical(message)
+
+
+__exports__ = ()

plugin_runner/aws_headers.py

@@ -20,7 +20,7 @@ def aws_sig_v4_headers(
 ) -> dict[str, str]:
     """Constructs signed headers for use in requests made to AWS."""
     algorithm = "AWS4-HMAC-SHA256"
-    now = datetime.datetime.utcnow()
+    now = datetime.datetime.now(datetime.UTC)
     amzdate = now.strftime("%Y%m%dT%H%M%SZ")
     datestamp = now.strftime("%Y%m%d")
     payload_hash = hashlib.sha256(payload).hexdigest()

plugin_runner/load_all_plugins.py

@@ -0,0 +1,202 @@
+#!/usr/bin/env uv run
+
+import json
+import logging
+import re
+import sys
+import traceback
+from collections import defaultdict
+from contextlib import redirect_stderr, redirect_stdout
+from glob import glob
+from io import StringIO
+from pathlib import Path
+from textwrap import indent
+
+import httpretty
+
+from canvas_generated.messages.events_pb2 import PLUGIN_CREATED
+from canvas_generated.messages.events_pb2 import Event as EventRequest
+from canvas_sdk.events.base import Event
+from canvas_sdk.protocols.base import BaseProtocol
+from canvas_sdk.utils import stats
+from plugin_runner.plugin_runner import LOADED_PLUGINS, load_or_reload_plugin
+
+stats.STATS_ENABLED = False
+
+ORIGINAL_PATH = sys.path.copy()
+
+
+def enable_httpretty() -> None:
+    """
+    Prevent any HTTP requests from being made.
+    """
+    httpretty.enable(verbose=True, allow_net_connect=False)
+
+    for method in [
+        httpretty.GET,
+        httpretty.PUT,
+        httpretty.POST,
+        httpretty.DELETE,
+        httpretty.HEAD,
+        httpretty.PATCH,
+        httpretty.OPTIONS,
+        httpretty.CONNECT,
+    ]:
+        httpretty.register_uri(method, re.compile(r".*"), body="{}")
+
+
+def disable_httpretty() -> None:
+    """
+    Allow normal HTTP activity.
+    """
+    httpretty.disable()
+    httpretty.reset()
+
+
+def main() -> None:
+    """
+    Iterate through all of our plugins to verify they work with this version of the SDK.
+    """
+    if len(sys.argv) < 2:
+        print("You must specify a base path.")
+        sys.exit(1)
+
+    base_path = sys.argv[1]
+
+    for folder in glob(f"{base_path}/**/*"):
+        path = Path(folder)
+
+        if "{{" in folder:
+            print(f"Ignoring templated path: {folder}")
+            continue
+
+        if not path.is_dir():
+            continue
+
+        if not (path / "CANVAS_MANIFEST.json").exists():
+            print(f"Missing CANVAS_MANIFEST.json in {folder}")
+            continue
+
+        sys.path = ORIGINAL_PATH.copy()
+
+        # this makes plugin imports work and mirrors what the plugin_runner does
+        sys.path.append((Path(".") / path.parent).as_posix())
+
+        print(path)
+
+        output = StringIO()
+
+        plugin_runner_logger = logging.getLogger("plugin_runner_logger")
+        old_handlers = plugin_runner_logger.handlers.copy()
+        plugin_runner_logger.handlers = [logging.StreamHandler(output)]
+
+        with redirect_stdout(output), redirect_stderr(output):
+            success = load_or_reload_plugin(path)
+
+        output_string = output.getvalue()
+
+        if not success:
+            print()
+            print(indent(output_string, prefix="    ").rstrip())
+            print()
+
+        plugin_runner_logger.handlers = old_handlers
+
+    enable_httpretty()
+
+    for key, plugin in LOADED_PLUGINS.items():
+        Klass: type[BaseProtocol] = plugin["class"]
+
+        if not hasattr(Klass, "compute") or not callable(Klass.compute):
+            print(f"Skipping {key} due to no compute method")
+
+        event_request = EventRequest(
+            type=PLUGIN_CREATED,
+            context=json.dumps(
+                {
+                    "key": "test",
+                    "fields": {
+                        "coding": {"value": "test"},
+                        "goal_statement": {"value": "test"},
+                        "questionnaire": {"text": "test"},
+                        "medication": {"extra": {"coding": "test"}},
+                        "ordering_provider": {"value": "test"},
+                        "text": "test",
+                    },
+                    "method": "GET",
+                    "note_id": 5,
+                    "note": {
+                        "uuid": "b2bd0672-ab36-4eca-b105-884f976ae810",
+                        "id": "b2bd0672-ab36-4eca-b105-884f976ae810",
+                    },
+                    "path": "https://test",
+                    "patient_id": 5,
+                    "patient": {"id": 5},
+                    "results": [],
+                    "search_term": "test",
+                    "state": "LKD",
+                }
+            ),
+            target="b2bd0672-ab36-4eca-b105-884f976ae810",
+            target_type="Patient",
+        )
+        event = Event(event_request=event_request)
+
+        try:
+            klass = Klass(
+                event=event,
+                secrets=defaultdict(lambda: "test", {"sentinel": True}),
+                environment=defaultdict(lambda: "test", {"sentinel": True}),
+            )
+        except TypeError as e:
+            print(f"Failed to instantiate {key}:", e)
+            continue
+
+        plugin_runner_logger = logging.getLogger("plugin_runner_logger")
+        old_handlers = plugin_runner_logger.handlers.copy()
+        plugin_runner_logger.handlers = [logging.StreamHandler(output)]
+
+        output = StringIO()
+
+        error: Exception | None = None
+
+        try:
+            with redirect_stdout(output), redirect_stderr(output):
+                result = klass.compute()
+        except TypeError as e:
+            error = e
+        except KeyError as e:
+            error = e
+        except Exception as e:
+            error = e
+
+        plugin_runner_logger.handlers = old_handlers
+
+        result_count = len(result)
+        request_count = len(httpretty.latest_requests())
+
+        print(f"{key}: {result_count}/{request_count}")
+
+        if error:
+            print()
+
+            # abbreviate these, they come from not being able to access the database
+            if "fake_getaddrinfo" in str(error):
+                print(indent(str(error), prefix="    ").rstrip())
+            else:
+                print(indent("".join(traceback.format_exception(error)), prefix="    ").rstrip())
+
+            print()
+
+        output_string = output.getvalue()
+
+        if output_string:
+            print()
+            print(indent(output_string, prefix="    ").rstrip())
+            print()
+
+    disable_httpretty()
+
+
+if __name__ == "__main__":
+    main()