canvas 0.72.1__py3-none-any.whl → 0.74.0__py3-none-any.whl

canvas_sdk/test_utils/factories/task.py

@@ -0,0 +1,66 @@
+import factory
+
+from canvas_sdk.v1.data import Task, TaskComment, TaskLabel, TaskMetadata, TaskTaskLabel
+from canvas_sdk.v1.data.common import ColorEnum, Origin
+from canvas_sdk.v1.data.task import TaskLabelModule, TaskStatus, TaskType
+
+
+class TaskFactory(factory.django.DjangoModelFactory[Task]):
+    """Factory for creating Task."""
+
+    class Meta:
+        model = Task
+
+    patient = factory.SubFactory("canvas_sdk.test_utils.factories.PatientFactory")
+    creator = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+    assignee = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+    task_type = TaskType.TASK
+    tag = factory.Faker("word")
+    title = factory.Faker("sentence", nb_words=4)
+    status = TaskStatus.OPEN
+
+
+class TaskMetadataFactory(factory.django.DjangoModelFactory[TaskMetadata]):
+    """Factory for creating TaskMetadata."""
+
+    class Meta:
+        model = TaskMetadata
+
+    task = factory.SubFactory(TaskFactory)
+    key = factory.Faker("word")
+    value = factory.Faker("word")
+
+
+class TaskCommentFactory(factory.django.DjangoModelFactory[TaskComment]):
+    """Factory for creating TaskComment."""
+
+    class Meta:
+        model = TaskComment
+
+    creator = factory.SubFactory("canvas_sdk.test_utils.factories.StaffFactory")
+    task = factory.SubFactory(TaskFactory)
+    body = factory.Faker("sentence", nb_words=10)
+
+
+class TaskLabelFactory(factory.django.DjangoModelFactory[TaskLabel]):
+    """Factory for creating TaskLabel."""
+
+    class Meta:
+        model = TaskLabel
+
+    position = factory.Sequence(lambda n: n)
+    color = ColorEnum.BLUE
+    task_association = [Origin.REFERAL]
+    name = factory.Faker("word")
+    active = True
+    modules = [TaskLabelModule.TASKS]
+
+
+class TaskTaskLabelFactory(factory.django.DjangoModelFactory[TaskTaskLabel]):
+    """Factory for creating TaskTaskLabel."""
+
+    class Meta:
+        model = TaskTaskLabel
+
+    task = factory.SubFactory(TaskFactory)
+    task_label = factory.SubFactory(TaskLabelFactory)

canvas_sdk/v1/data/__init__.py

@@ -1,5 +1,10 @@
 from .allergy_intolerance import AllergyIntolerance, AllergyIntoleranceCoding
-from .appointment import Appointment, AppointmentExternalIdentifier, AppointmentMetadata
+from .appointment import (
+    Appointment,
+    AppointmentExternalIdentifier,
+    AppointmentLabel,
+    AppointmentMetadata,
+)
 from .assessment import Assessment
 from .banner_alert import BannerAlert
 from .billing import BillingLineItem, BillingLineItemModifier
@@ -103,7 +108,7 @@ from .referral import Referral, ReferralReport
 from .service_provider import ServiceProvider
 from .staff import Staff, StaffAddress, StaffContactPoint, StaffLicense, StaffPhoto, StaffRole
 from .stop_medication_event import StopMedicationEvent
-from .task import Task, TaskComment, TaskLabel, TaskTaskLabel
+from .task import Task, TaskComment, TaskLabel, TaskMetadata, TaskTaskLabel
 from .team import Team, TeamContactPoint
 from .user import CanvasUser
 
@@ -111,6 +116,7 @@ __all__ = __exports__ = (
     "Appointment",
     "AppointmentMetadata",
     "AppointmentExternalIdentifier",
+    "AppointmentLabel",
     "AllergyIntolerance",
     "AllergyIntoleranceCoding",
     "Assessment",
@@ -227,6 +233,7 @@ __all__ = __exports__ = (
     "TaskComment",
     "TaskLabel",
     "TaskTaskLabel",
+    "TaskMetadata",
     "Team",
     "TeamContactPoint",
     "Transactor",

canvas_sdk/v1/data/appointment.py

@@ -1,6 +1,6 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
+from canvas_sdk.v1.data.base import IdentifiableModel, Model, TimestampedModel
 
 
 class AppointmentProgressStatus(models.TextChoices):
@@ -77,6 +77,21 @@ class AppointmentExternalIdentifier(TimestampedModel, IdentifiableModel):
     )
 
 
+class AppointmentLabel(Model):
+    """M2M for Appointment -> TaskLabels."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_appointment_labels_001"
+
+    appointment = models.ForeignKey(Appointment, on_delete=models.DO_NOTHING, null=True)
+    task_label = models.ForeignKey(
+        "v1.TaskLabel",
+        on_delete=models.DO_NOTHING,
+        null=True,
+        db_column="userselectedtasklabel_id",
+    )
+
+
 class AppointmentMetadata(IdentifiableModel):
     """A class representing Appointment Metadata."""
 
@@ -95,4 +110,5 @@ __exports__ = (
     "Appointment",
     "AppointmentMetadata",
     "AppointmentExternalIdentifier",
+    "AppointmentLabel",
 )

canvas_sdk/v1/data/claim_line_item.py

@@ -5,7 +5,7 @@ from django.db import models
 from django.db.models import Q, Sum
 from django.db.models.functions import Coalesce
 
-from canvas_sdk.v1.data.base import TimestampedModel
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
 from canvas_sdk.v1.data.note import PracticeLocationPOS
 
 
@@ -106,7 +106,7 @@ class ClaimLineItemQuerySet(models.QuerySet):
         return self.exclude(proc_code=LineItemCodes.UNLINKED.value).apply_ordering()
 
 
-class ClaimLineItem(TimestampedModel):
+class ClaimLineItem(TimestampedModel, IdentifiableModel):
     """ClaimLineItem."""
 
     class Meta:

canvas_sdk/v1/data/facility.py

@@ -12,6 +12,7 @@ class Facility(IdentifiableModel):
     name = models.CharField(max_length=255)
     npi_number = models.CharField(verbose_name="NPI number", max_length=10, blank=True)
     phone_number = models.CharField(max_length=10, blank=True, default="")
+    fax_number = models.CharField(max_length=10, blank=True, default="")
     active = models.BooleanField(default=True)
     line1 = models.CharField(max_length=255, default="", blank=True)
     line2 = models.CharField(max_length=255, default="", blank=True)

canvas_sdk/v1/data/task.py

@@ -31,6 +31,7 @@ class TaskLabelModule(models.TextChoices):
 
     CLAIMS = "claims", "Claims"
     TASKS = "tasks", "Tasks"
+    APPOINTMENTS = "appointments", "Appointments"
 
 
 class Task(TimestampedModel, IdentifiableModel):
@@ -78,6 +79,9 @@ class TaskLabel(IdentifiableModel):
         db_table = "canvas_sdk_data_api_tasklabel_001"
 
     tasks = models.ManyToManyField(Task, related_name="labels", through="TaskTaskLabel")  # type: ignore[var-annotated]
+    appointments = models.ManyToManyField(
+        "v1.Appointment", related_name="labels", through="v1.AppointmentLabel"
+    )
     position = models.IntegerField()
     color = models.CharField(choices=ColorEnum.choices, max_length=50)
     task_association = ArrayField(models.CharField(choices=Origin.choices, max_length=32))
@@ -96,6 +100,17 @@ class TaskTaskLabel(Model):
     task = models.ForeignKey(Task, on_delete=models.DO_NOTHING, null=True)
 
 
+class TaskMetadata(IdentifiableModel):
+    """TaskMetadata."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_taskmetadata_001"
+
+    task = models.ForeignKey(Task, on_delete=models.CASCADE, related_name="metadata")
+    key = models.CharField(max_length=32)
+    value = models.CharField(max_length=255)
+
+
 __exports__ = (
     "TaskType",
     "EventType",
@@ -105,4 +120,5 @@ __exports__ = (
     "TaskComment",
     "TaskLabel",
     "TaskTaskLabel",
+    "TaskMetadata",
 )

plugin_runner/allowed-module-imports.json

@@ -234,12 +234,23 @@
     "CreateEvent",
     "EventRecurrence"
   ],
+  "canvas_sdk.effects.claim_label": [
+    "AddClaimLabel",
+    "Label",
+    "RemoveClaimLabel"
+  ],
+  "canvas_sdk.effects.claim_line_item": [
+    "UpdateClaimLineItem"
+  ],
   "canvas_sdk.effects.compound_medications": [
     "CompoundMedication"
   ],
   "canvas_sdk.effects.compound_medications.compound_medication": [
     "CompoundMedication"
   ],
+  "canvas_sdk.effects.fax": [
+    "FaxNoteEffect"
+  ],
   "canvas_sdk.effects.generate_full_chart_pdf": [
     "GenerateFullChartPDFEffect"
   ],
@@ -253,13 +264,17 @@
     "Metadata"
   ],
   "canvas_sdk.effects.note": [
+    "AddAppointmentLabel",
     "Appointment",
     "AppointmentIdentifier",
     "Note",
+    "RemoveAppointmentLabel",
     "ScheduleEvent"
   ],
   "canvas_sdk.effects.note.appointment": [
+    "AddAppointmentLabel",
     "Appointment",
+    "RemoveAppointmentLabel",
     "ScheduleEvent"
   ],
   "canvas_sdk.effects.note.base": [
@@ -383,12 +398,14 @@
   "canvas_sdk.effects.task": [
     "AddTask",
     "AddTaskComment",
+    "TaskMetadata",
     "TaskStatus",
     "UpdateTask"
   ],
   "canvas_sdk.effects.task.task": [
     "AddTask",
     "AddTaskComment",
+    "TaskMetadata",
     "TaskStatus",
     "UpdateTask"
   ],
@@ -552,6 +569,7 @@
     "AllergyIntoleranceCoding",
     "Appointment",
     "AppointmentExternalIdentifier",
+    "AppointmentLabel",
     "AppointmentMetadata",
     "Assessment",
     "BannerAlert",
@@ -666,6 +684,7 @@
     "Task",
     "TaskComment",
     "TaskLabel",
+    "TaskMetadata",
     "TaskTaskLabel",
     "Team",
     "TeamContactPoint",
@@ -680,6 +699,7 @@
   "canvas_sdk.v1.data.appointment": [
     "Appointment",
     "AppointmentExternalIdentifier",
+    "AppointmentLabel",
     "AppointmentMetadata",
     "AppointmentProgressStatus"
   ],
@@ -959,6 +979,7 @@
     "TaskComment",
     "TaskLabel",
     "TaskLabelModule",
+    "TaskMetadata",
     "TaskStatus",
     "TaskTaskLabel",
     "TaskType"

protobufs/canvas_generated/messages/effects.proto

@@ -126,6 +126,7 @@ enum EffectType {
   CREATE_TASK = 100;
   UPDATE_TASK = 101;
   CREATE_TASK_COMMENT = 102;
+  UPSERT_TASK_METADATA = 111;
 
   ORIGINATE_MEDICAL_HISTORY_COMMAND = 103;
   EDIT_MEDICAL_HISTORY_COMMAND = 104;
@@ -266,10 +267,18 @@ enum EffectType {
   PATIENT_PORTAL__APPOINTMENTS__FORM_PROVIDERS__POST_SEARCH_RESULTS = 2011;
   PATIENT_PORTAL__APPLICATION_CONFIGURATION = 2012;
 
+  ADD_APPOINTMENT_LABEL = 2015;
+  REMOVE_APPOINTMENT_LABEL = 2016;
+
   ADD_BILLING_LINE_ITEM = 2030;
   UPDATE_BILLING_LINE_ITEM = 2031;
   REMOVE_BILLING_LINE_ITEM = 2032;
 
+  ADD_CLAIM_LABEL = 2050;
+  REMOVE_CLAIM_LABEL = 2051;
+
+  UPDATE_CLAIM_LINE_ITEM = 2080;
+
   SHOW_PATIENT_PORTAL_MENU_ITEMS = 2100;
   PORTAL_WIDGET = 2101;
 
@@ -284,6 +293,8 @@ enum EffectType {
 
   CREATE_NOTE = 6000;
   UPDATE_NOTE = 6013;
+  PUSH_NOTE_CHARGES = 5500;
+  FAX_NOTE = 6019;
 
   CREATE_APPOINTMENT = 6001;
   UPDATE_APPOINTMENT = 6014;

protobufs/canvas_generated/messages/events.proto

@@ -98,6 +98,8 @@ enum EventType {
 
   TASK_CLOSED = 86;
   TASK_COMPLETED = 87;
+  TASK_METADATA_CREATED = 96;
+  TASK_METADATA_UPDATED = 97;
 
   DETECTED_ISSUE_EVIDENCE_CREATED = 88;
   DETECTED_ISSUE_EVIDENCE_UPDATED = 89;
@@ -108,6 +110,9 @@ enum EventType {
   COMPOUND_MEDICATION_CREATED = 92;
   COMPOUND_MEDICATION_UPDATED = 93;
 
+  APPOINTMENT_LABEL_ADDED = 94;
+  APPOINTMENT_LABEL_REMOVED = 95;
+
   // General Command Events
 
   PRE_COMMAND_ORIGINATE = 100;
@@ -177,6 +182,8 @@ enum EventType {
    ADJUST_PRESCRIPTION__CHANGE_MEDICATION_TO__POST_SEARCH = 2019;
    ADJUST_PRESCRIPTION__SUPERVISING_PROVIDER__PRE_SEARCH = 2021;
    ADJUST_PRESCRIPTION__SUPERVISING_PROVIDER__POST_SEARCH = 2022;
+   ADJUST_PRESCRIPTION__PRESCRIBER__PRE_SEARCH = 2025;
+   ADJUST_PRESCRIPTION__PRESCRIBER__POST_SEARCH = 2026;
 
   // ADJUST_PROTOCOL_COMMAND__PRE_ORIGINATE = 3000;
   // ADJUST_PROTOCOL_COMMAND__POST_ORIGINATE = 3001;
@@ -703,6 +710,8 @@ enum EventType {
   PRESCRIBE__PHARMACY__POST_SEARCH = 33017;
   PRESCRIBE__SUPERVISING_PROVIDER__POST_SEARCH = 33019;
   PRESCRIBE__SUPERVISING_PROVIDER__PRE_SEARCH = 33020;
+  PRESCRIBE__PRESCRIBER__PRE_SEARCH = 33023;
+  PRESCRIBE__PRESCRIBER__POST_SEARCH = 33024;
 
   QUESTIONNAIRE_COMMAND__PRE_ORIGINATE = 34000;
   QUESTIONNAIRE_COMMAND__POST_ORIGINATE = 34001;
@@ -809,6 +818,8 @@ enum EventType {
   REFILL__PHARMACY__POST_SEARCH = 39017;
   REFILL__SUPERVISING_PROVIDER__PRE_SEARCH = 39019;
   REFILL__SUPERVISING_PROVIDER__POST_SEARCH = 39020;
+  REFILL__PRESCRIBER__PRE_SEARCH = 39023;
+  REFILL__PRESCRIBER__POST_SEARCH = 39024;
 
   REMOVE_ALLERGY_COMMAND__PRE_ORIGINATE = 40000;
   REMOVE_ALLERGY_COMMAND__POST_ORIGINATE = 40001;