us_core_test_kit 0.9.3 → 0.10.0

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

@@ -0,0 +1,41 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the <%= resource_type %> resources returned'
+      description %(
+        US Core Responders SHALL be capable of populating all data elements as
+        part of the query results as specified by the US Core Server Capability
+        Statement. This test will look through the <%= resource_type %> resources
+        found previously for the following must support elements:
+
+<%= must_support_list_string %><% if uscdi_list_string.present? %>
+
+        For ONC USCDI requirements, each <%= resource_type %> must support the following additional elements:
+
+<%= uscdi_list_string %><% end %>
+      )
+
+      id :<%= test_id %>
+
+      def resource_type
+        '<%= resource_type %>'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:<%= profile_identifier %>_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(<%= resource_collection_string %>)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generator/templates/practitioner_address_test.rb.erb

@@ -0,0 +1,32 @@
+require_relative '../../../practitioner_address_test'
+
+module USCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USCoreTestKit::PractitionerAddressTest
+
+      title 'Server support either Practitioner.address or PractitionerRole'
+      description %(
+        US Core Responders SHALL support either US Core PractitionerRole Profile or
+        these data elements in US Core Practitioner Profile
+
+        * Practitioner.address
+        * Practitioner.address.city
+        * Practitioner.address.country
+        * Practitioner.address.line
+        * Practitioner.address.postalCode
+        * Practitioner.address.state
+      )
+
+      id :<%= test_id %>
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      run do
+        verify_practitioner_address
+      end
+    end
+  end
+end

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

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

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

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

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

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

data/lib/us_core_test_kit/generator/templates/search.rb.erb

@@ -0,0 +1,46 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for <%= resource_type %> search by <%= search_param_name_string %>'
+      description %(
+<%= description %>
+      )
+
+      id :<%= test_id %><% if optional? %>
+      optional
+  <% end %><% if needs_patient_id? %>
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  <% end %><% if resource_type == 'Device' %>
+      input :implantable_device_codes,
+        title: 'Implantable Device Type Code',
+        description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. '\
+                    'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+        optional: true
+  <% end %>
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+  <%= search_test_properties_string %>
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:<%= profile_identifier %>_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generator/templates/suite.rb.erb

@@ -0,0 +1,160 @@
+require 'inferno/dsl/oauth_credentials'
+require_relative '../../version'
+require_relative '<%= capability_statement_file_name %>'
+require_relative '<%= clinical_notes_guidance_file_name %>'
+require_relative '../../custom_groups/data_absent_reason_group'
+require_relative '../../custom_groups/smart_app_launch_group'<% if us_core_6_and_above? %>
+require_relative '<%= granular_scopes_file_name %>'
+require_relative '<%= screening_assessment_file_name %>'<% end %>
+require_relative '../../provenance_validator'
+require_relative '../../us_core_options'<% if us_core_7_and_above? %>
+require_relative '<%= smart_app_launch_file_name %>'
+require_relative '<%= stu2_2_smart_app_launch_file_name %>'<% end %>
+
+<% group_file_list.each do |file_name| %>require_relative '<%= file_name %>'
+<% end %>
+module USCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::TestSuite
+      title '<%= title %>'
+      description %(
+        The US Core Test Kit tests systems for their conformance to the [US Core
+        Implementation Guide](<%=ig_link %>).
+
+        HL7® FHIR® resources are validated with the Java validator using
+        `tx.fhir.org` as the terminology server. Users should note that the
+        although the ONC Certification (g)(10) Standardized API Test Suite
+        includes tests from this suite, [it uses a different method to perform
+        terminology
+        validation](https://github.com/onc-healthit/onc-certification-g10-test-kit/wiki/FAQ#q-why-do-some-resources-fail-in-us-core-test-kit-with-terminology-validation-errors).
+        As a result, resource validation results may not be consistent between
+        the US Core Test Suite and the ONC Certification (g)(10) Standardized
+        API Test Suite.
+      )
+
+      GENERAL_MESSAGE_FILTERS = [
+        %r{Sub-extension url 'introspect' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
+        %r{Sub-extension url 'revoke' is not defined by the Extension http://fhir-registry\.smarthealthit\.org/StructureDefinition/oauth-uris},
+        /Observation\.effective\.ofType\(Period\): .*vs-1:/, # Invalid invariant in FHIR v4.0.1
+        /Observation\.effective\.ofType\(Period\): .*us-core-1:/, # Invalid invariant in US Core v3.1.1
+        /Provenance.agent\[\d*\]: Constraint failed: provenance-1/, #Invalid invariant in US Core v5.0.1
+        %r{Unknown Code System 'http://hl7.org/fhir/us/core/CodeSystem/us-core-tags'}, # Validator has an issue with this US Core 5 code system in US Core 6 resource
+        %r{URL value 'http://hl7.org/fhir/us/core/CodeSystem/us-core-tags' does not resolve}, # Validator has an issue with this US Core 5 code system in US Core 6 resource
+        /\A\S+: \S+: URL value '.*' does not resolve/,
+        %r{Observation.component\[\d+\].value.ofType\(Quantity\): The code provided \(http://unitsofmeasure.org#L/min\) was not found in the value set 'Vital Signs Units'} # Known issue with the Pulse Oximetry Profile
+      ].freeze
+<% if version_specific_message_filters.empty? %>
+      VERSION_SPECIFIC_MESSAGE_FILTERS = [].freeze
+<% else %>
+      VERSION_SPECIFIC_MESSAGE_FILTERS = [
+        <%= version_specific_message_filters.map { |filter| "%r{#{filter.source}}" }.join(",\n        ") %>
+      ].freeze
+<% end %>
+      VALIDATION_MESSAGE_FILTERS = GENERAL_MESSAGE_FILTERS + VERSION_SPECIFIC_MESSAGE_FILTERS
+
+      def self.metadata
+        @metadata ||= YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true)[:groups].map do |raw_metadata|
+            Generator::GroupMetadata.new(raw_metadata)
+          end
+      end
+
+      id :<%= suite_id %>
+
+      fhir_resource_validator do
+        igs '<%= ig_identifier %>'
+        message_filters = VALIDATION_MESSAGE_FILTERS
+
+        exclude_message do |message|
+
+          message_filters.any? { |filter| filter.match? message.message }
+        end
+
+        perform_additional_validation do |resource, profile_url|
+          ProvenanceValidator.validate(resource) if resource.instance_of?(FHIR::Provenance)
+        end
+      end
+
+      input :url,
+        title: 'FHIR Endpoint',
+        description: 'URL of the FHIR endpoint'
+
+      suite_option :smart_app_launch_version,
+        title: 'SMART App Launch Version',
+        list_options: [
+          {
+            label: 'SMART App Launch 1.0.0',
+            value: USCoreOptions::SMART_1
+          },
+          {
+            label: 'SMART App Launch 2.0.0',
+            value: USCoreOptions::SMART_2
+          },
+          {
+            label: 'SMART App Launch 2.2.0',
+            value: USCoreOptions::SMART_2_2
+          }
+        ]
+
+      group from: :<%= smart_app_launch_id %><% if us_core_7_and_above? %>,
+            required_suite_options: USCoreOptions::SMART_1_REQUIREMENT
+      group from: :<%= smart_app_launch_id %>,
+            required_suite_options: USCoreOptions::SMART_2_REQUIREMENT,
+            id: :<%= smart_app_launch_id %>_stu2
+      group from: :<%= smart_app_launch_id %>_stu2_2,
+            required_suite_options: USCoreOptions::SMART_2_2_REQUIREMENT<% end %>
+
+      group do
+        input :smart_credentials,
+          title: 'OAuth Credentials',
+          type: :oauth_credentials,
+          optional: true
+
+        fhir_client do
+          url :url
+          oauth_credentials :smart_credentials
+        end
+
+        title 'US Core FHIR API'
+        id :<%= fhir_api_group_id %><% if us_core_6_and_above? %>
+
+        config(
+          options: {
+            tag_requests: true
+          }
+        )<% end %>
+
+        group from: :<%= capability_statement_group_id %>
+      <% group_id_list.each do |id| %>
+        group from: :<%= id %><% end %>
+        group from: :<%= clinical_notes_guidance_group_id %><%if us_core_6_and_above? %>
+        group from: :<%= screening_assessment_id %><% end %>
+        group from: :us_core_311_data_absent_reason
+      end<% if us_core_6_and_above? %>
+
+      group from: :<%= granular_scopes_id %>,
+            required_suite_options: USCoreOptions::SMART_2_REQUIREMENT
+      group from: :<%= granular_scopes_id %>,
+            id: :<%= granular_scopes_id %>_stu2_2,
+            required_suite_options: USCoreOptions::SMART_2_2_REQUIREMENT
+      <% end %>
+
+      links [
+        {
+          type: 'report_issue',
+          label: 'Report Issue',
+          url: 'https://github.com/inferno-framework/us-core-test-kit/issues/'
+        },
+        {
+          type: 'source_code',
+          label: 'Open Source',
+          url: 'https://github.com/inferno-framework/us-core-test-kit/'
+        },
+        {
+          type: 'download',
+          label: 'Download', 
+          url: 'https://github.com/inferno-framework/us-core-test-kit/releases/'
+        }
+      ]
+    end
+  end
+end

data/lib/us_core_test_kit/generator/templates/validation.rb.erb

@@ -0,0 +1,31 @@
+require_relative '../../../validation_test'
+
+module USCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USCoreTestKit::ValidationTest
+
+      id :<%= test_id %>
+      title '<%= resource_type %> resources returned during previous tests conform to the <%= profile_name %>'
+      description %(
+<%= description %>
+      )
+      output :dar_code_found, :dar_extension_found
+
+      def resource_type
+        '<%= resource_type %>'
+      end
+
+      def scratch_resources
+        scratch[:<%= profile_identifier %>_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                '<%= profile_url %>',
+                                '<%= profile_version %>',
+                                skip_if_empty: <%= skip_if_empty %>)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/igs/README.md

@@ -0,0 +1,21 @@
+# Note on this IGs folder
+
+There are three reasons why it would be necessary to put an IG package.tgz in this folder. If none of these apply, you do not need to put any files here, or can consider removing any existing files to make it clear they are unused.
+
+## 1. Generated Test Suites
+Some test kits use a "generator" to automatically generate the contents of a test suite for an IG. The IG files are required every time the test suites need to be regenerated. Examples of test kits that use this approach are the US Core Test Kit and CARIN IG for Blue Button® Test Kit.
+
+
+## 2. Non-published IG
+If your IG, or the specific version of the IG you want to test against, is not published, then the validator service needs to load the IG from file in order to be able to validate resources with it. The IG must be referenced in the `fhir_resource_validator` block in the test suite definition by filename, ie:
+
+```ruby
+      fhir_resource_validator do
+        igs 'igs/filename.tgz'
+
+        ...
+      end
+```
+
+## 3. Inferno Validator UI
+The Inferno Validator UI is configured to auto-load any IGs present in the igs folder and include them in all validations. The Inferno Validator UI is currently disabled by default, so this is only relevant if you choose to re-enable it. In general, the Inferno team is currently leaving IGs in this folder even if not otherwise necessary to make it easy to re-enable the validator UI.

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/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module USCoreTestKit
-  VERSION = '0.9.3'
+  VERSION = '0.10.0'
+  LAST_UPDATED = '2024-02-10'
 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'