us_quality_core_test_kit 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d71c2e36b7ed3be04801523be2585090953365e9716279aab8cbb46dab077a6
-  data.tar.gz: 885e8a05af4bdfd964cb1656221ebd309b196e2be36b1fc4404e2a9c5a2069b3
+  metadata.gz: '0297423f25d4655d95c5d963fb2363bdef89197c13c082b63ee2bc339a9780fe'
+  data.tar.gz: 614f8a0f368729af2383e877bff720b9784ece107bef849cf887966dec2e73e0
 SHA512:
-  metadata.gz: 6bd30d52b1610e68728f93052002061195b2cc284b61c2fb99e356fce30c4477d749efeee3e757538cdd928e29befb329b146fb77d38a94f938bcabe7bad3099
-  data.tar.gz: acc81efae38e987ad357ea1fecdbec236454819e8ac3187e1a078401f30713e9be10a4a3798fc9d74c01d0d5716b057f9682d86f096d9741a1ed3a970f5f091b
+  metadata.gz: 10673556b891c029d3c94779d7439412f633dcc9c6dfe033fce3deeb64da61e1d29a96f953cdaf8dd8338db314eb7f6217d9b1518d356d702dd397b8daaf34e9
+  data.tar.gz: 8c8e669cebe8ff4a3b1fcb49ed3023c32f7546b27116ad21c965beb716017cc488694cb6ca225f1f17380cd7bb31f13ffa6273a777647de75ebb9790b57a2a5e

data/NOTICE.md

@@ -11,3 +11,15 @@ For further information, please contact The MITRE Corporation, Contracts Managem
 Approved for Public Release; Distribution Unlimited. Public Release Case Number: 25-3234 
 
 ### <p align='center'>**ⓒ2026 The MITRE Corporation.**</p>
+
+Portions of this software include code from the US Core Test Kit.
+
+That software was produced for the U. S. Government under Contract Number 75FCMC18D0047, and is subject to Federal Acquisition Regulation Clause 52.227-14, Rights in Data-General.
+
+No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation.
+
+To the extent necessary MITRE hereby grants express written permission to use, reproduce, distribute, modify, and otherwise leverage this software to the extent permitted by the Apache 2.0 license.
+
+For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA  22102-7539, (703) 983-6000.
+
+### <p align='center'>**ⓒ2024 The MITRE Corporation.**</p>

data/config/presets/{localhost_preset.json → inferno_reference_server_preset.json.erb}

@@ -1,5 +1,5 @@
 {
-  "title": "Localhost Server",
+  "title": "Inferno Reference Server",
   "id": null,
   "test_suite_id": "us_quality_core_v050",
   "inputs": [
@@ -8,7 +8,7 @@
       "type": "text",
       "title": "FHIR Endpoint",
       "description": "URL of the FHIR endpoint",
-      "value": "http://localhost:8080/reference-server/r4"
+      "value": "<%= ENV.fetch('FHIR_REFERENCE_SERVER', 'https://inferno.healthit.gov/reference-server/r4') %>"
     },
     {
       "name": "smart_auth_info",

data/lib/us_quality_core_test_kit/client/generator/example_client_generator.rb

@@ -126,7 +126,6 @@ module USQualityCoreTestKit
         end
       end
 
-      # rubocop:disable Metrics/ClassLength
       class ExampleClientGenerator
         class << self
           def generate(ig_metadata, base_output_dir)

data/lib/us_quality_core_test_kit/client/generator/tags_generator.rb

@@ -35,7 +35,6 @@ module USQualityCoreTestKit
 
         def groups
           ig_metadata.ordered_groups
-                     .reject { |group| USCoreTestKit::Generator::SpecialCases.exclude_group? group }
         end
 
         def resources

data/lib/us_quality_core_test_kit/client/server_proxy.rb

@@ -58,12 +58,8 @@ module USQualityCoreTestKit
 
       def replace_bundle_urls(bundle)
         reference_server_base = ENV.fetch('FHIR_REFERENCE_SERVER')
-        bundle&.link&.map! { |link| { relation: link.relation, url: link.url.gsub(reference_server_base, new_link) } }
-        bundle&.entry&.map! do |bundled_resource|
-          { fullUrl: bundled_resource.fullUrl.gsub(reference_server_base, new_link),
-            resource: bundled_resource.resource,
-            search: bundled_resource.search }
-        end
+        bundle&.link&.each { |link| link.url = link.url.gsub(reference_server_base, new_link) }
+        bundle&.entry&.each { |entry| entry.fullUrl = entry.fullUrl.gsub(reference_server_base, new_link) }
         bundle
       end
 

data/lib/us_quality_core_test_kit/date_search_validation.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module USQualityCoreTestKit
+  module DateSearchValidation
+    def get_fhir_datetime_range(datetime)
+      range = { start: DateTime.xmlschema(datetime), end: nil }
+      range[:end] =
+        case datetime
+        when /^\d{4}$/ # YYYY
+          range[:start].next_year - 1.seconds
+        when /^\d{4}-\d{2}$/ # YYYY-MM
+          range[:start].next_month - 1.seconds
+        when /^\d{4}-\d{2}-\d{2}$/ # YYYY-MM-DD
+          range[:start].next_day - 1.seconds
+        else # YYYY-MM-DDThh:mm:ss+zz:zz
+          range[:start]
+        end
+      range
+    end
+
+    def get_fhir_period_range(period)
+      range = { start: nil, end: nil }
+      range[:start] = DateTime.xmlschema(period.start) unless period.start.nil?
+      return range if period.end.nil?
+
+      period_end_beginning = DateTime.xmlschema(period.end)
+      range[:end] =
+        case period.end
+        when /^\d{4}$/ # YYYY
+          period_end_beginning.next_year - 1.seconds
+        when /^\d{4}-\d{2}$/ # YYYY-MM
+          period_end_beginning.next_month - 1.seconds
+        when /^\d{4}-\d{2}-\d{2}$/ # YYYY-MM-DD
+          period_end_beginning.next_day - 1.seconds
+        else # YYYY-MM-DDThh:mm:ss+zz:zz
+          period_end_beginning
+        end
+      range
+    end
+
+    def fhir_date_comparer(search_range, target_range, comparator, extend_start: false, extend_end: false)
+      # Implicitly, a missing lower boundary is "less than" any actual date. A missing upper boundary is "greater than" any actual date.
+      case comparator
+      when 'eq' # the range of the search value fully contains the range of the target value
+        !target_range[:start].nil? && !target_range[:end].nil? && search_range[:start] <= target_range[:start] && search_range[:end] >= target_range[:end]
+      when 'ne' # the range of the search value does not fully contain the range of the target value
+        target_range[:start].nil? || target_range[:end].nil? || search_range[:start] > target_range[:start] || search_range[:end] < target_range[:end]
+      when 'gt' #  the range above the search value intersects (i.e. overlaps) with the range of the target value
+        target_range[:end].nil? || search_range[:end] < target_range[:end] || (search_range[:end] < (target_range[:end] + 1) && extend_end)
+      when 'lt' # the range below the search value intersects (i.e. overlaps) with the range of the target value
+        target_range[:start].nil? || search_range[:start] > target_range[:start] || (search_range[:start] > (target_range[:start] - 1) && extend_start)
+      when 'ge'
+        fhir_date_comparer(search_range, target_range, 'gt', extend_start:, extend_end:) || fhir_date_comparer(search_range, target_range, 'eq')
+      when 'le'
+        fhir_date_comparer(search_range, target_range, 'lt', extend_start:, extend_end:) || fhir_date_comparer(search_range, target_range, 'eq')
+      when 'sa' # the range above the search value contains the range of the target value
+        !target_range[:start].nil? && search_range[:end] < target_range[:start]
+      when 'eb' # the range below the search value contains the range of the target value
+        !target_range[:end].nil? && search_range[:start] > target_range[:end]
+      when 'ap' # the range of the search value overlaps with the range of the target value
+        if target_range[:start].nil? || target_range[:end].nil?
+          (target_range[:start].nil? && search_range[:start] < target_range[:end]) ||
+            (target_range[:end].nil? && search_range[:end] > target_range[:start])
+        else
+          (search_range[:start] >= target_range[:start] && search_range[:start] <= target_range[:end]) ||
+            (search_range[:end] >= target_range[:start] && search_range[:end] <= target_range[:end])
+        end
+      end
+    end
+
+    def validate_date_search(search_value, target_value)
+      if target_value.instance_of? FHIR::Period
+        validate_period_search(search_value, target_value)
+      else
+        validate_datetime_search(search_value, target_value)
+      end
+    end
+
+    def validate_datetime_search(search_value, target_value)
+      comparator = search_value[0..1]
+      if %w[eq ge gt le lt ne sa eb ap].include? comparator
+        search_value = search_value[2..]
+      else
+        comparator = 'eq'
+      end
+      search_is_date = date?(search_value)
+      target_is_date = date?(target_value)
+      search_range = get_fhir_datetime_range(search_value)
+      target_range = get_fhir_datetime_range(target_value)
+      fhir_date_comparer(
+        search_range,
+        target_range,
+        comparator,
+        extend_start: !search_is_date && target_is_date,
+        extend_end: !search_is_date && target_is_date
+      )
+    end
+
+    def validate_period_search(search_value, target_value)
+      comparator = search_value[0..1]
+      if %w[eq ge gt le lt ne sa eb ap].include? comparator
+        search_value = search_value[2..]
+      else
+        comparator = 'eq'
+      end
+      search_is_date = date?(search_value)
+      search_range = get_fhir_datetime_range(search_value)
+      target_range = get_fhir_period_range(target_value)
+      fhir_date_comparer(
+        search_range,
+        target_range,
+        comparator,
+        extend_start: !search_is_date && date?(target_value.start),
+        extend_end: !search_is_date && date?(target_value.end)
+      )
+    end
+
+    def date?(value)
+      /^\d{4}(-\d{2})?(-\d{2})?$/.match?(value) # YYYY or YYYY-MM or YYYY-MM-DD
+    end
+  end
+end

data/lib/us_quality_core_test_kit/fhir_resource_navigation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'primitive_type'
+
+module USQualityCoreTestKit
+  # This functionality has been moved to Inferno Core, but this reference is
+  # retained to avoid a breaking change.
+  FHIRResourceNavigation = Inferno::DSL::FHIRResourceNavigation
+end

data/lib/us_quality_core_test_kit/generated/v0.5.0/devicenotrequested/devicenotrequested_validation_test.rb

@@ -20,6 +20,9 @@ bindings will fail if none of their codings have a code/system belonging
 to the bound ValueSet. Quantity, Coding, and code element bindings will
 fail if their code/system are not found in the valueset.
 
+Note: This test ignores a known validator slicing resolution message for
+`DeviceRequest.modifierExtension`.
+
       )
 
       output :dar_code_found, :dar_extension_found

data/lib/us_quality_core_test_kit/generated/v0.5.0/devicerequest/devicerequest_validation_test.rb

@@ -20,6 +20,9 @@ bindings will fail if none of their codings have a code/system belonging
 to the bound ValueSet. Quantity, Coding, and code element bindings will
 fail if their code/system are not found in the valueset.
 
+Note: This test ignores a known validator slicing resolution message for
+`DeviceRequest.modifierExtension`.
+
       )
 
       output :dar_code_found, :dar_extension_found

data/lib/us_quality_core_test_kit/generated/v0.5.0/patient/patient_validation_test.rb

@@ -20,6 +20,10 @@ bindings will fail if none of their codings have a code/system belonging
 to the bound ValueSet. Quantity, Coding, and code element bindings will
 fail if their code/system are not found in the valueset.
 
+Note: This test ignores validator messages for `Patient.extension`. This is a workaround for
+a known validator package interaction where CQL can load US Core 7 definitions into the
+validator session even though US Quality Core 0.5.0 is based on US Core 6.1.0.
+
       )
 
       output :dar_code_found, :dar_extension_found

data/lib/us_quality_core_test_kit/generated/v0.5.0/us_quality_core_test_suite.rb

@@ -98,8 +98,7 @@ module USQualityCoreTestKit
 
 
       VERSION_SPECIFIC_MESSAGE_FILTERS = [
-        %r{Patient.*Patient\.extension\[\d+\]\[url='http://hl7\.org/fhir/us/core/StructureDefinition/us-core-(race|ethnicity|tribal-affiliation)\|\d+\.\d+(?:\.\d+)?'\]:\s*The extension URL must not contain a version\.},
-        %r{Patient.*Patient\.extension\[\d+\]\.url:\s*Value is 'http://hl7\.org/fhir/us/core/StructureDefinition/us-core-(race|ethnicity|tribal-affiliation)\|\d+\.\d+(?:\.\d+)?'\s*but is fixed to 'http://hl7\.org/fhir/us/core/StructureDefinition/us-core-(race|ethnicity|tribal-affiliation)'\s*in the profile http://hl7\.org/fhir/us/core/StructureDefinition/us-core-(race|ethnicity|tribal-affiliation)\|\d+\.\d+(?:\.\d+)?#Extension\.url},
+        %r{\bPatient\.extension},
         %r{DeviceRequest.*DeviceRequest\.modifierExtension\[\d+\]:\s*Slicing cannot be evaluated:\s*Unable to resolve profile CanonicalType\[http://hl7\.org/fhir/5\.0/StructureDefinition/extension-DeviceRequest\.doNotPerform\]}
       ].freeze
 

data/lib/us_quality_core_test_kit/generator/group_generator.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
-require 'us_core_test_kit/generator/group_generator'
-
 require_relative 'naming'
 require_relative 'special_cases'
 
 module USQualityCoreTestKit
   class Generator
-    class GroupGenerator < USCoreTestKit::Generator::GroupGenerator
+    class GroupGenerator
       class << self
         def generate(ig_metadata, base_output_dir)
           ig_metadata.ordered_groups
@@ -16,10 +14,29 @@ module USQualityCoreTestKit
         end
       end
 
+      attr_accessor :group_metadata, :base_output_dir
+
+      def initialize(group_metadata, base_output_dir)
+        self.group_metadata = group_metadata
+        self.base_output_dir = base_output_dir
+      end
+
       def template
         @template ||= File.read(File.join(__dir__, 'templates', 'group.rb.erb'))
       end
 
+      def output
+        @output ||= ERB.new(template, trim_mode: '-').result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def base_metadata_file_name
+        'metadata.yml'
+      end
+
       def class_name
         "#{Naming.upper_camel_case_for_profile(group_metadata)}Group"
       end
@@ -28,6 +45,22 @@ module USQualityCoreTestKit
         "USQualityCore#{group_metadata.reformatted_version.upcase}"
       end
 
+      def title
+        group_metadata.title
+      end
+
+      def short_description
+        group_metadata.short_description
+      end
+
+      def output_file_name
+        File.join(base_output_dir, base_output_file_name)
+      end
+
+      def metadata_file_name
+        File.join(base_output_dir, profile_identifier, base_metadata_file_name)
+      end
+
       def profile_identifier
         Naming.snake_case_for_profile(group_metadata)
       end
@@ -36,16 +69,49 @@ module USQualityCoreTestKit
         "us_quality_core_#{group_metadata.reformatted_version}_#{profile_identifier}"
       end
 
+      def resource_type
+        group_metadata.resource
+      end
+
       def search_validation_resource_type
         "#{resource_type} resources"
       end
 
+      def profile_name
+        group_metadata.profile_name
+      end
+
+      def profile_url
+        group_metadata.profile_url
+      end
+
       def optional?
         SpecialCases::OPTIONAL_RESOURCES.include?(resource_type) || group_metadata.optional_profile?
       end
 
+      def generate
+        add_special_tests
+        File.write(output_file_name, output)
+        group_metadata.id = group_id
+        group_metadata.file_name = base_output_file_name
+        File.write(metadata_file_name, YAML.dump(group_metadata.to_hash))
+      end
+
       def add_special_tests; end
 
+      def test_id_list
+        @test_id_list ||=
+          group_metadata.tests.map { |test| test[:id] }
+      end
+
+      def test_file_list
+        @test_file_list ||=
+          group_metadata.tests.map do |test|
+            name_without_suffix = test[:file_name].delete_suffix('.rb')
+            name_without_suffix.start_with?('..') ? name_without_suffix : "#{profile_identifier}/#{name_without_suffix}"
+          end
+      end
+
       def required_searches
         group_metadata.searches.select { |search| search[:expectation] == 'SHALL' }
       end

data/lib/us_quality_core_test_kit/generator/group_metadata.rb

@@ -2,14 +2,110 @@
 
 require_relative 'special_cases'
 
-require 'us_core_test_kit/generator/group_metadata'
-
 module USQualityCoreTestKit
   class Generator
-    class GroupMetadata < USCoreTestKit::Generator::GroupMetadata
+    class GroupMetadata
+      ATTRIBUTES = %i[
+        name
+        class_name
+        version
+        reformatted_version
+        resource
+        profile_url
+        profile_name
+        profile_version
+        title
+        short_description
+        is_delayed
+        interactions
+        operations
+        searches
+        search_definitions
+        include_params
+        revincludes
+        required_concepts
+        must_supports
+        mandatory_elements
+        bindings
+        references
+        tests
+        granular_scope_tests
+        id
+        file_name
+        delayed_references
+        resource_conformance_expectation
+      ].freeze
+
+      ATTRIBUTES.each { |name| attr_accessor name }
+
+      def initialize(metadata)
+        metadata.each do |key, value|
+          raise "Unknown attribute #{key}" unless ATTRIBUTES.include? key
+
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      def exclude_search_tests?
+        delayed? && !searchable_delayed_resource?
+      end
+
+      def non_uscdi_resource?
+        SpecialCases::NON_USCDI_RESOURCES.key?(resource) && SpecialCases::NON_USCDI_RESOURCES[resource].include?(reformatted_version)
+      end
+
+      def optional_profile?
+        SpecialCases::OPTIONAL_PROFILES.key?(profile_url) && SpecialCases::OPTIONAL_PROFILES[profile_url].include?(reformatted_version)
+      end
+
+      def searchable_delayed_resource?
+        SpecialCases::SEARCHABLE_DELAYED_RESOURCES.key?(resource) && SpecialCases::SEARCHABLE_DELAYED_RESOURCES[resource].include?(reformatted_version)
+      end
+
+      def add_test(id:, file_name:)
+        self.tests ||= []
+
+        test_metadata = {
+          id: id,
+          file_name: file_name
+        }
+
+        if delayed? && id.include?('read')
+          self.tests.unshift(test_metadata)
+        else
+          self.tests << test_metadata
+        end
+      end
+
+      def add_granular_scope_test(id:, file_name:)
+        self.granular_scope_tests ||= []
+
+        self.granular_scope_tests << {
+          id:,
+          file_name:
+        }
+      end
+
+      def to_hash
+        ATTRIBUTES.each_with_object({}) { |key, hash| hash[key] = send(key) unless send(key).nil? }
+      end
+
+      def add_delayed_references(delayed_profiles, ig_resources)
+        self.delayed_references =
+          references
+          .select { |reference| (reference[:profiles] & delayed_profiles).present? }
+          .map do |reference|
+            profile_urls = (reference[:profiles] & delayed_profiles)
+            delayed_resources = profile_urls.map { |url| ig_resources.resource_for_profile(url) }
+            {
+              path: reference[:path].gsub("#{resource}.", ''),
+              resources: delayed_resources
+            }
+          end
+      end
+
       def delayed?
         # rubocop:disable Naming/MemoizedInstanceVariableName
-        # @is_delayed is used in USCoreTestKit::Generator::GroupMetadata
         @is_delayed ||= if resource == 'Patient'
                           false
                         else