us_quality_core_test_kit 0.1.0

data/lib/us_quality_core_test_kit/generator/provenance_revinclude_search_test_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/provenance_revinclude_search_test_generator'
+
+require_relative 'naming'
+require_relative 'special_cases'
+
+module USQualityCoreTestKit
+  class Generator
+    class ProvenanceRevincludeSearchTestGenerator < USCoreTestKit::Generator::ProvenanceRevincludeSearchTestGenerator
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'provenance_revinclude_search.rb.erb'))
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def needs_patient_id?
+        search_metadata[:names].include?('patient') ||
+          search_metadata[:names].include?('subject') ||
+          (resource_type == 'Patient' && search_metadata[:names].include?('_id'))
+      end
+
+      def fixed_value_search?
+        search_metadata[:names] != ['patient'] &&
+          search_metadata[:names] != ['subject'] &&
+          !group_metadata.delayed? && resource_type != 'Patient'
+      end
+
+      def test_id
+        "us_quality_core_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_search_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}SearchTest"
+      end
+
+      def module_name
+        "USQualityCore#{group_metadata.reformatted_version.upcase}"
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/read_test_generator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/read_test_generator'
+
+require_relative 'naming'
+require_relative 'special_cases'
+
+module USQualityCoreTestKit
+  class Generator
+    class ReadTestGenerator < USCoreTestKit::Generator::ReadTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .reject { |group| SpecialCases.exclude_group? group }
+                     .select { |group| read_interaction(group).present? }
+                     .each { |group| new(group, base_output_dir).generate }
+        end
+
+        def read_interaction(group_metadata)
+          group_metadata.interactions.find { |interaction| interaction[:code] == 'read' }
+        end
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'read.rb.erb'))
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "us_quality_core_#{group_metadata.reformatted_version}_#{profile_identifier}_read_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ReadTest"
+      end
+
+      def module_name
+        "USQualityCore#{group_metadata.reformatted_version.upcase}"
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/reference_resolution_test_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/reference_resolution_test_generator'
+
+require_relative 'naming'
+require_relative 'special_cases'
+
+module USQualityCoreTestKit
+  class Generator
+    class ReferenceResolutionTestGenerator < USCoreTestKit::Generator::ReferenceResolutionTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .reject { |group| SpecialCases.exclude_group? group }
+                     .each { |group| new(group, base_output_dir).generate }
+        end
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'reference_resolution.rb.erb'))
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "us_quality_core_#{group_metadata.reformatted_version}_#{profile_identifier}_reference_resolution_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ReferenceResolutionTest"
+      end
+
+      def module_name
+        "USQualityCore#{group_metadata.reformatted_version.upcase}"
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/search_definition_metadata_extractor.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/search_definition_metadata_extractor'
+
+require_relative 'special_cases'
+require_relative 'value_extractor'
+
+module USQualityCoreTestKit
+  class Generator
+    class SearchDefinitionMetadataExtractor < USCoreTestKit::Generator::SearchDefinitionMetadataExtractor
+      EXTENSION_URL_REGEX = /(?:modifierExtension|extension)\.where\(url='([^']+)'\)/
+      EXTENSION_VALUE_PATH_REGEX = /\.(?:value(?:[A-Z]\w*|\[x\])?)\z/
+
+      def value_extractor
+        @value_extractor ||= ValueExactor.new(ig_resources, resource, profile_elements)
+      end
+
+      def paths
+        @paths ||= full_paths.map { |a_path| a_path.delete_prefix("#{resource}.") }
+      end
+
+      def extensions
+        @extensions ||= full_paths.filter_map do |a_path|
+          url = a_path.match(EXTENSION_URL_REGEX)&.[](1)
+          { url: url } if url.present?
+        end.presence
+      end
+
+      def profile_element
+        @profile_element ||= begin
+          extension_value_element =
+            if full_paths.any? { |path| path.match?(EXTENSION_VALUE_PATH_REGEX) }
+              extension_slice =
+                extensions&.lazy&.filter_map do |extension_metadata|
+                  profile_elements.find do |element|
+                    element.type.any? do |type|
+                      type.code == 'Extension' && Array.wrap(type.profile).include?(extension_metadata[:url])
+                    end
+                  end
+                end&.first
+
+              profile_elements.find { |element| element.id.start_with?("#{extension_slice.id}.value") } if extension_slice
+            end
+
+          profile_elements.find { |element| full_paths.include?(element.id) } ||
+            extension_value_element ||
+            extension_definition&.differential&.element&.find { |element| element.id == 'Extension.value[x]' } ||
+            token_choice_element
+        end
+      end
+
+      def token_choice_element
+        return unless param.type == 'token'
+
+        profile_elements.find do |element|
+          next unless element.id.include?('[x]')
+
+          lb = element.id.split('.', 2).last&.gsub('[x]', '')
+          lb && paths.any? { |path| path.start_with?(lb) }
+        end
+      end
+
+      def values_from_must_support_elements(short_path)
+        valid_paths = [short_path, "#{short_path}.coding.code"].to_set
+
+        group_metadata[:must_supports][:elements]
+          .filter_map { |el| el[:fixed_value].presence if valid_paths.include?(el[:path]) }
+      end
+
+      def values
+        category_search = paths.any? { |path| path.split('.').first == 'category' }
+        fixed_boolean = profile_element.fixedBoolean if profile_element.respond_to?(:fixedBoolean)
+        fixed_boolean_value = [fixed_boolean.to_s] unless fixed_boolean.nil?
+
+        fixed_boolean_value.presence ||
+          (SpecialCases::PROFILE_CATEGORY_SEARCH_VALUES[group_metadata[:profile_url]] if category_search).presence ||
+          super.presence ||
+          (value_extractor.codes_from_system_code_pair(value_extractor.values_from_resource_metadata(paths)) if category_search).presence ||
+          []
+      end
+
+      def type
+        return param.type if profile_element.blank?
+
+        choice_element = token_choice_element
+        return profile_element.type.first.code if choice_element.blank?
+
+        token_data_types = %w[CodeableConcept Coding Identifier].to_set
+        id_without_choice = choice_element.id.gsub('[x]', '')
+        matched_path = full_paths.find { |path| path.start_with?(id_without_choice) }
+
+        if matched_path == id_without_choice
+          token_data_types.find { |type| choice_element.type.any? { |element_type| element_type.code == type } }
+        else
+          token_data_types.find { |type| matched_path&.end_with?(type) }
+        end
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/search_metadata_extractor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/search_metadata_extractor'
+
+require_relative 'search_definition_metadata_extractor'
+
+module USQualityCoreTestKit
+  class Generator
+    class SearchMetadataExtractor < USCoreTestKit::Generator::SearchMetadataExtractor
+      def search_definitions
+        search_param_names.each_with_object({}) do |name, definitions|
+          definitions[name.to_sym] =
+            SearchDefinitionMetadataExtractor.new(name, ig_resources, profile_elements,
+                                                  group_metadata).search_definition
+        end
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/search_test_generator.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/search_test_generator'
+
+require_relative 'naming'
+require_relative 'special_cases'
+
+module USQualityCoreTestKit
+  class Generator
+    class SearchTestGenerator < USCoreTestKit::Generator::SearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .reject { |group| SpecialCases.exclude_group? group }
+                     .select { |group| group.searches.present? }
+                     .each do |group|
+            group.searches.each { |search| new(group, search, base_output_dir).generate }
+          end
+        end
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'search.rb.erb'))
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def needs_patient_id?
+        search_metadata[:names].include?('patient') ||
+          search_metadata[:names].include?('subject') ||
+          (resource_type == 'Patient' && search_metadata[:names].include?('_id'))
+      end
+
+      def fixed_value_search?
+        first_search? && search_metadata[:names] != ['patient'] &&
+          search_metadata[:names] != ['subject'] &&
+          !group_metadata.delayed? && resource_type != 'Patient'
+      end
+
+      def test_id
+        "us_quality_core_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_search_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}SearchTest"
+      end
+
+      def module_name
+        "USQualityCore#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def test_medication_inclusion?
+        %w[MedicationRequest MedicationDispense MedicationAdministration].include?(resource_type)
+      end
+
+      def ig_link
+        Naming.ig_link(group_metadata.version)
+      end
+
+      def reference_search_description
+        return '' unless test_reference_variants?
+
+        <<~REFERENCE_SEARCH_DESCRIPTION
+          This test verifies that the server supports searching by reference using
+          the form `patient=[id]` as well as `patient=Patient/[id]`. The two
+          different forms are expected to return the same number of results.
+        REFERENCE_SEARCH_DESCRIPTION
+      end
+
+      def first_search_description
+        return '' unless first_search?
+
+        <<~FIRST_SEARCH_DESCRIPTION
+          Because this is the first search of the sequence, resources in the
+          response will be used for subsequent tests.
+        FIRST_SEARCH_DESCRIPTION
+      end
+
+      def post_search_description
+        return '' unless test_post_search?
+
+        <<~POST_SEARCH_DESCRIPTION
+          Additionally, this test will check that GET and POST search methods
+          return the same number of results. Search by POST is required by the
+          FHIR R4 specification.
+        POST_SEARCH_DESCRIPTION
+      end
+
+      def description
+        <<~DESCRIPTION.gsub(/\n{3,}/, "\n\n")
+          A server #{conformance_expectation} support searching by
+          #{search_param_name_string} on the #{resource_type} resource. This test
+          will pass if resources are returned and match the search criteria. If
+          none are returned, the test is skipped.
+
+          #{medication_inclusion_description}
+          #{reference_search_description}
+          #{first_search_description}
+          #{post_search_description}
+        DESCRIPTION
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/special_cases.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'naming'
+
+module USQualityCoreTestKit
+  class Generator
+    module SpecialCases
+      include Naming
+
+      # The generator will not create tests for resources found in this list
+      # for the specified IG versions.
+      RESOURCES_TO_EXCLUDE = {
+        'Medication' => %w[v050]
+      }.freeze
+
+      # This list is meant to capture "abstract" profiles that do not themselves
+      # need tests. Instead, tests will be generated for their descendent
+      # profiles. This list is not IG version specific.
+      PROFILES_TO_EXCLUDE = [].freeze
+
+      # The generator will create optional test groups for these resources. If a
+      # client or server supports them, the client or server must pass all of the
+      # associated tests. This list is not IG version specific.
+      OPTIONAL_RESOURCES = [
+        'PractitionerRole'
+      ].freeze
+
+      # The generator will create optional test groups for these profiles. If a
+      # client or server supports them, the client or server must pass all of the
+      # associated tests.
+      OPTIONAL_PROFILES = {}.freeze
+
+      # These resources will be gathered for testing via references from other
+      # resources.
+      DELAYED = {
+        'Encounter' => %w[v050],
+        'Location' => %w[v050]
+      }.freeze
+
+      # Category should be included in the initial search for these profiles.
+      ALL_VERSION_CATEGORY_FIRST_PROFILES = [
+        CARE_PLAN,
+        DIAGNOSTIC_REPORT_LAB,
+        DIAGNOSTIC_REPORT_NOTE,
+        CONDITION_ENCOUNTER_DIAGNOSIS,
+        CONDITION_PROBLEMS_HEALTH_CONCERNS
+      ].freeze
+
+      VERSION_SPECIFIC_CATEGORY_FIRST_PROFILES = {}.freeze
+
+      PROFILE_CATEGORY_SEARCH_VALUES = {
+        OBSERVATION_CLINICAL_RESULT => ['exam'],
+        SIMPLE_OBSERVATION => ['activity'],
+        OBSERVATION_CANCELLED => ['activity']
+      }.freeze
+
+      class << self
+        def exclude_group?(group)
+          RESOURCES_TO_EXCLUDE.key?(group.resource) &&
+            RESOURCES_TO_EXCLUDE[group.resource].include?(group.reformatted_version)
+        end
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/suite_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/suite_generator'
+
+require_relative 'naming'
+require_relative 'special_cases'
+
+module USQualityCoreTestKit
+  class Generator
+    class SuiteGenerator < USCoreTestKit::Generator::SuiteGenerator
+      def version_specific_message_filters
+        [
+          # Patient validation warnings suppressed for US Core extensions because
+          # validator tries to validate against different US Core version than we require
+          %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},
+          # This extension is correct but is not yet correctly passing in the validator
+          %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\]}
+        ]
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'suite.rb.erb'))
+      end
+
+      def base_output_file_name
+        'us_quality_core_test_suite.rb'
+      end
+
+      def class_name
+        'USQualityCoreTestSuite'
+      end
+
+      def module_name
+        "USCore#{ig_metadata.reformatted_version.upcase}"
+      end
+
+      def suite_id
+        "us_quality_core_#{ig_metadata.reformatted_version}"
+      end
+
+      def fhir_api_group_id
+        "us_quality_core_#{ig_metadata.reformatted_version}_fhir_api"
+      end
+
+      def title
+        "US Quality Core Server #{ig_metadata.ig_version}"
+      end
+
+      def ig_identifier
+        version = ig_metadata.ig_version[1..] # Remove leading 'v'
+        "fhir.onc.us-quality-core##{version}"
+      end
+
+      def ig_link
+        Naming.ig_link(ig_metadata.ig_version)
+      end
+
+      def groups
+        ig_metadata.ordered_groups.reject { |group| SpecialCases.exclude_group? group }.uniq(&:id)
+      end
+
+      def group_id_list
+        @group_id_list ||= groups.map(&:id)
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/templates/group.rb.erb

@@ -0,0 +1,29 @@
+<% test_file_list.each do |file_name| %>require_relative '<%= file_name %>'
+<% end %>
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::TestGroup
+      title '<%= title %> Tests'
+
+      short_description '<%= short_description %>'
+
+      description %(
+  <%= description %>
+      )
+
+      id :<%= group_id %>
+
+      run_as_group
+
+      <% if optional? %>optional<% end %>
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '<%= profile_identifier %>', 'metadata.yml'), aliases: true))
+      end
+
+  <% test_id_list.each do |id| %>
+      test from: :<%= id %><% end %>
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/templates/must_support.rb.erb

@@ -0,0 +1,40 @@
+require_relative '../../../must_support_test'
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USQualityCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the <%= resource_type %> resources returned'
+
+      description %(
+        This test will look through the <%= resource_type %> resources
+        found previously for the following Must Support and USCDI-flagged elements:
+
+<%= must_support_list_string %><% if uscdi_plus_quality_list_string.present? %>
+
+        For ONC USCDI+ Quality requirements, each <%= resource_type %> must support the following additional elements:
+
+<%= uscdi_plus_quality_list_string %><% end %>
+      )
+
+      id :<%= test_id %>
+
+      def resource_type
+        '<%= resource_type %>'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:<%= profile_identifier %>_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(<%= resource_collection_string %>)
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/templates/provenance_revinclude_search.rb.erb

@@ -0,0 +1,52 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USQualityCoreTestKit::SearchTest
+
+      title 'Server returns Provenance resources from <%= resource_type %> search by <%= search_param_name_string %>'
+      description %(
+        A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+        This test will perform a search by <%= search_param_name_string %> and
+        will pass if a Provenance resource is found in the response.
+      %)
+
+      id :<%= test_id %>
+  
+      <%- if needs_patient_id? -%>
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      <%- end -%>
+      def properties
+        @properties ||= SearchTestProperties.new(
+  <%= search_test_properties_string %>
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def self.provenance_metadata
+        @provenance_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', 'provenance', 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:<%= profile_identifier %>_resources] ||= {}
+      end
+
+      def scratch_provenance_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        run_provenance_revinclude_search_test
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/templates/read.rb.erb

@@ -0,0 +1,27 @@
+require_relative '../../../read_test'
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USQualityCoreTestKit::ReadTest
+
+      title 'Server returns correct <%= resource_type %> resource from <%= resource_type %> read interaction'
+
+      description 'A server <%= conformance_expectation %> support the <%= resource_type %> read interaction.'
+
+      id :<%= test_id %>
+
+      def resource_type
+        '<%= resource_type %>'
+      end
+
+      def scratch_resources
+        scratch[:<%= profile_identifier %>_resources] ||= {}
+      end
+
+      run do
+        perform_read_test(<%= resource_collection_string %>)
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/templates/reference_resolution.rb.erb

@@ -0,0 +1,41 @@
+require_relative '../../../reference_resolution_test'
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USQualityCoreTestKit::ReferenceResolutionTest
+
+      title 'MustSupport references within <%= resource_type %> resources are valid'
+
+      description %(
+        This test will attempt to read external references provided within elements
+        marked as 'MustSupport', if any are available.
+
+        It verifies that at least one external reference for each MustSupport Reference element
+        can be accessed by the test client.
+
+        Elements which may provide external references include:
+
+<%= must_support_reference_list_string %>
+      )
+
+      id :<%= test_id %>
+
+      def resource_type
+        '<%= resource_type %>'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:<%= profile_identifier %>_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(<%= resource_collection_string %>)
+      end
+    end
+  end
+end