canvas 0.66.0__py3-none-any.whl → 0.68.0__py3-none-any.whl

canvas_sdk/v1/data/questionnaire.py

@@ -10,19 +10,17 @@ from canvas_sdk.v1.data.base import (
     CommittableQuerySetMixin,
     ForPatientQuerySetMixin,
     IdentifiableModel,
-    Model,
+    TimestampedModel,
     ValueSetLookupByNameQuerySet,
 )
 
 
-class ResponseOptionSet(Model):
+class ResponseOptionSet(TimestampedModel):
     """ResponseOptionSet."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_responseoptionset_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     status = models.CharField(max_length=2)
     name = models.CharField(max_length=255)
     code_system = models.CharField(max_length=255)
@@ -31,14 +29,12 @@ class ResponseOptionSet(Model):
     use_in_shx = models.BooleanField()
 
 
-class ResponseOption(Model):
+class ResponseOption(TimestampedModel):
     """ResponseOption."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_responseoption_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     status = models.CharField(max_length=2)
     name = models.CharField(max_length=255)
     code = models.CharField(max_length=100)
@@ -50,14 +46,12 @@ class ResponseOption(Model):
     ordering = models.IntegerField()
 
 
-class Question(IdentifiableModel):
+class Question(TimestampedModel, IdentifiableModel):
     """Question."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_question_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     status = models.CharField(max_length=2)
     name = models.CharField(max_length=255)
     response_option_set = models.ForeignKey(
@@ -78,7 +72,7 @@ class QuestionnaireValueSetLookupQuerySet(ValueSetLookupByNameQuerySet):
         return Q(code_system=system, code__in=codes)
 
 
-class Questionnaire(IdentifiableModel):
+class Questionnaire(TimestampedModel, IdentifiableModel):
     """Questionnaire."""
 
     class Meta:
@@ -86,8 +80,6 @@ class Questionnaire(IdentifiableModel):
 
     objects = models.Manager.from_queryset(QuestionnaireValueSetLookupQuerySet)()
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     status = models.CharField(max_length=2)
     name = models.CharField(max_length=255)
     expected_completion_time = models.FloatField()
@@ -104,14 +96,12 @@ class Questionnaire(IdentifiableModel):
     carry_forward = models.TextField()
 
 
-class QuestionnaireQuestionMap(Model):
+class QuestionnaireQuestionMap(TimestampedModel):
     """QuestionnaireQuestionMap."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_questionnairequestionmap_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     status = models.CharField(max_length=2)
     questionnaire = models.ForeignKey(Questionnaire, on_delete=models.DO_NOTHING, null=True)
     question = models.ForeignKey(Question, on_delete=models.DO_NOTHING, null=True)
@@ -126,7 +116,7 @@ class InterviewQuerySet(BaseQuerySet, ForPatientQuerySetMixin, CommittableQueryS
 InterviewManager = BaseModelManager.from_queryset(InterviewQuerySet)
 
 
-class Interview(IdentifiableModel):
+class Interview(TimestampedModel, IdentifiableModel):
     """Interview."""
 
     class Meta:
@@ -155,31 +145,25 @@ class Interview(IdentifiableModel):
         through="v1.InterviewQuestionnaireMap",
     )
     progress_status = models.CharField(max_length=3)
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
 
 
-class InterviewQuestionnaireMap(Model):
+class InterviewQuestionnaireMap(TimestampedModel):
     """InterviewQuestionnaireMap."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_interviewquestionnairemap_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     status = models.CharField(max_length=2)
     interview = models.ForeignKey(Interview, on_delete=models.DO_NOTHING, null=True)
     questionnaire = models.ForeignKey(Questionnaire, on_delete=models.DO_NOTHING, null=True)
 
 
-class InterviewQuestionResponse(Model):
+class InterviewQuestionResponse(TimestampedModel):
     """InterviewQuestionResponse."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_interviewquestionresponse_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     status = models.CharField(max_length=2)
     interview = models.ForeignKey(
         Interview, on_delete=models.DO_NOTHING, related_name="interview_responses", null=True

canvas_sdk/v1/data/reason_for_visit.py

@@ -2,9 +2,10 @@ from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
 from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.coding import Coding
 
 
-class ReasonForVisitSettingCoding(IdentifiableModel):
+class ReasonForVisitSettingCoding(IdentifiableModel, Coding):
     """ReasonForVisitSettingCoding."""
 
     class Meta:
@@ -12,11 +13,6 @@ class ReasonForVisitSettingCoding(IdentifiableModel):
 
     objects: models.Manager["ReasonForVisitSettingCoding"]
 
-    code = models.CharField(max_length=255)
-    display = models.CharField(max_length=1000)
-    system = models.CharField(max_length=255)
-    version = models.CharField(max_length=255)
-
     duration = ArrayField(models.DurationField())
 
 

canvas_sdk/v1/data/referral.py

@@ -2,28 +2,16 @@ import json
 
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import AuditedModel, IdentifiableModel, TimestampedModel
 from canvas_sdk.v1.data.task import Task
 
 
-class Referral(IdentifiableModel):
+class Referral(AuditedModel, IdentifiableModel):
     """Referral."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_referral_001"
 
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
-    originator = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
-    )
-    deleted = models.BooleanField()
-    committer = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
-    )
-    entered_in_error = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
-    )
     patient = models.ForeignKey("v1.Patient", on_delete=models.DO_NOTHING)
     note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING)
     service_provider = models.ForeignKey(
@@ -66,14 +54,12 @@ class Referral(IdentifiableModel):
         return f"Referral {self.id}"
 
 
-class ReferralReport(IdentifiableModel):
+class ReferralReport(TimestampedModel, IdentifiableModel):
     """ReferralReport."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_referralreport_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     originator = models.ForeignKey(
         "v1.CanvasUser", on_delete=models.DO_NOTHING, null=True, related_name="+"
     )

canvas_sdk/v1/data/staff.py

@@ -5,7 +5,7 @@ from django.db import models
 from django.db.models.enums import TextChoices
 from timezone_utils.fields import TimeZoneField
 
-from canvas_sdk.v1.data.base import IdentifiableModel, Model
+from canvas_sdk.v1.data.base import IdentifiableModel, Model, TimestampedModel
 from canvas_sdk.v1.data.common import (
     AddressState,
     AddressType,
@@ -19,7 +19,7 @@ from canvas_sdk.v1.data.common import (
 from canvas_sdk.v1.data.utils import create_key
 
 
-class Staff(Model):
+class Staff(TimestampedModel):
     """Staff."""
 
     class Meta:
@@ -35,8 +35,6 @@ class Staff(Model):
         editable=False,
         default=create_key,
     )
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     prefix = models.CharField(max_length=100)
     suffix = models.CharField(max_length=100)
     first_name = models.CharField(max_length=255)
@@ -44,7 +42,7 @@ class Staff(Model):
     last_name = models.CharField(max_length=255)
     maiden_name = models.CharField(max_length=255)
     nickname = models.CharField(max_length=255)
-    previous_names = models.JSONField()
+    previous_names = models.JSONField(default=list)
     birth_date = models.DateField(null=True)
     sex_at_birth = models.CharField(choices=PersonSex.choices, max_length=3)
     sexual_orientation_term = models.CharField(max_length=255)
@@ -57,14 +55,14 @@ class Staff(Model):
     cultural_ethnicity_codes = ArrayField(models.CharField(max_length=100))
     cultural_ethnicity_terms = ArrayField(models.CharField(max_length=255))
     last_known_timezone = TimeZoneField(null=True)
-    active = models.BooleanField()
+    active = models.BooleanField(default=True)
     primary_practice_location = models.ForeignKey(
         "v1.PracticeLocation", on_delete=models.DO_NOTHING, null=True
     )
     npi_number = models.CharField(max_length=10)
     nadean_number = models.CharField(max_length=20)
     group_npi_number = models.CharField(max_length=10)
-    bill_through_organization = models.BooleanField()
+    bill_through_organization = models.BooleanField(default=True)
     tax_id = models.CharField(max_length=25)
     tax_id_type = models.CharField(choices=TaxIDType.choices, max_length=1)
     spi_number = models.CharField(max_length=50)
@@ -72,9 +70,9 @@ class Staff(Model):
     # language = models.ForeignKey('v1.Language', on_delete=models.DO_NOTHING, related_name="staff_speakers", null=True)
     # language_secondary = models.ForeignKey('v1.Language', on_delete=models.DO_NOTHING, related_name="staff_secondary_speakers", null=True)
     personal_meeting_room_link = models.URLField(null=True)
-    state = models.JSONField()
+    state = models.JSONField(default=dict, blank=True)
     user = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, null=True)
-    schedule_column_ordering = models.IntegerField()
+    schedule_column_ordering = models.IntegerField(default=999)
     default_supervising_provider = models.ForeignKey(
         "v1.Staff", on_delete=models.DO_NOTHING, related_name="supervising_team", null=True
     )
@@ -135,10 +133,14 @@ class StaffContactPoint(IdentifiableModel):
 
     system = models.CharField(choices=ContactPointSystem.choices, max_length=20)
     value = models.CharField(max_length=100)
-    use = models.CharField(choices=ContactPointUse.choices, max_length=20)
+    use = models.CharField(
+        choices=ContactPointUse.choices, max_length=20, default=ContactPointUse.HOME
+    )
     use_notes = models.CharField(max_length=255)
-    rank = models.IntegerField()
-    state = models.CharField(choices=ContactPointState.choices, max_length=20)
+    rank = models.IntegerField(default=1)
+    state = models.CharField(
+        choices=ContactPointState.choices, max_length=20, default=ContactPointState.ACTIVE
+    )
     staff = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, related_name="telecom")
 
 
@@ -148,31 +150,31 @@ class StaffAddress(IdentifiableModel):
     class Meta:
         db_table = "canvas_sdk_data_api_staffaddress_001"
 
-    line1 = models.CharField(max_length=255)
-    line2 = models.CharField(max_length=255)
+    line1 = models.CharField(max_length=255, default="", blank=True)
+    line2 = models.CharField(max_length=255, default="", blank=True)
     city = models.CharField(max_length=255)
-    district = models.CharField(max_length=255)
+    district = models.CharField(max_length=255, blank=True, default="")
     state_code = models.CharField(max_length=2)
     postal_code = models.CharField(max_length=255)
-    use = models.CharField(choices=AddressUse.choices, max_length=10)
-    type = models.CharField(choices=AddressType.choices, max_length=10)
-    longitude = models.FloatField()
-    latitude = models.FloatField()
-    start = models.DateField()
-    end = models.DateField()
+    use = models.CharField(choices=AddressUse.choices, max_length=10, default=AddressUse.HOME)
+    type = models.CharField(choices=AddressType.choices, max_length=10, default=AddressType.BOTH)
+    longitude = models.FloatField(null=True, default=None, blank=True)
+    latitude = models.FloatField(null=True, default=None, blank=True)
+    start = models.DateField(null=True, blank=True)
+    end = models.DateField(null=True, blank=True)
     country = models.CharField(max_length=255)
-    state = models.CharField(choices=AddressState.choices, max_length=20)
+    state = models.CharField(
+        choices=AddressState.choices, max_length=20, default=AddressState.ACTIVE
+    )
     staff = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, related_name="addresses")
 
 
-class StaffPhoto(Model):
+class StaffPhoto(TimestampedModel):
     """StaffPhoto."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_staffphoto_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     staff = models.ForeignKey(Staff, on_delete=models.CASCADE, related_name="photos")
     url = models.CharField(
         default="https://d3hn0m4rbsz438.cloudfront.net/avatar1.png", max_length=512
@@ -185,6 +187,12 @@ class StaffRole(Model):
 
     class Meta:
         db_table = "canvas_sdk_data_api_staffrole_001"
+        constraints = [
+            models.UniqueConstraint(
+                fields=["staff", "internal_code"],
+                name="staff_internal_code_unique",
+            )
+        ]
 
     class RoleDomain(TextChoices):
         CLINICAL = "CLI", "Clinical"

canvas_sdk/v1/data/stop_medication_event.py

@@ -1,9 +1,9 @@
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import AuditedModel, IdentifiableModel
 
 
-class StopMedicationEvent(IdentifiableModel):
+class StopMedicationEvent(AuditedModel, IdentifiableModel):
     """StopMedicationEvent."""
 
     class Meta:
@@ -21,15 +21,6 @@ class StopMedicationEvent(IdentifiableModel):
         related_name="stopmedicationevent_set",
         null=True,
     )
-    entered_in_error = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+", null=True
-    )
-    committer = models.ForeignKey(
-        "v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+", null=True
-    )
-    originator = models.ForeignKey("v1.CanvasUser", on_delete=models.DO_NOTHING, related_name="+")
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     rationale = models.CharField(max_length=1024, default="")
 
 

canvas_sdk/v1/data/task.py

@@ -1,7 +1,7 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel, Model
+from canvas_sdk.v1.data.base import IdentifiableModel, Model, TimestampedModel
 from canvas_sdk.v1.data.common import ColorEnum, Origin
 
 
@@ -33,14 +33,12 @@ class TaskLabelModule(models.TextChoices):
     TASKS = "tasks", "Tasks"
 
 
-class Task(IdentifiableModel):
+class Task(TimestampedModel, IdentifiableModel):
     """Task."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_task_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     creator = models.ForeignKey(
         "v1.Staff", on_delete=models.DO_NOTHING, related_name="creator_tasks", null=True
     )
@@ -60,14 +58,12 @@ class Task(IdentifiableModel):
     status = models.CharField(choices=TaskStatus.choices, max_length=9)
 
 
-class TaskComment(IdentifiableModel):
+class TaskComment(TimestampedModel, IdentifiableModel):
     """TaskComment."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_taskcomment_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     creator = models.ForeignKey(
         "v1.Staff", on_delete=models.DO_NOTHING, related_name="comments", null=True
     )

canvas_sdk/v1/data/team.py

@@ -1,7 +1,7 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
-from canvas_sdk.v1.data.base import IdentifiableModel
+from canvas_sdk.v1.data.base import IdentifiableModel, TimestampedModel
 from canvas_sdk.v1.data.common import ContactPointState, ContactPointSystem, ContactPointUse
 
 
@@ -39,14 +39,12 @@ class TeamResponsibility(models.TextChoices):
     REVIEW_COVERAGES = "REVIEW_COVERAGES", "Review incomplete patient coverages"
 
 
-class Team(IdentifiableModel):
+class Team(TimestampedModel, IdentifiableModel):
     """Team."""
 
     class Meta:
         db_table = "canvas_sdk_data_api_team_001"
 
-    created = models.DateTimeField(auto_now_add=True)
-    modified = models.DateTimeField(auto_now=True)
     name = models.CharField(max_length=200)
     responsibilities = ArrayField(
         models.CharField(choices=TeamResponsibility.choices, max_length=64)

canvas_sdk/v1/data/utils.py

@@ -29,4 +29,9 @@ def generate_mrn(length: int = 9, max_attempts: int = 100) -> str:
     raise RuntimeError(f"Unable to generate a unique MRN after {max_attempts} attempts")
 
 
+def empty_note_body() -> list[dict[str, str]]:
+    """Generates an empty note body with 15 empty text elements."""
+    return [{"type": "text", "value": ""}] * 15
+
+
 __exports__ = ()

plugin_runner/allowed-module-imports.json

@@ -249,6 +249,9 @@
   "canvas_sdk.effects.launch_modal": [
     "LaunchModalEffect"
   ],
+  "canvas_sdk.effects.metadata": [
+    "Metadata"
+  ],
   "canvas_sdk.effects.note": [
     "Appointment",
     "AppointmentIdentifier",
@@ -280,6 +283,7 @@
     "PatientAddress",
     "PatientContactPoint",
     "PatientExternalIdentifier",
+    "PatientMetadata",
     "PatientPreferredPharmacy"
   ],
   "canvas_sdk.effects.patient.base": [
@@ -287,6 +291,7 @@
     "PatientAddress",
     "PatientContactPoint",
     "PatientExternalIdentifier",
+    "PatientMetadata",
     "PatientPreferredPharmacy"
   ],
   "canvas_sdk.effects.patient.create_patient_external_identifier": [
@@ -346,6 +351,9 @@
   "canvas_sdk.effects.questionnaire_result": [
     "CreateQuestionnaireResult"
   ],
+  "canvas_sdk.effects.send_contact_verification": [
+    "SendContactVerificationEffect"
+  ],
   "canvas_sdk.effects.send_invite": [
     "SendInviteEffect"
   ],
@@ -574,6 +582,7 @@
     "DetectedIssueEvidence",
     "Device",
     "Discount",
+    "EligibilitySummary",
     "Encounter",
     "Facility",
     "Goal",
@@ -752,6 +761,7 @@
     "CoverageStack",
     "CoverageState",
     "CoverageType",
+    "EligibilitySummary",
     "Transactor",
     "TransactorAddress",
     "TransactorCoverageType",

protobufs/canvas_generated/messages/effects.proto

@@ -254,6 +254,7 @@ enum EffectType {
   PATIENT_PORTAL__APPOINTMENT_IS_RESCHEDULABLE = 2002;
   PATIENT_PORTAL__APPOINTMENT_SHOW_MEETING_LINK = 2003;
   PATIENT_PORTAL__SEND_INVITE = 2004;
+  PATIENT_PORTAL__SEND_CONTACT_VERIFICATION = 2013;
 
   PATIENT_PORTAL__APPOINTMENTS__SLOTS__POST_SEARCH_RESULTS = 2005;
   PATIENT_PORTAL__APPOINTMENTS__FORM_APPOINTMENT_TYPES__PRE_SEARCH_RESULTS = 2006;
@@ -285,10 +286,12 @@ enum EffectType {
 
   CREATE_APPOINTMENT = 6001;
   UPDATE_APPOINTMENT = 6014;
+  RESCHEDULE_APPOINTMENT = 6022;
   CANCEL_APPOINTMENT = 6015;
   CREATE_SCHEDULE_EVENT = 6002;
   UPDATE_SCHEDULE_EVENT = 6016;
   DELETE_SCHEDULE_EVENT = 6017;
+  RESCHEDULE_SCHEDULE_EVENT = 6023;
 
   CREATE_PATIENT = 6003;
   UPDATE_PATIENT = 6008;
@@ -323,6 +326,8 @@ enum EffectType {
 
   UPSERT_APPOINTMENT_METADATA = 6052;
 
+  APPOINTMENT__SLOTS__POST_SEARCH_RESULTS = 6053;
+
   SHOW_PANEL_SECTIONS = 6100;
 
   REDIRECT_CONTEXT = 6200;

protobufs/canvas_generated/messages/events.proto

@@ -1180,6 +1180,8 @@ enum EventType {
 
   APPOINTMENT__FORM__GET_ADDITIONAL_FIELDS = 141011;
 
+  APPOINTMENT__SLOTS__POST_SEARCH = 141012;
+
   APPOINTMENT_METADATA_CREATED = 141100;
   APPOINTMENT_METADATA_UPDATED = 141111;