au_core_test_kit 0.0.16

data/lib/au_core_test_kit/search_test.rb

@@ -0,0 +1,1032 @@
+# frozen_string_literal: true
+
+require_relative 'date_search_validation'
+require_relative 'fhir_resource_navigation'
+require_relative 'search_test_properties'
+require_relative 'read_test'
+require_relative 'assert_helpers'
+require_relative 'search_test_helpers'
+require_relative 'generator/special_cases'
+
+module AUCoreTestKit
+  module SearchTest
+    extend Forwardable
+    include DateSearchValidation
+    include FHIRResourceNavigation
+    include ReadTest
+    include AssertHelpers
+
+    def_delegators 'self.class', :metadata, :provenance_metadata, :properties
+    def_delegators 'properties',
+                   :resource_type,
+                   :search_param_names,
+                   :saves_delayed_references?,
+                   :first_search?,
+                   :fixed_value_search?,
+                   :possible_status_search?,
+                   :test_medication_inclusion?,
+                   :test_post_search?,
+                   :token_search_params,
+                   :test_reference_variants?,
+                   :params_with_comparators,
+                   :multiple_or_search_params,
+                   :optional_multiple_or_search_params,
+                   :multiple_and_search_params,
+                   :optional_multiple_and_search_params,
+                   :first_search_for_patient_by_patient_id,
+                   :includes,
+                   :use_any_data_for_search,
+                   :search_by_target_resource_data
+
+    def all_search_params
+      @all_search_params ||=
+        patient_id_list.each_with_object({}) do |patient_id, params|
+          params[patient_id] ||= []
+          new_params =
+            if fixed_value_search?
+              fixed_value_search_param_values.map { |value| fixed_value_search_params(value, patient_id) }
+            else
+              [search_params_with_values(search_param_names, patient_id)]
+            end
+          new_params.reject! do |params|
+            params.any? { |_key, value| value.blank? }
+          end
+
+          params[patient_id].concat(new_params)
+        end
+    end
+
+    def all_provenance_revinclude_search_params
+      @all_provenance_revinclude_search_params ||=
+        all_search_params.transform_values! do |params_list|
+          params_list.map { |params| params.merge(_revinclude: 'Provenance:target') }
+        end
+    end
+
+    def any_valid_search_params?(search_params)
+      search_params.any? { |_patient_id, params| params.present? }
+    end
+
+    def run_provenance_revinclude_search_test
+      # TODO: skip if not supported?
+      conditional_skip_with_msg !any_valid_search_params?(all_provenance_revinclude_search_params), unable_to_resolve_params_message
+
+      provenance_resources =
+        all_provenance_revinclude_search_params.flat_map do |_patient_id, params_list|
+          params_list.flat_map do |params|
+            fhir_search(resource_type, params:)
+
+            perform_search_with_status(params, patient_id) if response[:status] == 400 && possible_status_search?
+
+            check_search_response
+
+            fetch_all_bundled_resources(additional_resource_types: ['Provenance'])
+              .select { |resource| resource.resourceType == 'Provenance' }
+          end
+        end
+
+      scratch_provenance_resources[:all] ||= []
+      scratch_provenance_resources[:all].concat(provenance_resources)
+
+      save_delayed_references(provenance_resources, 'Provenance')
+
+      # NOTE: https://github.com/hl7au/au-fhir-core-inferno/issues/8
+      # skip_if provenance_resources.empty?, no_resources_skip_message('Provenance')
+    end
+
+    def search_by_patient_id_is_available(patient_id)
+      fhir_search('Patient', params: { _id: patient_id })
+      response[:status] == 200
+    end
+
+    def run_search_test
+      run_search_test_common(method(:perform_search))
+    end
+
+    def run_search_test_with_system
+      run_search_test_common(method(:perform_search_with_system))
+    end
+
+    def run_include_test
+      resources = []
+      all_search_params.each do |patient_id, params_list|
+        params_list.each do |params|
+          includes.each do |include_param|
+            patient_resources = find_include_resources(
+              params,
+              patient_id,
+              include_param,
+              false
+            )
+            if patient_resources.length.positive?
+              resources.concat(patient_resources)
+              break
+            end
+          end
+        end
+        break if resources.length.positive?
+      end
+      pass if resources.length.positive?
+
+      skip_with_msg 'No resources were included in the search results'
+    end
+
+    def run_read_test_and_skip_first_search(patient_id)
+      resource = create_reference('Patient', patient_id)
+      read_and_validate_as_first(resource, patient_id)
+    end
+
+    def check_availability_of_count_search_parameter(resource_type, params)
+      search_params = params.merge({ _count: 1 })
+
+      fhir_search(resource_type, params: search_params)
+
+      response[:status] == 200
+    end
+
+    def is_count_available_for_resource_type?(resource_type, params)
+      resource_sym = resource_type.to_sym
+      count = scratch&.dig(:info, resource_sym, :count)
+
+      return count unless count.nil?
+
+      result = check_availability_of_count_search_parameter(resource_type, params)
+
+      scratch[:info] ||= {}
+      scratch[:info][resource_sym] ||= {}
+      scratch[:info][resource_sym][:count] ||= result
+
+      result
+    end
+
+    def perform_search(params, patient_id)
+      search_params = is_count_available_for_resource_type?(resource_type, params) == false ? params : params.merge({ _count: 10 })
+      fhir_search(resource_type, params: search_params)
+
+      if SearchTestHelpers.search_by_reference?(search_params)
+        search_params = SearchTestHelpers.replace_full_reference_search_param_to_id(search_params)
+        fhir_search(resource_type, params: search_params)
+      end
+
+      perform_search_with_status(params, patient_id) if response[:status] == 400 && possible_status_search?
+
+      check_search_response
+      fetch_all_bundled_resources = is_count_available_for_resource_type?(resource_type, params) == false ? fetch_all_bundled_resources() : fetch_all_bundled_resources(max_pages: 2)
+      resources_returned =
+        fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
+
+      return [] if resources_returned.blank?
+
+      perform_comparator_searches(params, patient_id) if params_with_comparators.present?
+
+      filter_conditions(resources_returned) if resource_type == 'Condition' && metadata.version == 'v5.0.1'
+      filter_devices(resources_returned) if resource_type == 'Device'
+
+      if first_search?
+        all_scratch_resources.concat(resources_returned).uniq!
+        scratch_resources_for_patient(patient_id).concat(resources_returned).uniq!
+      end
+
+      resources_returned.each do |resource|
+        check_resource_against_params(resource, params)
+      end
+
+      save_delayed_references(resources_returned) if saves_delayed_references?
+
+      return resources_returned if all_search_variants_tested?
+
+      perform_post_search(resources_returned, params) if test_post_search?
+      if includes.present?
+        includes.each do |include_param|
+          test_include_param(resources_returned, params, patient_id, include_param)
+        end
+      end
+
+      perform_reference_with_type_search(params, resources_returned.count) if test_reference_variants?
+      perform_search_with_system(params, patient_id) if token_search_params.present?
+
+      resources_returned
+    end
+
+    def perform_post_search(get_search_resources, params)
+      fhir_search resource_type, params:, search_method: :post
+
+      check_search_response
+
+      post_search_resources = fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
+
+      filter_conditions(post_search_resources) if resource_type == 'Condition' && metadata.version == 'v5.0.1'
+      filter_devices(post_search_resources) if resource_type == 'Device'
+
+      get_resource_count = get_search_resources.length
+      post_resource_count = post_search_resources.length
+
+      search_variant_test_records[:post_variant] = true
+
+      assert get_resource_count == post_resource_count,
+             'Expected search by POST to return the same results as search by GET, ' \
+             "but GET search returned #{get_resource_count} resources, and POST search " \
+             "returned #{post_resource_count} resources."
+    end
+
+    def filter_devices(resources)
+      codes_to_include = implantable_device_codes&.split(',')&.map(&:strip)
+      return resources if codes_to_include.blank?
+
+      resources.select! do |resource|
+        resource&.type&.coding&.any? { |coding| codes_to_include.include?(coding.code) }
+      end
+    end
+
+    def filter_conditions(resources)
+      # HL7 JIRA FHIR-37917. AU Core v5.0.1 does not required patient+category.
+      # In order to distinguish which resources matches the current profile, Inferno has to manually filter
+      # the result of first search, which is searching by patient.
+      resources.select! do |resource|
+        resource.category.any? do |category|
+          category.coding.any? do |coding|
+            metadata.search_definitions[:category][:values].include? coding.code
+          end
+        end
+      end
+    end
+
+    def search_and_check_response(params, resource_type = self.resource_type)
+      fhir_search(resource_type, params:)
+      check_search_response
+    end
+
+    def optional_search_and_check_response(params, resource_type = self.resource_type)
+      fhir_search(resource_type, params:)
+    end
+
+    def check_search_response
+      assert_response_status(200)
+      assert_resource_type(:bundle)
+      # NOTE: how do we want to handle validating Bundles?
+    end
+
+    def search_variant_test_records
+      @search_variant_test_records ||= initial_search_variant_test_records
+    end
+
+    def initial_search_variant_test_records
+      {}.tap do |records|
+        records[:post_variant] = false if test_post_search?
+        records[:inclusion] = false if includes&.length&.positive?
+        records[:reference_variants] = false if test_reference_variants?
+        records[:token_variants] = false if token_search_params.present?
+        records[:comparator_searches] = Set.new if params_with_comparators.present?
+      end
+    end
+
+    def all_search_variants_tested?
+      search_variant_test_records.all? { |_variant, tested| tested.present? } &&
+        all_comparator_searches_tested?
+    end
+
+    def all_comparator_searches_tested?
+      return true if params_with_comparators.blank?
+
+      Set.new(params_with_comparators) == search_variant_test_records[:comparator_searches]
+    end
+
+    def date_comparator_value(comparator, date)
+      date = date.start || date.end if date.is_a? FHIR::Period
+      case comparator
+      when 'lt', 'le'
+        comparator + (DateTime.xmlschema(date) + 1).xmlschema
+      when 'gt', 'ge'
+        comparator + (DateTime.xmlschema(date) - 1).xmlschema
+      else
+        # ''
+        raise "Unsupported comparator '#{comparator}'"
+      end
+    end
+
+    def required_comparators(name)
+      metadata
+        .search_definitions
+        .dig(name.to_sym, :comparators)
+        .select { |_comparator, expectation| expectation == 'SHALL' }
+        .keys
+        .map(&:to_s)
+    end
+
+    def birthdate_comparator_value(comparator, date)
+      case comparator
+      when 'lt', 'le'
+        comparator + (DateTime.xmlschema(date) + 1).strftime('%F')
+      when 'gt', 'ge'
+        comparator + (DateTime.xmlschema(date) - 1).strftime('%F')
+      else
+        raise "Unsupported comparator '#{comparator}'"
+      end
+    end
+
+    def perform_comparator_searches(params, patient_id)
+      params_with_comparators.each do |name|
+        next if search_variant_test_records[:comparator_searches].include? name
+
+        required_comparators(name).each do |comparator|
+          paths = search_param_paths(name).first
+          date_element = find_a_value_at(scratch_resources_for_patient(patient_id), paths)
+          params_with_comparator = params.merge(name => name != 'birthdate' ? date_comparator_value(comparator, date_element) : birthdate_comparator_value(comparator, date_element))
+
+          search_and_check_response(params_with_comparator)
+
+          fetch_all_bundled_resources.each do |resource|
+            check_resource_against_params(resource, params_with_comparator) if resource.resourceType == resource_type
+          end
+        end
+
+        search_variant_test_records[:comparator_searches] << name
+      end
+    end
+
+    def perform_reference_with_type_search(params, resource_count)
+      return if resource_count.zero?
+      return if search_variant_test_records[:reference_variants]
+
+      if params.keys.include?('patient')
+        new_search_params = params.merge('patient' => "Patient/#{params['patient']}")
+      else
+        param_key = params.keys.first
+        new_search_params = params.merge(param_key => params[param_key].split('/').last)
+      end
+      search_and_check_response(new_search_params)
+
+      reference_with_type_resources = fetch_all_bundled_resources.select do |resource|
+        resource.resourceType == resource_type
+      end
+
+      filter_conditions(reference_with_type_resources) if resource_type == 'Condition' && metadata.version == 'v5.0.1'
+      filter_devices(reference_with_type_resources) if resource_type == 'Device'
+
+      new_resource_count = reference_with_type_resources.count
+
+      assert new_resource_count == resource_count,
+             "Expected search by `#{params['patient']}` to to return the same results as searching " \
+             "by `#{new_search_params['patient']}`, but found #{resource_count} resources with " \
+             "`#{params['patient']}` and #{new_resource_count} with `#{new_search_params['patient']}`"
+
+      search_variant_test_records[:reference_variants] = true
+    end
+
+    def perform_search_with_system(params, patient_id)
+      return if search_variant_test_records[:token_variants]
+
+      new_search_params = search_params_with_values(token_search_params, patient_id, include_system: true)
+      return if new_search_params.any? { |_name, value| value.blank? }
+
+      search_params = params.merge(new_search_params)
+      search_and_check_response(search_params)
+
+      resources_returned =
+        fetch_all_bundled_resources
+        .select { |resource| resource.resourceType == resource_type }
+
+      assert resources_returned.present?, 'No resources were returned when searching by `system|code`'
+
+      search_variant_test_records[:token_variants] = true
+    end
+
+    def perform_search_with_status(
+      original_params,
+      _patient_id,
+      status_search_values: self.status_search_values,
+      resource_type: self.resource_type
+    )
+      assert resource.is_a?(FHIR::OperationOutcome), 'Server returned a status of 400 without an OperationOutcome'
+      # TODO: warn about documenting status requirements
+      status_search_values.flat_map do |status_value|
+        search_params = original_params.merge("#{status_search_param_name}": status_value)
+
+        search_and_check_response(search_params)
+
+        entries = resource.entry.select { |entry| entry.resource.resourceType == resource_type }
+
+        if entries.present?
+          original_params.merge!("#{status_search_param_name}": status_value)
+          break
+        end
+      end
+    end
+
+    def status_search_param_name
+      @status_search_param_name ||=
+        metadata.search_definitions.keys.find { |key| key.to_s.include? 'status' }
+    end
+
+    def status_search_values
+      default_search_values(status_search_param_name)
+    end
+
+    def default_values_for_param(param_name)
+      definition = metadata.search_definitions[param_name]
+      return [] if definition.blank?
+
+      definition[:values]
+    end
+
+    def default_search_values(param_name)
+      definition = metadata.search_definitions[param_name]
+      return [] if definition.blank?
+
+      definition[:multiple_or] == 'SHALL' || definition[:multiple_or] == 'SHOULD' ? [definition[:values].join(',')] : Array.wrap(definition[:values])
+    end
+
+    def default_search_values_clean(param_name)
+      definition = metadata.search_definitions[param_name]
+      return [] if definition.blank?
+
+      definition[:values]
+    end
+
+    def extract_existing_values_safety(resources_arr, param_name)
+      results = []
+
+      resources_arr.each do |resource|
+        temp = search_param_value(param_name, resource)
+        results << temp
+      end
+
+      results.compact.uniq
+    end
+
+    def perform_multiple_or_search_test
+      perform_multiple_search_test('or')
+    end
+
+    def perform_multiple_and_search_test
+      perform_multiple_search_test('and')
+    end
+
+    def modify_value_by_multiple_type(values, multiple_type)
+      return [values.join(',')] if multiple_type == 'or'
+
+      Array.wrap(values)
+    end
+
+    def perform_multiple_search_test(multiple_type)
+      if search_param_names.length > 2
+        skip 'Inconsistent state of the test (params to search more than 2)'
+      elsif search_param_names.empty?
+        skip 'Inconsistent state of the test (number of params to search is 0)'
+      else
+        param_name = search_param_names[0]
+        default_search_values = default_search_values_clean(param_name.to_sym)
+
+        if default_search_values.length > 1
+          if default_search_values.length == 2
+            search_params = { param_name => modify_value_by_multiple_type(default_search_values, multiple_type) }
+            search_and_check_response(search_params)
+          else
+            chunk_size = 2
+            search_params_slices = default_search_values.each_slice(chunk_size).to_a
+            search_params_slices.pop if search_params_slices.last.length < chunk_size
+            search_params_slices.each do |values_slice|
+              search_params = { param_name => modify_value_by_multiple_type(values_slice, multiple_type) }
+              search_and_check_response(search_params)
+            end
+          end
+        else
+          resources_arr = all_search_params.map { |patient_id, _params_list| scratch_resources_for_patient(patient_id) }.flatten
+          resources_arr = scratch_resources[:all].filter { |r| r.resourceType == resource_type } if resources_arr.empty? && search_by_target_resource_data
+          existing_values = extract_existing_values_safety(resources_arr, param_name)
+
+          if existing_values.length > 1
+            search_params = { param_name => modify_value_by_multiple_type(existing_values, multiple_type) }
+            search_and_check_response(search_params)
+          else
+            skip insufficient_number_of_values(existing_values)
+          end
+        end
+      end
+    end
+
+    def find_include_resources(params, patient_id, include_param, _keep_search_variant = true)
+      resources_to_check = "#{include_param['target_resource'].downcase}_resources".to_sym
+      target_resource_type = include_param['target_resource']
+      scratch[resources_to_check] ||= {}
+      scratch[resources_to_check][:all] ||= []
+      scratch[resources_to_check][patient_id] ||= []
+      scratch[resources_to_check][:contained] ||= []
+
+      search_params = params.merge(_include: include_param['parameter'])
+      search_and_check_response(search_params)
+
+      resources = fetch_all_bundled_resources.select { |resource| resource.resourceType == target_resource_type }
+
+      resources.uniq!(&:id)
+      scratch[resources_to_check][:all] += resources
+      scratch[resources_to_check][patient_id] += resources
+      scratch[resources_to_check][:contained] += resources
+
+      resources
+    end
+
+    def test_include_param(base_resources, params, patient_id, include_param, keep_search_variant = true)
+      return if keep_search_variant && search_variant_test_records[:inclusion]
+
+      resources_to_check = "#{include_param['target_resource'].downcase}_resources".to_sym
+      target_resource_type = include_param['target_resource']
+
+      scratch[resources_to_check] ||= {}
+      scratch[resources_to_check][:all] ||= []
+      scratch[resources_to_check][patient_id] ||= []
+      scratch[resources_to_check][:contained] ||= []
+
+      base_resources_with_external_reference =
+        base_resources
+        .select { |resource| resource&.to_hash&.[](include_param['paths'].first)&.present? }
+        .reject { |resource| resource&.to_hash&.[](include_param['paths'].first)&.fetch('reference', '')&.start_with?('#') }
+
+      contained_resources =
+        base_resources
+        .select { |resource| resource&.to_hash&.[](include_param['paths'].first)&.fetch('reference', '')&.start_with?('#') }
+        .flat_map(&:contained)
+        .select { |resource| resource.resourceType == target_resource_type }
+
+      scratch[resources_to_check][:all] += contained_resources
+      scratch[resources_to_check][patient_id] += contained_resources
+      scratch[resources_to_check][:contained] += contained_resources
+
+      return if base_resources_with_external_reference.blank?
+
+      search_params = params.merge(_include: include_param['parameter'])
+
+      search_and_check_response(search_params)
+
+      resources = fetch_all_bundled_resources.select { |resource| resource.resourceType == target_resource_type }
+      assert resources.present?, "No #{resource_type} were included in the search results"
+
+      included_resources = resources.map { |resource| "#{resource.resourceType}/#{resource.id}" }
+
+      matched_base_resources = base_resources_with_external_reference.select do |base_resource|
+        included_resources.any? do |resource_reference|
+          is_reference_match?(base_resource&.to_hash&.[](include_param['paths'].first)&.fetch('reference', ''), resource_reference)
+        end
+      end
+
+      not_matched_included_resources = included_resources.select do |resource_reference|
+        matched_base_resources.none? do |base_resource|
+          is_reference_match?(base_resource&.to_hash&.[](include_param['paths'].first)&.fetch('reference', ''), resource_reference)
+        end
+      end
+
+      not_matched_included_medications_string = not_matched_included_resources.join(',')
+      assert not_matched_included_resources.empty?,
+             "No #{resource_type} references #{not_matched_included_medications_string} in the search result."
+
+      resources.uniq!(&:id)
+
+      scratch[resources_to_check][:all] += resources
+      scratch[resources_to_check][patient_id] += resources
+
+      return unless keep_search_variant
+
+      search_variant_test_records[:inclusion] = true
+    end
+
+    def is_reference_match?(reference, local_reference)
+      regex_pattern = %r{^(#{Regexp.escape(local_reference)}|\S+/#{Regexp.escape(local_reference)}(?:[/|]\S+)*)$}
+      reference.match?(regex_pattern)
+    end
+
+    def all_scratch_resources
+      scratch_resources[:all] ||= []
+    end
+
+    def scratch_resources_for_patient(patient_id)
+      return all_scratch_resources if patient_id.nil?
+
+      scratch_resources[patient_id] ||= []
+    end
+
+    def references_to_save(resource_type = nil)
+      reference_metadata = resource_type == 'Provenance' ? provenance_metadata : metadata
+      reference_metadata.delayed_references
+    end
+
+    def fixed_value_search_param_name
+      (search_param_names - ['patient']).first
+    end
+
+    def fixed_value_search_param_values
+      metadata.search_definitions[fixed_value_search_param_name.to_sym][:values]
+    end
+
+    def fixed_value_search_params(value, patient_id)
+      search_param_names.each_with_object({}) do |name, params|
+        params[name] = patient_id_param?(name) ? patient_id : value
+      end
+    end
+
+    def search_params_with_values(search_param_names, patient_id, include_system: false)
+      resources = scratch_resources_for_patient(patient_id)
+
+      if resources.empty?
+        return search_param_names.each_with_object({}) do |name, params|
+          value = patient_id_param?(name) ? patient_id : nil
+          if value.nil? && use_any_data_for_search
+            scratch_resources[:all].each do |resource|
+              value = search_param_value(name, resource, include_system:)
+              break if value.present?
+            end
+          end
+          params[name] = value
+        end
+      end
+
+      resources.each_with_object({}) do |resource, outer_params|
+        results_from_one_resource = search_param_names.each_with_object({}) do |name, params|
+          value = if patient_id_param?(name)
+                    patient_id
+                  else
+                    search_param_value(name, resource,
+                                       include_system:)
+                  end
+          params[name] = value
+        end
+
+        outer_params.merge!(results_from_one_resource)
+
+        # stop if all parameter values are found
+        return outer_params if outer_params.all? { |_key, value| value.present? }
+      end
+    end
+
+    def patient_id_list
+      return [nil] unless respond_to? :patient_ids
+
+      patient_ids.split(',').map(&:strip)
+    end
+
+    def patient_search?
+      search_param_names.any? { |name| patient_id_param? name }
+    end
+
+    def patient_id_param?(name)
+      name == 'patient' || (name == '_id' && resource_type == 'Patient')
+    end
+
+    def search_param_paths(name)
+      paths = metadata.search_definitions[name.to_sym][:paths]
+      paths[0] = 'local_class' if paths.first == 'class'
+
+      paths
+    end
+
+    def all_search_params_present?(params)
+      params.all? { |_name, value| value.present? }
+    end
+
+    def array_of_codes(array)
+      array.map { |name| "`#{name}`" }.join(', ')
+    end
+
+    def insufficient_number_of_values(values_to_search)
+      "Insufficient number of values for the search. The number of values should be more than 1. The current number of values is #{values_to_search.length}."
+      # extra_message = "Current values: #{values_to_search.join(', ')}." if values_to_search.length.positive?
+
+      # "#{main_message} #{extra_message}"
+    end
+
+    def unable_to_resolve_params_message
+      "Could not find values for all search params #{array_of_codes(search_param_names)}"
+    end
+
+    def empty_search_params_message(empty_search_params)
+      "Could not find values for the search parameters #{array_of_codes(empty_search_params.keys)}"
+    end
+
+    def no_resources_skip_message(resource_type = self.resource_type)
+      msg = "No #{resource_type} resources appear to be available"
+
+      msg.concat(" with the following Device Type Code filter: #{implantable_device_codes}") if resource_type == 'Device' && implantable_device_codes.present?
+
+      "#{msg}. Please use patients with more information"
+    end
+
+    def chain_search_restriction(search_parameter)
+      "I don't know how to run a chain search with this search parameter: #{search_parameter} (generator restrictions)."
+    end
+
+    def fetch_all_bundled_resources(
+      reply_handler: nil,
+      max_pages: 20,
+      additional_resource_types: [],
+      resource_type: self.resource_type
+    )
+      page_count = 1
+      resources = []
+      bundle = resource
+
+      until bundle.nil? || page_count == max_pages
+        resources += bundle&.entry&.map { |entry| entry&.resource }
+        next_bundle_link = bundle&.link&.find { |link| link.relation == 'next' }&.url
+        reply_handler&.call(response)
+
+        break if next_bundle_link.blank?
+
+        reply = fhir_client.raw_read_url(next_bundle_link)
+
+        store_request('outgoing') { reply }
+        error_message = cant_resolve_next_bundle_message(next_bundle_link)
+
+        assert_response_status(200)
+        assert_valid_json(reply.body, error_message)
+
+        bundle = fhir_client.parse_reply(FHIR::Bundle, fhir_client.default_format, reply)
+
+        page_count += 1
+      end
+
+      valid_resource_types = [resource_type, 'OperationOutcome'].concat(additional_resource_types)
+      valid_resource_types << 'Medication' if %w[MedicationRequest MedicationDispense].include?(resource_type)
+
+      invalid_resource_types =
+        resources.reject { |entry| valid_resource_types.include? entry.resourceType }
+                 .map(&:resourceType)
+                 .uniq
+
+      if invalid_resource_types.any?
+        info "Received resource type(s) #{invalid_resource_types.join(', ')} in search bundle, " \
+             "but only expected resource types #{valid_resource_types.join(', ')}. " \
+             'This is unusual but allowed if the server believes additional resource types are relevant.'
+      end
+
+      resources
+    end
+
+    def cant_resolve_next_bundle_message(link)
+      "Could not resolve next bundle: #{link}"
+    end
+
+    def search_param_value(name, resource, include_system: false)
+      paths = search_param_paths(name)
+      search_value = nil
+      paths.each do |path|
+        element = find_a_value_at(resource, path) { |element| element_has_valid_value?(element, include_system) }
+
+        search_value =
+          case element
+          when FHIR::Period
+            if element.start.present?
+              "gt#{(DateTime.xmlschema(element.start) - 1).xmlschema}"
+            else
+              end_datetime = get_fhir_datetime_range(element.end)[:end]
+              "lt#{(end_datetime + 1).xmlschema}"
+            end
+          when FHIR::Reference
+            element.reference
+          when FHIR::CodeableConcept
+            if include_system
+              coding =
+                find_a_value_at(element, 'coding') { |coding| coding.code.present? && coding.system.present? }
+              "#{coding.system}|#{coding.code}"
+            else
+              find_a_value_at(element, 'coding.code')
+            end
+          when FHIR::Identifier
+            include_system ? "#{element.system}|#{element.value}" : element.value
+          when FHIR::Coding
+            include_system ? "#{element.system}|#{element.code}" : element.code
+          when FHIR::HumanName
+            element.family || element.given&.first || element.text
+          when FHIR::Address
+            element.text || element.city || element.state || element.postalCode || element.country
+          else
+            if metadata.version != 'v3.1.1' &&
+               metadata.search_definitions[name.to_sym][:type] == 'date' &&
+               params_with_comparators&.include?(name)
+              # convert date search to greath-than comparator search with correct precision
+              # For all date search parameters:
+              #   Patient.birthDate does not mandate comparators so cannot be converted
+              #   Goal.target-date has day precision
+              #   All others have second + time offset precision
+              if /^\d{4}(-\d{2})?$/.match?(element) || # YYYY or YYYY-MM
+                 (/^\d{4}-\d{2}-\d{2}$/.match?(element) && resource_type != 'Goal') # YYY-MM-DD AND Resource is NOT Goal
+                if !(path == 'birthDate' && resource_type == 'Patient')
+                  "gt#{(DateTime.xmlschema(element) - 1).xmlschema}"
+                else
+                  "gt#{(DateTime.xmlschema(element) - 1).strftime('%F')}"
+                end
+              else
+                element
+              end
+            else
+              element
+            end
+          end
+
+        break if search_value.present?
+      end
+      search_value&.gsub(',', '\\,')
+    end
+
+    def element_has_valid_value?(element, include_system)
+      case element
+      when FHIR::Reference
+        element.reference.present?
+      when FHIR::CodeableConcept
+        if include_system
+          coding =
+            find_a_value_at(element, 'coding') { |coding| coding.code.present? && coding.system.present? }
+          coding.present?
+        else
+          find_a_value_at(element, 'coding.code').present?
+        end
+      when FHIR::Identifier
+        include_system ? element.value.present? && element.system.present? : element.value.present?
+      when FHIR::Coding
+        include_system ? element.code.present? && element.system.present? : element.code.present?
+      when FHIR::HumanName
+        (element.family || element.given&.first || element.text).present?
+      when FHIR::Address
+        (element.text || element.city || element.state || element.postalCode || element.country).present?
+      else
+        true
+      end
+    end
+
+    def save_resource_reference(resource_type, reference)
+      scratch[:references] ||= {}
+      scratch[:references][resource_type] ||= Set.new
+      scratch[:references][resource_type] << reference
+    end
+
+    def save_delayed_references(resources, containing_resource_type = resource_type)
+      resources.each do |resource|
+        references_to_save(containing_resource_type).each do |reference_to_save|
+          resolve_path(resource, reference_to_save[:path])
+            .select { |reference| reference.is_a?(FHIR::Reference) && !reference.contained? }
+            .each do |reference|
+              resource_type = reference.resource_class.name.demodulize
+              need_to_save = reference_to_save[:resources].include?(resource_type)
+              next unless need_to_save
+
+              save_resource_reference(resource_type, reference)
+            end
+        end
+      end
+    end
+
+    #### RESULT CHECKING ####
+
+    def extension_check(resource, extension_url)
+      extension_elements = resource.extension.filter { |ext| ext.url == extension_url }
+      extension_element = extension_elements.first
+
+      return extension_element.extension.first.valueCodeableConcept.coding.first.code if extension_url == 'http://hl7.org/fhir/StructureDefinition/individual-genderIdentity'
+
+      extension_element.valueCoding.code
+    end
+
+    def check_resource_against_params(resource, params)
+      params.each do |name, escaped_search_value|
+        # unescape search value
+        search_value = escaped_search_value&.gsub('\\,', ',')
+        paths = search_param_paths(name)
+
+        match_found = false
+        values_found = []
+        if %w[indigenous-status gender-identity].include?(name)
+          search_param_extension_map = {
+            'indigenous-status' => 'http://hl7.org.au/fhir/StructureDefinition/indigenous-status',
+            'gender-identity' => 'http://hl7.org/fhir/StructureDefinition/individual-genderIdentity'
+          }
+          values_found = [extension_check(resource, search_param_extension_map[name])]
+          match_found = search_value.to_s == values_found.first if values_found.length.positive?
+        else
+          paths.each do |path|
+            type = metadata.search_definitions[name.to_sym][:type]
+            values_found =
+              resolve_path(resource, path)
+              .map do |value|
+                if value.is_a? FHIR::Reference
+                  value.reference
+                else
+                  value
+                end
+              end
+
+            match_found =
+              case type
+              when 'Period', 'date', 'instant', 'dateTime'
+                values_found.any? { |date| validate_date_search(search_value, date) }
+              when 'HumanName'
+                # When a string search parameter refers to the types HumanName and Address,
+                # the search covers the elements of type string, and does not cover elements such as use and period
+                # https://www.hl7.org/fhir/search.html#string
+                search_value_downcase = search_value.downcase
+                values_found.any? do |name|
+                  name&.text&.downcase&.start_with?(search_value_downcase) ||
+                    name&.family&.downcase&.start_with?(search_value_downcase) ||
+                    name&.given&.any? { |given| given.downcase.start_with?(search_value_downcase) } ||
+                    name&.prefix&.any? { |prefix| prefix.downcase.start_with?(search_value_downcase) } ||
+                    name&.suffix&.any? { |suffix| suffix.downcase.start_with?(search_value_downcase) }
+                end
+              when 'Address'
+                search_value_downcase = search_value.downcase
+                values_found.any? do |address|
+                  address&.text&.downcase&.start_with?(search_value_downcase) ||
+                    address&.city&.downcase&.start_with?(search_value_downcase) ||
+                    address&.state&.downcase&.start_with?(search_value_downcase) ||
+                    address&.postalCode&.downcase&.start_with?(search_value_downcase) ||
+                    address&.country&.downcase&.start_with?(search_value_downcase)
+                end
+              when 'CodeableConcept'
+                # FHIR token search (https://www.hl7.org/fhir/search.html#token): "When in doubt, servers SHOULD
+                # treat tokens in a case-insensitive manner, on the grounds that including undesired data has
+                # less safety implications than excluding desired behavior".
+                codings = values_found.flat_map(&:coding)
+                if search_value.include? '|'
+                  system = search_value.split('|').first
+                  code = search_value.split('|').last
+                  codings&.any? { |coding| coding.system == system && coding.code&.casecmp?(code) }
+                else
+                  codings&.any? { |coding| coding.code&.casecmp?(search_value) }
+                end
+              when 'Coding'
+                if search_value.include? '|'
+                  system = search_value.split('|').first
+                  code = search_value.split('|').last
+                  values_found.any? { |coding| coding.system == system && coding.code&.casecmp?(code) }
+                else
+                  values_found.any? { |coding| coding.code&.casecmp?(search_value) }
+                end
+              when 'Identifier'
+                if search_value.include? '|'
+                  values_found.any? { |identifier| "#{identifier.system}|#{identifier.value}" == search_value }
+                else
+                  values_found.any? { |identifier| identifier.value == search_value }
+                end
+              when 'string'
+                searched_values = search_value.downcase.split(/(?<!\\\\),/).map { |string| string.gsub('\\,', ',') }
+                values_found.any? do |value_found|
+                  searched_values.any? { |searched_value| value_found.downcase.starts_with? searched_value }
+                end
+              else
+                # searching by patient requires special case because we are searching by a resource identifier
+                # references can also be URLs, so we may need to resolve those URLs
+                if %w[subject patient].include? name.to_s
+                  id = search_value.split('Patient/').last
+                  possible_values = [id, "Patient/#{id}", "#{url}/Patient/#{id}"]
+                  values_found.any? do |reference|
+                    possible_values.include? reference
+                  end
+                else
+                  search_values = search_value.split(/(?<!\\\\),/).map { |string| string.gsub('\\,', ',') }
+                  values_found.any? { |value_found| search_values.include? value_found }
+                end
+              end
+
+            break if match_found
+          end
+        end
+
+        assert match_found,
+               "#{resource_type}/#{resource.id} did not match the search parameters:\n" \
+               "* Expected: #{search_value}\n" \
+               "* Found: #{values_found.map(&:inspect).join(', ')}"
+      end
+    end
+
+    private
+
+    def run_search_test_common(search_method)
+      conditional_skip_with_msg !any_valid_search_params?(all_search_params), unable_to_resolve_params_message
+
+      ability_to_search_is_checked = false
+      search_is_available = true
+
+      resources_returned = all_search_params.flat_map do |patient_id, params_list|
+        params_list.flat_map do |params|
+          if first_search_for_patient_by_patient_id
+            unless ability_to_search_is_checked
+              search_is_available = search_by_patient_id_is_available(patient_id)
+              ability_to_search_is_checked = true
+            end
+
+            if search_is_available
+              search_method.call(params, patient_id)
+            else
+              run_read_test_and_skip_first_search(patient_id)
+            end
+          else
+            search_method.call(params, patient_id)
+          end
+        end
+      end
+
+      conditional_skip_with_msg resources_returned.empty?, no_resources_skip_message
+
+      return unless search_is_available == false
+
+      info 'This test was run as a read test. The search functionality is missing in this test, so the test will fail. However, the obtained data will be available.'
+      assert false
+    end
+  end
+end