canvas 0.8.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

{canvas-0.8.1.dist-info → canvas-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: canvas
-Version: 0.8.1
+Version: 0.9.0
 Summary: SDK to customize event-driven actions in your Canvas instance
 License: MIT
 Author: Canvas Team

{canvas-0.8.1.dist-info → canvas-0.9.0.dist-info}/RECORD

@@ -65,7 +65,7 @@ canvas_cli/apps/emit/event_fixtures/VITAL_SIGN_UPDATED.ndjson,sha256=Er0aUWIYkqb
 canvas_cli/apps/logs/__init__.py,sha256=ehY9SRb6nBw81xZF50yyBlUZJtNR2VeVSNI5sFuWJ7o,64
 canvas_cli/apps/logs/logs.py,sha256=BFpZ-2OF2Rs1EMLePo5UjqC9fKQeqm8qZobNTFNCL_M,1972
 canvas_cli/apps/plugin/__init__.py,sha256=G_nLsu6cdko5OjatnbqUyEboGcNlGGLwpZmCBxMKdfo,236
-canvas_cli/apps/plugin/plugin.py,sha256=i1c4aKNlUrqlvQSz8agIi8aW2wWb8E5t6oh8sOpVJxw,14826
+canvas_cli/apps/plugin/plugin.py,sha256=pAyZQ5mNUkTvvwGLVjr8gW-4BXRh12GgTCSqinTFIb0,14832
 canvas_cli/apps/plugin/tests.py,sha256=SsYeYY25ly9TMn-nkJEZjLaPCyFbT4vs1sN_FnQbJ5U,2746
 canvas_cli/apps/run_plugins/__init__.py,sha256=iAMgX_6D3CdjQodGx_azwhSjouaxquOm8Z8QVXnlTFE,117
 canvas_cli/apps/run_plugins/run_plugins.py,sha256=qsf6-UhFAZpIL-1C50fzSoIwXMsZISxg2fxzM46UHTA,384
@@ -156,7 +156,7 @@ canvas_sdk/handlers/base.py,sha256=7kw95-nYOsphP2_dVoJxBvi2RsuUpwBo5RcKvo924Yw,5
 canvas_sdk/handlers/cron_task.py,sha256=Q4_D3bDKE5hyEpCf0JnGSgZlnLh_g9RSP3oEfIuLJ9Y,945
 canvas_sdk/protocols/__init__.py,sha256=3u9zet5D4DX4V953tLCoN1xhaOhAUCwGwscMv-7IIxo,186
 canvas_sdk/protocols/base.py,sha256=GhFZejVrbMdVQ2LkLlRQh0m0wHA7XSUGD0GA3NyeT8U,153
-canvas_sdk/protocols/clinical_quality_measure.py,sha256=8Z3onmmIA8hW0k8-nierCqahlpGuofT52grAP4Dv2fU,3548
+canvas_sdk/protocols/clinical_quality_measure.py,sha256=39ddtSIBCFB4DF7Kpuh2uDwSxH-mV7sjrsVrQY7tEuo,4835
 canvas_sdk/protocols/timeframe.py,sha256=SlTDhTy0TqPXKS9JZFeTVApQJDf8C-NIRLqFJltB17g,1148
 canvas_sdk/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_sdk/utils/__init__.py,sha256=sFuhqcWvXb2-33FOuXZgWuUeC5jZL2MDoqjGoQZGwd8,60
@@ -171,22 +171,22 @@ canvas_sdk/v1/data/base.py,sha256=ZMZEpwkeg3ewl3QsbPAF7-z1MqqWu5hCR-IibWQCiHI,61
 canvas_sdk/v1/data/billing.py,sha256=w5vK7aWqOGEkgjrzJWTiDsywUdxFdK7naEImZkvKxHk,2040
 canvas_sdk/v1/data/command.py,sha256=z9LHw95Vq8efZE5y9r-Ei-Yzt8qj-o-BE3x9BBb4yPQ,945
 canvas_sdk/v1/data/common.py,sha256=OvF4Oxo3BqE1Cv2lfyA1MXp_q_VHwoihyiJ0ETfa5lY,3459
-canvas_sdk/v1/data/condition.py,sha256=EHDb9o1ixXFLZKODCpp-2Wvhc6OmiA0ENPSzRId6pAU,1858
+canvas_sdk/v1/data/condition.py,sha256=qUiwTf4Le5GIhWRgvXZFsXTS4nH4trNBc2mtJsO12FQ,1858
 canvas_sdk/v1/data/detected_issue.py,sha256=c1rKZuPV_tTp_1yDJJa88gIsixpPV_F-a3eooje8BW8,1710
 canvas_sdk/v1/data/device.py,sha256=uxeQRT8ljzBmDwsARFDB9MZKAVAKOA-pu4nAa6fcHeU,1655
 canvas_sdk/v1/data/imaging.py,sha256=z6CtVcBYv8EL7fxzT0pWPUuh1mt5XFPlRDNNbOjvLng,4303
-canvas_sdk/v1/data/lab.py,sha256=nGV2FGDtnj7NcO8WS5LRXv5JUiLjuWMtm0i-PUNsKLk,10313
+canvas_sdk/v1/data/lab.py,sha256=9_yZAX_JQRWRkdjegivpAd3NAlZ_pV-t6eehPKXhJKU,10909
 canvas_sdk/v1/data/medication.py,sha256=PGOOTnhrPSSExSuQJyIdsDLSg09riMb2usvpRmcUo7s,1998
 canvas_sdk/v1/data/note.py,sha256=cC0fifgVby04YcjuOAVycpfsDGIGaJ8_INFRXQID2wU,6607
 canvas_sdk/v1/data/observation.py,sha256=BftaK7tOZaTlfUKoTH_A-X23J4DUFRVWpvZhkBJ1DJg,3710
-canvas_sdk/v1/data/patient.py,sha256=0OB07_w2DoAYwCFU0mIZ2KDqcM5uwTG9wyhEOepd2pQ,2729
+canvas_sdk/v1/data/patient.py,sha256=iUSTAsEB_cVEUP12mkvJ7J5DkYhUZWmHTDw4JPdB6pc,3090
 canvas_sdk/v1/data/protocol_override.py,sha256=Dra2qf5-VX7qsK5mWy6U5XU7Y9v4NGkobRU4BAeAxkU,1835
 canvas_sdk/v1/data/questionnaire.py,sha256=8RIX_YtxCZd2NK9hK41ehywHA5vHks1wqigZf5LHPvI,6908
 canvas_sdk/v1/data/staff.py,sha256=J-U5NeKH-P41ph6pWiTd5v-QYQHV0GmvxxGVVUUf1nc,2786
 canvas_sdk/v1/data/task.py,sha256=9N66XL4B51rla4Q-Tn7STIGvR5Qr6-DNqfMYnT6t8yE,3585
 canvas_sdk/v1/data/user.py,sha256=DmA8fNNGwiNOmuR-RYxQw1NpxN5yYhgwtRtRBRJ_22g,309
 canvas_sdk/value_set/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-canvas_sdk/value_set/custom.py,sha256=33ceZ416kJ4sftqMGTQVUpmfMyydSl51gpxmmilM6F0,17842
+canvas_sdk/value_set/custom.py,sha256=0xzGP86ioCGcsx8wwf46SXfe9IefLSGVq7Z4yrHbEUU,19709
 canvas_sdk/value_set/tests/test_value_sets.py,sha256=ZoDdR6npR9L8h7qGdQj3B7lRghHI3PBV3klRDYV7wak,3116
 canvas_sdk/value_set/v2022/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 canvas_sdk/value_set/v2022/adverse_event.py,sha256=8zsNFBsLDRY0mrPomzogD-W15xyo2CFFkiEcT2ruGCg,1032
@@ -250,7 +250,7 @@ plugin_runner/tests/test_sandbox.py,sha256=I44rz0sbxqtWm6mAG8fGhneE1yu9M-K3PMkE4
 pubsub/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pubsub/pubsub.py,sha256=pyTW0JU8mtaqiAV6g6xjZwel1CVy2EonPMU-_vkmhUM,1044
 settings.py,sha256=6YTybI0eNeuDamnXdRrEUOBICf9bM1uW1lCwj4IR9sU,2081
-canvas-0.8.1.dist-info/METADATA,sha256=oRCTBDikhw0IZcizZpGWXye9dYRtt0cKV_gk2snL3BE,4663
-canvas-0.8.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-canvas-0.8.1.dist-info/entry_points.txt,sha256=VSmSo1IZ3aEfL7enmLmlWSraS_IIkoXNVeyXzgRxFiY,46
-canvas-0.8.1.dist-info/RECORD,,
+canvas-0.9.0.dist-info/METADATA,sha256=of4-iMy4Axlmd6WC0hOlBCdQVVoNmTxYnTmxi1rHkHc,4663
+canvas-0.9.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+canvas-0.9.0.dist-info/entry_points.txt,sha256=VSmSo1IZ3aEfL7enmLmlWSraS_IIkoXNVeyXzgRxFiY,46
+canvas-0.9.0.dist-info/RECORD,,

canvas_cli/apps/plugin/plugin.py

@@ -54,7 +54,7 @@ def _build_package(package: Path) -> Path:
 def _get_name_from_metadata(host: str, token: str, package: Path) -> str | None:
     """Extract metadata from a provided package and return the package name if it exists in the metadata."""
     try:
-        with open(package) as package_file:
+        with open(package, "rb") as package_file:
             metadata_response = requests.post(
                 plugin_url(host, "extract-metadata"),
                 headers={"Authorization": f"Bearer {token}"},

canvas_sdk/protocols/clinical_quality_measure.py

@@ -1,13 +1,18 @@
-from typing import Any, cast
+from typing import TYPE_CHECKING, Any, cast
 
 import arrow
-from django.db.models import Model
 
 from canvas_sdk.events import EventType
 from canvas_sdk.protocols.base import BaseProtocol
 from canvas_sdk.protocols.timeframe import Timeframe
+from canvas_sdk.v1.data import Patient
 from canvas_sdk.v1.data.condition import Condition
+from canvas_sdk.v1.data.lab import LabOrder, LabReport
 from canvas_sdk.v1.data.medication import Medication
+from canvas_sdk.v1.data.protocol_override import ProtocolOverride
+
+if TYPE_CHECKING:
+    from django.db.models import Model
 
 
 class ClinicalQualityMeasure(BaseProtocol):
@@ -54,6 +59,19 @@ class ClinicalQualityMeasure(BaseProtocol):
         """
         return cls.__name__
 
+    @staticmethod
+    def relative_float(value: str) -> float:
+        """Relative float method (better explanation needed here)."""
+        try:
+            sigma = 0.0
+            if value[0] == "<" and value[1] != "=":
+                sigma = -1e-6
+            elif value[0] == ">" and value[1] != "=":
+                sigma = +1e-6
+            return float(value.strip("<≤=≥>")) + sigma
+        except (ValueError, IndexError):
+            return 0
+
     @property
     def timeframe(self) -> Timeframe:
         """The default Timeframe (self.timeframe) for all protocols.
@@ -74,27 +92,41 @@ class ClinicalQualityMeasure(BaseProtocol):
         incurring more SQL queries.
         """
 
-        def patient_id(model: type[Model]) -> str:
-            return cast(
-                str,
-                model._default_manager.select_related("patient")
-                .values_list("patient__id")
-                .get(id=self.event.target)[0],
-            )
+        def patient_id(model: "type[Model]") -> str:
+            if model == Patient:
+                return self.target
+            else:
+                return cast(
+                    str,
+                    model._default_manager.select_related("patient")
+                    .values_list("patient__id")
+                    .get(id=self.event.target)[0],
+                )
+
+        models = {
+            EventType.CONDITION_ASSESSED: Condition,
+            EventType.CONDITION_CREATED: Condition,
+            EventType.CONDITION_RESOLVED: Condition,
+            EventType.CONDITION_UPDATED: Condition,
+            EventType.LAB_ORDER_CREATED: LabOrder,
+            EventType.LAB_ORDER_UPDATED: LabOrder,
+            EventType.LAB_REPORT_CREATED: LabReport,
+            EventType.LAB_REPORT_UPDATED: LabReport,
+            EventType.MEDICATION_LIST_ITEM_CREATED: Medication,
+            EventType.MEDICATION_LIST_ITEM_UPDATED: Medication,
+            EventType.PATIENT_CREATED: Patient,
+            EventType.PATIENT_UPDATED: Patient,
+            EventType.PROTOCOL_OVERRIDE_CREATED: ProtocolOverride,
+            EventType.PROTOCOL_OVERRIDE_DELETED: ProtocolOverride,
+            EventType.PROTOCOL_OVERRIDE_UPDATED: ProtocolOverride,
+        }
 
         if not self._patient_id:
-            # TODO: Add cases for ProtocolOverride
-            match self.event.type:
-                case EventType.CONDITION_CREATED | EventType.CONDITION_UPDATED:
-                    self._patient_id = patient_id(Condition)
-                case (
-                    EventType.MEDICATION_LIST_ITEM_CREATED
-                    | EventType.MEDICATION_LIST_ITEM_UPDATED
-                ):
-                    self._patient_id = patient_id(Medication)
-                case _:
-                    raise AssertionError(
-                        f"Event type {self.event.type} not supported by 'patient_id_from_event'"
-                    )
+            try:
+                self._patient_id = patient_id(models[self.event.type])
+            except KeyError as error:
+                raise ValueError(
+                    f"Event type {self.event.type} not supported by 'patient_id_from_event'"
+                ) from error
 
         return self._patient_id

canvas_sdk/v1/data/condition.py

@@ -34,13 +34,13 @@ class Condition(models.Model):
 
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
-    onset_date = models.DateField()
-    resolution_date = models.DateField()
-    clinical_status = models.CharField(choices=ClinicalStatus.choices)
     deleted = models.BooleanField()
     entered_in_error = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)
     committer = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)
     patient = models.ForeignKey(Patient, on_delete=models.DO_NOTHING, related_name="conditions")
+    onset_date = models.DateField()
+    resolution_date = models.DateField()
+    clinical_status = models.CharField(choices=ClinicalStatus.choices)
 
 
 class ConditionCoding(models.Model):

canvas_sdk/v1/data/lab.py

@@ -1,6 +1,10 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import CommittableModelManager
+from canvas_sdk.v1.data.base import (
+    CommittableModelManager,
+    TimeframeLookupQuerySetMixin,
+    ValueSetLookupQuerySet,
+)
 from canvas_sdk.v1.data.condition import Condition
 from canvas_sdk.v1.data.patient import Patient
 
@@ -79,6 +83,21 @@ class LabReview(models.Model):
     patient_communication_method = models.CharField()
 
 
+class LabValueTimeframeLookupQuerySetMixin(TimeframeLookupQuerySetMixin):
+    """A class that adds queryset functionality to filter using timeframes."""
+
+    @property
+    def timeframe_filter_field(self) -> str:
+        """Returns the field that should be filtered on. Can be overridden for different models."""
+        return "report__original_date"
+
+
+class LabValueQuerySet(ValueSetLookupQuerySet, LabValueTimeframeLookupQuerySetMixin):
+    """LabValueQuerySet."""
+
+    pass
+
+
 class LabValue(models.Model):
     """A class representing a lab value."""
 
@@ -87,6 +106,8 @@ class LabValue(models.Model):
         app_label = "canvas_sdk"
         db_table = "canvas_sdk_data_api_labvalue_001"
 
+    objects = LabValueQuerySet.as_manager()
+
     id = models.UUIDField()
     dbid = models.BigIntegerField(primary_key=True)
     created = models.DateTimeField()

canvas_sdk/v1/data/patient.py

@@ -1,7 +1,19 @@
 from typing import Self
 
 import arrow
+from django.contrib.postgres.fields import ArrayField
 from django.db import models
+from django.db.models import TextChoices
+
+
+class SexAtBirth(TextChoices):
+    """SexAtBirth."""
+
+    FEMALE = "F", "female"
+    MALE = "M", "male"
+    OTHER = "O", "other"
+    UNKNOWN = "UNK", "unknown"
+    BLANK = "", ""
 
 
 class Patient(models.Model):
@@ -17,7 +29,7 @@ class Patient(models.Model):
     first_name = models.CharField()
     last_name = models.CharField()
     birth_date = models.DateField()
-    sex_at_birth = models.CharField()
+    sex_at_birth = models.CharField(choices=SexAtBirth.choices)
     created = models.DateTimeField()
     modified = models.DateTimeField()
     prefix = models.CharField()
@@ -30,6 +42,7 @@ class Patient(models.Model):
     gender_identity_term = models.CharField()
     gender_identity_code = models.CharField()
     preferred_pronouns = models.CharField()
+    biological_race_codes = ArrayField(models.CharField())
     last_known_timezone = models.CharField()
     mrn = models.CharField()
     active = models.BooleanField()

canvas_sdk/value_set/custom.py

@@ -181,6 +181,89 @@ class Antiarrhythmics(ValueSet):
     }
 
 
+class LabReportCreatinine(ValueSet):
+    """LabReportCreatinine."""
+
+    VALUE_SET_NAME = "Lab Report Creatinine"
+    EXPANSION_VERSION = "CanvasHCC Update 2018-10-04"
+
+    LOINC = {
+        "2160-0",
+    }
+
+
+class HypertensiveChronicKidneyDisease(ValueSet):
+    """
+    **Clinical Focus:** This value set contains concepts that represent hypertensive kidney disease.
+
+    **Data Element Scope:** This value set may use the Quality Data Model (QDM) category related to Diagnosis.
+
+    **Inclusion Criteria:** Includes only relevant concepts associated with hypertensive kidney disease.
+
+    **Exclusion Criteria:** No exclusions.
+    """
+
+    OID = "2.16.840.1.113883.3.464.1003.109.12.1017"
+    VALUE_SET_NAME = "Hypertensive Chronic Kidney Disease"
+    EXPANSION_VERSION = "eCQM Update 2020-05-07"
+
+    ICD10CM = {"I120", "I129", "I130", "I1310", "I1311", "I132", "I150", "I151"}
+
+    ICD9CM = {
+        "40301",
+        "40310",
+        "40311",
+        "40390",
+        "40391",
+        "40400",
+        "40401",
+        "40402",
+        "40403",
+        "40410",
+        "40411",
+        "40412",
+        "40413",
+        "40490",
+        "40491",
+        "40492",
+        "40493",
+    }
+
+    SNOMEDCT = {
+        "111438007",
+        "123799005",
+        "123800009",
+        "14973001",
+        "193003",
+        "194774006",
+        "194783001",
+        "19769006",
+        "23130000",
+        "28119000",
+        "285831000119108",
+        "285841000119104",
+        "286371000119107",
+        "32916005",
+        "38481006",
+        "39018007",
+        "397748008",
+        "427889009",
+        "428575007",
+        "473392002",
+        "49220004",
+        "57684003",
+        "62240004",
+        "65443008",
+        "66052004",
+        "66610008",
+        "73410007",
+        "78544004",
+        "81363003",
+        "86234004",
+        "90493000",
+    }
+
+
 class DiabetesWithoutComplication(ValueSet):
     """Diabetes Without Complication."""