Merge pull request #6476 from NHSDigital/alistair/imms-api-save-reason-code

Save reason code and term from API records

Author: alistair-white-horne-tng

app/lib/fhir_mapper/vaccination_record.rb

@@ -150,6 +150,10 @@ def self.from_fhir_record(fhir_record, patient:)
         notes << dose_number_string_note_from_fhir(fhir_record)
       end
 
+      reason_coding = reason_coding_from_fhir(fhir_record)
+      attrs[:nhs_immunisations_api_snomed_reason_code] = reason_coding&.code
+      attrs[:nhs_immunisations_api_snomed_reason_term] = reason_coding&.display
+
       attrs[:vaccine] = Vaccine.from_fhir_record(fhir_record)
       attrs[:batch_number] = fhir_record.lotNumber&.to_s
 
@@ -362,6 +366,12 @@ def fhir_org_performer
         &.find { it.system == "http://snomed.info/sct" }
     end
 
+    private_class_method def self.reason_coding_from_fhir(fhir_record)
+      fhir_record.reasonCode&.first&.coding&.find do
+        it.system == "http://snomed.info/sct"
+      end
+    end
+
     def fhir_reason_code
       FHIR::CodeableConcept.new(
         coding: [

app/models/vaccination_record.rb

@@ -22,6 +22,8 @@
 #  nhs_immunisations_api_primary_source        :boolean
 #  nhs_immunisations_api_snomed_procedure_code :string
 #  nhs_immunisations_api_snomed_procedure_term :string
+#  nhs_immunisations_api_snomed_reason_code    :string
+#  nhs_immunisations_api_snomed_reason_term    :string
 #  nhs_immunisations_api_sync_pending_at       :datetime
 #  nhs_immunisations_api_synced_at             :datetime
 #  notes                                       :text

db/migrate/20260331100000_add_reason_code_to_vaccination_records.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class AddReasonCodeToVaccinationRecords < ActiveRecord::Migration[8.1]
+  def change
+    change_table :vaccination_records, bulk: true do |t|
+      t.string :nhs_immunisations_api_snomed_reason_code
+      t.string :nhs_immunisations_api_snomed_reason_term
+    end
+  end
+end

db/schema.rb

@@ -10,8 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-
-ActiveRecord::Schema[8.1].define(version: 2026_03_30_130232) do
+ActiveRecord::Schema[8.1].define(version: 2026_03_31_100000) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
   enable_extension "pg_trgm"
@@ -1007,6 +1006,8 @@
     t.boolean "nhs_immunisations_api_primary_source"
     t.string "nhs_immunisations_api_snomed_procedure_code"
     t.string "nhs_immunisations_api_snomed_procedure_term"
+    t.string "nhs_immunisations_api_snomed_reason_code"
+    t.string "nhs_immunisations_api_snomed_reason_term"
     t.datetime "nhs_immunisations_api_sync_pending_at"
     t.datetime "nhs_immunisations_api_synced_at"
     t.text "notes"

spec/factories/vaccination_records.rb

@@ -22,6 +22,8 @@
 #  nhs_immunisations_api_primary_source        :boolean
 #  nhs_immunisations_api_snomed_procedure_code :string
 #  nhs_immunisations_api_snomed_procedure_term :string
+#  nhs_immunisations_api_snomed_reason_code    :string
+#  nhs_immunisations_api_snomed_reason_term    :string
 #  nhs_immunisations_api_sync_pending_at       :datetime
 #  nhs_immunisations_api_synced_at             :datetime
 #  notes                                       :text

spec/lib/fhir_mapper/vaccination_record_spec.rb

@@ -712,6 +712,12 @@
         its(:nhs_immunisations_api_snomed_procedure_term) do
           should eq "Seasonal influenza vaccination 111 (procedure)"
         end
+
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "453684005" }
+
+        its(:nhs_immunisations_api_snomed_reason_term) do
+          should eq "Disease outbreak (event)"
+        end
       end
 
       context "with a record with not full dose" do
@@ -752,6 +758,12 @@
         its(:performed_ods_code) { should eq "B0C4P" }
         its(:nhs_immunisations_api_primary_source) { should be true }
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "453684005" }
+
+        its(:nhs_immunisations_api_snomed_reason_term) do
+          should eq "Disease outbreak (event)"
+        end
+
         its(:notes) do
           should eq "Performing organisation display name: Acme Healthcare"
         end
@@ -796,6 +808,12 @@
         its(:location_name) { should be_nil }
         its(:performed_ods_code) { should eq "B0C4P" }
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "453684005" }
+
+        its(:nhs_immunisations_api_snomed_reason_term) do
+          should eq "Disease outbreak (event)"
+        end
+
         its(:notes) do
           should eq "Performing organisation display name: Acme Healthcare"
         end
@@ -849,6 +867,9 @@
           should eq "Influenza vaccination given by other healthcare provider (situation)"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) { should be_nil }
       end
 
@@ -894,6 +915,12 @@
           should eq "Administration of first intranasal seasonal influenza vaccination"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "453684005" }
+
+        its(:nhs_immunisations_api_snomed_reason_term) do
+          should eq "Disease outbreak (event)"
+        end
+
         its(:notes) do
           should include(
                    "SNOMED product code: 43207411000001106",
@@ -932,19 +959,22 @@
         its(:performed_ods_code) { should eq "B12345" }
         its(:nhs_immunisations_api_primary_source) { should be false }
 
-        its(:notes) do
-          should include(
-                   "Reported dose number string: Dose sequence not recorded"
-                 )
-        end
-
         its(:nhs_immunisations_api_snomed_procedure_code) do
           should eq "955651000000100"
         end
 
         its(:nhs_immunisations_api_snomed_procedure_term) do
           should eq "Influenza vaccination given by other healthcare provider (situation)"
         end
+
+        its(:nhs_immunisations_api_snomed_reason_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
+        its(:notes) do
+          should include(
+                   "Reported dose number string: Dose sequence not recorded"
+                 )
+        end
       end
 
       context "with a record that is nasal flu, and is missing dose quantity (from real GP)" do
@@ -982,6 +1012,9 @@
           should eq "Administration of first intranasal seasonal influenza vaccination"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) { should be_nil }
       end
 
@@ -1018,6 +1051,9 @@
           should eq "Administration of first intranasal seasonal influenza vaccination"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) { should be_nil }
       end
 
@@ -1058,6 +1094,9 @@
           should eq "Administration of first inactivated seasonal influenza vaccination"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) { should be_nil }
       end
 
@@ -1103,6 +1142,9 @@
           should eq "Administration of first intranasal seasonal influenza vaccination"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "723620004" }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) { should be_nil }
       end
 
@@ -1148,6 +1190,9 @@
           should eq "Administration of first intranasal seasonal influenza vaccination"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) { should be_nil }
       end
 
@@ -1182,14 +1227,17 @@
         its(:outcome) { should eq "administered" }
         its(:performed_ods_code) { should eq "B12345" }
 
+        its(:nhs_immunisations_api_snomed_procedure_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_procedure_term) { should be_nil }
+
+        its(:nhs_immunisations_api_snomed_reason_code) { should be_nil }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) do
           should include(
                    "Reported dose number string: Dose sequence not recorded"
                  )
         end
-
-        its(:nhs_immunisations_api_snomed_procedure_code) { should be_nil }
-        its(:nhs_immunisations_api_snomed_procedure_term) { should be_nil }
       end
     end
 
@@ -1242,6 +1290,9 @@
           should eq "Administration of vaccine product containing only Human papillomavirus antigen (procedure)"
         end
 
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "723620004" }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
         its(:notes) { should be_nil }
       end
     end
@@ -1287,8 +1338,6 @@
         its(:performed_ods_code) { should eq "R1L" }
         its(:nhs_immunisations_api_primary_source) { should be true }
 
-        its(:notes) { should include("Reported dose number string: Unknown") }
-
         its(:nhs_immunisations_api_snomed_procedure_code) do
           should eq "871874000"
         end
@@ -1298,6 +1347,11 @@
                       "Neisseria meningitidis serogroup A, C, W135 and Y " \
                       "antigens (procedure)"
         end
+
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "723620004" }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
+        its(:notes) { should include("Reported dose number string: Unknown") }
       end
     end
 
@@ -1342,8 +1396,6 @@
         its(:performed_ods_code) { should eq "R1L" }
         its(:nhs_immunisations_api_primary_source) { should be true }
 
-        its(:notes) { should include("Reported dose number string: Unknown") }
-
         its(:nhs_immunisations_api_snomed_procedure_code) do
           should eq "866186002"
         end
@@ -1353,6 +1405,11 @@
                       "Clostridium tetani and Corynebacterium diphtheriae " \
                       "and Human poliovirus antigens (procedure)"
         end
+
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "723620004" }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
+        its(:notes) { should include("Reported dose number string: Unknown") }
       end
     end
 
@@ -1401,8 +1458,6 @@
         its(:performed_ods_code) { should eq "R1L" }
         its(:nhs_immunisations_api_primary_source) { should be true }
 
-        its(:notes) { should include("Reported dose number string: Unknown") }
-
         its(:nhs_immunisations_api_snomed_procedure_code) do
           should eq "38598009"
         end
@@ -1412,6 +1467,11 @@
                       "Measles morbillivirus and Mumps orthorubulavirus " \
                       "and Rubella virus antigens (procedure)"
         end
+
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "723620004" }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
+        its(:notes) { should include("Reported dose number string: Unknown") }
       end
     end
 
@@ -1460,8 +1520,6 @@
         its(:performed_ods_code) { should eq "R1L" }
         its(:nhs_immunisations_api_primary_source) { should be true }
 
-        its(:notes) { should include("Reported dose number string: Unknown") }
-
         its(:nhs_immunisations_api_snomed_procedure_code) do
           should eq "432636005"
         end
@@ -1471,6 +1529,11 @@
                       "Human alphaherpesvirus 3 and Measles morbillivirus " \
                       "and Mumps orthorubulavirus and Rubella virus antigens"
         end
+
+        its(:nhs_immunisations_api_snomed_reason_code) { should eq "723620004" }
+        its(:nhs_immunisations_api_snomed_reason_term) { should be_nil }
+
+        its(:notes) { should include("Reported dose number string: Unknown") }
       end
     end
   end

spec/models/vaccination_record_spec.rb

@@ -22,6 +22,8 @@
 #  nhs_immunisations_api_primary_source        :boolean
 #  nhs_immunisations_api_snomed_procedure_code :string
 #  nhs_immunisations_api_snomed_procedure_term :string
+#  nhs_immunisations_api_snomed_reason_code    :string
+#  nhs_immunisations_api_snomed_reason_term    :string
 #  nhs_immunisations_api_sync_pending_at       :datetime
 #  nhs_immunisations_api_synced_at             :datetime
 #  notes                                       :text