feat: Mark codes as final for reporting purposes

lib/medicode/transcriptions.ex

@@ -14,6 +14,8 @@ defmodule Medicode.Transcriptions do
     TranscriptionChunkKeyword
   }
 
+  alias Medicode.Coding.CodeVector
+
   @doc """
   Create transcription record and begin transcribing
 
@@ -177,6 +179,31 @@ defmodule Medicode.Transcriptions do
     end
   end
 
+  def finalize_code_vector_by_chunk_id_and_by_user_id(
+        chunk_id,
+        code_vector_id,
+        user_id
+      ) do
+    query =
+      TranscriptionChunkCodeVector
+      |> where(
+        [v],
+        v.transcription_chunk_id == ^chunk_id and v.code_vector_id == ^code_vector_id
+      )
+
+    with %TranscriptionChunkCodeVector{} = chunk_vector <- Medicode.Repo.one(query),
+         changeset <-
+           TranscriptionChunkCodeVector.changeset(chunk_vector, %{
+             finalized_at: DateTime.utc_now(),
+             finalized_by_user_id: user_id
+           }),
+         {:ok, chunk_vector} <- Medicode.Repo.update(changeset) do
+      {:ok, chunk_vector}
+    else
+      res -> res
+    end
+  end
+
   @doc """
   List transcription chunks by transcription ID.
 
@@ -236,6 +263,33 @@ defmodule Medicode.Transcriptions do
     Repo.all(query)
   end
 
+  @doc """
+  List transcription chunk vector codes by transcription ID.
+  """
+  def list_transcription_finalized_codes(transcription_id) do
+    code_vector_query =
+      from(
+        cv in CodeVector,
+        join: tc in TranscriptionChunkCodeVector,
+        on: tc.code_vector_id == cv.id,
+        join: chunk in TranscriptionChunk,
+        on: tc.transcription_chunk_id == chunk.id,
+        where: chunk.transcription_id == ^transcription_id and not is_nil(tc.finalized_at),
+        select: [:id, :code]
+      )
+
+    query =
+      from(
+        tc in TranscriptionChunkCodeVector,
+        join: chunk in TranscriptionChunk,
+        on: tc.transcription_chunk_id == chunk.id,
+        where: chunk.transcription_id == ^transcription_id and not is_nil(tc.finalized_at),
+        preload: [code_vector: ^code_vector_query]
+      )
+
+    Repo.all(query)
+  end
+
   @doc """
   Creates a transcription.
 

lib/medicode/transcriptions/transcription_chunk_code_vector.ex

@@ -11,10 +11,12 @@ defmodule Medicode.Transcriptions.TranscriptionChunkCodeVector do
   schema "transcription_chunk_code_vectors" do
     field :cosine_similarity, :float
     field :weighting, {:array, :string}
+    field :finalized_at, :utc_datetime
 
     belongs_to :transcription_chunk, Medicode.Transcriptions.TranscriptionChunk
     belongs_to :code_vector, Medicode.Coding.CodeVector
     belongs_to :assigned_by_user, Medicode.Accounts.User
+    belongs_to :finalized_by_user, Medicode.Accounts.User
 
     timestamps(type: :utc_datetime)
   end
@@ -27,7 +29,9 @@ defmodule Medicode.Transcriptions.TranscriptionChunkCodeVector do
       :code_vector_id,
       :cosine_similarity,
       :weighting,
-      :assigned_by_user_id
+      :assigned_by_user_id,
+      :finalized_by_user_id,
+      :finalized_at
     ])
     |> validate_required([
       :transcription_chunk_id,

lib/medicode_web/components/components.ex

@@ -72,6 +72,7 @@ defmodule MedicodeWeb.Components do
   attr(:target, :any, required: true)
   attr(:transcription, Medicode.Transcriptions.Transcription, required: true)
   attr(:summary_keywords, :list, default: [])
+  attr(:finalized_codes, :list, default: [])
 
   @doc """
   Shows the status and keywords for the current session.
@@ -132,6 +133,18 @@ defmodule MedicodeWeb.Components do
           <% end %>
         </div>
       </div>
+      <div :if={!Enum.empty?(@finalized_codes)} class="px-4 pt-2 pb-10 flex flex-col gap-2">
+        <p class="leading-normal font-bold text-type-black-primary uppercase">Finalized Codes</p>
+
+        <div
+          class="flex flex-row items-center divide-x divide-black/15 text-sm leading-normal text-type-black-tertiary"
+          id="finalized_vector_code_list"
+        >
+          <span :for={chunk_code <- @finalized_codes} class="px-2" title={chunk_code.code_vector.code}>
+            <%= chunk_code.code_vector.code %>
+          </span>
+        </div>
+      </div>
     </div>
     """
   end

lib/medicode_web/components/transcription_chunk_codings_component.ex

@@ -18,8 +18,9 @@ defmodule MedicodeWeb.Components.TranscriptionTextCodingsComponent do
           {%TranscriptionChunkCodeVector{
              code_vector: code_vector,
              assigned_by_user: assigned_by_user
-           }, feedback} <- @code_vectors_with_feedback
+           } = transcription_chunk_code_vector, feedback} <- @code_vectors_with_feedback
         }
+        transcription_chunk_code_vector={transcription_chunk_code_vector}
         chunk_id={@chunk_id}
         code_vector={code_vector}
         score={1.0}
@@ -38,7 +39,7 @@ defmodule MedicodeWeb.Components.TranscriptionTextCodingsComponent do
     ~H"""
     <div
       phx-mounted={JS.transition({"ease-out", "opacity-0", "opacity-100"})}
-      class="ease-out duration-300 opacity-0 transition-all flex items-center gap-4 px-[14px] py-3 text-sm"
+      class="group ease-out duration-300 opacity-0 transition-all flex items-center gap-4 px-[14px] py-3 text-sm"
     >
       <div class="flex gap-3">
         <.feedback_button
@@ -62,10 +63,29 @@ defmodule MedicodeWeb.Components.TranscriptionTextCodingsComponent do
       <div class="w-1 h-full border-l border-[#444444]/20"></div>
 
       <div
+        id={"chunk-#{@chunk_id}-coding-#{@code_vector.id}"}
         class={"w-full flex flex-col gap-1 font-secondary text-type-black-primary ml-4 px-2 py-1 rounded #{code_color(@weighting)}"}
         title={code_title(@score, @weighting)}
       >
-        <p class="text-lg font-bold leading-[22.97px]"><%= @code_vector.code %></p>
+        <div class="flex flex-row justify-between">
+          <p class="text-lg font-bold leading-[22.97px]"><%= @code_vector.code %></p>
+          <button
+            :if={is_nil(@transcription_chunk_code_vector.finalized_at)}
+            type="button"
+            class="transition-all duration-300 opacity-0 group-hover:opacity-100 hover:bg-slate-200 px-2 border border-1 border-iron-mountain rounded-md"
+            phx-click="finalize_code"
+            phx-value-chunk_id={@chunk_id}
+            phx-value-code_vector_id={@code_vector.id}
+            phx-target={@myself}
+          >
+            Finalize
+          </button>
+          <.icon
+            :if={!is_nil(@transcription_chunk_code_vector.finalized_at)}
+            name="hero-check-badge"
+            class="opacity-40 group-hover:opacity-70"
+          />
+        </div>
         <p class="text-base leading-[20.42px]"><%= @code_vector.description %></p>
         <div class="flex flex-row items-center w-full gap-4">
           <p :if={!is_nil(@assigned_by_user)} class="text-xs text-base leading-[20.42px]">
@@ -133,6 +153,11 @@ defmodule MedicodeWeb.Components.TranscriptionTextCodingsComponent do
     {:noreply, socket}
   end
 
+  def handle_event("finalize_code", params, socket) do
+    socket.assigns.on_finalize_code.(params)
+    {:noreply, socket}
+  end
+
   # Supporting function for determining background color for code in `tag_result/1`
   defp code_color(weighting) do
     cond do

lib/medicode_web/components/transcription_text_component.ex

@@ -48,6 +48,7 @@ defmodule MedicodeWeb.Components.TranscriptionTextComponent do
       |> assign(:code_vectors_with_feedback, code_vectors_with_feedback)
       |> assign(:on_feedback, assigns.on_feedback)
       |> assign(:on_remove_code, assigns.on_remove_code)
+      |> assign(:on_finalize_code, assigns.on_finalize_code)
     end)
   end
 
@@ -111,6 +112,7 @@ defmodule MedicodeWeb.Components.TranscriptionTextComponent do
           code_vectors_with_feedback={@code_vectors_with_feedback}
           on_feedback={@on_feedback}
           on_remove_code={@on_remove_code}
+          on_finalize_code={@on_finalize_code}
         />
         <.live_component
           :if={!@classification_loading}

lib/medicode_web/live/transcriptions_live/show.ex

@@ -20,6 +20,7 @@ defmodule MedicodeWeb.TranscriptionsLive.Show do
     transcription_chunk_ids = Enum.map(transcription.chunks, &%{id: &1.id})
 
     summary_keywords = Transcriptions.list_transcription_summary_keywords(transcription.id)
+    finalized_codes = Transcriptions.list_transcription_finalized_codes(transcription.id)
 
     initial_state = %{
       current_recording_id: 0,
@@ -29,7 +30,7 @@ defmodule MedicodeWeb.TranscriptionsLive.Show do
       summary_keywords: summary_keywords,
       transcription: transcription,
       transcriptions: list_transcriptions(session["current_user"]),
-      finalized_codes: []
+      finalized_codes: finalized_codes
     }
 
     socket =
@@ -57,6 +58,7 @@ defmodule MedicodeWeb.TranscriptionsLive.Show do
             target={self()}
             transcription={@transcription}
             summary_keywords={@summary_keywords}
+            finalized_codes={@finalized_codes}
           />
 
           <img
@@ -76,6 +78,7 @@ defmodule MedicodeWeb.TranscriptionsLive.Show do
               finalized_codes={@finalized_codes}
               on_feedback={&on_feedback/1}
               on_remove_code={&on_remove_code/1}
+              on_finalize_code={&on_finalize_code/1}
             />
           </div>
         </div>
@@ -92,6 +95,10 @@ defmodule MedicodeWeb.TranscriptionsLive.Show do
     send(self(), {"remove_code", params})
   end
 
+  def on_finalize_code(params) do
+    send(self(), {"finalize_code", params})
+  end
+
   @impl Phoenix.LiveView
   def handle_event("reset_to_pending", _params, socket) do
     {:noreply, assign(socket, :status, :pending)}
@@ -260,6 +267,28 @@ defmodule MedicodeWeb.TranscriptionsLive.Show do
     {:noreply, socket}
   end
 
+  def handle_info(
+        {"finalize_code", %{"chunk_id" => chunk_id, "code_vector_id" => code_vector_id}},
+        socket
+      ) do
+    Transcriptions.finalize_code_vector_by_chunk_id_and_by_user_id(
+      chunk_id,
+      code_vector_id,
+      socket.assigns.current_user.id
+    )
+
+    send_transcription_text_update(chunk_id, false, socket)
+
+    socket =
+      socket
+      |> assign(
+        :finalized_codes,
+        Transcriptions.list_transcription_finalized_codes(socket.assigns.transcription.id)
+      )
+
+    {:noreply, socket}
+  end
+
   def handle_info({ref, _result}, socket) do
     # See this Fly article for the usage of Task.async to start `transcribe_and_tag_audio/2` and handle the end of the
     # task here: https://fly.io/phoenix-files/liveview-async-task/
@@ -275,7 +304,9 @@ defmodule MedicodeWeb.TranscriptionsLive.Show do
       classification_loading: classification_loading,
       current_user: socket.assigns.current_user,
       on_feedback: &on_feedback/1,
-      on_remove_code: &on_remove_code/1
+      on_remove_code: &on_remove_code/1,
+      on_finalize_code: &on_finalize_code/1,
+      finalized_codes: socket.assigns.finalized_codes
     )
 
     chunk = Transcriptions.get_transcription_chunk!(chunk_id)

priv/repo/migrations/20240301170622_add_finalized_at_and_finalized_by_id_to_transcription_chunk_code_vectors.exs

@@ -0,0 +1,12 @@
+defmodule Medicode.Repo.Migrations.AddFinalizedAtAndFinalizedByIdToTranscriptionChunkCodeVectors do
+  use Ecto.Migration
+
+  def change do
+    alter table(:transcription_chunk_code_vectors) do
+      add :finalized_at, :utc_datetime, null: true
+
+      add :finalized_by_user_id, references(:users, type: :binary_id, on_delete: :nilify_all),
+        null: true
+    end
+  end
+end

test/medicode_web/live/transcriptions_live_show_test.exs

@@ -6,7 +6,9 @@ defmodule MedicodeWeb.TranscriptionsLive.ShowTest do
   import Medicode.{
     AccountsFixtures,
     TranscriptionsFixtures,
-    TranscriptionChunksFixtures
+    TranscriptionChunksFixtures,
+    TranscriptionChunkCodeVectorsFixtures,
+    CodeVectorsFixtures
   }
 
   setup %{conn: conn} do
@@ -14,10 +16,37 @@ defmodule MedicodeWeb.TranscriptionsLive.ShowTest do
     user = user_fixture(%{password: password})
     transcription = transcription_fixture(%{filename: "my-audio.mp3"})
 
-    transcription_chunk_fixture(%{transcription_id: transcription.id, text: "Foo"})
-    transcription_chunk_fixture(%{transcription_id: transcription.id, text: "Bar"})
+    transcription_chunk1 =
+      transcription_chunk_fixture(%{transcription_id: transcription.id, text: "Bar"})
 
-    %{conn: log_in_user(conn, user), current_user: user, transcription: transcription}
+    transcription_chunk2 =
+      transcription_chunk_fixture(%{transcription_id: transcription.id, text: "Foo"})
+
+    code_vector1 = code_vector_fixture(%{code: "001"})
+    code_vector2 = code_vector_fixture(%{code: "002"})
+
+    transcription_chunk_code_vector_fixture(%{
+      transcription_chunk_id: transcription_chunk1.id,
+      code_vector_id: code_vector1.id
+    })
+
+    transcription_chunk_code_vector_fixture(%{
+      transcription_chunk_id: transcription_chunk1.id,
+      code_vector_id: code_vector2.id
+    })
+
+    transcription_chunk_code_vector_fixture(%{
+      transcription_chunk_id: transcription_chunk2.id,
+      code_vector_id: code_vector2.id
+    })
+
+    %{
+      conn: log_in_user(conn, user),
+      current_user: user,
+      transcription: transcription,
+      transcription_chunk1: transcription_chunk1,
+      code_vector1: code_vector1
+    }
   end
 
   describe "/" do
@@ -35,5 +64,38 @@ defmodule MedicodeWeb.TranscriptionsLive.ShowTest do
       invalid_id = Ecto.UUID.generate()
       assert_raise Medicode.Fallback, fn -> get(conn, "/transcriptions/#{invalid_id}") end
     end
+
+    test "renders codes as finalized", %{
+      conn: conn,
+      transcription: transcription,
+      transcription_chunk1: transcription_chunk1,
+      code_vector1: code_vector1
+    } do
+      conn = get(conn, "/transcriptions/#{transcription.id}")
+      assert html_response(conn, 200) =~ "MediCode"
+
+      {:ok, view, _html} = live(conn)
+
+      # NOTE: Since MedicodeWeb.TranscriptionsLive.Show.send_transcription_text_update/3 relies on Phoenix.LiveView.send_update/3,
+      # we need to call `render(view)` to get the async update rendered before asserting.
+      #
+      # Additionally, we are using PubSub to update child components. The call to `:sys.get_state(view.pid)` ensures the mailbox is empty
+      # and it's safe to assert results.
+      # See: https://elixirforum.com/t/testing-liveviews-that-rely-on-pubsub-for-updates/40938/5
+      view
+      |> element(
+        "#chunk-#{transcription_chunk1.id}-coding-#{code_vector1.id} button",
+        "Finalize"
+      )
+      |> render_click()
+
+      _ = :sys.get_state(view.pid)
+
+      rendered = render(view)
+
+      assert rendered =~ "<span class=\"hero-check-badge"
+      assert rendered =~ "Finalized Codes"
+      assert rendered =~ "001"
+    end
   end
 end