canvas 0.38.0__py3-none-any.whl → 0.39.0__py3-none-any.whl

canvas_sdk/effects/note/message.py

@@ -0,0 +1,123 @@
+import json
+from typing import Any
+from uuid import UUID
+
+from pydantic_core import InitErrorDetails
+
+from canvas_generated.messages.effects_pb2 import Effect
+from canvas_sdk.base import TrackableFieldsModel
+from canvas_sdk.v1.data import Message as MessageModel
+from canvas_sdk.v1.data import Patient, Staff
+
+
+class Message(TrackableFieldsModel):
+    """
+    Effect to create and/or send a message.
+    """
+
+    class Meta:
+        effect_type = "MESSAGE"
+
+    message_id: str | UUID | None = None
+    content: str
+    sender_id: str | UUID
+    recipient_id: str | UUID
+
+    def _get_error_details(self, method: Any) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        if (
+            not Patient.objects.filter(id=self.sender_id).exists()
+            and not Staff.objects.filter(id=self.sender_id).exists()
+        ):
+            errors.append(
+                self._create_error_detail(
+                    "value",
+                    f"Sender with ID {self.sender_id} does not exist.",
+                    self.sender_id,
+                )
+            )
+
+        if (
+            not Patient.objects.filter(id=self.recipient_id).exists()
+            and not Staff.objects.filter(id=self.recipient_id).exists()
+        ):
+            errors.append(
+                self._create_error_detail(
+                    "value",
+                    f"Recipient with ID {self.recipient_id} does not exist.",
+                    self.recipient_id,
+                )
+            )
+
+        if method == "edit":
+            if not self.message_id:
+                errors.append(
+                    self._create_error_detail(
+                        "value",
+                        "Message ID is required when editing a message.",
+                        self.message_id,
+                    )
+                )
+            else:
+                if not MessageModel.objects.filter(id=self.message_id).exists():
+                    errors.append(
+                        self._create_error_detail(
+                            "value",
+                            f"Can't edit message with ID {self.message_id}: Does not exist.",
+                            self.message_id,
+                        )
+                    )
+        elif (
+            method
+            in (
+                "create",
+                "create_and_send",
+            )
+            and self.message_id
+        ):
+            errors.append(
+                self._create_error_detail(
+                    "value",
+                    "Can't set message ID when creating a message.",
+                    self.message_id,
+                )
+            )
+
+        return errors
+
+    def create(self) -> Effect:
+        """Originate a new command in the note body."""
+        self._validate_before_effect("create")
+        return Effect(
+            type=f"CREATE_{self.Meta.effect_type}",
+            payload=json.dumps(
+                {
+                    "data": self.values,
+                }
+            ),
+        )
+
+    def create_and_send(self) -> Effect:
+        """Create and send message."""
+        self._validate_before_effect("create_and_send")
+        return Effect(
+            type="CREATE_AND_SEND_MESSAGE",
+            payload=json.dumps({"data": self.values}),
+        )
+
+    def edit(self) -> Effect:
+        """Edit message."""
+        self._validate_before_effect("edit")
+        return Effect(type="EDIT_MESSAGE", payload=json.dumps({"data": self.values}))
+
+    def send(self) -> Effect:
+        """Send message."""
+        self._validate_before_effect("send")
+        return Effect(
+            type="SEND_MESSAGE",
+            payload=json.dumps({"data": self.values}),
+        )
+
+
+__exports__ = ("Message",)

canvas_sdk/effects/patient_metadata_create_form.py

@@ -0,0 +1,70 @@
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Any
+
+from pydantic_core import InitErrorDetails
+
+from canvas_sdk.effects import EffectType, _BaseEffect
+
+
+class InputType(StrEnum):
+    """Type of input for a form field."""
+
+    TEXT = "text"
+    SELECT = "select"
+    DATE = "date"
+
+
+@dataclass
+class FormField:
+    """A class representing a Field."""
+
+    key: str | None = None
+    label: str | None = None
+    required: bool = False
+    editable: bool = True
+    type: InputType = InputType.TEXT
+    options: list[str] | None = None
+
+    def to_dict(self) -> dict[str, Any]:
+        """Convert the Field to a dictionary."""
+        return {
+            "key": self.key,
+            "label": self.label,
+            "required": self.required,
+            "editable": self.editable,
+            "type": self.type.value,
+            "options": self.options,
+        }
+
+
+class PatientMetadataCreateFormEffect(_BaseEffect):
+    """An Effect that will create a form."""
+
+    class Meta:
+        effect_type = EffectType.PATIENT_METADATA__CREATE_ADDITIONAL_FIELDS
+
+    form_fields: list[FormField]
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Return the values of the form as a dictionary."""
+        return {"form": [field.to_dict() for field in self.form_fields]}
+
+    def _get_error_details(self, method: Any) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        for field in self.form_fields:
+            if field.type != InputType.SELECT and field.options:
+                errors.append(
+                    self._create_error_detail(
+                        "value",
+                        "The options attribute is only used for fields of type select",
+                        field.key,
+                    )
+                )
+
+        return errors
+
+
+__exports__ = ("PatientMetadataCreateFormEffect", "FormField", "InputType")

canvas_sdk/v1/data/__init__.py

@@ -36,6 +36,7 @@ from .patient import (
     PatientAddress,
     PatientContactPoint,
     PatientExternalIdentifier,
+    PatientMetadata,
     PatientSetting,
 )
 from .practicelocation import PracticeLocation, PracticeLocationSetting
@@ -106,6 +107,7 @@ __all__ = __exports__ = (
     "PatientContactPoint",
     "PatientExternalIdentifier",
     "PatientSetting",
+    "PatientMetadata",
     "PracticeLocation",
     "PracticeLocationSetting",
     "ProtocolOverride",

canvas_sdk/v1/data/patient.py

@@ -227,6 +227,21 @@ class PatientSetting(models.Model):
     value = models.JSONField()
 
 
+class PatientMetadata(models.Model):
+    """A class representing Patient Metadata."""
+
+    class Meta:
+        managed = False
+        db_table = "canvas_sdk_data_api_patientmetadata_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    patient = models.ForeignKey(
+        "v1.Patient", on_delete=models.DO_NOTHING, related_name="metadata", null=True
+    )
+    key = models.CharField(max_length=255)
+    value = models.CharField(max_length=255)
+
+
 __exports__ = (
     "SexAtBirth",
     "PatientSettingConstants",
@@ -235,6 +250,7 @@ __exports__ = (
     "PatientAddress",
     "PatientExternalIdentifier",
     "PatientSetting",
+    "PatientMetadata",
     # not defined here but used by current plugins
     "ContactPointState",
     "ContactPointSystem",

canvas_sdk/value_set/custom.py

@@ -1,4 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
 from canvas_sdk.value_set.value_set import ValueSet
 
 
@@ -1058,4 +1057,17 @@ class DiabetesOtherClassConditionSuspect(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "Antiarrhythmics",
+    "DiabetesCirculatoryClassConditionSuspect",
+    "DiabetesEyeClassConditionSuspect",
+    "DiabetesEyeConditionSuspect",
+    "DiabetesNeurologicConditionSuspect",
+    "DiabetesOtherClassConditionSuspect",
+    "DiabetesRenalConditionSuspect",
+    "DiabetesWithoutComplication",
+    "DysrhythmiaClassConditionSuspect",
+    "Hcc005v1AnnualWellnessVisit",
+    "HypertensiveChronicKidneyDisease",
+    "LabReportCreatinine",
+)

canvas_sdk/value_set/v2022/allergy.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -234,4 +232,11 @@ class StatinAllergen(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "AceInhibitorOrArbIngredient",
+    "BetaBlockerTherapyIngredient",
+    "EggSubstance",
+    "InfluenzaVaccination",
+    "InfluenzaVaccine",
+    "StatinAllergen",
+)

canvas_sdk/value_set/v2022/assessment.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -217,4 +215,13 @@ class HistoryOfHipFractureInParent(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "AverageNumberOfDrinksPerDrinkingDay",
+    "FallsScreening",
+    "HistoryOfHipFractureInParent",
+    "Phq9AndPhq9MTools",
+    "SexuallyActive",
+    "StandardizedPainAssessmentTool",
+    "StandardizedToolsForAssessmentOfCognition",
+    "TobaccoUseScreening",
+)

canvas_sdk/value_set/v2022/communication.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -327,4 +325,8 @@ class ConsultantReport(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "ConsultantReport",
+    "LevelOfSeverityOfRetinopathyFindings",
+    "MacularEdemaFindingsPresent",
+)

canvas_sdk/value_set/v2022/condition.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -40656,4 +40654,178 @@ class UrinaryRetention(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "ActiveTuberculosisForUrologyCare",
+    "AcuteAndSubacuteIridocyclitis",
+    "AcutePharyngitis",
+    "AcuteTonsillitis",
+    "AlcoholAndDrugDependence",
+    "AlcoholWithdrawal",
+    "AllergyToAceInhibitorOrArb",
+    "AllergyToBetaBlockerTherapy",
+    "AllergyToEggs",
+    "AllergyToInfluenzaVaccine",
+    "Amblyopia",
+    "AnaphylacticReactionToCommonBakersYeast",
+    "AnaphylacticReactionToDtapVaccine",
+    "AnkylosingSpondylitis",
+    "Arrhythmia",
+    "Asthma",
+    "AtherosclerosisAndPeripheralArterialDisease",
+    "AtrioventricularBlock",
+    "BenzodiazepineWithdrawal",
+    "BipolarDiagnosis",
+    "BipolarDisorder",
+    "BladderCancerForUrologyCare",
+    "Bradycardia",
+    "Breastfeeding",
+    "BurnConfinedToEyeAndAdnexa",
+    "Cancer",
+    "CardiacPacerInSitu",
+    "Cataract_Congenital",
+    "Cataract_MatureOrHypermature",
+    "Cataract_PosteriorPolar",
+    "CataractSecondaryToOcularDisorders",
+    "CentralCornealUlcer",
+    "CerebrovascularDisease_Stroke_Tia",
+    "CertainTypesOfIridocyclitis",
+    "ChoroidalDegenerations",
+    "ChoroidalDetachment",
+    "ChoroidalHemorrhageAndRupture",
+    "ChronicIridocyclitis",
+    "ChronicKidneyDisease_Stage5",
+    "ChronicLiverDisease",
+    "ChronicMalnutrition",
+    "CloudyCornea",
+    "ComorbidConditionsForRespiratoryConditions",
+    "CompetingConditionsForRespiratoryConditions",
+    "ComplicationsOfPregnancy_ChildbirthAndThePuerperium",
+    "CongenitalOrAcquiredAbsenceOfCervix",
+    "CornealEdema",
+    "CornealOpacityAndOtherDisordersOfCornea",
+    "CoronaryArteryDiseaseNoMi",
+    "CushingsSyndrome",
+    "DegenerationOfMaculaAndPosteriorPole",
+    "DegenerativeDisordersOfGlobe",
+    "DementiaAndMentalDegenerations",
+    "DentalCaries",
+    "DepressionDiagnosis",
+    "Diabetes",
+    "DiabeticMacularEdema",
+    "DiabeticNephropathy",
+    "DiabeticRetinopathy",
+    "DiagnosesUsedToIndicateSexualActivity",
+    "DiagnosisOfHypertension",
+    "DisordersOfOpticChiasm",
+    "DisordersOfTheImmuneSystem",
+    "DisordersOfVisualCortex",
+    "DisseminatedChorioretinitisAndDisseminatedRetinochoroiditis",
+    "Dysthymia",
+    "EhlersDanlosSyndrome",
+    "EncephalopathyDueToChildhoodVaccination",
+    "EndStageRenalDisease",
+    "EssentialHypertension",
+    "FamilialHypercholesterolemia",
+    "FocalChorioretinitisAndFocalRetinochoroiditis",
+    "FractureLowerBody",
+    "FrailtyDiagnosis",
+    "GeneralizedAnxietyDisorder",
+    "Glaucoma",
+    "GlaucomaAssociatedWithCongenitalAnomalies_Dystrophies_AndSystemicSyndromes",
+    "GlomerulonephritisAndNephroticSyndrome",
+    "HeartFailure",
+    "HepatitisA",
+    "HepatitisB",
+    "HereditaryChoroidalDystrophies",
+    "HereditaryCornealDystrophies",
+    "HereditaryRetinalDystrophies",
+    "HistoryOfBilateralMastectomy",
+    "Hiv",
+    "Hyperparathyroidism",
+    "HypertensiveChronicKidneyDisease",
+    "Hyperthyroidism",
+    "Hypotension",
+    "HypotonyOfEye",
+    "ImmunocompromisedConditions",
+    "IndicatorsOfHumanImmunodeficiencyVirusHiv",
+    "InjuryToOpticNerveAndPathways",
+    "IntoleranceToAceInhibitorOrArb",
+    "IntoleranceToBetaBlockerTherapy",
+    "IntoleranceToInfluenzaVaccine",
+    "Intussusception",
+    "IschemicHeartDiseaseOrOtherRelatedDiagnoses",
+    "KidneyFailure",
+    "KidneyTransplantRecipient",
+    "LimitedLifeExpectancy",
+    "LiverDisease",
+    "Lupus",
+    "MacularScarOfPosteriorPolar",
+    "MajorDepression",
+    "MajorDepressionIncludingRemission",
+    "MalabsorptionSyndromes",
+    "MalignantNeoplasmOfColon",
+    "MalignantNeoplasmOfLymphaticAndHematopoieticTissue",
+    "MarfansSyndrome",
+    "Measles",
+    "MixedHistologyUrothelialCellCarcinomaForUrologyCare",
+    "ModerateOrSevereLvsd",
+    "MorbidObesity",
+    "MorgagnianCataract",
+    "Mumps",
+    "MyocardialInfarction",
+    "Narcolepsy",
+    "NystagmusAndOtherIrregularEyeMovements",
+    "OpenWoundOfEyeball",
+    "OpticAtrophy",
+    "OpticNeuritis",
+    "OsteogenesisImperfecta",
+    "Osteopenia",
+    "Osteoporosis",
+    "OsteoporoticFractures",
+    "OtherAndUnspecifiedFormsOfChorioretinitisAndRetinochoroiditis",
+    "OtherBackgroundRetinopathyAndRetinalVascularChanges",
+    "OtherBipolarDisorder",
+    "OtherDisordersOfOpticNerve",
+    "OtherEndophthalmitis",
+    "OtherProliferativeRetinopathy",
+    "PainRelatedToProstateCancer",
+    "PathologicMyopia",
+    "PersonalityDisorderEmotionallyLabile",
+    "PervasiveDevelopmentalDisorder",
+    "PosteriorLenticonus",
+    "Pregnancy",
+    "PregnancyOrOtherRelatedDiagnoses",
+    "PrimaryOpenAngleGlaucoma",
+    "PriorPenetratingKeratoplasty",
+    "ProstateCancer",
+    "Proteinuria",
+    "PsoriaticArthritis",
+    "PurulentEndophthalmitis",
+    "RemSleepBehaviorDisorder",
+    "RenalFailureDueToAceInhibitor",
+    "RetinalDetachmentWithRetinalDefect",
+    "RetinalVascularOcclusion",
+    "RetrolentalFibroplasias",
+    "Rhabdomyolysis",
+    "RheumatoidArthritis",
+    "Rubella",
+    "Schizophrenia",
+    "SchizophreniaOrPsychoticDisorder",
+    "Scleritis",
+    "SeizureDisorder",
+    "SeparationOfRetinalLayers",
+    "SevereCombinedImmunodeficiency",
+    "StableAndUnstableAngina",
+    "StatinAssociatedMuscleSymptoms",
+    "StatusPostLeftMastectomy",
+    "StatusPostRightMastectomy",
+    "TraumaticCataract",
+    "Type1Diabetes",
+    "UnilateralMastectomy_UnspecifiedLaterality",
+    "UpperRespiratoryInfection",
+    "UrinaryRetention",
+    "Uveitis",
+    "VaricellaZoster",
+    "VascularDisordersOfIrisAndCiliaryBody",
+    "VisualFieldDefects",
+)

canvas_sdk/value_set/v2022/device.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -176,4 +174,7 @@ class CardiacPacer(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "CardiacPacer",
+    "FrailtyDevice",
+)

canvas_sdk/value_set/v2022/diagnostic_study.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -4969,4 +4967,16 @@ class DexaDualEnergyXrayAbsorptiometry_BoneDensityForUrologyCare(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "BoneScan",
+    "CtColonography",
+    "CupToDiscRatio",
+    "DexaDualEnergyXrayAbsorptiometry_BoneDensityForUrologyCare",
+    "DiagnosticStudiesDuringPregnancy",
+    "DxaDualEnergyXrayAbsorptiometryScan",
+    "EjectionFraction",
+    "MacularExam",
+    "Mammography",
+    "OpticDiscExamForStructuralAbnormalities",
+    "XRayStudyAllInclusive",
+)

canvas_sdk/value_set/v2022/encounter.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -2566,4 +2564,61 @@ class HospitalServicesForUrologyCare(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "AcuteInpatient",
+    "AnnualWellnessVisit",
+    "AudiologyVisit",
+    "BehavioralHealthFollowUpVisit",
+    "BehavioralNeuropsychAssessment",
+    "CareServicesInLongTermResidentialFacility",
+    "ClinicalOralEvaluation",
+    "ContactOrOfficeVisit",
+    "DetoxificationVisit",
+    "DischargeServicesHospitalInpatient",
+    "DischargeServicesHospitalInpatientSameDayDischarge",
+    "DischargeServicesNursingFacility",
+    "EmergencyDepartmentVisit",
+    "EncounterInfluenza",
+    "EncounterInpatient",
+    "EncounterToDocumentMedications",
+    "EncounterToEvaluateBmi",
+    "EncounterToScreenForBloodPressure",
+    "EncounterToScreenForDepression",
+    "EsrdMonthlyOutpatientServices",
+    "FrailtyEncounter",
+    "GroupPsychotherapy",
+    "HomeHealthcareServices",
+    "HospitalInpatientVisitInitial",
+    "HospitalObservationCareInitial",
+    "HospitalServicesForUrologyCare",
+    "MedicalDisabilityExam",
+    "NonacuteInpatient",
+    "NursingFacilityVisit",
+    "Observation",
+    "OccupationalTherapyEvaluation",
+    "OfficeVisit",
+    "OnlineAssessments",
+    "OphthalmologicalServices",
+    "OphthalmologicServices",
+    "Outpatient",
+    "OutpatientConsultation",
+    "OutpatientEncountersForPreventiveCare",
+    "PalliativeCareEncounter",
+    "PatientProviderInteraction",
+    "PhysicalTherapyEvaluation",
+    "PreventiveCare_EstablishedOfficeVisit_0To17",
+    "PreventiveCareServices_InitialOfficeVisit_0To17",
+    "PreventiveCareServicesEstablishedOfficeVisit_18AndUp",
+    "PreventiveCareServicesGroupCounseling",
+    "PreventiveCareServicesIndividualCounseling",
+    "PreventiveCareServicesInitialOfficeVisit_18AndUp",
+    "PreventiveCareServicesOther",
+    "Psychoanalysis",
+    "PsychotherapyAndPharmacologicManagement",
+    "PsychVisitDiagnosticEvaluation",
+    "PsychVisitFamilyPsychotherapy",
+    "PsychVisitPsychotherapy",
+    "SpeechAndHearingEvaluation",
+    "TelehealthServices",
+    "TelephoneVisits",
+)

canvas_sdk/value_set/v2022/immunization.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -343,4 +341,18 @@ class PneumococcalPolysaccharide23Vaccine(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "DtapVaccine",
+    "HepatitisAVaccine",
+    "HepatitisBVaccine",
+    "HibVaccine3DoseSchedule",
+    "HibVaccine4DoseSchedule",
+    "InactivatedPolioVaccineIpv",
+    "InfluenzaVaccine",
+    "InfluenzaVirusLaivImmunization",
+    "Measles_MumpsAndRubellaMmrVaccine",
+    "PneumococcalConjugateVaccine",
+    "PneumococcalPolysaccharide23Vaccine",
+    "RotavirusVaccine3DoseSchedule",
+    "VaricellaZosterVaccineVzv",
+)

canvas_sdk/value_set/v2022/individual_characteristic.py

@@ -1,5 +1,3 @@
-from canvas_sdk.value_set._utilities import get_overrides
-
 from ..value_set import ValueSet
 
 
@@ -315,4 +313,11 @@ class White(ValueSet):
     }
 
 
-__exports__ = get_overrides(locals())
+__exports__ = (
+    "Ethnicity",
+    "Female",
+    "OncAdministrativeSex",
+    "Payer",
+    "Race",
+    "White",
+)