onc_certification_g31_test_kit 1.0.0

data/lib/onc_certification_g31_test_kit/g31_crd_import.rb

@@ -0,0 +1,96 @@
+require 'davinci_crd_test_kit/client/v2.2.1/client_urls'
+require_relative 'g31_options'
+
+module ONCCertificationG31TestKit
+  module G31ClientURLs
+    SUITE_ID = 'g31_certification'.freeze
+
+    def inferno_base_url
+      @inferno_base_url ||= G31CRDImport.base_url
+    end
+  end
+
+  module G31CRDImport
+    STALE_CACHE_IVARS = [:@test_count, :@available_inputs, :@children_available_inputs].freeze
+    RUNNABLE_TEXT_FIELDS = [:title, :short_title, :description, :input_instructions].freeze
+    INPUT_TEXT_FIELDS = [:title, :description].freeze
+
+    # Singular references only: statements about "CRD clients" in general are left as is.
+    # NOTE: this pattern gets replaced within static text in the suite (descriptions,
+    #       titles for runnables and inputs). It does not update the same strings within
+    #       dynamic messages associated with the runnable during testing. This is expected
+    #       and documented in docs/Technical-Overview.md.
+    CRD_CLIENT_PATTERN = /CRD client(?!s)/
+    HEALTH_IT_MODULE = 'Health IT Module'.freeze
+
+    def self.import!(runnable)
+      exclude_optional!(runnable)
+      rewrite_crd_references!(runnable)
+
+      runnable
+    end
+
+    def self.exclude_optional!(runnable)
+      runnable.all_children.reject(&:required?).each(&:remove_self_from_repository)
+      runnable.all_children.select!(&:required?)
+      STALE_CACHE_IVARS.each do |ivar|
+        runnable.remove_instance_variable(ivar) if runnable.instance_variable_defined?(ivar)
+      end
+
+      runnable.all_children.each { |child| exclude_optional!(child) }
+    end
+    private_class_method :exclude_optional!
+
+    def self.rewrite_crd_references!(runnable)
+      runnable.include(G31ClientURLs) if runnable.include?(DaVinciCRDTestKit::V221::ClientURLs)
+      rewrite_runnable_text!(runnable)
+      rewrite_input_text!(runnable)
+
+      runnable.all_children.each { |child| rewrite_crd_references!(child) }
+    end
+    private_class_method :rewrite_crd_references!
+
+    def self.rewrite_runnable_text!(runnable)
+      RUNNABLE_TEXT_FIELDS.each do |field|
+        text = runnable.send(field)
+        next if text.nil?
+
+        rewritten = rewrite_text(text)
+        runnable.send(field, rewritten) unless rewritten == text
+      end
+    end
+    private_class_method :rewrite_runnable_text!
+
+    def self.rewrite_input_text!(runnable)
+      updates = runnable.config.inputs.each_with_object({}) do |(identifier, input), acc|
+        input_updates = INPUT_TEXT_FIELDS.each_with_object({}) do |field, field_acc|
+          text = input.send(field)
+          next if text.nil?
+
+          rewritten = rewrite_text(text)
+          field_acc[field] = rewritten unless rewritten == text
+        end
+
+        acc[identifier] = input_updates if input_updates.any?
+      end
+
+      runnable.config(inputs: updates) if updates.any?
+    end
+    private_class_method :rewrite_input_text!
+
+    def self.rewrite_text(text)
+      text.to_s.gsub(crd_base_url, base_url).gsub(CRD_CLIENT_PATTERN, HEALTH_IT_MODULE)
+    end
+    private_class_method :rewrite_text
+
+    # Includes the CRD version prefix, so imported tests point at this suite's v2.2.1 endpoints
+    # rather than at the suite root.
+    def self.base_url
+      "#{Inferno::Application['base_url']}/custom/#{G31ClientURLs::SUITE_ID}#{G31Options::CRD_V221_PREFIX}"
+    end
+
+    def self.crd_base_url
+      "#{Inferno::Application['base_url']}/custom/#{DaVinciCRDTestKit::V221::ClientURLs::SUITE_ID}"
+    end
+  end
+end

data/lib/onc_certification_g31_test_kit/g31_options.rb

@@ -0,0 +1,33 @@
+module ONCCertificationG31TestKit
+  module G31Options
+    CRD_V221 = '2.2.1'.freeze
+    CRD_V221_COMPACT = "v#{CRD_V221.delete('.')}".freeze              # v221
+    CRD_V221_DOTTED = "v#{CRD_V221}".freeze                           # v2.2.1
+    CRD_V221_PREFIX = "/crd_#{CRD_V221_COMPACT}".freeze               # /crd_v221
+    CRD_V221_IG_PACKAGE = "hl7.fhir.us.davinci-crd##{CRD_V221}".freeze
+
+    US_CORE_3 = 'us_core_3'.freeze
+    US_CORE_4 = 'us_core_4'.freeze
+    US_CORE_5 = 'us_core_5'.freeze
+    US_CORE_6 = 'us_core_6'.freeze
+    US_CORE_7 = 'us_core_7'.freeze
+
+    US_CORE_VERSION_NUMBERS = {
+      US_CORE_3 => '3.1.1',
+      US_CORE_4 => '4.0.0',
+      US_CORE_5 => '5.0.1',
+      US_CORE_6 => '6.1.0',
+      US_CORE_7 => '7.0.0'
+    }.freeze
+
+    US_CORE_3_REQUIREMENT = { us_core_version: US_CORE_3 }.freeze
+    US_CORE_4_REQUIREMENT = { us_core_version: US_CORE_4 }.freeze
+    US_CORE_5_REQUIREMENT = { us_core_version: US_CORE_5 }.freeze
+    US_CORE_6_REQUIREMENT = { us_core_version: US_CORE_6 }.freeze
+    US_CORE_7_REQUIREMENT = { us_core_version: US_CORE_7 }.freeze
+
+    def us_core_version
+      suite_options[:us_core_version]
+    end
+  end
+end

data/lib/onc_certification_g31_test_kit/g31_requirements.rb

@@ -0,0 +1,96 @@
+module ONCCertificationG31TestKit
+  # Maps the § 170.315(g)(31) and § 170.315(j)(20) certification requirements onto the runnables
+  # imported from the Da Vinci CRD client suite.
+  #
+  # The imported runnables already declare the IG-level requirements that they verify, so these
+  # regulatory requirements are added to what each one declares rather than replacing it.
+  #
+  # Regulatory requirements are written at the level of a whole capability, so they are attached to
+  # the group that exercises that capability when no single test demonstrates it, and to individual
+  # tests when one does.
+  module G31Requirements
+    G31_SET = '170.315(g)(31)_HTI-4'.freeze
+    J20_SET = '170.315(j)(20)_HTI-4'.freeze
+
+    # Requirement id => the runnables that verify it, identified by the trailing portion of their id
+    # within this suite. Keys are the shortest suffix that identifies a single runnable; ids that
+    # are reused across groups (e.g., the response attestation) are qualified by their parent.
+    REQUIREMENT_MAP = {
+      "#{G31_SET}@3" => [
+        'crd_v221_client_registration'
+      ],
+      "#{G31_SET}@4" => [
+        'g31_hook_invocation'
+      ],
+      "#{G31_SET}@5" => [
+        'crd_v221_client_order_sign'
+      ],
+      "#{J20_SET}@1" => [
+        'g31_hook_invocation'
+      ],
+      "#{J20_SET}@2" => [
+        'crd_v221_client_registration'
+      ],
+      "#{J20_SET}@3" => [
+        'crd_v221_order_sign_auth',
+        'crd_v221_cross_hook_auth'
+      ],
+      "#{J20_SET}@4" => [
+        'crd_v221_order_sign_auth',
+        'crd_v221_cross_hook_auth'
+      ],
+      "#{J20_SET}@5" => [
+        'crd_v221_order_sign_requests-crd_v221_hook_data_fetch_verification',
+        'crd_v221_cross_hook_requests-crd_v221_hook_data_fetch_verification'
+      ],
+      "#{J20_SET}@6" => [
+        'crd_v221_client_order_sign',
+        'crd_v221_client_cross_hook_interaction'
+      ],
+      "#{J20_SET}@7" => [
+        'crd_v221_client_order_sign',
+        'crd_v221_client_cross_hook_interaction'
+      ],
+      "#{J20_SET}@8" => [
+        'crd_v221_order_sign_requests-crd_v221_hook_data_fetch_verification',
+        'crd_v221_cross_hook_requests-crd_v221_hook_data_fetch_verification'
+      ],
+      "#{J20_SET}@9" => [
+        'crd_v221_order_sign_responses-crd_v221_card_display_attest_test',
+        'crd_v221_cross_hook_responses-crd_v221_card_display_attest_test'
+      ]
+    }.freeze
+
+    # Adds the requirements above to the runnables that verify them. Raises if a key no longer
+    # identifies exactly one runnable, so that a change to the imported suite is caught here rather
+    # than silently dropping coverage.
+    def self.apply!(suite)
+      runnables = [suite, *suite.all_descendants]
+
+      REQUIREMENT_MAP.each do |requirement_id, runnable_keys|
+        runnable_keys.each do |runnable_key|
+          add_requirement!(find_runnable!(runnables, runnable_key), requirement_id)
+        end
+      end
+    end
+
+    def self.find_runnable!(runnables, runnable_key)
+      matches = runnables.select { |runnable| runnable.id.to_s.end_with?("-#{runnable_key}") }
+
+      raise "No runnable found for requirement mapping key '#{runnable_key}'" if matches.empty?
+
+      if matches.length > 1
+        raise "Requirement mapping key '#{runnable_key}' matches multiple runnables: " \
+              "#{matches.map(&:id).join(', ')}"
+      end
+
+      matches.first
+    end
+    private_class_method :find_runnable!
+
+    def self.add_requirement!(runnable, requirement_id)
+      runnable.verifies_requirements(*(runnable.verifies_requirements + [requirement_id]).uniq)
+    end
+    private_class_method :add_requirement!
+  end
+end

data/lib/onc_certification_g31_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. 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/onc_certification_g31_test_kit/metadata.rb

@@ -0,0 +1,71 @@
+require_relative 'version'
+
+module ONCCertificationG31TestKit
+  class Metadata < Inferno::TestKit
+    id :onc_certification_g31_test_kit
+    title 'ONC Certification (g)(31) Coverage Requirements Discovery API Test Kit'
+    description <<~DESCRIPTION
+      The ONC Certification (g)(31) Coverage Requirements Discovery API Test Kit is a
+      testing tool for Health IT Modules seeking to meet the requirements of the
+      Coverage Requirements Discovery criterion § 170.315(g)(31) in the ONC Health
+      IT Certification Program.
+      <!-- break -->
+
+      The CRD standard allows clients to support one of several US Core versions. To begin testing,
+      select a US Core version for Inferno to verify against, and click 'Create Test Session'.
+
+      ## Status
+
+      The ONC Certification (g)(31) Coverage Requirements Discovery API Test Kit is actively
+      developed and updates are released monthly.
+
+      The test kit currently tests requirements for the [Coverage Requirements
+      Discovery criterion §
+      170.315(g)(31)](https://healthit.gov/test-method/provider-prior-authorization-api-coverage-requirements-discovery).
+      This includes:
+      - Registration
+      - CDS Hooks support for the order-sign hook
+      - CRD Client capabilities, including support for specific scenarios and must support elements
+      - FHIR API
+      - Documentation
+
+      See the test descriptions within the test kit for detail on the specific
+      validations performed as part of testing these requirements. These descriptions
+      also contain a "View Specification Requirements" link that can be used to see
+      the specific requirements verified. Testers seeking help in using these tests
+      can find additional details within the [Walkthrough](https://github.com/onc-healthit/onc-certification-g31-test-kit/wiki/Walkthrough)
+      on the (g)(31) Test Kit wiki.
+
+      ## Repository and Resources
+
+      The ONC Certification (g)(31) Coverage Requirements Discovery API Test Kit can be
+      [downloaded from its GitHub repository](https://github.com/onc-healthit/onc-certification-g31-test-kit),
+      where additional resources and documentation are also available to help users
+      get started with the testing process. The
+      [Releases](https://github.com/onc-healthit/onc-certification-g31-test-kit/releases)
+      page provides information about each new release.
+
+      ## 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/onc-healthit/onc-certification-g31-test-kit/issues)
+      of the repository.
+    DESCRIPTION
+
+    suite_ids [:g31_certification]
+    tags ['Da Vinci', 'CRD', 'US Core']
+    last_updated LAST_UPDATED
+    version VERSION
+    maturity 'Certification'
+    authors ['Inferno Team']
+    repo 'https://github.com/onc-healthit/onc-certification-g31-test-kit'
+  end
+end