canvas 0.34.1__py3-none-any.whl → 0.35.0__py3-none-any.whl

canvas_sdk/base.py

@@ -1,6 +1,7 @@
 from datetime import date, datetime
 from enum import Enum
 from typing import Any
+from uuid import UUID
 
 from pydantic import BaseModel, ConfigDict
 from pydantic_core import InitErrorDetails, PydanticCustomError, ValidationError
@@ -51,3 +52,58 @@ class Model(BaseModel):
         self.model_validate(self)
         if error_details := self._get_error_details(method):
             raise ValidationError.from_exception_data(self.__class__.__name__, error_details)
+
+
+class TrackableFieldsModel(Model):
+    """
+    A base model with additional functionality for tracking modified fields.
+
+    Attributes:
+        _dirty_keys (set[str]): A set to track which fields have been modified.
+    """
+
+    _dirty_excluded_keys: list[str] = [
+        "note_uuid",
+    ]
+
+    _dirty_keys: set[str] = set()
+
+    def __init__(self, /, **data: Any) -> None:
+        """Initialize the command and mark all provided keys as dirty."""
+        super().__init__(**data)
+
+        # Initialize a set to track which fields have been modified.
+        self._dirty_keys = set()
+
+        # Explicitly mark all keys provided in the constructor as dirty.
+        self._dirty_keys.update(data.keys())
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        """Set an attribute and mark it as dirty unless excluded."""
+        if not name.startswith("_") and name not in self._dirty_excluded_keys:
+            self._dirty_keys.add(name)
+        super().__setattr__(name, value)
+
+    def is_dirty(self, key: str) -> bool:
+        """Returns True if the given property has been modified (i.e. marked as dirty), False otherwise."""
+        return key in self._dirty_keys
+
+    @property
+    def values(self) -> dict:
+        """Return a dictionary of modified attributes with type-specific transformations."""
+        result = {}
+        for key in self._dirty_keys:
+            value = getattr(self, key)
+            if isinstance(value, Enum):
+                # If it's an enum, use its .value.
+                result[key] = value.value if value else None
+            elif isinstance(value, date | datetime):
+                # If it's a date/datetime, use isoformat().
+                result[key] = value.isoformat() if value else None
+            elif isinstance(value, UUID):
+                # If it's a UUID, use its string representation.
+                result[key] = str(value) if value else None
+            else:
+                # For strings, integers, or any other type, return as is.
+                result[key] = value
+        return result

canvas_sdk/commands/base.py

@@ -1,18 +1,18 @@
-import datetime
 import json
 import re
-from enum import Enum, EnumType
+from enum import EnumType
 from types import NoneType, UnionType
 from typing import Any, Union, get_args, get_origin
-from uuid import UUID
 
-from canvas_sdk.base import Model
+from django.core.exceptions import ImproperlyConfigured
+
+from canvas_sdk.base import TrackableFieldsModel
 from canvas_sdk.commands.constants import Coding
 from canvas_sdk.effects import Effect
 from canvas_sdk.effects.protocol_card import Recommendation
 
 
-class _BaseCommand(Model):
+class _BaseCommand(TrackableFieldsModel):
     class Meta:
         key = ""
         originate_required_fields = ("note_uuid",)
@@ -21,34 +21,29 @@ class _BaseCommand(Model):
         commit_required_fields = ("command_uuid",)
         enter_in_error_required_fields = ("command_uuid",)
 
-    # A set to track which fields have been modified.
-    _dirty_keys: set[str] = set()
+    _dirty_excluded_keys = [
+        "note_uuid",
+        "command_uuid",
+    ]
 
     def __init__(self, /, **data: Any) -> None:
         """Initialize the command and mark all provided keys as dirty."""
         super().__init__(**data)
 
-        # Initialize a set to track which fields have been modified.
-        self._dirty_keys = set()
-
-        # Explicitly mark all keys provided in the constructor as dirty.
-        self._dirty_keys.update(data.keys())
+    def __init_subclass__(cls, **kwargs: Any) -> None:
+        """Validate that the command has a key and required fields."""
+        if not hasattr(cls.Meta, "key") or not cls.Meta.key:
+            raise ImproperlyConfigured(f"Command {cls.__name__!r} must specify Meta.key.")
 
-    def __setattr__(self, name: str, value: Any) -> None:
-        """Set an attribute and mark it as dirty unless excluded."""
-        if not name.startswith("_") and name not in (
-            "note_uuid",
-            "command_uuid",
-        ):
-            self._dirty_keys.add(name)
-        super().__setattr__(name, value)
+        if hasattr(cls.Meta, "commit_required_fields"):
+            command_fields = set(cls.__pydantic_fields__.keys() | cls.__annotations__.keys())
+            for field in cls.Meta.commit_required_fields:
+                if field not in command_fields:
+                    raise ImproperlyConfigured(f"Command {cls.__name__!r} must specify {field}.")
 
-    def is_dirty(self, key: str) -> bool:
-        """Returns True if the given property has been modified (i.e. marked as dirty), False otherwise."""
-        return key in self._dirty_keys
-
-    def constantized_key(self) -> str:
-        return re.sub(r"(?<!^)(?=[A-Z])", "_", self.Meta.key).upper()
+    @classmethod
+    def constantized_key(cls) -> str:
+        return re.sub(r"(?<!^)(?=[A-Z])", "_", cls.Meta.key).upper()
 
     note_uuid: str | None = None
     command_uuid: str | None = None
@@ -58,26 +53,6 @@ class _BaseCommand(Model):
         command_required_fields = super()._get_effect_method_required_fields(method)
         return tuple(set(base_required_fields) | set(command_required_fields))
 
-    @property
-    def values(self) -> dict:
-        """Return a dictionary of modified attributes with type-specific transformations."""
-        result = {}
-        for key in self._dirty_keys:
-            value = getattr(self, key)
-            if isinstance(value, Enum):
-                # If it's an enum, use its .value.
-                result[key] = value.value if value else None
-            elif isinstance(value, datetime.date | datetime.datetime):
-                # If it's a date/datetime, use isoformat().
-                result[key] = value.isoformat() if value else None
-            elif isinstance(value, UUID):
-                # If it's a UUID, use its string representation.
-                result[key] = str(value) if value else None
-            else:
-                # For strings, integers, or any other type, return as is.
-                result[key] = value
-        return result
-
     @property
     def coding_filter(self) -> Coding | None:
         """The coding filter used for command insertion in protocol cards."""
@@ -115,6 +90,7 @@ class _BaseCommand(Model):
         base_properties = {"note_uuid", "command_uuid"}
         schema = cls.model_json_schema()
         required_fields: tuple = getattr(cls.Meta, "commit_required_fields", ())
+
         return {
             definition.get("commands_api_name", name): {
                 "required": name in required_fields,

canvas_sdk/commands/commands/adjust_prescription.py

@@ -8,16 +8,6 @@ class AdjustPrescriptionCommand(RefillCommand):
 
     class Meta:
         key = "adjustPrescription"
-        commit_required_fields = (
-            "fdb_code",
-            "sig",
-            "quantity_to_dispense",
-            "type_to_dispense",
-            "refills",
-            "substitutions",
-            "prescriber_id",
-            "new_fdb_code",
-        )
 
     new_fdb_code: str | None = Field(
         default=None, json_schema_extra={"commands_api_name": "change_medication_to"}

canvas_sdk/commands/commands/allergy.py

@@ -26,7 +26,6 @@ class AllergyCommand(BaseCommand):
 
     class Meta:
         key = "allergy"
-        commit_required_fields = ("allergy",)
 
     class Severity(Enum):
         MILD = "mild"

canvas_sdk/commands/commands/assess.py

@@ -1,4 +1,5 @@
 from enum import Enum
+from uuid import UUID
 
 from pydantic import Field
 
@@ -10,14 +11,13 @@ class AssessCommand(_BaseCommand):
 
     class Meta:
         key = "assess"
-        commit_required_fields = ("condition_id",)
 
     class Status(Enum):
         IMPROVED = "improved"
         STABLE = "stable"
         DETERIORATED = "deteriorated"
 
-    condition_id: str | None = Field(
+    condition_id: UUID | str | None = Field(
         default=None, json_schema_extra={"commands_api_name": "condition"}
     )
     background: str | None = None

canvas_sdk/commands/commands/change_medication.py

@@ -0,0 +1,58 @@
+from typing import Literal
+
+from pydantic import Field
+from pydantic_core import InitErrorDetails
+
+from canvas_sdk.commands.base import _BaseCommand as BaseCommand
+from canvas_sdk.v1.data import Medication, Note
+
+
+class ChangeMedicationCommand(BaseCommand):
+    """A class for managing a ChangeMedication command within a specific note."""
+
+    class Meta:
+        key = "changeMedication"
+        commit_required_fields = ("medication_id",)
+
+    medication_id: str | None = Field(
+        default=None, json_schema_extra={"commands_api_name": "medication"}
+    )
+    sig: str | None = None
+
+    def _get_error_details(
+        self, method: Literal["originate", "edit", "delete", "commit", "enter_in_error"]
+    ) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        note = None
+
+        if self.note_uuid:
+            note = Note.objects.filter(id=self.note_uuid).first()
+
+            if not note:
+                errors.append(
+                    self._create_error_detail(
+                        "value",
+                        f"note with id {self.note_uuid} not found.",
+                        self.note_uuid,
+                    )
+                )
+
+        if self.medication_id and note:
+            medication = Medication.objects.filter(
+                id=self.medication_id, patient=note.patient
+            ).first()
+
+            if not medication:
+                errors.append(
+                    self._create_error_detail(
+                        "value",
+                        f"Medication with Id {self.medication_id} not found or not associated with the patient.",
+                        self.medication_id,
+                    )
+                )
+
+        return errors
+
+
+__exports__ = ("ChangeMedicationCommand",)

canvas_sdk/commands/commands/close_goal.py

@@ -7,7 +7,6 @@ class CloseGoalCommand(BaseCommand):
 
     class Meta:
         key = "closeGoal"
-        commit_required_fields = ("goal_id",)
 
     goal_id: int | None = None
     achievement_status: GoalCommand.AchievementStatus | None = None

canvas_sdk/commands/commands/diagnose.py

@@ -10,7 +10,6 @@ class DiagnoseCommand(_BaseCommand):
 
     class Meta:
         key = "diagnose"
-        commit_required_fields = ("icd10_code",)
 
     icd10_code: str | None = Field(
         default=None, json_schema_extra={"commands_api_name": "diagnose"}

canvas_sdk/commands/commands/exam.py

@@ -6,7 +6,6 @@ class PhysicalExamCommand(QuestionnaireCommand):
 
     class Meta:
         key = "exam"
-        commit_required_fields = ("questionnaire_id",)
 
 
 __exports__ = ("PhysicalExamCommand",)

canvas_sdk/commands/commands/family_history.py

@@ -6,7 +6,6 @@ class FamilyHistoryCommand(BaseCommand):
 
     class Meta:
         key = "familyHistory"
-        commit_required_fields = ("family_history",)
 
     family_history: str | None = None
     relative: str | None = None

canvas_sdk/commands/commands/follow_up.py

@@ -2,6 +2,7 @@ from datetime import date
 from typing import Literal
 from uuid import UUID
 
+from pydantic import Field
 from pydantic_core import InitErrorDetails
 
 from canvas_sdk.commands.base import _BaseCommand
@@ -14,11 +15,12 @@ class FollowUpCommand(_BaseCommand):
 
     class Meta:
         key = "followUp"
-        commit_required_fields = ("requested_date", "note_type")
 
     structured: bool = False
     requested_date: date | None = None
-    note_type_id: UUID | str | None = None
+    note_type_id: UUID | str | None = Field(
+        default=None, json_schema_extra={"commands_api_name": "note_type"}
+    )
     reason_for_visit: Coding | UUID | str | None = None
     comment: str | None = None
 

canvas_sdk/commands/commands/goal.py

@@ -1,5 +1,7 @@
-from datetime import datetime
-from enum import Enum
+from datetime import date, datetime
+from enum import StrEnum
+
+from pydantic import Field
 
 from canvas_sdk.commands.base import _BaseCommand
 
@@ -9,14 +11,13 @@ class GoalCommand(_BaseCommand):
 
     class Meta:
         key = "goal"
-        commit_required_fields = ("goal_statement", "start_date")
 
-    class Priority(Enum):
+    class Priority(StrEnum):
         HIGH = "high-priority"
         MEDIUM = "medium-priority"
         LOW = "low-priority"
 
-    class AchievementStatus(Enum):
+    class AchievementStatus(StrEnum):
         IN_PROGRESS = "in-progress"
         IMPROVING = "improving"
         WORSENING = "worsening"
@@ -28,8 +29,8 @@ class GoalCommand(_BaseCommand):
         NOT_ATTAINABLE = "not-attainable"
 
     goal_statement: str = ""
-    start_date: datetime = datetime.now()
-    due_date: datetime | None = None
+    start_date: date = Field(default_factory=lambda: datetime.now().date())
+    due_date: date | None = None
     achievement_status: AchievementStatus | None = None
     priority: Priority | None = None
     progress: str | None = None

canvas_sdk/commands/commands/history_present_illness.py

@@ -6,7 +6,6 @@ class HistoryOfPresentIllnessCommand(_BaseCommand):
 
     class Meta:
         key = "hpi"
-        commit_required_fields = ("narrative",)
 
     narrative: str | None = None
 

canvas_sdk/commands/commands/imaging_order.py

@@ -1,5 +1,7 @@
 from enum import Enum
 
+from pydantic import Field
+
 from canvas_sdk.commands.base import _BaseCommand as BaseCommand
 from canvas_sdk.commands.constants import ServiceProvider
 
@@ -9,21 +11,20 @@ class ImagingOrderCommand(BaseCommand):
 
     class Meta:
         key = "imagingOrder"
-        commit_required_fields = (
-            "image_code",
-            "diagnosis_codes",
-            "ordering_provider",
-        )
 
     class Priority(Enum):
         ROUTINE = "Routine"
         URGENT = "Urgent"
 
-    image_code: str | None = None
-    diagnosis_codes: list[str] = []
+    image_code: str | None = Field(default=None, json_schema_extra={"commands_api_name": "image"})
+    diagnosis_codes: list[str] | None = Field(
+        default=None, json_schema_extra={"commands_api_name": "indications"}
+    )
     priority: Priority | None = None
     additional_details: str | None = None
-    service_provider: ServiceProvider | None = None
+    service_provider: ServiceProvider | None = Field(
+        default=None, json_schema_extra={"commands_api_name": "ordering_provider"}
+    )
     comment: str | None = None
     ordering_provider_key: str | None = None
     linked_items_urns: list[str] | None = None

canvas_sdk/commands/commands/instruct.py

@@ -1,3 +1,4 @@
+from pydantic import Field
 from pydantic_core import InitErrorDetails
 
 from canvas_sdk.commands.base import _BaseCommand as BaseCommand
@@ -9,9 +10,8 @@ class InstructCommand(BaseCommand):
 
     class Meta:
         key = "instruct"
-        commit_required_fields = ("instruction",)
 
-    coding: Coding | None = None
+    coding: Coding | None = Field(default=None, json_schema_extra={"commands_api_name": "instruct"})
     comment: str | None = None
 
     def _get_error_details(self, method: str) -> list[InitErrorDetails]:

canvas_sdk/commands/commands/lab_order.py

@@ -2,6 +2,7 @@ from typing import Literal
 from uuid import UUID
 
 from django.db.models.query_utils import Q
+from pydantic import Field
 from pydantic_core import InitErrorDetails
 
 from canvas_sdk.commands.base import _BaseCommand as BaseCommand
@@ -13,17 +14,17 @@ class LabOrderCommand(BaseCommand):
 
     class Meta:
         key = "labOrder"
-        commit_required_fields = (
-            "lab_partner",
-            "tests_order_codes",
-            "ordering_provider",
-            "diagnosis_codes",
-        )
 
     lab_partner: UUID | str | None = None
-    tests_order_codes: list[str] = []
-    ordering_provider_key: str | None = None
-    diagnosis_codes: list[str] = []
+    tests_order_codes: list[str] = Field(
+        default=[], json_schema_extra={"commands_api_name": "tests"}
+    )
+    ordering_provider_key: str | None = Field(
+        default=None, json_schema_extra={"commands_api_name": "ordering_provider"}
+    )
+    diagnosis_codes: list[str] = Field(
+        default=[], json_schema_extra={"commands_api_name": "diagnosis"}
+    )
     fasting_required: bool = False
     comment: str | None = None
 

canvas_sdk/commands/commands/medical_history.py

@@ -10,7 +10,6 @@ class MedicalHistoryCommand(BaseCommand):
 
     class Meta:
         key = "medicalHistory"
-        commit_required_fields = ("past_medical_history",)
 
     past_medical_history: str | None = None
     approximate_start_date: date | None = None

canvas_sdk/commands/commands/medication_statement.py

@@ -8,7 +8,6 @@ class MedicationStatementCommand(_BaseCommand):
 
     class Meta:
         key = "medicationStatement"
-        commit_required_fields = ("fdb_code",)
 
     fdb_code: str | None = Field(
         default=None, json_schema_extra={"commands_api_name": "medication"}

canvas_sdk/commands/commands/past_surgical_history.py

@@ -10,7 +10,6 @@ class PastSurgicalHistoryCommand(BaseCommand):
 
     class Meta:
         key = "surgicalHistory"
-        commit_required_fields = ("past_surgical_history",)
 
     past_surgical_history: str | None = None
     approximate_date: date | None = None

canvas_sdk/commands/commands/perform.py

@@ -1,3 +1,5 @@
+from pydantic import Field
+
 from canvas_sdk.commands.base import _BaseCommand as BaseCommand
 
 
@@ -6,9 +8,8 @@ class PerformCommand(BaseCommand):
 
     class Meta:
         key = "perform"
-        commit_required_fields = ("cpt_code",)
 
-    cpt_code: str | None = None
+    cpt_code: str | None = Field(default=None, json_schema_extra={"commands_api_name": "perform"})
     notes: str | None = None
 
 

canvas_sdk/commands/commands/plan.py

@@ -6,7 +6,6 @@ class PlanCommand(_BaseCommand):
 
     class Meta:
         key = "plan"
-        commit_required_fields = ("narrative",)
 
     narrative: str = ""
 

canvas_sdk/commands/commands/prescribe.py

@@ -12,15 +12,6 @@ class PrescribeCommand(_BaseCommand):
 
     class Meta:
         key = "prescribe"
-        commit_required_fields = (
-            "fdb_code",
-            "sig",
-            "quantity_to_dispense",
-            "type_to_dispense",
-            "refills",
-            "substitutions",
-            "prescriber_id",
-        )
 
     class Substitutions(Enum):
         ALLOWED = "allowed"

canvas_sdk/commands/commands/refer.py

@@ -1,5 +1,7 @@
 from enum import Enum
 
+from pydantic import Field
+
 from canvas_sdk.commands.base import _BaseCommand as BaseCommand
 from canvas_sdk.commands.constants import ServiceProvider
 
@@ -9,12 +11,6 @@ class ReferCommand(BaseCommand):
 
     class Meta:
         key = "refer"
-        commit_required_fields = (
-            "service_provider",
-            "diagnosis_codes",
-            "clinical_question",
-            "notes_to_specialist",
-        )
 
     class ClinicalQuestion(Enum):
         """Clinical question choices."""
@@ -30,8 +26,12 @@ class ReferCommand(BaseCommand):
         ROUTINE = "Routine"
         URGENT = "Urgent"
 
-    service_provider: ServiceProvider | None = None
-    diagnosis_codes: list[str] = []
+    service_provider: ServiceProvider | None = Field(
+        default=None, json_schema_extra={"commands_api_name": "refer_to"}
+    )
+    diagnosis_codes: list[str] = Field(
+        default=[], json_schema_extra={"commands_api_name": "indications"}
+    )
     clinical_question: ClinicalQuestion | None = None
     priority: Priority | None = None
     notes_to_specialist: str | None = None
@@ -44,8 +44,8 @@ class ReferCommand(BaseCommand):
         """The Refer command's field values."""
         values = super().values
 
-        if self.is_dirty("service_provider"):
-            values["service_provider"] = self.service_provider.__dict__
+        if self.service_provider and self.is_dirty("service_provider"):
+            values["service_provider"] = self.service_provider.model_dump()
 
         return values
 

canvas_sdk/commands/commands/refill.py

@@ -12,15 +12,6 @@ class RefillCommand(PrescribeCommand):
 
     class Meta:
         key = "refill"
-        commit_required_fields = (
-            "fdb_code",
-            "sig",
-            "quantity_to_dispense",
-            "type_to_dispense",
-            "refills",
-            "substitutions",
-            "prescriber_id",
-        )
 
     def _get_error_details(
         self, method: Literal["originate", "edit", "delete", "commit", "enter_in_error"]

canvas_sdk/commands/commands/remove_allergy.py

@@ -8,7 +8,6 @@ class RemoveAllergyCommand(BaseCommand):
 
     class Meta:
         key = "removeAllergy"
-        commit_required_fields = ("allergy_id",)
 
     allergy_id: str | None = Field(
         description="The external ID of the allergy to remove.",

canvas_sdk/commands/commands/resolve_condition.py

@@ -14,9 +14,10 @@ class ResolveConditionCommand(BaseCommand):
 
     class Meta:
         key = "resolveCondition"
-        commit_required_fields = ("condition_id",)
 
-    condition_id: UUID | str | None = None
+    condition_id: UUID | str | None = Field(
+        default=None, json_schema_extra={"commands_api_name": "condition"}
+    )
     show_in_condition_list: bool = False
     rationale: str | None = Field(max_length=1024, default=None)
 

canvas_sdk/commands/commands/review_of_systems.py

@@ -6,7 +6,6 @@ class ReviewOfSystemsCommand(QuestionnaireCommand):
 
     class Meta:
         key = "ros"
-        commit_required_fields = ("questionnaire_id",)
 
 
 __exports__ = ("ReviewOfSystemsCommand",)

canvas_sdk/commands/commands/stop_medication.py

@@ -8,7 +8,6 @@ class StopMedicationCommand(_BaseCommand):
 
     class Meta:
         key = "stopMedication"
-        commit_required_fields = ("medication_id",)
 
     # how do we make sure this is a valid medication_id for the patient?
     medication_id: str | None = Field(

canvas_sdk/commands/commands/structured_assessment.py

@@ -6,7 +6,6 @@ class StructuredAssessmentCommand(QuestionnaireCommand):
 
     class Meta:
         key = "structuredAssessment"
-        commit_required_fields = ("questionnaire_id",)
 
 
 __exports__ = ("StructuredAssessmentCommand",)