canvas 0.5.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

canvas_sdk/v1/data/note.py

@@ -0,0 +1,161 @@
+from django.contrib.postgres.fields import ArrayField
+from django.db import models
+
+from canvas_sdk.v1.data.patient import Patient
+
+# from canvas_sdk.v1.data.staff import Staff
+from canvas_sdk.v1.data.user import CanvasUser
+
+
+class NoteTypeCategories(models.TextChoices):
+    """Note type categories."""
+
+    MESSAGE = "message", "Message"
+    LETTER = "letter", "Letter"
+    INPATIENT = "inpatient", "Inpatient Visit Note"
+    REVIEW = "review", "Chart Review Note"
+    ENCOUNTER = "encounter", "Encounter Note"
+    APPOINTMENT = "appointment", "Appointment Note"
+    TASK = "task", "Task"
+    DATA = "data", "Data"
+    CCDA = "ccda", "C-CDA"
+    SCHEDULE_EVENT = "schedule_event", "Schedule Event"
+
+
+class PracticeLocationPOS(models.TextChoices):
+    """Practice Location POS."""
+
+    PHARMACY = "01", "Pharmacy"
+    TELEHEALTH = "02", "Telehealth"
+    SCHOOL = "03", "Education Facility"
+    HOMELESS_SHELTER = "04", "Homeless Shelter"
+    PRISON = "09", "Prison"
+    TELEHEALTH_IN_PATIENT_HOME = "10", "Telehealth in Patient's Home"
+    OFFICE = "11", "Office"
+    HOME = "12", "Home"
+    ASSISTED_LIVING = "13", "Asssisted Living Facility"
+    GROUP_HOME = "14", "Group Home"
+    MOBILE = "15", "Mobile Unit"
+    WALK_IN_RETAIL = "17", "Walk-In Retail Health Clinic"
+    OFF_CAMPUS_OUTPATIENT_HOSPITAL = "19", "Off-Campus Outpatient Hospital"
+    URGENT_CARE = "20", "Urgent Care Facility"
+    INPATIENT_HOSPITAL = "21", "Inpatient Hospital"
+    ON_CAMPUS_OUTPATIENT_HOSPITAL = "22", "On-Campus Outpatient Hospital"
+    ER_HOSPITAL = "23", "Emergency Room Hospital"
+    AMBULATORY_SURGERY_CENTER = "24", "Ambulatory Surgery Center"
+    BIRTHING_CENTER = "25", "Birthing Center"
+    MILITARY_FACILITY = "26", "Military Treatment Facility"
+    STREET = "27", "Outreach Site / Street"
+    SNF = "31", "Skilled Nursing Facility"
+    NURSING = "32", "Nursing Facility"
+    CUSTODIAL = "33", "Custodial Care Facility"
+    HOSPICE = "34", "Hospice"
+    AMBULANCE_LAND = "41", "Ambulance Land"
+    AMBULANCE_AIR_WATER = "42", "Ambulance Air or Water"
+    INDEPENDENT_CLINIC = "49", "Independent Clinic"
+    FQHC = "50", "Federally Qualified Health Center"
+    PSYCH = "51", "Inpatient Psychiatric Facility"
+    PSYCH_PARTIAL = "52", "Inpatient Psychiatric Facility - Partial Hospitalization"
+    MENTAL_HEALTH_CENTER = "53", "Community Mental Health Center"
+    INTERMEDIATE_MENTAL = "54", "Intermediate Care Facility for Mentally Retarded"
+    SUBSTANCE_RESIDENTIAL = "55", "Residential Substance Abuse Treatment Facility"
+    PSYCH_RESIDENTIAL = "56", "Psychiatric Residential Treatment Center"
+    SUBSTANCE_NON_RESIDENTIAL = "57", "Non-Residential Substance Abuse Treatment Facility"
+    MASS_IMMUNIZATION = "60", "Mass Immunization Center"
+    INPATIENT_REHAB = "61", "Inpatient Rehabilitation Facility"
+    OUTPATIENT_REHAB = "62", "Outpatient Rehabilitation Facility"
+    ESRD = "65", "End-Stage Renal Disease Treatment Facility"
+    PUBLIC_CLINIC = "71", "State or Local Public Health Clinic"
+    RURAL_CLINIC = "72", "Rural Health Clinic"
+    INDEPENDENT_LAB = "81", "Independent Laboratory"
+    OTHER = "99", "Other Place of Service"
+
+
+class NoteTypes(models.TextChoices):
+    """Note types."""
+
+    MESSAGE = "message", "Message"
+    LETTER = "letter", "Letter"
+    INPATIENT = "inpatient", "Inpatient Visit Note"
+    REVIEW = "review", "Chart Review Note"
+    VOICE = "voice", "Phone Call Note"
+    VIDEO = "video", "Video Call Note"
+    OFFICE = "office", "Office Visit Note"
+    LAB = "lab", "Lab Visit Note"
+    HOME = "home", "Home Visit Note"
+    GROUP = "group", "Group Visit Note"
+    APPOINTMENT = "appointment", "Appointment Note"
+    OFFSITE = "offsite", "Other Offsite Visit Note"
+    SEARCH = "search", "Search"
+    TASK = "task", "Task"
+    DATA = "data", "Data"
+    CCDA = "ccda", "C-CDA Import"
+
+
+class NoteType(models.Model):
+    """NoteType."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_notetype_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    system = models.CharField()
+    version = models.CharField()
+    code = models.CharField()
+    display = models.CharField()
+    user_selected = models.BooleanField()
+    name = models.CharField()
+    icon = models.CharField()
+    category = models.CharField(choices=NoteTypeCategories.choices)
+    rank = models.PositiveIntegerField()
+    is_default_appointment_type = models.BooleanField()
+    is_scheduleable = models.BooleanField()
+    is_telehealth = models.BooleanField()
+    is_billable = models.BooleanField()
+    defer_place_of_service_to_practice_location = models.BooleanField()
+    available_places_of_service = ArrayField(models.CharField(choices=PracticeLocationPOS.choices))
+    default_place_of_service = models.CharField(choices=PracticeLocationPOS.choices)
+    is_system_managed = models.BooleanField()
+    is_visible = models.BooleanField()
+    is_active = models.BooleanField()
+    unique_identifier = models.UUIDField()
+    deprecated_at = models.DateTimeField()
+    is_patient_required = models.BooleanField()
+    allow_custom_title = models.BooleanField()
+
+
+class Note(models.Model):
+    """Note."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_note_001"
+
+    id = models.CharField(max_length=32)
+    dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    patient = models.ForeignKey(Patient, on_delete=models.DO_NOTHING)
+    # provider = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, related_name="notes")
+    note_type = models.CharField(choices=NoteTypes.choices, null=True)
+    note_type_version = models.ForeignKey(
+        "NoteType", on_delete=models.DO_NOTHING, related_name="notes"
+    )
+    title = models.TextField()
+    body = models.JSONField()
+    originator = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)
+    # last_modified_by_staff = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, null=True)
+    checksum = models.CharField()
+    billing_note = models.TextField()
+    # TODO -implement InpatientStay model
+    # inpatient_stay = models.ForeignKey("InpatientStay", on_delete=models.DO_NOTHING)
+    related_data = models.JSONField()
+    # TODO -implement PracticeLocation model
+    # location = models.ForeignKey(PracticeLocation, on_delete=models.DO_NOTHING)
+    datetime_of_service = models.DateTimeField()
+    place_of_service = models.CharField()

canvas_sdk/v1/data/patient.py

@@ -1,5 +1,6 @@
-from typing import Self
+from typing import TYPE_CHECKING, Self
 
+import arrow
 from django.db import models
 
 
@@ -53,3 +54,20 @@ class Patient(models.Model):
 
     def __str__(self) -> str:
         return f"{self.first_name} {self.last_name}"
+
+    def age_at(self, time: arrow.Arrow) -> float:
+        """Given a datetime, returns what the patient's age would be at that datetime."""
+        age = float(0)
+        birth_date = arrow.get(self.birth_date)
+        if birth_date.date() < time.date():
+            age = time.datetime.year - birth_date.datetime.year
+            if time.datetime.month < birth_date.datetime.month or (
+                time.datetime.month == birth_date.datetime.month
+                and time.datetime.day < birth_date.datetime.day
+            ):
+                age -= 1
+
+            current_year = birth_date.shift(years=age)
+            next_year = birth_date.shift(years=age + 1)
+            age += (time.date() - current_year.date()) / (next_year.date() - current_year.date())
+        return age

canvas_sdk/v1/data/protocol_override.py

@@ -40,7 +40,7 @@ class ProtocolOverride(models.Model):
     patient = models.ForeignKey(
         Patient,
         on_delete=models.DO_NOTHING,
-        related_name="allergy_intolerances",
+        related_name="protocol_overrides",
     )
     protocol_key = models.CharField()
     is_adjustment = models.BooleanField()

canvas_sdk/v1/data/staff.py

@@ -0,0 +1,65 @@
+from django.contrib.postgres.fields import ArrayField
+from django.db import models
+from timezone_utils.fields import TimeZoneField
+
+from canvas_sdk.v1.data.common import PersonSex, TaxIDType
+from canvas_sdk.v1.data.user import CanvasUser
+
+
+class Staff(models.Model):
+    """Staff."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_staff_001"
+
+    def __str__(self) -> str:
+        return f"{self.first_name} {self.last_name}"
+
+    id = models.CharField(max_length=32, db_column="key")
+    dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    prefix = models.CharField()
+    suffix = models.CharField()
+    first_name = models.CharField()
+    middle_name = models.CharField()
+    last_name = models.CharField()
+    maiden_name = models.CharField()
+    nickname = models.CharField()
+    previous_names = models.JSONField()
+    birth_date = models.DateField(null=True)
+    sex_at_birth = models.CharField(choices=PersonSex.choices)
+    sexual_orientation_term = models.CharField()
+    sexual_orientation_code = models.CharField()
+    gender_identity_term = models.CharField()
+    gender_identity_code = models.CharField()
+    preferred_pronouns = models.CharField()
+    biological_race_codes = ArrayField(models.CharField())
+    biological_race_terms = ArrayField(models.CharField())
+    cultural_ethnicity_codes = ArrayField(models.CharField())
+    cultural_ethnicity_terms = ArrayField(models.CharField())
+    last_known_timezone = TimeZoneField(null=True)
+    active = models.BooleanField()
+    # TODO - uncomment when PracticeLocation field is developed
+    # primary_practice_location = models.ForeignKey(
+    #     PracticeLocation, on_delete=models.DO_NOTHING, null=True
+    # )
+    npi_number = models.CharField()
+    nadean_number = models.CharField()
+    group_npi_number = models.CharField()
+    bill_through_organization = models.BooleanField()
+    tax_id = models.CharField()
+    tax_id_type = models.CharField(choices=TaxIDType.choices)
+    spi_number = models.CharField()
+    # TODO - uncomment when Language is developed
+    # language = models.ForeignKey(Language, on_delete=models.DO_NOTHING, related_name="staff_speakers")
+    # language_secondary = models.ForeignKey(Language, on_delete=models.DO_NOTHING, related_name="staff_secondary_speakers")
+    personal_meeting_room_link = models.URLField(null=True)
+    state = models.JSONField()
+    user = models.ForeignKey(CanvasUser, on_delete=models.DO_NOTHING)
+    schedule_column_ordering = models.IntegerField()
+    default_supervising_provider = models.ForeignKey(
+        "Staff", on_delete=models.DO_NOTHING, null=True, related_name="supervising_team"
+    )

canvas_sdk/v1/data/task.py

@@ -0,0 +1,112 @@
+from django.contrib.postgres.fields import ArrayField
+from django.db import models
+
+from canvas_sdk.v1.data.common import ColorEnum, Origin
+from canvas_sdk.v1.data.patient import Patient
+from canvas_sdk.v1.data.staff import Staff
+
+
+class TaskType(models.TextChoices):
+    """Choices for task types."""
+
+    TASK = "Task", "Task"
+    REMINDER = "Reminder", "Reminder"
+
+
+class EventType(models.TextChoices):
+    """Choices for event types."""
+
+    EVENT_CHART_OPEN = "Chart Open", "Chart Open"
+
+
+class TaskStatus(models.TextChoices):
+    """Choices for task statuses."""
+
+    COMPLETED = "COMPLETED", "Completed"
+    CLOSED = "CLOSED", "Closed"
+    OPEN = "OPEN", "Open"
+
+
+class TaskLabelModule(models.TextChoices):
+    """Choices for task label modules."""
+
+    CLAIMS = "claims", "Claims"
+    TASKS = "tasks", "Tasks"
+
+
+class Task(models.Model):
+    """Task."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_task_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    creator = models.ForeignKey(Staff, related_name="creator_tasks", on_delete=models.DO_NOTHING)
+    assignee = models.ForeignKey(
+        Staff, related_name="assignee_tasks", null=True, on_delete=models.DO_NOTHING
+    )
+    # TODO - uncomment when Team model is created
+    # team = models.ForeignKey(Team, related_name="tasks", null=True, on_delete=models.DO_NOTHING)
+    patient = models.ForeignKey(
+        Patient, blank=True, null=True, on_delete=models.DO_NOTHING, related_name="tasks"
+    )
+    task_type = models.CharField(choices=TaskType.choices)
+    tag = models.CharField()
+    title = models.CharField()
+    due = models.DateTimeField(null=True)
+    due_event = models.CharField(choices=EventType.choices, blank=True)
+    status = models.CharField(choices=TaskStatus.choices)
+
+
+class TaskComment(models.Model):
+    """TaskComment."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_taskcomment_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    created = models.DateTimeField()
+    modified = models.DateTimeField()
+    creator = models.ForeignKey(Staff, related_name="comments", on_delete=models.DO_NOTHING)
+    task = models.ForeignKey(Task, on_delete=models.DO_NOTHING, related_name="comments")
+    body = models.TextField()
+
+
+class TaskLabel(models.Model):
+    """TaskLabel."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_tasklabel_001"
+
+    id = models.UUIDField()
+    dbid = models.BigIntegerField(primary_key=True)
+    tasks = models.ManyToManyField(Task, related_name="labels", through="TaskTaskLabel")  # type: ignore[var-annotated]
+    position = models.IntegerField()
+    color = models.CharField(choices=ColorEnum.choices)
+    task_association = ArrayField(models.CharField(choices=Origin.choices))
+    name = models.CharField()
+    active = models.BooleanField()
+    modules = ArrayField(models.CharField(choices=TaskLabelModule.choices))
+
+
+class TaskTaskLabel(models.Model):
+    """M2M for Task -> TaskLabels."""
+
+    class Meta:
+        managed = False
+        app_label = "canvas_sdk"
+        db_table = "canvas_sdk_data_api_tasktasklabel_001"
+
+    dbid = models.BigIntegerField(primary_key=True)
+    task_label = models.ForeignKey(TaskLabel, on_delete=models.DO_NOTHING)
+    task = models.ForeignKey(Task, on_delete=models.DO_NOTHING)