us_quality_core_test_kit 0.1.0

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

@@ -0,0 +1,45 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+require_relative '../../../search_test_properties'
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USQualityCoreTestKit::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 %>
+
+      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_quality_core_test_kit/generator/templates/suite.rb.erb

@@ -0,0 +1,119 @@
+require_relative '../../version'
+
+<% group_file_list.each do |file_name| %>require_relative '<%= file_name %>'
+<% end %>
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::TestSuite
+      title '<%= title %>'
+
+      description %(
+        The US Quality Core Server Test Kit tests server systems for their conformance to the [US Quality Core
+        Implementation Guide](<%=ig_link %>).
+
+        # Scope
+
+        These tests are a DRAFT intended to allow implementers to perform
+        preliminary checks of server systems against the requirements stated
+        in the US Quality Core Implementation Guide and provide feedback on the tests.
+        Future versions of these tests may verify other requirements and may
+        change the test verification logic.
+
+
+        # Test Methodology
+
+        These test simulate a realistic client that is capable of retrieving
+        all necessary information necessary to perform calculation measurement
+        against a single patient from a US Quality Core conformant server.  HL7® FHIR®
+        resources are validated with the Java validator using `tx.fhir.org` as
+        the terminology server.
+      )
+
+      GENERAL_MESSAGE_FILTERS = [
+        /Observation\.effective\.ofType\(Period\): .*vs-1:/, # Invalid invariant in FHIR v4.0.1
+        %r{No definition could be found for URL value '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
+        # temporary disable these two errors. 
+        # us-core-medication-adherence and http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed are defined in us-core-7 
+        # but us-quality-core is based on us-core-6
+        %r{No definition could be found for URL value 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication-adherence'}, 
+        %r{No definition could be found for URL value 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed'}
+      ].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
+      end
+
+      input :url,
+        title: 'FHIR Endpoint',
+        description: 'URL of the FHIR endpoint'
+
+      group do
+        input :smart_auth_info,
+          title: 'OAuth Credentials',
+          type: :auth_info,
+          optional: true
+
+        fhir_client do
+          url :url
+          auth_info :smart_auth_info
+        end
+
+        title 'US Quality Core FHIR API'
+
+        id :<%= fhir_api_group_id %>
+
+        config(
+          options: {
+            tag_requests: true
+          }
+        )
+
+        <% group_id_list.each do |id| %>
+        group from: :<%= id %><% end %>
+      end
+
+      links [
+        {
+          type: 'report_issue',
+          label: 'Report Issue',
+          url: 'https://github.com/inferno-framework/us-quality-core-test-kit/issues'
+        },
+        {
+          type: 'source_code',
+          label: 'Open Source',
+          url: 'https://github.com/inferno-framework/us-quality-core-test-kit'
+        },
+        {
+          type: 'download',
+          label: 'Download',
+          url: 'https://github.com/inferno-framework/us-quality-core-test-kit/releases'
+        }
+      ]
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require_relative '../../../validation_test'
+
+module USQualityCoreTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include USQualityCoreTestKit::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_quality_core_test_kit/generator/terminology_binding_metadata_extractor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/terminology_binding_metadata_extractor'
+
+module USQualityCoreTestKit
+  class Generator
+    class TerminologyBindingMetadataExtractor < USCoreTestKit::Generator::TerminologyBindingMetadataExtractor
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/validation_test_generator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/validation_test_generator'
+
+require_relative 'naming'
+require_relative 'special_cases'
+
+module USQualityCoreTestKit
+  class Generator
+    class ValidationTestGenerator < USCoreTestKit::Generator::ValidationTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .reject { |group| SpecialCases.exclude_group? group }
+                     .each do |group|
+            new(group, base_output_dir: base_output_dir).generate
+          end
+        end
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'validation.rb.erb'))
+      end
+
+      def directory_name
+        Naming.snake_case_for_profile(medication_request_metadata || group_metadata)
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "us_quality_core_#{group_metadata.reformatted_version}_#{profile_identifier}_validation_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ValidationTest"
+      end
+
+      def module_name
+        "USQualityCore#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def skip_if_empty
+        # Return true if a system must demonstrate at least one example of the resource type.
+        # This drives omit vs. skip result statuses in this test.
+        resource_type != 'Medication'
+      end
+
+      def description
+        <<~DESCRIPTION
+          #{description_intro}
+          It verifies the presence of mandatory elements and that elements with
+          required bindings contain appropriate values. CodeableConcept element
+          bindings will fail if none of their codings have a code/system belonging
+          to the bound ValueSet. Quantity, Coding, and code element bindings will
+          fail if their code/system are not found in the valueset.
+        DESCRIPTION
+      end
+
+      def description_intro
+        if resource_type == 'Medication'
+          <<~MEDICATION_INTRO
+            This test verifies resources returned from previous tests conform to
+            the [#{profile_name}](#{profile_url}).
+          MEDICATION_INTRO
+        else
+          <<~GENERIC_INTRO
+            This test verifies resources returned from the first search conform to
+            the [#{profile_name}](#{profile_url}).
+            Systems must demonstrate at least one valid example in order to pass this test.
+          GENERIC_INTRO
+        end
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/value_extractor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/generator/value_extractor'
+
+module USQualityCoreTestKit
+  class Generator
+    class ValueExactor < USCoreTestKit::Generator::ValueExactor
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative 'generator/ig_loader'
+require_relative 'generator/ig_metadata_extractor'
+require_relative 'generator/search_test_generator'
+require_relative 'generator/read_test_generator'
+require_relative 'generator/validation_test_generator'
+require_relative 'generator/must_support_test_generator'
+require_relative 'generator/provenance_revinclude_search_test_generator'
+require_relative 'generator/reference_resolution_test_generator'
+require_relative 'generator/group_generator'
+require_relative 'generator/suite_generator'
+
+module USQualityCoreTestKit
+  class Generator
+    def self.generate
+      ig_packages = Dir.glob(File.join(Dir.pwd, 'lib', 'us_quality_core_test_kit', 'igs', '*.tgz'))
+
+      ig_packages.each do |ig_package|
+        new(ig_package).generate
+      end
+    end
+
+    attr_accessor :ig_resources, :ig_metadata, :ig_file_name
+
+    def initialize(ig_file_name)
+      self.ig_file_name = ig_file_name
+    end
+
+    def generate
+      puts "Generating server suite for #{File.basename(ig_file_name)}..."
+
+      # Extraction
+      load_ig_package
+      extract_metadata
+
+      # Generation
+      FileUtils.mkdir_p(base_output_dir)
+      generate_search_tests
+      generate_read_tests
+      generate_provenance_revinclude_search_tests
+      generate_validation_tests
+      generate_must_support_tests
+      generate_reference_resolution_tests
+      generate_groups
+      generate_suites
+
+      write_metadata
+
+      puts 'done.'
+    end
+
+    def base_output_dir
+      File.join(__dir__, 'generated', ig_metadata.ig_version)
+    end
+
+    def load_ig_package
+      FHIR.logger = Logger.new(File::NULL)
+      self.ig_resources = IGLoader.new(ig_file_name).load
+    end
+
+    def extract_metadata
+      self.ig_metadata = IGMetadataExtractor.new(ig_resources).extract
+    end
+
+    def generate_search_tests
+      SearchTestGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def generate_read_tests
+      ReadTestGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def generate_provenance_revinclude_search_tests
+      ProvenanceRevincludeSearchTestGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def generate_validation_tests
+      ValidationTestGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def generate_must_support_tests
+      MustSupportTestGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def generate_reference_resolution_tests
+      ReferenceResolutionTestGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def generate_groups
+      GroupGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def generate_suites
+      SuiteGenerator.generate(ig_metadata, base_output_dir)
+    end
+
+    def write_metadata
+      File.write(File.join(base_output_dir, 'metadata.yml'), YAML.dump(ig_metadata.to_hash))
+    end
+  end
+end

data/lib/us_quality_core_test_kit/igs/us_quality_core_v050/ValueSet-medicationrequest-intent.json

@@ -0,0 +1,86 @@
+{
+  "resourceType": "ValueSet",
+  "meta": {
+    "lastUpdated": "2019-11-01T09:29:23.356+11:00",
+    "profile": [
+      "http://hl7.org/fhir/StructureDefinition/shareablevalueset"
+    ]
+  },
+  "url": "http://hl7.org/fhir/ValueSet/medicationrequest-intent",
+  "identifier": [
+    {
+      "system": "urn:ietf:rfc:3986",
+      "value": "urn:oid:2.16.840.1.113883.4.642.3.1321"
+    }
+  ],
+  "version": "4.0.1",
+  "name": "medicationRequest Intent",
+  "title": "Medication request  intent",
+  "status": "draft",
+  "experimental": false,
+  "date": "2019-11-01T09:29:23+11:00",
+  "contact": [
+    {
+      "telecom": [
+        {
+          "system": "url",
+          "value": "http://hl7.org/fhir"
+        }
+      ]
+    }
+  ],
+  "immutable": true,
+  "expansion": {
+    "timestamp": "2026-03-20T20:07:10.511Z",
+    "identifier": "urn:uuid:3169bb11-77ee-4456-b02e-62a9f75e252b",
+    "parameter": [
+      {
+        "name": "used-codesystem",
+        "valueUri": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent|4.0.1"
+      }
+    ],
+    "total": 8,
+    "contains": [
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "proposal",
+        "display": "Proposal"
+      },
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "plan",
+        "display": "Plan"
+      },
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "order",
+        "display": "Order"
+      },
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "original-order",
+        "display": "Original Order"
+      },
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "reflex-order",
+        "display": "Reflex Order"
+      },
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "filler-order",
+        "display": "Filler Order"
+      },
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "instance-order",
+        "display": "Instance Order"
+      },
+      {
+        "system": "http://hl7.org/fhir/CodeSystem/medicationrequest-intent",
+        "code": "option",
+        "display": "Option"
+      }
+    ]
+  }
+}

data/lib/us_quality_core_test_kit/metadata.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+
+module USQualityCoreTestKit
+  class Metadata < Inferno::TestKit
+    id :us_quality_core_test_kit
+
+    title 'US Quality Core Test Kit'
+
+    description <<~DESCRIPTION
+      The US Quality Core Test Kit validates server and client implementations
+      against the [US Quality Core Implementation Guide
+      v0.5.0](https://fhir.org/guides/onc/us-quality-core/).
+
+      <!-- break -->
+
+      This test kit is [open source](https://github.com/inferno-framework/us-quality-core-test-kit)
+      and freely available for use or adoption by the health IT community,
+      including EHR vendors, health app developers, quality measure developers,
+      payers, and testing labs. It is built using the [Inferno
+      Framework](https://inferno-framework.github.io), which is designed for
+      reuse and aims to make it easier to build test kits for FHIR-based data
+      exchange, including quality measurement and clinical decision support.
+
+      ## Status
+
+      These tests are a DRAFT intended to allow US Quality Core implementers to
+      perform preliminary checks of their implementations against the
+      [US Quality Core conformance requirements](https://fhir.org/guides/onc/us-quality-core/general-requirements.html)
+      and provide feedback on the tests. Future versions may validate
+      additional requirements or change how these requirements are tested.
+
+      ## Scope
+
+      The scope of this test kit is intended to match the conformance scope
+      defined by US Quality Core v0.5.0. The IG is derived from QI-Core STU 6
+      and includes inherited profiles to ease adoption, but its conformance
+      requirements are focused on USCDI+ Quality V1 data. The IG's
+      [USCDI+ Quality mapping](https://fhir.org/guides/onc/us-quality-core/uscdiquality.html)
+      identifies the in-scope V1 data elements. For conformance,
+      implementations are expected to support profile types with at least one
+      USCDI+ Quality-flagged data element, all USCDI+ Quality-flagged elements,
+      and inherited US Core MustSupport elements.
+
+      ## Server Suite
+
+      The US Quality Core Server Suite verifies support for the IG's in-scope
+      profile, element, and API requirements. It includes:
+
+      * Support for in-scope US Quality Core and US Core profiles that implement USCDI+ Quality V1 data elements
+      * Support for USCDI+ Quality-flagged elements and inherited US Core MustSupport elements
+      * Support for FHIR read and search operations required by the [US Quality Core Server CapabilityStatement](https://fhir.org/guides/onc/us-quality-core/CapabilityStatement-us-quality-core-server.html)
+      * Support for base FHIR requirements and terminology bindings, with validation performed by the HL7 FHIR Validator using tx.fhir.org
+
+      ## Client Suite
+
+      The US Quality Core Client Suite verifies a client's ability to ingest
+      in-scope USCDI+ Quality data from a conformant US Quality Core server over
+      the standard FHIR API. It includes evaluating:
+
+      * The ability to request profile-conformant data from Inferno's simulated US Quality Core server
+      * Support for read and search interaction requests described by the [US Quality Core CapabilityStatements](https://fhir.org/guides/onc/us-quality-core/capability-statements.html)
+
+      ## Repository
+
+      The [US Quality Core Test Kit](https://github.com/inferno-framework/us-quality-core-test-kit)
+      repository contains the source code for this 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 missed US Quality Core requirements
+      * User experience, such as confusing or missing information in the test UI
+
+      Please report issues in the [repository's
+      issues](https://github.com/inferno-framework/us-quality-core-test-kit/issues)
+      section.
+
+    DESCRIPTION
+
+    suite_ids %i[
+      us_quality_core_v050
+      us_quality_core_client_v050
+    ]
+
+    tags ['US Quality Core']
+
+    version VERSION
+
+    last_updated LAST_UPDATED
+
+    maturity 'Low'
+
+    authors ['MITRE']
+  end
+end

data/lib/us_quality_core_test_kit/must_support_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/must_support_test'
+
+module USQualityCoreTestKit
+  module MustSupportTest
+    include USCoreTestKit::MustSupportTest
+    extend USCoreTestKit::MustSupportTest
+  end
+end

data/lib/us_quality_core_test_kit/read_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/read_test'
+
+module USQualityCoreTestKit
+  module ReadTest
+    include USCoreTestKit::ReadTest
+    extend USCoreTestKit::ReadTest
+  end
+end

data/lib/us_quality_core_test_kit/reference_resolution_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'us_core_test_kit/reference_resolution_test'
+
+module USQualityCoreTestKit
+  module ReferenceResolutionTest
+    include USCoreTestKit::ReferenceResolutionTest
+    extend USCoreTestKit::ReferenceResolutionTest
+  end
+end