canvas 0.62.0__py3-none-any.whl → 0.64.0__py3-none-any.whl

canvas_sdk/v1/data/appointment.py

@@ -29,6 +29,11 @@ class Appointment(IdentifiableModel):
         related_name="appointments",
         null=True,
     )
+
+    parent_appointment = models.ForeignKey(
+        "self", on_delete=models.CASCADE, null=True, blank=True, related_name="children"
+    )
+
     appointment_rescheduled_from = models.ForeignKey(
         "self",
         on_delete=models.DO_NOTHING,
@@ -74,8 +79,22 @@ class AppointmentExternalIdentifier(IdentifiableModel):
     )
 
 
+class AppointmentMetadata(IdentifiableModel):
+    """A class representing Appointment Metadata."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_appointmentmetadata_001"
+
+    appointment = models.ForeignKey(
+        "v1.Appointment", on_delete=models.CASCADE, related_name="metadata", null=True
+    )
+    key = models.CharField(max_length=32)
+    value = models.CharField(max_length=256)
+
+
 __exports__ = (
     "AppointmentProgressStatus",
     "Appointment",
+    "AppointmentMetadata",
     "AppointmentExternalIdentifier",
 )

canvas_sdk/v1/data/claim_diagnosis_code.py

@@ -0,0 +1,22 @@
+from django.db import models
+
+from canvas_sdk.v1.data.base import IdentifiableModel
+
+
+class ClaimDiagnosisCode(IdentifiableModel):
+    """ClaimDiagnosisCode model for claim diagnosis codes."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_quality_and_revenue_claimdiagnosiscode_001"
+        ordering = ["rank"]
+
+    claim = models.ForeignKey("v1.Claim", on_delete=models.CASCADE, related_name="diagnosis_codes")
+    rank = models.IntegerField()
+    code = models.CharField(max_length=20, blank=True)
+    display = models.CharField(max_length=1000, blank=True)
+
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+
+
+__exports__ = ("ClaimDiagnosisCode",)

canvas_sdk/v1/data/encounter.py

@@ -0,0 +1,46 @@
+from django.db import models
+from django.utils import timezone
+
+from canvas_sdk.v1.data.base import IdentifiableModel
+
+
+class EncounterMedium(models.TextChoices):
+    """Encounter medium."""
+
+    VOICE = "voice", "Telephone visit"
+    VIDEO = "video", "Video visit"
+    OFFICE = "office", "Office visit"
+    HOME = "home", "Home visit"
+    OFFSITE = "offsite", "Other offsite visit"
+    LAB = "lab", "Lab visit"
+
+
+class EncounterState(models.TextChoices):
+    """Encounter state."""
+
+    STARTED = "STA", "Started"
+    PLANNED = "PLA", "Planned"
+    CONCLUDED = "CON", "Concluded"
+    CANCELLED = "CAN", "Cancelled"
+
+
+class Encounter(IdentifiableModel):
+    """Encounter."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_encounter_001"
+
+    note = models.OneToOneField("v1.Note", on_delete=models.CASCADE, related_name="encounter")
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+    medium = models.CharField(choices=EncounterMedium.choices, max_length=20)
+    state = models.CharField(max_length=3, choices=EncounterState.choices)
+    start_time = models.DateTimeField(default=timezone.now, null=True)
+    end_time = models.DateTimeField(default=None, null=True)
+
+
+__exports__ = (
+    "Encounter",
+    "EncounterMedium",
+    "EncounterState",
+)

canvas_sdk/v1/data/immunization.py

@@ -0,0 +1,159 @@
+from typing import Self, cast
+
+from django.db import models
+
+from canvas_sdk.v1.data.base import (
+    BaseModelManager,
+    CommittableQuerySetMixin,
+    ForPatientQuerySetMixin,
+    IdentifiableModel,
+    Model,
+    ValueSetLookupQuerySet,
+)
+
+
+class ImmunizationStatus(models.TextChoices):
+    """ImmunizationStatus."""
+
+    STATUS_IN_PROGRESS = "in-progress", "In Progress"
+    STATUS_ONHOLD = "on-hold"
+    STATUS_COMPLETED = "completed"
+    STATUS_STOPPED = "stopped"
+
+
+class ImmunizationReasonsNotGiven(models.TextChoices):
+    """ImmunizationReasonsNotGiven."""
+
+    NA = "NA", "not applicable"
+    IMMUNE = "IMMUNE", "immunity"
+    MEDPREC = "MEDPREC", "medical precaution"
+    OSTOCK = "OSTOCK", "product out of stock"
+    PATOBJ = "PATOBJ", "patient objection"
+
+
+class ImmunizationQuerySet(
+    ValueSetLookupQuerySet, CommittableQuerySetMixin, ForPatientQuerySetMixin
+):
+    """ImmunizationQuerySet."""
+
+    def active(self) -> Self:
+        """Filter immunizations."""
+        return self.committed()
+
+
+ImmunizationManager = BaseModelManager.from_queryset(ImmunizationQuerySet)
+
+
+class Immunization(IdentifiableModel):
+    """Immunization."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_immunization_001"
+
+    objects = cast(ImmunizationQuerySet, ImmunizationManager())
+
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="immunizations", null=True
+    )
+    note = models.ForeignKey("v1.Note", on_delete=models.DO_NOTHING, related_name="immunizations")
+    status = models.CharField(
+        choices=ImmunizationStatus.choices,
+        max_length=20,
+        default=ImmunizationStatus.STATUS_IN_PROGRESS,
+    )
+    lot_number = models.CharField(max_length=20, blank=True, default="")
+    manufacturer = models.CharField(max_length=100, blank=True, default="")
+    exp_date_original = models.CharField(max_length=50, blank=True, default="")
+    exp_date = models.DateField(null=True)
+    sig_original = models.CharField(max_length=75, blank=True, default="")
+    date_ordered = models.DateField(null=True)
+    given_by = models.ForeignKey(
+        "v1.Staff", on_delete=models.DO_NOTHING, related_name="immunizations_given", null=True
+    )
+    consent_given = models.BooleanField(default=False)
+    take_quantity = models.FloatField(null=True)
+    dose_form = models.CharField(max_length=255, blank=True, default="")
+    route = models.CharField(max_length=255, blank=True, default="")
+    frequency_normalized_per_day = models.FloatField(null=True)
+    deleted = models.BooleanField()
+
+
+class ImmunizationCoding(Model):
+    """ImmunizationCoding."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_immunizationcoding_001"
+
+    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()
+    immunization = models.ForeignKey(
+        Immunization, on_delete=models.DO_NOTHING, related_name="codings", null=True
+    )
+
+
+class ImmunizationStatementQuerySet(
+    ValueSetLookupQuerySet, CommittableQuerySetMixin, ForPatientQuerySetMixin
+):
+    """ImmunizationStatementQuerySet."""
+
+    def active(self) -> Self:
+        """Filter immunizations statements."""
+        return self.committed()
+
+
+ImmunizationStatementManager = BaseModelManager.from_queryset(ImmunizationStatementQuerySet)
+
+
+class ImmunizationStatement(IdentifiableModel):
+    """ImmunizationStatement."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_immunizationstatement_001"
+
+    objects = cast(ImmunizationStatementQuerySet, ImmunizationStatementManager())
+
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="immunization_statements", null=True
+    )
+    note = models.ForeignKey(
+        "v1.Note", on_delete=models.DO_NOTHING, related_name="immunization_statements"
+    )
+    date_original = models.CharField(max_length=50, blank=True, default="")
+    date = models.DateField(null=True)
+    evidence = models.CharField(max_length=255, blank=True, default="")
+    comment = models.CharField(max_length=255, blank=True, default="")
+    reason_not_given = models.CharField(
+        max_length=20,
+        choices=ImmunizationReasonsNotGiven.choices,
+        default=ImmunizationReasonsNotGiven.NA,
+    )
+    deleted = models.BooleanField()
+
+
+class ImmunizationStatementCoding(Model):
+    """ImmunizationStatementCoding."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_immunizationstatementcoding_001"
+
+    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()
+    immunization_statement = models.ForeignKey(
+        ImmunizationStatement, on_delete=models.CASCADE, related_name="coding"
+    )
+
+
+__exports__ = (
+    "ImmunizationStatus",
+    "ImmunizationReasonsNotGiven",
+    "Immunization",
+    "ImmunizationCoding",
+    "ImmunizationStatement",
+    "ImmunizationStatementCoding",
+)

canvas_sdk/v1/data/medication_statement.py

@@ -0,0 +1,50 @@
+from django.db import models
+
+from canvas_sdk.v1.data.base import IdentifiableModel
+
+
+class MedicationStatement(IdentifiableModel):
+    """MedicationStatement."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_medicationstatement_001"
+
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="medication_statements"
+    )
+    note = models.ForeignKey(
+        "v1.Note", on_delete=models.DO_NOTHING, related_name="medication_statements"
+    )
+    medication = models.ForeignKey(
+        "v1.Medication",
+        on_delete=models.DO_NOTHING,
+        related_name="medication_statements",
+        null=True,
+    )
+    indications = models.ManyToManyField(
+        "v1.Assessment",
+        related_name="treatments_stated",
+        db_table="canvas_sdk_data_api_medicationstatement_indications_001",
+    )
+    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)
+    start_date_original_input = models.CharField(max_length=255, default="")
+    start_date = models.DateField(default=None, null=True)
+    end_date_original_input = models.CharField(max_length=255, default="")
+    end_date = models.DateField(default=None, null=True)
+    dose_quantity = models.FloatField(null=True)
+    dose_form = models.CharField(max_length=255, default="")
+    dose_route = models.CharField(max_length=255, default="")
+    dose_frequency = models.FloatField(null=True)
+    dose_frequency_interval = models.CharField(max_length=255, default="")
+    sig_original_input = models.CharField(max_length=255, default="")
+
+
+__exports__ = ("MedicationStatement",)

canvas_sdk/v1/data/patient.py

@@ -72,6 +72,9 @@ class Patient(Model):
     biological_race_codes = ArrayField(
         models.CharField(max_length=100, default="", blank=True), default=list, blank=True
     )
+    cultural_ethnicity_codes = ArrayField(
+        models.CharField(max_length=100, default="", blank=True), default=list, blank=True
+    )
     last_known_timezone = models.CharField(max_length=32, null=True, blank=True)
     mrn = models.CharField(max_length=9, unique=True, default=generate_mrn)
     active = models.BooleanField(default=True)
@@ -287,10 +290,10 @@ class PatientMetadata(IdentifiableModel):
         db_table = "canvas_sdk_data_api_patientmetadata_001"
 
     patient = models.ForeignKey(
-        "v1.Patient", on_delete=models.DO_NOTHING, related_name="metadata", null=True
+        "v1.Patient", on_delete=models.CASCADE, related_name="metadata", null=True
     )
-    key = models.CharField(max_length=255)
-    value = models.CharField(max_length=255)
+    key = models.CharField(max_length=32)
+    value = models.CharField(max_length=256)
 
 
 class PatientFacilityAddress(PatientAddress):

canvas_sdk/v1/data/stop_medication_event.py

@@ -0,0 +1,36 @@
+from django.db import models
+
+from canvas_sdk.v1.data.base import IdentifiableModel
+
+
+class StopMedicationEvent(IdentifiableModel):
+    """StopMedicationEvent."""
+
+    class Meta:
+        db_table = "canvas_sdk_data_api_stopmedicationevent_001"
+
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="stopped_medications"
+    )
+    note = models.ForeignKey(
+        "v1.Note", on_delete=models.DO_NOTHING, related_name="stopped_medications"
+    )
+    medication = models.ForeignKey(
+        "v1.Medication",
+        on_delete=models.DO_NOTHING,
+        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="")
+
+
+__exports__ = ("StopMedicationEvent",)

plugin_runner/allowed-module-imports.json

@@ -178,6 +178,20 @@
     "EffectType",
     "_BaseEffect"
   ],
+  "canvas_sdk.effects.appointments_metadata": [
+    "AppointmentsMetadata",
+    "AppointmentsMetadataCreateFormEffect",
+    "FormField",
+    "InputType"
+  ],
+  "canvas_sdk.effects.appointments_metadata.appointments_metadata_create_form": [
+    "AppointmentsMetadataCreateFormEffect",
+    "FormField",
+    "InputType"
+  ],
+  "canvas_sdk.effects.appointments_metadata.base": [
+    "AppointmentsMetadata"
+  ],
   "canvas_sdk.effects.banner_alert": [
     "AddBannerAlert",
     "RemoveBannerAlert"
@@ -206,12 +220,29 @@
   "canvas_sdk.effects.billing_line_item.update_billing_line_item": [
     "UpdateBillingLineItem"
   ],
+  "canvas_sdk.effects.calendar": [
+    "CalendarType",
+    "CreateCalendar",
+    "CreateEvent",
+    "EventRecurrence"
+  ],
+  "canvas_sdk.effects.calendar.create_calendar": [
+    "CalendarType",
+    "CreateCalendar"
+  ],
+  "canvas_sdk.effects.calendar.create_event": [
+    "CreateEvent",
+    "EventRecurrence"
+  ],
   "canvas_sdk.effects.compound_medications": [
     "CompoundMedication"
   ],
   "canvas_sdk.effects.compound_medications.compound_medication": [
     "CompoundMedication"
   ],
+  "canvas_sdk.effects.generate_full_chart_pdf": [
+    "GenerateFullChartPDFEffect"
+  ],
   "canvas_sdk.effects.group": [
     "Group"
   ],
@@ -478,6 +509,7 @@
   "canvas_sdk.questionnaires.utils": [
     "Draft7Validator",
     "ExtendedDraft7Validator",
+    "QuestionnaireConfig",
     "from_yaml"
   ],
   "canvas_sdk.templates": [
@@ -512,6 +544,7 @@
     "AllergyIntoleranceCoding",
     "Appointment",
     "AppointmentExternalIdentifier",
+    "AppointmentMetadata",
     "Assessment",
     "BannerAlert",
     "BasePosting",
@@ -526,6 +559,7 @@
     "ChargeDescriptionMaster",
     "Claim",
     "ClaimCoverage",
+    "ClaimDiagnosisCode",
     "ClaimLineItem",
     "ClaimPatient",
     "ClaimQueue",
@@ -540,11 +574,16 @@
     "DetectedIssueEvidence",
     "Device",
     "Discount",
+    "Encounter",
     "Facility",
     "Goal",
     "ImagingOrder",
     "ImagingReport",
     "ImagingReview",
+    "Immunization",
+    "ImmunizationCoding",
+    "ImmunizationStatement",
+    "ImmunizationStatementCoding",
     "InstallmentPlan",
     "Interview",
     "InterviewQuestionResponse",
@@ -563,6 +602,7 @@
     "LineItemTransfer",
     "Medication",
     "MedicationCoding",
+    "MedicationStatement",
     "Message",
     "MessageAttachment",
     "MessageTransmission",
@@ -609,6 +649,7 @@
     "StaffLicense",
     "StaffPhoto",
     "StaffRole",
+    "StopMedicationEvent",
     "Task",
     "TaskComment",
     "TaskLabel",
@@ -626,6 +667,7 @@
   "canvas_sdk.v1.data.appointment": [
     "Appointment",
     "AppointmentExternalIdentifier",
+    "AppointmentMetadata",
     "AppointmentProgressStatus"
   ],
   "canvas_sdk.v1.data.assessment": [
@@ -664,6 +706,9 @@
     "InstallmentPlan",
     "InstallmentPlanStatus"
   ],
+  "canvas_sdk.v1.data.claim_diagnosis_code": [
+    "ClaimDiagnosisCode"
+  ],
   "canvas_sdk.v1.data.claim_line_item": [
     "ClaimLineItem",
     "ClaimLineItemStatus",
@@ -719,6 +764,11 @@
   "canvas_sdk.v1.data.discount": [
     "Discount"
   ],
+  "canvas_sdk.v1.data.encounter": [
+    "Encounter",
+    "EncounterMedium",
+    "EncounterState"
+  ],
   "canvas_sdk.v1.data.facility": [
     "Facility"
   ],
@@ -733,6 +783,14 @@
     "ImagingReport",
     "ImagingReview"
   ],
+  "canvas_sdk.v1.data.immunization": [
+    "Immunization",
+    "ImmunizationCoding",
+    "ImmunizationReasonsNotGiven",
+    "ImmunizationStatement",
+    "ImmunizationStatementCoding",
+    "ImmunizationStatus"
+  ],
   "canvas_sdk.v1.data.invoice": [
     "Invoice",
     "InvoiceRecipients",
@@ -764,6 +822,9 @@
     "MedicationCoding",
     "Status"
   ],
+  "canvas_sdk.v1.data.medication_statement": [
+    "MedicationStatement"
+  ],
   "canvas_sdk.v1.data.message": [
     "Message",
     "MessageAttachment",
@@ -869,6 +930,9 @@
     "StaffPhoto",
     "StaffRole"
   ],
+  "canvas_sdk.v1.data.stop_medication_event": [
+    "StopMedicationEvent"
+  ],
   "canvas_sdk.v1.data.task": [
     "EventType",
     "Task",

protobufs/canvas_generated/messages/effects.proto

@@ -307,6 +307,22 @@ enum EffectType {
 
   PATIENT_CHART__GROUP_ITEMS = 6030;
 
+  APPOINTMENT__FORM__PROVIDERS__PRE_SEARCH_RESULTS = 6040;
+  APPOINTMENT__FORM__LOCATIONS__PRE_SEARCH_RESULTS = 6041;
+  APPOINTMENT__FORM__VISIT_TYPES__PRE_SEARCH_RESULTS = 6042;
+  APPOINTMENT__FORM__DURATIONS__PRE_SEARCH_RESULTS = 6043;
+  APPOINTMENT__FORM__REASON_FOR_VISIT__PRE_SEARCH_RESULTS = 6044;
+
+  APPOINTMENT__FORM__PROVIDERS__POST_SEARCH_RESULTS = 6046;
+  APPOINTMENT__FORM__LOCATIONS__POST_SEARCH_RESULTS = 6047;
+  APPOINTMENT__FORM__VISIT_TYPES__POST_SEARCH_RESULTS = 6048;
+  APPOINTMENT__FORM__DURATIONS__POST_SEARCH_RESULTS = 6049;
+  APPOINTMENT__FORM__REASON_FOR_VISIT__POST_SEARCH_RESULTS = 6050;
+
+  APPOINTMENT__FORM__CREATE_ADDITIONAL_FIELDS = 6051;
+
+  UPSERT_APPOINTMENT_METADATA = 6052;
+
   SHOW_PANEL_SECTIONS = 6100;
 
   REDIRECT_CONTEXT = 6200;
@@ -318,6 +334,10 @@ enum EffectType {
   REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD__ADD_RESPONSE = 7005;
   REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD__REMOVE_RESPONSE = 7006;
 
+  GENERATE_FULL_CHART_PDF = 6101;
+
+  CALENDAR__CREATE = 8001;
+  CALENDAR__EVENT__CREATE = 8002;
 }
 
 message Effect {

protobufs/canvas_generated/messages/events.proto

@@ -1122,6 +1122,7 @@ enum EventType {
   PLUGIN_UPDATED = 102001;
 
   APPLICATION__ON_OPEN = 103000;
+  APPLICATION__ON_CONTEXT_CHANGE = 103001;
 
   PATIENT_PORTAL__GET_FORMS = 110000;
   PATIENT_PORTAL__APPOINTMENT_CANCELED = 110001;
@@ -1165,6 +1166,23 @@ enum EventType {
   PATIENT_METADATA_CREATED = 140004;
   PATIENT_METADATA_UPDATED = 140005;
 
+  APPOINTMENT__FORM__PROVIDERS__PRE_SEARCH = 141000;
+  APPOINTMENT__FORM__LOCATIONS__PRE_SEARCH = 141001;
+  APPOINTMENT__FORM__VISIT_TYPES__PRE_SEARCH = 141002;
+  APPOINTMENT__FORM__DURATIONS__PRE_SEARCH = 141003;
+  APPOINTMENT__FORM__REASON_FOR_VISIT__PRE_SEARCH = 141004;
+
+  APPOINTMENT__FORM__PROVIDERS__POST_SEARCH = 141006;
+  APPOINTMENT__FORM__LOCATIONS__POST_SEARCH = 141007;
+  APPOINTMENT__FORM__VISIT_TYPES__POST_SEARCH = 141008;
+  APPOINTMENT__FORM__DURATIONS__POST_SEARCH = 141009;
+  APPOINTMENT__FORM__REASON_FOR_VISIT__POST_SEARCH = 141010;
+
+  APPOINTMENT__FORM__GET_ADDITIONAL_FIELDS = 141011;
+
+  APPOINTMENT_METADATA_CREATED = 141100;
+  APPOINTMENT_METADATA_UPDATED = 141111;
+
   DOCUMENT_REFERENCE_CREATED = 150000;
   DOCUMENT_REFERENCE_UPDATED = 150001;
   DOCUMENT_REFERENCE_DELETED = 150002;

settings.py

@@ -77,10 +77,24 @@ else:
 
 PLUGIN_RUNNER_MAX_WORKERS = int(os.getenv("PLUGIN_RUNNER_MAX_WORKERS", 5))
 
+# By default, allow a pool size that gives each worker 2 active connections
+# and allow overriding via environment variable if necessary
+PLUGIN_RUNNER_DATABASE_POOL_MAX = int(
+    os.getenv(
+        "PLUGIN_RUNNER_DATABASE_POOL_MAX",
+        PLUGIN_RUNNER_MAX_WORKERS * 2,
+    )
+)
+
 if CANVAS_SDK_DB_BACKEND == "postgres":
     db_config: dict[str, Any] = {
         "ENGINE": "django.db.backends.postgresql",
-        "OPTIONS": {"pool": {"min_size": 2, "max_size": PLUGIN_RUNNER_MAX_WORKERS}},
+        "OPTIONS": {
+            "pool": {
+                "min_size": 2,
+                "max_size": PLUGIN_RUNNER_DATABASE_POOL_MAX,
+            }
+        },
     }
 
     if CANVAS_SDK_DB_URL: