feat: add FamilyHistory command SDK definition

canvas-medical · Sep 25, 2024 · a77fa6d · a77fa6d
1 parent 3348685
commit a77fa6d
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 2 deletions.
diff --git a/canvas_generated/messages/effects_pb2.py b/canvas_generated/messages/effects_pb2.py
diff --git a/canvas_generated/messages/effects_pb2.pyi b/canvas_generated/messages/effects_pb2.pyi
@@ -83,6 +83,11 @@ class EffectType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     DELETE_LAB_ORDER_COMMAND: _ClassVar[EffectType]
     COMMIT_LAB_ORDER_COMMAND: _ClassVar[EffectType]
     ENTER_IN_ERROR_LAB_ORDER_COMMAND: _ClassVar[EffectType]
+    ORIGINATE_FAMILY_HISTORY_COMMAND: _ClassVar[EffectType]
+    EDIT_FAMILY_HISTORY_COMMAND: _ClassVar[EffectType]
+    DELETE_FAMILY_HISTORY_COMMAND: _ClassVar[EffectType]
+    COMMIT_FAMILY_HISTORY_COMMAND: _ClassVar[EffectType]
+    ENTER_IN_ERROR_FAMILY_HISTORY_COMMAND: _ClassVar[EffectType]
     CREATE_TASK: _ClassVar[EffectType]
     UPDATE_TASK: _ClassVar[EffectType]
     CREATE_TASK_COMMENT: _ClassVar[EffectType]
@@ -164,6 +169,11 @@ EDIT_LAB_ORDER_COMMAND: EffectType
 DELETE_LAB_ORDER_COMMAND: EffectType
 COMMIT_LAB_ORDER_COMMAND: EffectType
 ENTER_IN_ERROR_LAB_ORDER_COMMAND: EffectType
+ORIGINATE_FAMILY_HISTORY_COMMAND: EffectType
+EDIT_FAMILY_HISTORY_COMMAND: EffectType
+DELETE_FAMILY_HISTORY_COMMAND: EffectType
+COMMIT_FAMILY_HISTORY_COMMAND: EffectType
+ENTER_IN_ERROR_FAMILY_HISTORY_COMMAND: EffectType
 CREATE_TASK: EffectType
 UPDATE_TASK: EffectType
 CREATE_TASK_COMMENT: EffectType

diff --git a/canvas_sdk/commands/__init__.py b/canvas_sdk/commands/__init__.py
@@ -1,5 +1,6 @@
 from canvas_sdk.commands.commands.assess import AssessCommand
 from canvas_sdk.commands.commands.diagnose import DiagnoseCommand
+from canvas_sdk.commands.commands.family_history import FamilyHistoryCommand
 from canvas_sdk.commands.commands.goal import GoalCommand
 from canvas_sdk.commands.commands.history_present_illness import (
     HistoryOfPresentIllnessCommand,
@@ -18,6 +19,7 @@
 __all__ = (
     "AssessCommand",
     "DiagnoseCommand",
+    "FamilyHistoryCommand",
     "GoalCommand",
     "HistoryOfPresentIllnessCommand",
     "InstructCommand",

diff --git a/canvas_sdk/commands/commands/family_history.py b/canvas_sdk/commands/commands/family_history.py
@@ -0,0 +1,18 @@
+from canvas_sdk.commands.base import _BaseCommand as BaseCommand
+
+
+class FamilyHistoryCommand(BaseCommand):
+    """A class for managing a Family History command within a specific note."""
+
+    class Meta:
+        key = "familyHistory"
+        commit_required_fields = ("family_history",)
+
+    family_history: str | None = None
+    relative: str | None = None
+    note: str | None = None
+
+    @property
+    def values(self) -> dict:
+        """The Family History command's field values."""
+        return {"family_history": self.family_history, "relative": self.relative, "note": self.note}
diff --git a/protobufs/canvas_generated/messages/effects.proto b/protobufs/canvas_generated/messages/effects.proto
@@ -97,6 +97,12 @@ enum EffectType {
   COMMIT_LAB_ORDER_COMMAND = 74;
   ENTER_IN_ERROR_LAB_ORDER_COMMAND = 75;
 
+  ORIGINATE_FAMILY_HISTORY_COMMAND = 76;
+  EDIT_FAMILY_HISTORY_COMMAND = 77;
+  DELETE_FAMILY_HISTORY_COMMAND = 78;
+  COMMIT_FAMILY_HISTORY_COMMAND = 79;
+  ENTER_IN_ERROR_FAMILY_HISTORY_COMMAND = 80;
+
   CREATE_TASK = 100;
   UPDATE_TASK = 101;
   CREATE_TASK_COMMENT = 102;