canvas 0.2.10__py3-none-any.whl → 0.3.0__py3-none-any.whl

canvas_sdk/v1/data/lab.py

@@ -6,6 +6,8 @@ from canvas_sdk.v1.data.user import CanvasUser
 
 
 class LabReport(models.Model):
+    """A class representing a lab report."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"
@@ -38,6 +40,8 @@ class LabReport(models.Model):
 
 
 class LabReview(models.Model):
+    """A class representing a lab review."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"
@@ -61,6 +65,8 @@ class LabReview(models.Model):
 
 
 class LabValue(models.Model):
+    """A class representing a lab value."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"
@@ -82,6 +88,8 @@ class LabValue(models.Model):
 
 
 class LabValueCoding(models.Model):
+    """A class representing a lab value coding."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"

canvas_sdk/v1/data/patient.py

@@ -4,6 +4,8 @@ from django.db import models
 
 
 class Patient(models.Model):
+    """A class representing a patient."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"
@@ -46,4 +48,5 @@ class Patient(models.Model):
 
     @classmethod
     def find(cls, id: str) -> Self:
+        """Find a patient by id."""
         return cls.objects.get(id=id)

canvas_sdk/v1/data/questionnaire.py

@@ -0,0 +1,204 @@
+from collections.abc import Container
+
+from django.db import models
+from django.db.models import Q
+
+from canvas_sdk.v1.data import Patient
+from canvas_sdk.v1.data.base import (
+    CommittableModelManager,
+    ValueSetLookupByNameQuerySet,
+)
+from canvas_sdk.v1.data.user import CanvasUser
+
+
+class ResponseOptionSet(models.Model):
+    """ResponseOptionSet."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_responseoptionset_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    status = models.CharField()
+    name = models.CharField()
+    code_system = models.CharField()
+    code = models.CharField()
+    type = models.CharField()
+    use_in_shx = models.BooleanField()
+
+
+class ResponseOption(models.Model):
+    """ResponseOption."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_responseoption_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    status = models.CharField()
+    name = models.CharField()
+    code = models.CharField()
+    code_description = models.CharField()
+    value = models.CharField()
+    response_option_set = models.ForeignKey(
+        ResponseOptionSet, on_delete=models.DO_NOTHING, related_name="options"
+    )
+    ordering = models.IntegerField()
+
+
+class Question(models.Model):
+    """Question."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_question_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    status = models.CharField()
+    name = models.CharField()
+    response_option_set = models.ForeignKey(
+        ResponseOptionSet, on_delete=models.DO_NOTHING, related_name="questions"
+    )
+    acknowledge_only = models.BooleanField()
+    show_prologue = models.BooleanField()
+    code_system = models.CharField()
+    code = models.CharField()
+
+
+class QuestionnaireValueSetLookupQuerySet(ValueSetLookupByNameQuerySet):
+    """QuerySet class for Questionaire ValueSet lookups."""
+
+    @staticmethod
+    def q_object(system: str, codes: Container[str]) -> Q:
+        """The code system and code values for a Questionnaire are just attributes on the model."""
+        return Q(code_system=system, code__in=codes)
+
+
+class Questionnaire(models.Model):
+    """Questionnaire."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_questionnaire_001"
+
+    objects = models.Manager.from_queryset(QuestionnaireValueSetLookupQuerySet)()
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    status = models.CharField()
+    name = models.CharField()
+    expected_completion_time = models.FloatField()
+    can_originate_in_charting = models.BooleanField()
+    use_case_in_charting = models.CharField()
+    scoring_function_name = models.TextField()
+    scoring_code_system = models.CharField()
+    scoring_code = models.CharField()
+    code_system = models.CharField()
+    code = models.CharField()
+    search_tags = models.CharField()
+    questions = models.ManyToManyField(Question, through="QuestionnaireQuestionMap")
+    use_in_shx = models.BooleanField()
+    carry_forward = models.TextField()
+
+
+class QuestionnaireQuestionMap(models.Model):
+    """QuestionnaireQuestionMap."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_questionnairequestionmap_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    status = models.CharField()
+    questionnaire = models.ForeignKey(Questionnaire, on_delete=models.DO_NOTHING)
+    question = models.ForeignKey(Question, on_delete=models.DO_NOTHING)
+
+
+class Interview(models.Model):
+    """Interview."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_interview_001"
+
+    objects = CommittableModelManager()
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    deleted = models.BooleanField()
+    committer = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)
+    entered_in_error = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)
+    status = models.CharField()
+    name = models.CharField()
+    language_id = models.BigIntegerField()
+    use_case_in_charting = models.CharField()
+    patient = models.ForeignKey(Patient, on_delete=models.DO_NOTHING, related_name="interviews")
+    note_id = models.BigIntegerField()
+    appointment_id = models.BigIntegerField()
+    questionnaires = models.ManyToManyField(Questionnaire, through="InterviewQuestionnaireMap")
+    progress_status = models.CharField()
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+
+
+class InterviewQuestionnaireMap(models.Model):
+    """InterviewQuestionnaireMap."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_interviewquestionnairemap_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    status = models.CharField()
+    interview = models.ForeignKey(Interview, on_delete=models.DO_NOTHING)
+    questionnaire = models.ForeignKey(Questionnaire, on_delete=models.CASCADE)
+
+
+class InterviewQuestionResponse(models.Model):
+    """InterviewQuestionResponse."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_interviewquestionresponse_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    status = models.CharField()
+    interview = models.ForeignKey(
+        Interview, on_delete=models.DO_NOTHING, related_name="interview_responses"
+    )
+    questionnaire = models.ForeignKey(
+        Questionnaire, on_delete=models.DO_NOTHING, related_name="interview_responses"
+    )
+    question = models.ForeignKey(
+        Question, on_delete=models.DO_NOTHING, related_name="interview_responses"
+    )
+    response_option = models.ForeignKey(
+        ResponseOption, on_delete=models.DO_NOTHING, related_name="interview_responses"
+    )
+    response_option_value = models.TextField()
+    questionnaire_state = models.TextField()
+    interview_state = models.TextField()
+    comment = models.CharField()

canvas_sdk/v1/data/user.py

@@ -2,6 +2,8 @@ from django.db import models
 
 
 class CanvasUser(models.Model):
+    """A class representing a Canvas User."""
+
     class Meta:
         managed = False
         app_label = "canvas_sdk"

canvas_sdk/value_set/v2022/condition.py

@@ -8101,7 +8101,7 @@ class KidneyFailure(ValueSet):
 
 class Proteinuria(ValueSet):
     """
-    **Clinical Focus:** The purpose of this value set is to represent concepts for a diagnosis of  proteinuria
+    **Clinical Focus:** The purpose of this value set is to represent concepts for a diagnosis of  proteinuria.
 
     **Data Element Scope:** This value set may use a model element related to Diagnosis.
 
@@ -33137,7 +33137,7 @@ class StableAndUnstableAngina(ValueSet):
 
 class StatinAssociatedMuscleSymptoms(ValueSet):
     """
-    **Clinical Focus:**
+    **Clinical Focus:** The purpose of this value set is to represent diagnoses of muscle-related symptoms associated with statin use.
 
     **Data Element Scope:**
 

canvas_sdk/value_set/v2022/encounter.py

@@ -1557,7 +1557,7 @@ class AudiologyVisit(ValueSet):
 
 class MedicalDisabilityExam(ValueSet):
     """
-    **Clinical Focus:** The purpose of this value set is to represent concepts for encounters for work related or medical disability examinations
+    **Clinical Focus:** The purpose of this value set is to represent concepts for encounters for work related or medical disability examinations.
 
     **Data Element Scope:** This value set may use a model element related to Encounter.
 

canvas_sdk/value_set/value_set.py

@@ -1,8 +1,10 @@
 from collections import defaultdict
-from typing import Dict, Union
+from typing import Dict, Union, cast
 
 
 class CodeConstants:
+    """A class representing different code systems and their URLs."""
+
     CPT = "CPT"
     HCPCSLEVELII = "HCPCSLEVELII"
     CVX = "CVX"
@@ -32,6 +34,8 @@ class CodeConstants:
 
 
 class CodeConstantsURLMapping:
+    """A class that maps code systems to their URLs."""
+
     CODE_SYSTEM_MAPPING = {
         CodeConstants.CPT: CodeConstants.URL_CPT,
         CodeConstants.HCPCSLEVELII: CodeConstants.URL_HCPCSLEVELII,
@@ -50,6 +54,8 @@ class CodeConstantsURLMapping:
 
 
 class CombinedValueSet(CodeConstantsURLMapping):
+    """A class representing a combination of two value sets."""
+
     def __init__(
         self,
         value_set_1: Union["ValueSet", "CombinedValueSet"],
@@ -59,7 +65,8 @@ class CombinedValueSet(CodeConstantsURLMapping):
         self.value_set_2 = value_set_2
 
     @property
-    def values(self):
+    def values(self) -> Dict[str, set]:
+        """A property that returns the combined values from both value sets."""
         values: Dict[str, set] = defaultdict(set)
 
         for vs in [self.value_set_1, self.value_set_2]:
@@ -71,21 +78,29 @@ class CombinedValueSet(CodeConstantsURLMapping):
         return values
 
     def __or__(self, value_set: Union["ValueSet", "CombinedValueSet"]) -> "CombinedValueSet":
+        """Implements the `|` (or) operator to combine value sets."""
         return CombinedValueSet(self, value_set)
 
 
 class ValueSystems(type):
+    """A metaclass for defining a ValueSet."""
+
     @property
     def values(cls) -> dict[str, set]:
+        """A property that returns a dictionary of code systems and their associated values."""
         return {
             system: getattr(cls, system)
-            for system in cls.CODE_SYSTEM_MAPPING.keys()
+            for system in cast(ValueSet, cls).CODE_SYSTEM_MAPPING.keys()
             if hasattr(cls, system)
         }
 
-    def __or__(self, value_set: Union["ValueSet", "CombinedValueSet"]) -> CombinedValueSet:
-        return CombinedValueSet(self, value_set)
+    def __or__(self, value_set: Union["ValueSet", "CombinedValueSet"]) -> CombinedValueSet:  # type: ignore[override]
+        """Implements the `|` (or) operator."""
+        return CombinedValueSet(cast(ValueSet, self), value_set)
 
 
 class ValueSet(CodeConstantsURLMapping, metaclass=ValueSystems):
+    """The Base class for a ValueSet."""
+
+    values: dict[str, set]
     pass

logger/__init__.py

@@ -1,2 +1,3 @@
 from logger.logger import PluginLogger
+
 log = PluginLogger()

logger/logger.py

@@ -1,20 +1,26 @@
 import logging
 import os
+from typing import Any
 
 from pubsub.pubsub import Publisher
 
 
 class PubSubLogHandler(logging.Handler):
+    """Custom logging handler that publishes logs to a pub/sub channel."""
+
     def __init__(self) -> None:
         self.publisher = Publisher()
         logging.Handler.__init__(self=self)
 
-    def emit(self, record) -> None:
+    def emit(self, record: Any) -> None:
+        """Publishes the log message to the pub/sub channel."""
         message = self.format(record)
         self.publisher.publish(message)
 
 
 class PluginLogger:
+    """A custom logger for plugins."""
+
     def __init__(self) -> None:
         self.logger = logging.getLogger("plugin_runner_logger")
         self.logger.setLevel(logging.INFO)
@@ -32,17 +38,22 @@ class PluginLogger:
             pubsub_handler.setFormatter(formatter)
             self.logger.addHandler(pubsub_handler)
 
-    def debug(self, message) -> None:
+    def debug(self, message: Any) -> None:
+        """Logs a debug message."""
         self.logger.debug(message)
 
-    def info(self, message) -> None:
+    def info(self, message: Any) -> None:
+        """Logs an info message."""
         self.logger.info(message)
 
-    def warning(self, message) -> None:
+    def warning(self, message: Any) -> None:
+        """Logs a warning message."""
         self.logger.warning(message)
 
-    def error(self, message) -> None:
+    def error(self, message: Any) -> None:
+        """Logs an error message."""
         self.logger.error(message)
 
-    def critical(self, message) -> None:
+    def critical(self, message: Any) -> None:
+        """Logs a critical message."""
         self.logger.critical(message)

settings.py

@@ -0,0 +1,43 @@
+import os
+
+from dotenv import load_dotenv
+
+from canvas_sdk.utils.db import get_database_dict_from_url
+
+load_dotenv()
+
+INTEGRATION_TEST_URL = os.getenv("INTEGRATION_TEST_URL")
+INTEGRATION_TEST_CLIENT_ID = os.getenv("INTEGRATION_TEST_CLIENT_ID")
+INTEGRATION_TEST_CLIENT_SECRET = os.getenv("INTEGRATION_TEST_CLIENT_SECRET")
+
+GRAPHQL_ENDPOINT = os.getenv("GRAPHQL_ENDPOINT", "http://localhost:8000/plugins-graphql")
+
+INSTALLED_APPS = ["canvas_sdk"]
+
+SECRET_KEY = os.getenv(
+    "SECRET_KEY",
+    "This value is the key to securing signed data – it is vital you keep this secure, or attackers could use it to generate their own signed values.",
+)
+
+# Use BigAutoField for Default Primary Key field type
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+CANVAS_SDK_DB_NAME = os.getenv("CANVAS_SDK_DB_NAME", "home-app")
+CANVAS_SDK_DB_USERNAME = os.getenv("CANVAS_SDK_DB_USERNAME", "app")
+CANVAS_SDK_DB_PASSWORD = os.getenv("CANVAS_SDK_DB_PASSWORD", "app")
+CANVAS_SDK_DB_HOST = os.getenv("CANVAS_SDK_DB_HOST", "home-app-db")
+CANVAS_SDK_DB_PORT = os.getenv("CANVAS_SDK_DB_PORT", "5432")
+
+if os.getenv("DATABASE_URL"):
+    database_dict = get_database_dict_from_url()
+else:
+    database_dict = {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": CANVAS_SDK_DB_NAME,
+        "USER": CANVAS_SDK_DB_USERNAME,
+        "PASSWORD": CANVAS_SDK_DB_PASSWORD,
+        "HOST": CANVAS_SDK_DB_HOST,
+        "PORT": CANVAS_SDK_DB_PORT,
+    }
+
+DATABASES = {"default": database_dict}