us_core_test_kit 0.6.1 → 0.6.3

data/lib/us_core_test_kit/search_test.rb

@@ -59,13 +59,15 @@ module USCoreTestKit
       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: params
+            fhir_search resource_type, params:, tags: tags(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'])
+            # TODO: check that only provenance resources for resources matching
+            # granular scopes returned
+            fetch_all_bundled_resources(additional_resource_types: ['Provenance'], params:)
               .select { |resource| resource.resourceType == 'Provenance' }
           end
         end
@@ -93,14 +95,14 @@ module USCoreTestKit
     end
 
     def perform_search(params, patient_id)
-      fhir_search resource_type, params: params
+      fhir_search resource_type, params:, tags: tags(params)
 
       perform_search_with_status(params, patient_id) if response[:status] == 400 && possible_status_search?
 
       check_search_response
 
       resources_returned =
-        fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
+        fetch_all_bundled_resources(params:).select { |resource| resource.resourceType == resource_type }
 
       return [] if resources_returned.blank?
 
@@ -131,7 +133,7 @@ module USCoreTestKit
     end
 
     def perform_post_search(get_search_resources, params)
-      fhir_search resource_type, params: params, search_method: :post
+      fhir_search resource_type, params:, search_method: :post
 
       check_search_response
 
@@ -174,7 +176,7 @@ module USCoreTestKit
     end
 
     def search_and_check_response(params, resource_type = self.resource_type)
-      fhir_search resource_type, params: params
+      fhir_search resource_type, params:, tags: tags(params)
 
       check_search_response
     end
@@ -243,7 +245,7 @@ module USCoreTestKit
 
           search_and_check_response(params_with_comparator)
 
-          fetch_all_bundled_resources.each do |resource|
+          comparator_resources = fetch_all_bundled_resources(params: params_with_comparator).each do |resource|
             check_resource_against_params(resource, params_with_comparator) if resource.resourceType == resource_type
           end
         end
@@ -259,7 +261,9 @@ module USCoreTestKit
       new_search_params = params.merge('patient' => "Patient/#{params['patient']}")
       search_and_check_response(new_search_params)
 
-      reference_with_type_resources = fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
+      reference_with_type_resources =
+        fetch_all_bundled_resources(params: new_search_params)
+          .select { |resource| resource.resourceType == resource_type }
 
       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'
@@ -284,7 +288,7 @@ module USCoreTestKit
       search_and_check_response(search_params)
 
       resources_returned =
-        fetch_all_bundled_resources
+        fetch_all_bundled_resources(params: search_params)
           .select { |resource| resource.resourceType == resource_type }
 
       assert resources_returned.present?, "No resources were returned when searching by `system|code`"
@@ -355,7 +359,7 @@ module USCoreTestKit
         search_and_check_response(search_params)
 
         resources_returned =
-          fetch_all_bundled_resources
+          fetch_all_bundled_resources(params: search_params)
             .select { |resource| resource.resourceType == resource_type }
 
         multiple_or_search_params.each do |param_name|
@@ -402,7 +406,9 @@ module USCoreTestKit
 
       search_and_check_response(search_params)
 
-      medications = fetch_all_bundled_resources.select { |resource| resource.resourceType == 'Medication' }
+      medications =
+        fetch_all_bundled_resources(params: search_params)
+          .select { |resource| resource.resourceType == 'Medication' }
       assert medications.present?, 'No Medications were included in the search results'
 
       included_medications = medications.map { |medication| "#{medication.resourceType}/#{medication.id}" }
@@ -542,7 +548,8 @@ module USCoreTestKit
           reply_handler: nil,
           max_pages: 20,
           additional_resource_types: [],
-          resource_type: self.resource_type
+          resource_type: self.resource_type,
+          params: nil
         )
       page_count = 1
       resources = []
@@ -557,7 +564,7 @@ module USCoreTestKit
 
         reply = fhir_client.raw_read_url(next_bundle_link)
 
-        store_request('outgoing') { reply }
+        store_request('outgoing', tags: tags(params)) { reply }
         error_message = cant_resolve_next_bundle_message(next_bundle_link)
 
         assert_response_status(200)
@@ -700,104 +707,131 @@ module USCoreTestKit
 
     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 = []
+        search_value = unescape_search_value(escaped_search_value)
 
-        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 = resource_matches_param?(resource, name, escaped_search_value, values_found)
 
-          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) ||
+        assert match_found,
+               "#{resource_type}/#{resource.id} did not match the search parameters:\n" \
+               "* Expected: #{unescape_search_value(search_value)}\n" \
+               "* Found: #{values_found.map(&:inspect).join(', ')}"
+      end
+    end
+
+    def unescape_search_value(value)
+      value&.gsub('\\,', ',')
+    end
+
+    def resource_matches_param?(resource, search_param_name, escaped_search_value, values_found = [])
+      search_value = unescape_search_value(escaped_search_value)
+      paths = search_param_paths(search_param_name)
+
+      match_found = false
+
+      paths.each do |path|
+        type = metadata.search_definitions[search_param_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
+            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
-              # 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 ['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 }
+              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 ['subject', 'patient'].include? search_param_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
+        break if match_found
+      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(', ')}"
+      match_found
+    end
+
+    def tags(params)
+      return nil unless config.options[:tag_requests]
+
+      return nil if params.blank?
+
+      if ['Condition', 'DiagnosticReport', 'DocumentReference', 'Observation', 'ServiceRequest'].include? resource_type
+        return [search_params_tag(params)]
       end
+
+      nil
+    end
+
+    def search_params_tag(params)
+      "#{resource_type}?#{params.keys.join('&')}"
     end
   end
 end

data/lib/us_core_test_kit/us_core_options.rb

@@ -0,0 +1,10 @@
+module USCoreTestKit
+    module USCoreOptions
+      SMART_1 = 'smart_app_launch_1'.freeze
+      SMART_2 = 'smart_app_launch_2'.freeze
+  
+      SMART_1_REQUIREMENT = { smart_app_launch_version: SMART_1 }.freeze
+      SMART_2_REQUIREMENT = { smart_app_launch_version: SMART_2 }.freeze
+    end
+  end
+  

data/lib/us_core_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module USCoreTestKit
-  VERSION = '0.6.1'
+  VERSION = '0.6.3'
 end

data/lib/us_core_test_kit.rb

@@ -2,3 +2,5 @@ require_relative 'us_core_test_kit/generated/v3.1.1/us_core_test_suite'
 require_relative 'us_core_test_kit/generated/v4.0.0/us_core_test_suite'
 require_relative 'us_core_test_kit/generated/v5.0.1/us_core_test_suite'
 require_relative 'us_core_test_kit/generated/v6.1.0/us_core_test_suite'
+require_relative 'us_core_test_kit/generated/v7.0.0-ballot/us_core_test_suite'
+