us_core_test_kit 0.9.3 → 0.10.1

data/lib/us_core_test_kit/metadata.rb

@@ -0,0 +1,70 @@
+require_relative 'version'
+
+module USCoreTestKit
+  class Metadata < Inferno::TestKit
+    id :us_core_test_kit
+    title 'US Core Test Kit'
+    description <<~DESCRIPTION
+      The US Core Test Kit validates the conformance of a server implementation to a specific
+      version of the [US Core IG](http://hl7.org/fhir/us/core). Currently, Inferno can test
+      against implementations of following versions of the US Core IG:
+      [v3.1.1](http://hl7.org/fhir/us/core/STU3.1.1/),
+      [v4.0.0](http://hl7.org/fhir/us/core/STU4/),
+      [v5.0.1](http://hl7.org/fhir/us/core/STU5.0.1/),
+      [v6.1.0](https://hl7.org/fhir/us/core/STU6.1/),
+      and
+      [v7.0.0](https://hl7.org/fhir/us/core/STU7/).
+      <!-- break -->
+
+      This test kit is [open source](https://github.com/inferno-framework/us-core-test-kit#license)
+      and freely available for use or adoption by the health IT community including EHR vendors,
+      health app developers, and testing labs. It is built using the
+      [Inferno Framework](https://inferno-framework.github.io/inferno-core/).
+      The Inferno Framework is designed for reuse and aims to make it easier to build test kits
+      for any FHIR-based data exchange.
+
+      ## Status
+
+      The US Core Test Kit is actively developed and regularly updated. Starting with STU3,
+      each STU sequence is kept up-to-date with the latest version.
+
+      The test kit currently tests the following requirements:
+
+      - Support for Capability Statement
+      - Support for all US Core Profiles
+      - Searches required for each resource
+      - Support for Must Support Elements
+      - Profile Validation
+      - Reference Validation
+      - Clinical Notes Guidance
+      - Missing Data Guidance
+
+      See the test descriptions within the test kit for detail on the specific validations
+      performed as part of testing these requirements.
+
+      ## Repository
+
+      The US Core Test Kit GitHub repository can be [found here](https://github.com/inferno-framework/us-core-test-kit).
+
+      ## Providing Feedback and Reporting Issues
+
+      We welcome feedback on the tests, including but not limited to the following areas:
+
+       - Validation logic, such as potential bugs, lax checks, and unexpected failures.
+       - Requirements coverage, such as requirements that have been missed, tests that necessitate
+         features that the IG does not require, or other issues with the interpretation of the IG’s requirements.
+       - User experience, such as confusing or missing information in the test UI.
+
+      Please report any issues with this set of tests in the
+      [issues section](https://github.com/inferno-framework/us-core-test-kit/issues)
+      of the repository.
+    DESCRIPTION
+    suite_ids [:us_core_v311, :us_core_v400, :us_core_v501, :us_core_v610, :us_core_v700]
+    tags ['SMART App Launch', 'US Core']
+    last_updated LAST_UPDATED
+    version VERSION
+    maturity 'High'
+    authors ['Stephen MacVicar', 'Yunwei Wang']
+    repo 'https://github.com/inferno-framework/us-core-test-kit'
+  end
+end

data/lib/us_core_test_kit/reference_resolution_test.rb

@@ -167,22 +167,7 @@ module USCoreTestKit
     def resource_is_valid_with_target_profile?(resource, target_profile)
       return true if target_profile.blank?
 
-      # Only need to know if the resource is valid.
-      # Calling resource_is_valid? causes validation errors to be logged.
-      validator = find_validator(:default)
-
-      target_profile_with_version =  target_profile.include?('|') ? target_profile : "#{target_profile}|#{metadata.profile_version}"
-
-      validator_response = validator.validate(resource, target_profile_with_version)
-      outcome = validator.operation_outcome_from_hl7_wrapped_response(validator_response)
-
-      message_hashes = outcome.issue&.map { |issue| validator.message_hash_from_issue(issue, resource) } || []
-
-      message_hashes.concat(validator.additional_validation_messages(resource, target_profile_with_version))
-
-      validator.filter_messages(message_hashes)
-
-      message_hashes.none? { |message_hash| message_hash[:type] == 'error' }
+      resource_is_valid?(resource:, profile_url: target_profile, add_messages_to_runnable: false)
     end
   end
 end

data/lib/us_core_test_kit/search_test.rb

@@ -69,7 +69,7 @@ module USCoreTestKit
 
             # TODO: check that only provenance resources for resources matching
             # granular scopes returned
-            fetch_all_bundled_resources(additional_resource_types: ['Provenance'], params:)
+            fetch_and_assert_all_bundled_resources(additional_resource_types: ['Provenance'], params:)
               .select { |resource| resource.resourceType == 'Provenance' }
           end
         end
@@ -104,7 +104,7 @@ module USCoreTestKit
       check_search_response
 
       resources_returned =
-        fetch_all_bundled_resources(params:).select { |resource| resource.resourceType == resource_type }
+        fetch_and_assert_all_bundled_resources(params:).select { |resource| resource.resourceType == resource_type }
 
       return [] if resources_returned.blank?
 
@@ -139,7 +139,7 @@ module USCoreTestKit
 
       check_search_response
 
-      post_search_resources = fetch_all_bundled_resources.select { |resource| resource.resourceType == resource_type }
+      post_search_resources = fetch_and_assert_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'
@@ -247,7 +247,7 @@ module USCoreTestKit
 
           search_and_check_response(params_with_comparator)
 
-          comparator_resources = fetch_all_bundled_resources(params: params_with_comparator).each do |resource|
+          comparator_resources = fetch_and_assert_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
@@ -264,7 +264,7 @@ module USCoreTestKit
       search_and_check_response(new_search_params)
 
       reference_with_type_resources =
-        fetch_all_bundled_resources(params: new_search_params)
+        fetch_and_assert_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'
@@ -290,7 +290,7 @@ module USCoreTestKit
       search_and_check_response(search_params)
 
       resources_returned =
-        fetch_all_bundled_resources(params: search_params)
+        fetch_and_assert_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`"
@@ -361,7 +361,7 @@ module USCoreTestKit
         search_and_check_response(search_params)
 
         resources_returned =
-          fetch_all_bundled_resources(params: search_params)
+          fetch_and_assert_all_bundled_resources(params: search_params)
             .select { |resource| resource.resourceType == resource_type }
 
         multiple_or_search_params.each do |param_name|
@@ -409,7 +409,7 @@ module USCoreTestKit
       search_and_check_response(search_params)
 
       medications =
-        fetch_all_bundled_resources(params: search_params)
+        fetch_and_assert_all_bundled_resources(params: search_params)
           .select { |resource| resource.resourceType == 'Medication' }
       assert medications.present?, 'No Medications were included in the search results'
 
@@ -546,56 +546,32 @@ module USCoreTestKit
       msg + ". Please use patients with more information"
     end
 
-    def fetch_all_bundled_resources(
+    def fetch_and_assert_all_bundled_resources(
+          resource_type: self.resource_type,
           reply_handler: nil,
           max_pages: 20,
           additional_resource_types: [],
-          resource_type: self.resource_type,
           params: nil
         )
-      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', tags: tags(params)) { 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 ['MedicationRequest', 'MedicationDispense'].include?(resource_type)
-
-      invalid_resource_types =
-        resources.reject { |entry| valid_resource_types.include? entry.resourceType }
-                 .map(&:resourceType)
-                 .uniq
+        tags = tags(params)
+        bundle = resource
+        additional_resource_types << 'Medication' if ['MedicationRequest', 'MedicationDispense'].include?(resource_type)
 
-      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
+        assert_handler = Proc.new do |response|
+          assert_response_status(200, response: response)
+          assert_valid_json(response[:body], "Could not resolve bundle as JSON: #{response[:body]}")
+        end
 
-      resources
-    end
+        if reply_handler
+          reply_and_assert_handler = Proc.new do |response|
+            assert_handler.call(response)
+            reply_handler.call(response)
+          end
+        else
+          reply_and_assert_handler = assert_handler
+        end
 
-    def cant_resolve_next_bundle_message(link)
-      "Could not resolve next bundle: #{link}"
+        fetch_all_bundled_resources(resource_type:, bundle:, reply_handler: reply_and_assert_handler, max_pages:, additional_resource_types:, tags:)
     end
 
     def search_param_value(name, resource, include_system: false)

data/lib/us_core_test_kit/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module USCoreTestKit
-  VERSION = '0.9.3'
+  VERSION = '0.10.1'
+  LAST_UPDATED = '2025-02-25'
 end

data/lib/us_core_test_kit.rb

@@ -1,3 +1,4 @@
+require_relative 'us_core_test_kit/metadata'
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: us_core_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.1
 platform: ruby
 authors:
 - Stephen MacVicar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: smart_app_launch_test_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.6
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.6
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: tls_test_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner-sequel
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- config/presets/inferno_reference_server_311_preset.json
+- config/presets/inferno_reference_server_400_preset.json
+- config/presets/inferno_reference_server_501_preset.json
+- config/presets/inferno_reference_server_610_preset.json
+- config/presets/inferno_reference_server_700_preset.json
 - lib/us_core_test_kit.rb
 - lib/us_core_test_kit/custom_groups/base_smart_granular_scopes_group.rb
 - lib/us_core_test_kit/custom_groups/capability_statement/conformance_support_test.rb
@@ -2537,12 +2542,26 @@ files:
 - lib/us_core_test_kit/generator/search_test_generator.rb
 - lib/us_core_test_kit/generator/special_cases.rb
 - lib/us_core_test_kit/generator/suite_generator.rb
+- lib/us_core_test_kit/generator/templates/granular_scope_group.rb.erb
+- lib/us_core_test_kit/generator/templates/granular_scope_read_test.rb.erb
+- lib/us_core_test_kit/generator/templates/granular_scope_resource_type_group.rb.erb
+- lib/us_core_test_kit/generator/templates/granular_scope_test.rb.erb
+- lib/us_core_test_kit/generator/templates/group.rb.erb
+- lib/us_core_test_kit/generator/templates/must_support.rb.erb
+- lib/us_core_test_kit/generator/templates/practitioner_address_test.rb.erb
+- lib/us_core_test_kit/generator/templates/provenance_revinclude_search.rb.erb
+- lib/us_core_test_kit/generator/templates/read.rb.erb
+- lib/us_core_test_kit/generator/templates/reference_resolution.rb.erb
+- lib/us_core_test_kit/generator/templates/search.rb.erb
+- lib/us_core_test_kit/generator/templates/suite.rb.erb
+- lib/us_core_test_kit/generator/templates/validation.rb.erb
 - lib/us_core_test_kit/generator/terminology_binding_metadata_extractor.rb
 - lib/us_core_test_kit/generator/validation_test_generator.rb
 - lib/us_core_test_kit/generator/value_extractor.rb
 - lib/us_core_test_kit/granular_scope.rb
 - lib/us_core_test_kit/granular_scope_read_test.rb
 - lib/us_core_test_kit/granular_scope_search_test.rb
+- lib/us_core_test_kit/igs/README.md
 - lib/us_core_test_kit/igs/us_core_311.tgz
 - lib/us_core_test_kit/igs/us_core_311/StructureDefinition-bodyheight.json
 - lib/us_core_test_kit/igs/us_core_311/StructureDefinition-bodytemp.json
@@ -2564,6 +2583,7 @@ files:
 - lib/us_core_test_kit/igs/us_core_700/StructureDefinition-condition-assertedDate.json
 - lib/us_core_test_kit/igs/us_core_700/ValueSet-SmokingStatusType.json
 - lib/us_core_test_kit/igs/us_core_700/ValueSet-servicerequest-category.json
+- lib/us_core_test_kit/metadata.rb
 - lib/us_core_test_kit/must_support_test.rb
 - lib/us_core_test_kit/practitioner_address_test.rb
 - lib/us_core_test_kit/primitive_type.rb
@@ -2581,6 +2601,7 @@ homepage: https://github.com/inferno-framework/us-core-test-kit
 licenses:
 - Apache-2.0
 metadata:
+  inferno_test_kit: 'true'
   homepage_uri: https://github.com/inferno-framework/us-core-test-kit
   source_code_uri: https://github.com/inferno-framework/us-core-test-kit
 post_install_message:
@@ -2591,14 +2612,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: US Core Inferno tests