canvas 0.20.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

canvas_sdk/commands/commands/refill.py

@@ -1,4 +1,10 @@
+from typing import Literal
+
+from django.db.models.expressions import Subquery
+from pydantic_core import InitErrorDetails
+
 from canvas_sdk.commands.commands.prescribe import PrescribeCommand
+from canvas_sdk.v1.data import Medication, Note
 
 
 class RefillCommand(PrescribeCommand):
@@ -15,3 +21,25 @@ class RefillCommand(PrescribeCommand):
             "substitutions",
             "prescriber_id",
         )
+
+    def _get_error_details(
+        self, method: Literal["originate", "edit", "delete", "commit", "enter_in_error"]
+    ) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        if self.fdb_code:
+            subquery = Subquery(Note.objects.filter(id=self.note_uuid).values("patient_id")[:1])
+            if (
+                not Medication.objects.active()
+                .filter(codings__code=self.fdb_code, patient=subquery)
+                .exists()
+            ):
+                errors.append(
+                    self._create_error_detail(
+                        "value",
+                        f"Medication with fdb_code {self.fdb_code} does not exist.",
+                        self.fdb_code,
+                    )
+                )
+
+        return errors

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/effects/billing_line_item/__init__.py

@@ -0,0 +1,11 @@
+from canvas_sdk.effects.billing_line_item.add_billing_line_item import (
+    AddBillingLineItem,
+)
+from canvas_sdk.effects.billing_line_item.remove_billing_line_item import (
+    RemoveBillingLineItem,
+)
+from canvas_sdk.effects.billing_line_item.update_billing_line_item import (
+    UpdateBillingLineItem,
+)
+
+__all__ = ("AddBillingLineItem", "UpdateBillingLineItem", "RemoveBillingLineItem")

canvas_sdk/effects/billing_line_item/add_billing_line_item.py

@@ -0,0 +1,38 @@
+from typing import Any
+
+from canvas_sdk.commands.constants import Coding
+from canvas_sdk.effects.base import EffectType, _BaseEffect
+
+
+class AddBillingLineItem(_BaseEffect):
+    """
+    An Effect that will result in a billing line item in a note footer.
+    """
+
+    class Meta:
+        effect_type = EffectType.ADD_BILLING_LINE_ITEM
+        apply_required_fields = ("note_id", "cpt")
+
+    note_id: str | None = None
+    cpt: str | None = None
+    units: int | None = 1
+    assessment_ids: list[str] = []
+    modifiers: list[Coding] = []
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """The BillingLineItem's values."""
+        return {
+            "cpt": self.cpt,
+            "units": self.units,
+            "assessment_ids": self.assessment_ids,
+            "modifiers": self.modifiers,
+        }
+
+    @property
+    def effect_payload(self) -> dict[str, Any]:
+        """The payload of the effect."""
+        return {
+            "note_id": self.note_id,
+            "data": self.values,
+        }

canvas_sdk/effects/billing_line_item/remove_billing_line_item.py

@@ -0,0 +1,22 @@
+from typing import Any
+
+from canvas_sdk.effects.base import EffectType, _BaseEffect
+
+
+class RemoveBillingLineItem(_BaseEffect):
+    """
+    An Effect that will remove a billing line item in a note footer.
+    """
+
+    class Meta:
+        effect_type = EffectType.REMOVE_BILLING_LINE_ITEM
+        apply_required_fields = ("billing_line_item_id",)
+
+    billing_line_item_id: str | None = None
+
+    @property
+    def effect_payload(self) -> dict[str, Any]:
+        """The payload of the effect."""
+        return {
+            "billing_line_item_id": self.billing_line_item_id,
+        }

canvas_sdk/effects/billing_line_item/update_billing_line_item.py

@@ -0,0 +1,44 @@
+from typing import Any
+
+from canvas_sdk.commands.constants import Coding
+from canvas_sdk.effects.base import EffectType, _BaseEffect
+
+
+class UpdateBillingLineItem(_BaseEffect):
+    """
+    An Effect that will update a billing line item in a note footer.
+    """
+
+    class Meta:
+        effect_type = EffectType.UPDATE_BILLING_LINE_ITEM
+        apply_required_fields = ("billing_line_item_id",)
+
+    billing_line_item_id: str | None = None
+    cpt: str | None = None
+    units: int | None = None
+    assessment_ids: list[str] | None = None
+    modifiers: list[Coding] | None = None
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """The BillingLineItem's values."""
+        values: dict[str, str | int | list] = {}
+        # only include the values where a value has been set so as to not unintentionally override existing values
+        if self.cpt is not None:
+            values["cpt"] = self.cpt
+        if self.units is not None:
+            values["units"] = self.units
+        if self.assessment_ids is not None:
+            values["assessment_ids"] = self.assessment_ids
+        if self.modifiers is not None:
+            values["modifiers"] = self.modifiers
+
+        return values
+
+    @property
+    def effect_payload(self) -> dict[str, Any]:
+        """The payload of the effect."""
+        return {
+            "billing_line_item_id": self.billing_line_item_id,
+            "data": self.values,
+        }

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)

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;
@@ -217,6 +241,10 @@ enum EffectType {
   PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__PRE_SEARCH_RESULTS = 2010;
   PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__POST_SEARCH_RESULTS = 2011;
 
+  ADD_BILLING_LINE_ITEM = 2030;
+  UPDATE_BILLING_LINE_ITEM = 2031;
+  REMOVE_BILLING_LINE_ITEM = 2032;
+
   LAUNCH_MODAL = 3000;
 }
 
@@ -228,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