hln_ice 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc821a0690dfaa750fb0dd36f1409a8a20054486318166f708bd8a266ff5c7a
-  data.tar.gz: 424486397d7ae838ee6af769155deef6a8b5bff76309291470a295c10eb58389
+  metadata.gz: ad2a04435e36bc2e843e01c674c067f8d552f7b528e95e5540b19cbb11a06ff4
+  data.tar.gz: c5a5769cbf8c2d41e7074812a1ff83e0caf489a9a31d3bf4f2486a2160674118
 SHA512:
-  metadata.gz: 172c72400334ad1e9ca73b37fd7c77c7227386336e44e5d751c69d1bf40e021664ac0ceeeb835361924d6ddaff6cc0898420e07f5088fe72925821fdfa35bf11
-  data.tar.gz: 1ee834f1abd93c7cb9dc19453a7afd111a39f5745ad12d3d6345bae406805c9fb837fa3aacb80ecc03e9fe81c1cfe6d36d36b6790be2ed657aa0596e147f624d
+  metadata.gz: 0ea75c7a3a922fb8fb76388f3d5d3ae568f324afe744861cc79b74c2eb0d83fbcdbed60ff2839391dd0823ba36cb197101494c147cd690036013ad46ea9ffc54
+  data.tar.gz: e66a9cd04e3b62d2e47731311dbc1ddc1f57f5a52259f81cc5d3a334fd8f82826ac53ba6e75c3f76630b92b8d54761ae5236127162b2893ec177c7c1469c9f00

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [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.
+- The service response is now logged at `debug` (was `info`), matching the input data and generated XML, so all payload logging behaves uniformly and stays out of `info`-level logs.
+
 ## [0.1.0] - 2026-06-22
 
 - Initial release

data/README.md

@@ -49,6 +49,7 @@ All options:
 | `max_retries:`| `3`                      | Number of retries on a failed evaluation request.     |
 | `retry_delay:`| `1`                      | Seconds to wait between retries.                      |
 | `logger:`     | `Logger.new($stdout)`    | Any `Logger`-compatible object. In Rails, pass `Rails.logger`. |
+| `log_payloads:`| `false`                 | When `true`, logs the ICE input data, generated request XML, and raw service response. These contain patient PHI, so keep this off outside local debugging. |
 
 ```ruby
 # In a Rails app, reuse the application logger:
@@ -107,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

@@ -37,14 +37,18 @@ module HlnIce
       "Varicella Vaccine Group" => :var,
     }.freeze
 
-    attr_reader :base_url, :timeout, :max_retries, :retry_delay, :logger
+    attr_reader :base_url, :timeout, :max_retries, :retry_delay, :logger, :log_payloads
 
-    def initialize(base_url:, timeout: 30, max_retries: 3, retry_delay: 1, logger: nil)
+    # log_payloads: when false (default), the ICE input data, generated request
+    # XML, and raw service response are NOT logged. These contain patient PHI, so
+    # logging stays off unless a caller explicitly opts in (e.g. local debugging).
+    def initialize(base_url:, timeout: 30, max_retries: 3, retry_delay: 1, logger: nil, log_payloads: false)
       @base_url = base_url
       @timeout = timeout
       @max_retries = max_retries
       @retry_delay = retry_delay
       @logger = logger || Logger.new($stdout)
+      @log_payloads = log_payloads
     end
 
     # Check if the ICE service is available
@@ -127,7 +131,7 @@ module HlnIce
         gender = "U" if blank?(gender) # Set default to 'U' if blank
 
         # Log input data for debugging
-        logger.debug("ICE Input Data: #{JSON.pretty_generate(patient_data)}")
+        logger.debug("ICE Input Data: #{JSON.pretty_generate(patient_data)}") if log_payloads
 
         # Build the VMR XML
         xml_payload = <<~XML
@@ -196,7 +200,7 @@ module HlnIce
         XML
 
         # Log the generated XML for debugging
-        logger.debug("Generated ICE XML: #{xml_payload}")
+        logger.debug("Generated ICE XML: #{xml_payload}") if log_payloads
 
         # Base64 encode the XML
         base64_encoded_payload = Base64.strict_encode64(xml_payload)
@@ -245,7 +249,7 @@ module HlnIce
       end
 
       def parse_ice_response(response_body)
-        logger.info("ICE service response: #{response_body}")
+        logger.debug("ICE service response: #{response_body}") if log_payloads
 
         result = JSON.parse(response_body)
 
@@ -302,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"]
@@ -365,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
 
@@ -409,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.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hln_ice
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Sohn
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-22 00:00:00.000000000 Z
+date: 2026-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -78,7 +77,6 @@ metadata:
   homepage_uri: https://github.com/PrimaryDotHealth/hln_ice
   source_code_uri: https://github.com/PrimaryDotHealth/hln_ice
   changelog_uri: https://github.com/PrimaryDotHealth/hln_ice/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Ruby client for the HLN ICE (Immunization Calculation Engine) OpenCDS service.
 test_files: []