hln_ice 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 693ce96464262bed3bdbba9a9d38cc91aaaba9620c270e49994b4c0537c21b4d
-  data.tar.gz: 74711ef35d3caf83aa5b210ad0665b152275224fbc571349b686432d0fed0e10
+  metadata.gz: ad2a04435e36bc2e843e01c674c067f8d552f7b528e95e5540b19cbb11a06ff4
+  data.tar.gz: c5a5769cbf8c2d41e7074812a1ff83e0caf489a9a31d3bf4f2486a2160674118
 SHA512:
-  metadata.gz: 6f47f5f31184385ebf20e319a415720094a792fe2e91b3e35218771e7ff15f80ecac1956771eab2bbd773c820ae2e54b5df6dc774f1bffc97786ad7814419918
-  data.tar.gz: ac317607ab177277cba5c32c458d3f5ddb583a6e84f0e98ab70d774128986db2c393d1a2d783f50386d93ae74ad0800967443024f20a93cd5f6e0a9eedaa9405
+  metadata.gz: 0ea75c7a3a922fb8fb76388f3d5d3ae568f324afe744861cc79b74c2eb0d83fbcdbed60ff2839391dd0823ba36cb197101494c147cd690036013ad46ea9ffc54
+  data.tar.gz: e66a9cd04e3b62d2e47731311dbc1ddc1f57f5a52259f81cc5d3a334fd8f82826ac53ba6e75c3f76630b92b8d54761ae5236127162b2893ec177c7c1469c9f00

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.3.0] - 2026-09-24
+
+- Expose schedule authorities (e.g. `ACIP_CDC`, `AAP`, `AAFP`) on each recommendation under `schedule_authorities` when the ICE server has `outputScheduleAuthorities` enabled. The key is omitted when the server does not return them.
+- Fix recommendations being silently dropped when a proposal's schedule authorities observation precedes its status observation.
+
 ## [0.2.0] - 2026-07-02
 
 - Stop logging PHI by default. The ICE input data, generated request XML, and raw service response are no longer logged unless the new `log_payloads:` option is set to `true`. Warnings and errors are still logged.

data/README.md

@@ -108,7 +108,12 @@ On success:
         vaccine: { code: "10", code_system: "...", name: "Polio Vaccine Group" },
         status:  { code: "RECOMMENDED", name: "Recommended" },
         reasons: [{ code: "DUE_NOW", name: "Due Now" }],
-        intervals: { proposed: { low: "2020-03-01", high: "2020-04-01" } }
+        intervals: { proposed: { low: "2020-03-01", high: "2020-04-01" } },
+        # Only present when the ICE server has outputScheduleAuthorities enabled
+        schedule_authorities: [
+          { code: "ACIP_CDC", name: "Advisory Committee on Immunization Practices / Centers for Disease Control and Prevention" },
+          { code: "AAP", name: "American Academy of Pediatrics" }
+        ]
       }
     ],
     simplified_status: { ipv_opv: "overdue" }

data/lib/hln_ice/client.rb

@@ -306,13 +306,14 @@ module HlnIce
           vaccine_name        = substance_element["displayName"]
           vaccine_code_system = substance_element["codeSystem"]
 
-          # Get the clinical observation result
-          observation = proposal.xpath(".//observationResult").first
+          # Get the clinical observation result carrying the recommendation status.
+          # A proposal may contain other observation results (e.g. schedule
+          # authorities), in any order, so select the one with a status concept.
+          observation = proposal.xpath(".//observationResult[observationValue/concept]").first
           next unless observation
 
           # Get recommendation status
           status_element = observation.xpath(".//observationValue/concept").first
-          next unless status_element
 
           status_code = status_element["code"]
           status_name = status_element["displayName"]
@@ -369,6 +370,11 @@ module HlnIce
           # Only add intervals if they exist
           recommendation[:intervals] = intervals if present?(intervals)
 
+          # Only add schedule authorities if the service returned them
+          # (requires the ICE outputScheduleAuthorities property)
+          schedule_authorities = parse_schedule_authorities(proposal)
+          recommendation[:schedule_authorities] = schedule_authorities if present?(schedule_authorities)
+
           all_recommendations << recommendation
         end
 
@@ -413,6 +419,21 @@ module HlnIce
         }
       end
 
+      # Extract the schedule authorities (e.g. ACIP_CDC, AAP) for a proposal.
+      # Returns an empty array when the service did not include them.
+      def parse_schedule_authorities(proposal)
+        authorities = proposal.xpath(
+          ".//observationResult[observationFocus/@code='ICE_VACCINE_GROUP_SCHEDULE_AUTHORITIES']/interpretation"
+        )
+
+        authorities.map do |interpretation|
+          {
+            code: interpretation["code"],
+            name: interpretation["displayName"]
+          }
+        end
+      end
+
       def handle_error_response(response)
         error_message = "ICE service error: #{response.code}"
 

data/lib/hln_ice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HlnIce
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hln_ice
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Sohn
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -65,7 +65,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- hln_ice.gemspec
 - lib/hln_ice.rb
 - lib/hln_ice/client.rb
 - lib/hln_ice/version.rb
@@ -92,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.15
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Ruby client for the HLN ICE (Immunization Calculation Engine) OpenCDS service.
 test_files: []

data/hln_ice.gemspec

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/hln_ice/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "hln_ice"
-  spec.version = HlnIce::VERSION
-  spec.authors = ["Sam Sohn"]
-  spec.email = ["sam@primary.health"]
-
-  spec.summary = "Ruby client for the HLN ICE (Immunization Calculation Engine) OpenCDS service."
-  spec.description = "Evaluates a patient's immunization history against the HLN ICE forecasting " \
-                     "rules and returns both the raw recommendations and a simplified status mapping."
-  spec.homepage = "https://github.com/PrimaryDotHealth/hln_ice"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "base64", "~> 0.2"
-  spec.add_dependency "httparty", "~> 0.21"
-  spec.add_dependency "nokogiri", "~> 1.15"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end