us_core_test_kit 1.0.0 → 1.1.0

data/lib/us_core_test_kit/generated/v7.0.0/granular_scope_tests/observation/observation_patient_code_date_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + code + date and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v7.0.0/granular_scope_tests/observation/observation_patient_code_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + code and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_abatement_date_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + abatement-date and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_asserted_date_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + asserted-date and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_category_clinical_status_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + category + clinical-status and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_category_encounter_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + category + encounter and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_category_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + category and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_clinical_status_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + clinical-status and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_code_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + code and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_lastupdated_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + _lastUpdated and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_onset_date_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + onset-date and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/condition/condition_patient_recorded_date_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Condition searches by
 patient + recorded-date and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/observation/observation_patient_category_date_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + category + date and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/observation/observation_patient_category_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + category and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/observation/observation_patient_category_lastupdated_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + category + _lastUpdated and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/observation/observation_patient_category_status_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + category + status and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/observation/observation_patient_code_date_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + code + date and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generated/v8.0.0/granular_scope_tests/observation/observation_patient_code_granular_scope_search_test.rb

@@ -12,7 +12,20 @@ module USCoreTestKit
       description %(
 This test repeats all Observation searches by
 patient + code and verifies that the results have been
-filtered based on the granted granular scopes.
+filtered based on the granted granular scopes. The response to each
+repeated request will be compared to the corresponding original response
+independently using the following logic:
+- If the repeated search filters on a category value that
+  is explicitly included within the granted scopes, e.g., a search for
+  `Observation?category=survey` when the granted scopes includes
+  `patient/Observation.rs?category=survey`, then the server is required to
+  return the original response filtered to include only entries that match
+  one of the granted scopes.
+- Otherwise, e.g., a search for `Observation?category=cognitive-status`
+  when the granted scopes include only `patient/Observation.rs?category=survey`,
+  servers may indicate that the request is unauthorized either through an empty
+  Bundle or an explicit HTTP error, or they may return the original response
+  filtered to include only entries that match one of the granted scopes.
 
       )
 

data/lib/us_core_test_kit/generator/granular_scope_test_generator.rb

@@ -155,7 +155,20 @@ module USCoreTestKit
         <<~DESCRIPTION.gsub(/\n{3,}/, "\n\n")
           This test repeats all #{resource_type} searches by
           #{search_param_name_string} and verifies that the results have been
-          filtered based on the granted granular scopes.
+          filtered based on the granted granular scopes. The response to each
+          repeated request will be compared to the corresponding original response
+          independently using the following logic:
+          - If the repeated search filters on a category value that
+            is explicitly included within the granted scopes, e.g., a search for
+            `Observation?category=survey` when the granted scopes includes
+            `patient/Observation.rs?category=survey`, then the server is required to
+            return the original response filtered to include only entries that match
+            one of the granted scopes.
+          - Otherwise, e.g., a search for `Observation?category=cognitive-status`
+            when the granted scopes include only `patient/Observation.rs?category=survey`,
+            servers may indicate that the request is unauthorized either through an empty
+            Bundle or an explicit HTTP error, or they may return the original response
+            filtered to include only entries that match one of the granted scopes.
         DESCRIPTION
       end
     end

data/lib/us_core_test_kit/granular_scope_search_test.rb

@@ -33,24 +33,26 @@ module USCoreTestKit
           end
 
         mismatched_ids = mismatched_resource_ids(found_resources)
-
         assert mismatched_ids.empty?,
                'Resources with the following ids were received even though they do not match the ' \
                "granted granular scopes: #{mismatched_ids.join(', ')}"
 
-        found_ids = found_resources.map(&:id)
-        previous_ids = expected_resource_ids(all_previous_resources)
-        missing_ids = previous_ids - found_ids
+        # if the query is in scope or resource were returned, we must check missing and unexpected
+        if query_in_scope?(resource_type, params) || found_resources.present?
 
-        assert missing_ids.empty?,
-               'Resources with the following ids were received when using resource-level scopes, ' \
-               "but not when using granular scopes: #{missing_ids.join(', ')}"
+          found_ids = found_resources.map(&:id)
+          previous_ids = expected_resource_ids(all_previous_resources)
 
-        unexpected_ids = found_ids - previous_ids
+          missing_ids = previous_ids - found_ids
+          assert missing_ids.empty?,
+                 'Resources with the following ids were received when using resource-level scopes, ' \
+                 "but not when using granular scopes: #{missing_ids.join(', ')}"
 
-        assert unexpected_ids.empty?,
-               'Resources with the following ids were received when using granular scopes, ' \
-               "but not when using resource-level scopes: #{unexpected_ids.join(', ')}"
+          unexpected_ids = found_ids - previous_ids
+          assert unexpected_ids.empty?,
+                 'Resources with the following ids were received when using granular scopes, ' \
+                 "but not when using resource-level scopes: #{unexpected_ids.join(', ')}"
+        end
       end
     end
 
@@ -63,6 +65,29 @@ module USCoreTestKit
           .sort_by { |request| request.index }
     end
 
+    def query_in_scope?(resource_type, params)
+      received_scopes.split(' ').each do |scope|
+        parsed_scope = URI.parse(scope)
+        
+        # check for resource type, search scope, and matched params
+        next unless parsed_scope.path =~ /\/#{resource_type}\./ &&
+                    parsed_scope.path.split('.')[1].include?('s') &&
+                    granular_params_present?(parsed_scope.query, params)
+      
+        return true
+      end
+
+      false
+    end
+
+    def granular_params_present?(granular_params, search_params)
+      CGI.parse(granular_params).each do |param_name, value|
+        return false unless search_params.key?(param_name) && value.include?(search_params[param_name])
+      end
+
+      true
+    end
+
     def previous_resources(params)
       previous_requests(params)
         .flat_map do |request|

data/lib/us_core_test_kit/metadata.rb

@@ -70,7 +70,7 @@ module USCoreTestKit
       of the repository.
     DESCRIPTION
     suite_ids [:us_core_v311, :us_core_v400, :us_core_v501, :us_core_v610, :us_core_v700, :us_core_v800, :us_core_client_v311,
-               :us_core_client_v400, :us_core_client_v501, :us_core_client_v610, :us_core_client_v700]
+               :us_core_client_v400, :us_core_client_v501, :us_core_client_v610, :us_core_client_v700, :us_core_client_v800]
     tags ['SMART App Launch', 'US Core']
     last_updated LAST_UPDATED
     version VERSION