canvas 0.45.0__py3-none-any.whl → 0.47.0__py3-none-any.whl

canvas_generated/messages/events_pb2.pyi

@@ -55,6 +55,8 @@ class EventType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     PRESCRIPTION_UPDATED: _ClassVar[EventType]
     REFERRAL_REPORT_CREATED: _ClassVar[EventType]
     REFERRAL_REPORT_UPDATED: _ClassVar[EventType]
+    STAFF_CREATED: _ClassVar[EventType]
+    STAFF_UPDATED: _ClassVar[EventType]
     TASK_COMMENT_CREATED: _ClassVar[EventType]
     TASK_CREATED: _ClassVar[EventType]
     TASK_LABELS_ADJUSTED: _ClassVar[EventType]
@@ -91,6 +93,8 @@ class EventType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     TASK_COMPLETED: _ClassVar[EventType]
     DETECTED_ISSUE_EVIDENCE_CREATED: _ClassVar[EventType]
     DETECTED_ISSUE_EVIDENCE_UPDATED: _ClassVar[EventType]
+    STAFF_ACTIVATED: _ClassVar[EventType]
+    STAFF_DEACTIVATED: _ClassVar[EventType]
     PRE_COMMAND_ORIGINATE: _ClassVar[EventType]
     POST_COMMAND_ORIGINATE: _ClassVar[EventType]
     PRE_COMMAND_UPDATE: _ClassVar[EventType]
@@ -842,6 +846,11 @@ class EventType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     PATIENT_EXTERNAL_IDENTIFIER_CREATED: _ClassVar[EventType]
     PATIENT_EXTERNAL_IDENTIFIER_UPDATED: _ClassVar[EventType]
     PATIENT_EXTERNAL_IDENTIFIER_DELETED: _ClassVar[EventType]
+    PATIENT_METADATA_CREATED: _ClassVar[EventType]
+    PATIENT_METADATA_UPDATED: _ClassVar[EventType]
+    DOCUMENT_REFERENCE_CREATED: _ClassVar[EventType]
+    DOCUMENT_REFERENCE_UPDATED: _ClassVar[EventType]
+    DOCUMENT_REFERENCE_DELETED: _ClassVar[EventType]
 UNKNOWN: EventType
 ALLERGY_INTOLERANCE_CREATED: EventType
 ALLERGY_INTOLERANCE_UPDATED: EventType
@@ -888,6 +897,8 @@ PRESCRIPTION_CREATED: EventType
 PRESCRIPTION_UPDATED: EventType
 REFERRAL_REPORT_CREATED: EventType
 REFERRAL_REPORT_UPDATED: EventType
+STAFF_CREATED: EventType
+STAFF_UPDATED: EventType
 TASK_COMMENT_CREATED: EventType
 TASK_CREATED: EventType
 TASK_LABELS_ADJUSTED: EventType
@@ -924,6 +935,8 @@ TASK_CLOSED: EventType
 TASK_COMPLETED: EventType
 DETECTED_ISSUE_EVIDENCE_CREATED: EventType
 DETECTED_ISSUE_EVIDENCE_UPDATED: EventType
+STAFF_ACTIVATED: EventType
+STAFF_DEACTIVATED: EventType
 PRE_COMMAND_ORIGINATE: EventType
 POST_COMMAND_ORIGINATE: EventType
 PRE_COMMAND_UPDATE: EventType
@@ -1675,6 +1688,11 @@ PATIENT_METADATA__GET_ADDITIONAL_FIELDS: EventType
 PATIENT_EXTERNAL_IDENTIFIER_CREATED: EventType
 PATIENT_EXTERNAL_IDENTIFIER_UPDATED: EventType
 PATIENT_EXTERNAL_IDENTIFIER_DELETED: EventType
+PATIENT_METADATA_CREATED: EventType
+PATIENT_METADATA_UPDATED: EventType
+DOCUMENT_REFERENCE_CREATED: EventType
+DOCUMENT_REFERENCE_UPDATED: EventType
+DOCUMENT_REFERENCE_DELETED: EventType
 
 class Event(_message.Message):
     __slots__ = ("type", "target", "context", "target_type")

canvas_sdk/commands/commands/exam.py

@@ -1,7 +1,8 @@
 from canvas_sdk.commands.commands.questionnaire import QuestionnaireCommand
+from canvas_sdk.commands.commands.questionnaire.toggle_questions import ToggleQuestionsMixin
 
 
-class PhysicalExamCommand(QuestionnaireCommand):
+class PhysicalExamCommand(ToggleQuestionsMixin, QuestionnaireCommand):
     """A class for managing physical exam command."""
 
     class Meta:

canvas_sdk/commands/commands/immunization_statement.py

@@ -0,0 +1,32 @@
+from datetime import date
+
+from pydantic_core import InitErrorDetails
+
+from canvas_sdk.commands.base import _BaseCommand as BaseCommand
+
+
+class ImmunizationStatementCommand(BaseCommand):
+    """A class for managing an ImmunizationStatement command within a specific note."""
+
+    class Meta:
+        key = "immunizationStatement"
+
+    cpt_code: str
+    cvx_code: str
+    approximate_date: date | None = None
+    comments: str | None = None
+
+    def _get_error_details(self, method: str) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        if self.comments and len(self.comments) > 255:
+            errors.append(
+                self._create_error_detail(
+                    "comments", "Comments must be 255 characters or less.", self.comments
+                )
+            )
+
+        return errors
+
+
+__exports__ = ("ImmunizationStatementCommand",)

canvas_sdk/commands/commands/questionnaire/__init__.py

@@ -12,7 +12,7 @@ from canvas_sdk.commands.commands.questionnaire.question import (
     ResponseOption,
     TextQuestion,
 )
-from canvas_sdk.v1.data import Questionnaire
+from canvas_sdk.v1.data import Command, Questionnaire
 
 QUESTION_CLASSES: dict[str, type[BaseQuestion]] = {
     ResponseOption.TYPE_TEXT: TextQuestion,
@@ -37,8 +37,22 @@ class QuestionnaireCommand(_BaseCommand):
     @cached_property
     def _questionnaire(self) -> Questionnaire | None:
         if not self.questionnaire_id:
-            return None
-        return Questionnaire.objects.get(id=self.questionnaire_id)
+            if command_uuid := self.command_uuid:
+                # If the questionnaire is not set, try to fetch it from the command
+                try:
+                    command_data = Command.objects.values_list("data", flat=True).get(
+                        id=command_uuid
+                    )
+                    if questionnaire_dbid := command_data.get("questionnaire", {}).get("value"):
+                        questionnaire = Questionnaire.objects.get(dbid=questionnaire_dbid)
+                        self.questionnaire_id = str(questionnaire.id)
+                        return questionnaire
+                except (Command.DoesNotExist, Questionnaire.DoesNotExist):
+                    return None
+            else:
+                return None
+
+        return Questionnaire.objects.get(id=self.questionnaire_id)  # type: ignore[misc]
 
     @cached_property
     def questions(self) -> list[BaseQuestion]:
@@ -54,6 +68,7 @@ class QuestionnaireCommand(_BaseCommand):
 
         for question in self._questionnaire.questions.all():
             qdata: dict[str, Any] = {
+                "id": question.pk,
                 "name": f"question-{question.pk}",
                 "label": question.name,
                 "coding": {

canvas_sdk/commands/commands/questionnaire/question.py

@@ -38,8 +38,9 @@ class BaseQuestion(ABC):
     type: str
 
     def __init__(
-        self, name: str, label: str, coding: dict[str, str], options: list[ResponseOption]
+        self, id: str, name: str, label: str, coding: dict[str, str], options: list[ResponseOption]
     ) -> None:
+        self.id: str = id
         self.name: str = name
         self.label: str = label
         self.coding: dict[str, str] = coding
@@ -47,7 +48,7 @@ class BaseQuestion(ABC):
         self.response: Any | None = None
 
     def __repr__(self) -> str:
-        return f"Question({self.name=!r}, {self.label=!r}, {self.type=!r}, {self.options=!r}, {self.response=!r})"
+        return f"Question({self.id=!r}, {self.name=!r}, {self.label=!r}, {self.type=!r}, {self.options=!r}, {self.response=!r})"
 
     @abstractmethod
     def add_response(self, *args: Any, **kwargs: Any) -> None:

canvas_sdk/commands/commands/questionnaire/toggle_questions.py

@@ -0,0 +1,68 @@
+from canvas_sdk.v1.data import Command
+
+
+class ToggleQuestionsMixin:
+    """Mixin that adds toggle functionality to questionnaire-based commands.
+
+    This mixin should be used with classes that inherit from QuestionnaireCommand
+    and provides the ability to skip/enable individual questions.
+
+    Note: In the data model, skip=true means the question is ENABLED (not skipped).
+    This is counterintuitive but matches the existing behavior.
+    """
+
+    # All toggle states (persisted + runtime changes)
+    _question_toggles: dict[str, bool] | None = None
+
+    def _ensure_toggles_loaded(self) -> None:
+        """Load toggle states from the database if not already loaded."""
+        if self._question_toggles is not None:
+            return
+
+        self._question_toggles = {}
+
+        if hasattr(self, "command_uuid") and self.command_uuid:
+            try:
+                command_data = Command.objects.values_list("data", flat=True).get(
+                    id=self.command_uuid
+                )
+                for key, value in command_data.items():
+                    if key.startswith("skip-"):
+                        question_id = key.replace("skip-", "")
+                        self._question_toggles[question_id] = bool(value)
+            except Command.DoesNotExist:
+                pass
+
+    @property
+    def question_toggles(self) -> dict[str, bool]:
+        """Get the current toggle states for questions (question_id -> enabled)."""
+        self._ensure_toggles_loaded()
+        return self._question_toggles.copy()  # type: ignore[union-attr]
+
+    def is_question_enabled(self, question_id: str | int) -> bool | None:
+        """Check if a question is enabled."""
+        self._ensure_toggles_loaded()
+        question_id = str(question_id)
+        return self._question_toggles.get(question_id, None)  # type: ignore[union-attr]
+
+    def set_question_enabled(self, question_id: str | int, enabled: bool) -> None:
+        """Enable or disable a question."""
+        self._ensure_toggles_loaded()
+        self._question_toggles[str(question_id)] = enabled  # type: ignore[index]
+
+    @property
+    def values(self) -> dict:
+        """Include skip states in command values."""
+        values = super().values  # type: ignore[misc]
+
+        # Get all current toggle states
+        all_toggles = self.question_toggles
+
+        # Add skip- prefix for the values dict
+        for question_id, enabled in all_toggles.items():
+            values[f"skip-{question_id}"] = enabled
+
+        return values
+
+
+__exports__ = ()

canvas_sdk/commands/commands/review_of_systems.py

@@ -1,7 +1,8 @@
 from canvas_sdk.commands.commands.questionnaire import QuestionnaireCommand
+from canvas_sdk.commands.commands.questionnaire.toggle_questions import ToggleQuestionsMixin
 
 
-class ReviewOfSystemsCommand(QuestionnaireCommand):
+class ReviewOfSystemsCommand(ToggleQuestionsMixin, QuestionnaireCommand):
     """A class for managing physical exam command."""
 
     class Meta:

canvas_sdk/v1/data/__init__.py

@@ -5,7 +5,8 @@ from .banner_alert import BannerAlert
 from .billing import BillingLineItem, BillingLineItemModifier
 from .business_line import BusinessLine
 from .care_team import CareTeamMembership, CareTeamRole
-from .claim import Claim, ClaimCoverage, ClaimPatient, ClaimQueue
+from .charge_description_master import ChargeDescriptionMaster
+from .claim import Claim, ClaimCoverage, ClaimPatient, ClaimQueue, InstallmentPlan
 from .claim_line_item import ClaimLineItem
 from .command import Command
 from .condition import Condition, ConditionCoding
@@ -19,6 +20,8 @@ from .lab import (
     LabOrder,
     LabOrderReason,
     LabOrderReasonCondition,
+    LabPartner,
+    LabPartnerTest,
     LabReport,
     LabReview,
     LabTest,
@@ -32,7 +35,7 @@ from .line_item_transaction import (
 )
 from .medication import Medication, MedicationCoding
 from .message import Message, MessageAttachment, MessageTransmission
-from .note import Note, NoteType
+from .note import CurrentNoteStateEvent, Note, NoteStateChangeEvent, NoteType
 from .observation import (
     Observation,
     ObservationCoding,
@@ -76,8 +79,9 @@ from .questionnaire import (
     ResponseOptionSet,
 )
 from .reason_for_visit import ReasonForVisitSettingCoding
-from .staff import Staff, StaffContactPoint
+from .staff import Staff, StaffAddress, StaffContactPoint, StaffPhoto
 from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
+from .team import Team, TeamContactPoint
 from .user import CanvasUser
 
 __all__ = __exports__ = (
@@ -96,6 +100,7 @@ __all__ = __exports__ = (
     "CanvasUser",
     "CareTeamMembership",
     "CareTeamRole",
+    "ChargeDescriptionMaster",
     "Claim",
     "ClaimCoverage",
     "ClaimLineItem",
@@ -106,6 +111,7 @@ __all__ = __exports__ = (
     "ConditionCoding",
     "Coverage",
     "CoveragePosting",
+    "CurrentNoteStateEvent",
     "DetectedIssue",
     "DetectedIssueEvidence",
     "Device",
@@ -113,6 +119,7 @@ __all__ = __exports__ = (
     "ImagingOrder",
     "ImagingReport",
     "ImagingReview",
+    "InstallmentPlan",
     "Interview",
     "InterviewQuestionnaireMap",
     "InterviewQuestionResponse",
@@ -120,6 +127,8 @@ __all__ = __exports__ = (
     "LabOrder",
     "LabOrderReason",
     "LabOrderReasonCondition",
+    "LabPartner",
+    "LabPartnerTest",
     "LabReport",
     "LabReview",
     "LabTest",
@@ -134,6 +143,7 @@ __all__ = __exports__ = (
     "NewLineItemAdjustment",
     "NewLineItemPayment",
     "Note",
+    "NoteStateChangeEvent",
     "NoteType",
     "Observation",
     "ObservationCoding",
@@ -163,11 +173,15 @@ __all__ = __exports__ = (
     "ResponseOption",
     "ResponseOptionSet",
     "Staff",
+    "StaffAddress",
+    "StaffPhoto",
     "StaffContactPoint",
     "Task",
     "TaskComment",
     "TaskLabel",
     "TaskTaskLabel",
+    "Team",
+    "TeamContactPoint",
     "Transactor",
     "TransactorAddress",
     "TransactorPhone",

canvas_sdk/v1/data/allergy_intolerance.py

@@ -6,6 +6,8 @@ from canvas_sdk.v1.data.base import (
     BaseModelManager,
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
+    IdentifiableModel,
+    Model,
     ValueSetLookupQuerySet,
 )
 
@@ -23,19 +25,16 @@ class AllergyIntoleranceQuerySet(
 AllergyIntoleranceManager = BaseModelManager.from_queryset(AllergyIntoleranceQuerySet)
 
 
-class AllergyIntolerance(models.Model):
+class AllergyIntolerance(IdentifiableModel):
     """AllergyIntolerance."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_allergyintolerance_001"
 
     objects = cast(AllergyIntoleranceQuerySet, AllergyIntoleranceManager())
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
     deleted = models.BooleanField()
     committer = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
@@ -50,30 +49,28 @@ class AllergyIntolerance(models.Model):
         null=True,
     )
     note_id = models.BigIntegerField()
-    allergy_intolerance_type = models.CharField()
+    allergy_intolerance_type = models.CharField(max_length=1)
     category = models.IntegerField()
-    status = models.CharField()
-    severity = models.CharField()
+    status = models.CharField(max_length=20)
+    severity = models.CharField(max_length=20)
     onset_date = models.DateField()
-    onset_date_original_input = models.CharField()
+    onset_date_original_input = models.CharField(max_length=255)
     last_occurrence = models.DateField()
-    last_occurrence_original_input = models.CharField()
+    last_occurrence_original_input = models.CharField(max_length=255)
     recorded_date = models.DateTimeField()
-    narrative = models.CharField()
+    narrative = models.CharField(max_length=512)
 
 
-class AllergyIntoleranceCoding(models.Model):
+class AllergyIntoleranceCoding(Model):
     """AllergyIntoleranceCoding."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_allergyintolerancecoding_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField()
-    version = models.CharField()
-    code = models.CharField()
-    display = models.CharField()
+    system = models.CharField(max_length=255)
+    version = models.CharField(max_length=255)
+    code = models.CharField(max_length=255)
+    display = models.CharField(max_length=1000)
     user_selected = models.BooleanField()
     allergy_intolerance = models.ForeignKey(
         AllergyIntolerance,

canvas_sdk/v1/data/appointment.py

@@ -1,5 +1,7 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel
+
 
 class AppointmentProgressStatus(models.TextChoices):
     """AppointmentProgressStatus."""
@@ -14,15 +16,12 @@ class AppointmentProgressStatus(models.TextChoices):
     CANCELLED = "cancelled", "Cancelled"
 
 
-class Appointment(models.Model):
+class Appointment(IdentifiableModel):
     """Appointment."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_appointment_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
     entered_in_error = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
     patient = models.ForeignKey(
         "v1.Patient",
@@ -56,21 +55,18 @@ class Appointment(models.Model):
     description = models.TextField(null=True, blank=True)
 
 
-class AppointmentExternalIdentifier(models.Model):
+class AppointmentExternalIdentifier(IdentifiableModel):
     """AppointmentExternalIdentifier."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_appointmentexternalidentifier_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
-    use = models.CharField()
-    identifier_type = models.CharField()
-    system = models.CharField()
-    value = models.CharField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+    use = models.CharField(max_length=255)
+    identifier_type = models.CharField(max_length=255)
+    system = models.CharField(max_length=255)
+    value = models.CharField(max_length=255)
     issued_date = models.DateField()
     expiration_date = models.DateField()
     appointment = models.ForeignKey(

canvas_sdk/v1/data/assessment.py

@@ -1,5 +1,7 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel
+
 
 class AssessmentStatus(models.TextChoices):
     """AssessmentStatus."""
@@ -9,17 +11,14 @@ class AssessmentStatus(models.TextChoices):
     STATUS_DETERIORATING = "deteriorated", "Deteriorated"
 
 
-class Assessment(models.Model):
+class Assessment(IdentifiableModel):
     """Assessment."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_assessment_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
     originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+")
     committer = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
@@ -38,10 +37,10 @@ class Assessment(models.Model):
         "v1.Condition", on_delete=models.CASCADE, related_name="assessments", null=True
     )
     interview = models.ForeignKey("v1.Interview", on_delete=models.DO_NOTHING, null=True)
-    status = models.CharField(choices=AssessmentStatus.choices)
-    narrative = models.CharField()
-    background = models.CharField()
-    care_team = models.CharField()
+    status = models.CharField(choices=AssessmentStatus.choices, max_length=20)
+    narrative = models.CharField(max_length=2048)
+    background = models.CharField(max_length=2048)
+    care_team = models.CharField(max_length=500)
 
 
 __exports__ = ("AssessmentStatus", "Assessment")

canvas_sdk/v1/data/banner_alert.py

@@ -1,30 +1,30 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
+from canvas_sdk.v1.data.base import Model
 
-class BannerAlert(models.Model):
+
+class BannerAlert(Model):
     """BannerAlert."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_banneralert_001"
 
-    dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
     patient = models.ForeignKey(
         "v1.Patient",
         on_delete=models.DO_NOTHING,
         related_name="banner_alerts",
         null=True,
     )
-    plugin_name = models.CharField()
-    key = models.CharField()
-    narrative = models.CharField()
-    placement = ArrayField(models.CharField())
-    intent = models.CharField()
-    href = models.CharField()
-    status = models.CharField()
+    plugin_name = models.CharField(max_length=256)
+    key = models.CharField(max_length=255)
+    narrative = models.CharField(max_length=90)
+    placement = ArrayField(models.CharField(max_length=64))
+    intent = models.CharField(max_length=64)
+    href = models.CharField(max_length=255)
+    status = models.CharField(max_length=64)
 
 
 __exports__ = ("BannerAlert",)

canvas_sdk/v1/data/base.py

@@ -1,14 +1,58 @@
+import uuid
 from abc import abstractmethod
 from collections.abc import Container
 from typing import TYPE_CHECKING, Any, Protocol, Self, cast
 
-from django.db import models
+from django.contrib.postgres.fields import ArrayField
+from django.db import connection, models
 from django.db.models import Q
+from django.db.models.base import ModelBase
 
 if TYPE_CHECKING:
     from canvas_sdk.protocols.timeframe import Timeframe
     from canvas_sdk.value_set.value_set import ValueSet
 
+IS_SQLITE = connection.vendor == "sqlite"
+
+
+class ModelMetaclass(ModelBase):
+    """A metaclass for configuring data models."""
+
+    def __new__(cls, name: str, bases: tuple, attrs: dict[str, Any], **kwargs: Any) -> type:
+        """Create a new model class."""
+        meta = attrs.get("Meta")
+
+        for field_name, field in list(attrs.items()):
+            if isinstance(field, ArrayField) and IS_SQLITE:
+                # Replace ArrayField(CharField(...)) with JSONField
+                attrs[field_name] = models.JSONField(default=list)
+
+        # set managed to True if database is SQLite and not explicitly set
+        if meta and not hasattr(meta, "managed") and not getattr(meta, "abstract", False):
+            meta.managed = IS_SQLITE
+
+        new_class = cast(type["Model"], super().__new__(cls, name, bases, attrs, **kwargs))
+
+        return new_class
+
+
+class Model(models.Model, metaclass=ModelMetaclass):
+    """A base model."""
+
+    class Meta:
+        abstract = True
+
+    dbid = models.BigAutoField(primary_key=True)
+
+
+class IdentifiableModel(Model):
+    """A model that includes an identifier."""
+
+    class Meta:
+        abstract = True
+
+    id = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)
+
 
 class BaseModelManager(models.Manager):
     """A base manager for models."""