carin_for_blue_button_test_kit 0.13.3 → 0.15.0

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

@@ -0,0 +1,43 @@
+require_relative '../../../carin_search_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include CarinForBlueButtonTestKit::CarinSearchTest
+
+      title 'Server returns valid results for <%= resource_type %> search by <%= search_param_name_string %>'
+      description %(<%=
+        description %>
+      )
+
+      id :<%= test_id %><% if optional? %>
+      optional
+      <% end %>
+      <% if first_search? %>
+      input :<%=input_id%>,
+        title: '<%=input_title.strip%>',
+        type: 'text',
+        description: '<%=input_description.strip%>'<%if !needs_patient_id?%>,
+        optional: true<% end %>
+      <% end %>
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+  <%= search_test_properties_string.gsub("\n", "\n" + " "*2) %>
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:<%= resource_type.downcase %>_resources] ||= {}
+      end
+
+      run do
+        run_search_test<% if first_search? && !needs_patient_id? %>(<%=input_id%>)<% end %>
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+require 'smart_app_launch_test_kit'
+require_relative '../../version'
+
+require_relative '../../capability_statement/capability_statement_group'
+require_relative '<%= smart_launch_file_name %>'
+
+<% group_file_list.each do |file_name| %>require_relative '<%= file_name %>'
+<% end %>
+module CarinForBlueButtonTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::TestSuite
+      title '<%= title %>'
+      description %(
+        The CARIN for Blue Button test suite validates system conformance to the HL7® FHIR® [CARIN for Blue Button® Implementation Guide](<%= ig_link %>).
+
+        <% if module_name.include? ("FINANCIAL") %>
+        Development build for the [non-financial branch](https://build.fhir.org/ig/HL7/carin-bb/branches/non-financial/).
+        <% end %>
+      )
+
+      links [
+        {
+          label: 'Report Issue',
+          url: 'https://github.com/inferno-framework/carin-for-blue-button-test-kit/issues'
+        },
+        {
+          label: 'Open Source',
+          url: 'https://github.com/inferno-framework/carin-for-blue-button-test-kit'
+        },
+        {
+          label: 'Download',
+          url: 'https://github.com/inferno-framework/carin-for-blue-button-test-kit/releases'
+        },
+        {
+          label: 'Implementation Guide',
+          url: '<%= ig_link %>'
+        }
+      ]
+
+      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 %>
+
+      VALIDATION_MESSAGE_FILTERS = [
+        /\A\S+: \S+: URL value '.*' does not resolve/
+      ].freeze
+
+      fhir_resource_validator do
+        igs '<%= ig_relative_path %>'
+
+        exclude_message do |message|
+          VALIDATION_MESSAGE_FILTERS.any? { |filter| filter.match? message.message }
+        end
+      end
+
+      config(
+        inputs: {
+          smart_auth_info: { name: :smart_auth_info }
+        },
+        outputs: {
+          smart_auth_info: { name: :smart_auth_info }
+        }
+      )
+
+      input :url,
+        title: 'FHIR Endpoint',
+        description: 'URL of the FHIR endpoint'
+
+      fhir_client do
+        url :url
+        auth_info :smart_auth_info
+      end
+
+      group from: :<%= smart_launch_group_id %>
+
+      group do
+        title 'C4BB FHIR API Tests'
+        description %(
+          The CARIN for Blue Button FHIR API Tests evaluate the ability of a system (C4BB FHIR Server)
+          to support required and optional FHIR operations and search parameters to return
+          conformant C4BB resources.
+        )
+
+        input :smart_auth_info,
+            title: 'OAuth Credentials',
+            type: :auth_info,
+            optional: true
+
+        group from: :capability_statement_group
+    <% group_id_list.each do |id| %>
+        group from: :<%= id %><% end %>
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require_relative '../../../validation_test'
+require_relative './read_test'
+
+module CarinForBlueButtonTestKit
+  module <%= module_name %>
+    class <%= class_name %> < Inferno::Test
+      include CarinForBlueButtonTestKit::ValidationTest
+      include CarinForBlueButtonTestKit::<%= module_name %>
+
+      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[:<%= resource_type.downcase %>_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/carin_for_blue_button_test_kit/metadata.rb

@@ -0,0 +1,70 @@
+require_relative 'version'
+
+module CarinForBlueButtonTestKit
+  class Metadata < Inferno::TestKit
+    id :carin_for_blue_button_test_kit
+    title 'CARIN IG for Blue Button Test Kit'
+    description <<~DESCRIPTION
+      The Carin IG for Blue Button Test Kit validates the conformance of server
+      and client implementations to the [CARIN IG for Blue
+      Button](https://hl7.org/fhir/us/carin-bb/) including versions:
+      - [**v1.1.0**](http://hl7.org/fhir/us/carin-bb/STU1.1) (server tests only)
+      - [**v2.0.0**](http://hl7.org/fhir/us/carin-bb/STU2) (server and client tests)
+      - **Non-financial Proposal** (server tests only)
+
+      <!-- break -->
+
+      This test kit 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
+
+      These tests are intended to allow CARIN IG for Blue Button server implementers to perform checks of their server against CARIN IG for Blue Button requrirements. Future versions of these tests may validate other requirements and may change how these are tested.
+
+      For more details on the specific validations performed as part of testing the following requirements, see the test descriptions within the test suites.
+
+      ### Server Tests
+
+      The server suites currently test the following requirements:
+      - SMART on FHIR Discovery
+      - SMART App Launch Protocol's standalone launch sequence
+      - Support for Capability Statement
+      - Support for Must Support Elements
+      - Profile Validation
+      - Reference Validation
+      - Searching on ExplanationofBenefit Resource
+
+      ### Client Tests
+
+      The client suite currently tests that clients are able to
+      - Fetch instances conformant to each FHIR profile defined in the CARIN IG.
+      - Perform searches using each of the required search parameters.
+      - Correctly process instances containing populated examples of all must support elements.
+
+      You can find additional information on the IG requirements that the client test suite covers
+      and does not cover in the [Requirements Coverage](https://github.com/inferno-framework/carin-for-blue-button-test-kit/blob/main/lib/carin_for_blue_button_test_kit/requirements/generated/carin-for-blue-button-test-kit_requirements_coverage.csv)
+      CSV document.
+
+      Specific known limitations of the client tests include:
+      - Inferno's simulated CARIN server does not support all required search parameters on the ExplanationOfBenefit resource, including service-date, service-start-date, billable-period-start, type, and _include=ExplanationOfBenefit:insurer. Inferno recognizes searches made using those parameters and will give the client credit for having performed them but will always return an OperationOutcome indicating failure.
+      - Testers must manually configure their client system to connect to a specific target patient and ingest specific curated sample CARIN data. Future versions of the tests may allow more flexibility in the patient identity and the associated data.
+      - Testers must attest to their system's ability to process and retain all received information. Currently, this is implemented as a single test. Future versions of the tests may split this test out into different attestations per profile or other more fine-grained organization.
+
+      ## Repository
+
+      The Carin IG for Blue Button Test Kit GitHub repository can be [found here](https://github.com/inferno-framework/carin-for-blue-button-test-kit).
+
+      ## Providing Feedback and Reporting Issues
+
+      Please report any issues with this set of tests in the [issues section](https://github.com/inferno-framework/carin-for-blue-button-test-kit/issues) of the repository.
+    DESCRIPTION
+    suite_ids [:c4bb_v110, :c4bb_v200, :c4bb_v200_client, :c4bb_v200devnonfinancial]
+    tags ['CARIN']
+    last_updated LAST_UPDATED
+    version VERSION
+    maturity 'Medium'
+    authors ['Inferno Team']
+    repo 'https://github.com/inferno-framework/carin-for-blue-button-test-kit'
+  end
+end

data/lib/carin_for_blue_button_test_kit/requirements/carin-for-blue-button-test-kit_out_of_scope_requirements.csv

@@ -0,0 +1,53 @@
+Req Set,ID,Reason,Details
+hl7.fhir.us.carin-bb_2.0.0,7,Not Verifiable,Can't know if the Health Plan API actor knows the precise reason for the absence of data
+hl7.fhir.us.carin-bb_2.0.0,15,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,16,Not Verifiable,Nothing to verify
+hl7.fhir.us.carin-bb_2.0.0,18,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,20,Not Verifiable,Cannot know if the a business value is an exact match or not
+hl7.fhir.us.carin-bb_2.0.0,21,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,22,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,23,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,24,Not Verifiable,Doesn't specify where the descriptions would be provided.
+hl7.fhir.us.carin-bb_2.0.0,25,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,26,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,27,Not Verifiable,This is a description of the CPCDS dataset rather than a requirement specification for an implementer.
+hl7.fhir.us.carin-bb_2.0.0,29,Not Verifiable,This defines a mapping not a requirement on the Health Plan.
+hl7.fhir.us.carin-bb_2.0.0,49,Not Verifiable,"""Proper"" undefined"
+hl7.fhir.us.carin-bb_2.0.0,50,Not Verifiable,"""Appropriately secured"" undefined"
+hl7.fhir.us.carin-bb_2.0.0,52,Not Verifiable,We can't know agreements between trading partners
+hl7.fhir.us.carin-bb_2.0.0,59,Not Tested,"""should consider"" not strong enough to warrant testing."
+hl7.fhir.us.carin-bb_2.0.0,82,Not Tested,"Maybe - It's a ""MAY"" requirement but I think the criteria will turn it into a ""SHALL"" requirement."
+hl7.fhir.us.carin-bb_2.0.0,84,Not Verifiable,Doesn't specify where and how these will be recorded so they are not verifiable.
+hl7.fhir.us.carin-bb_2.0.0,85,Not Verifiable,"Unclear wth ""IG related data"" is"
+hl7.fhir.us.carin-bb_2.0.0,88,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,91,Not Verifiable,Cannot know what data was effective at what time
+hl7.fhir.us.carin-bb_2.0.0,92,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,93,Not Verifiable,Cannot know when data was last changed
+hl7.fhir.us.carin-bb_2.0.0,94,Not Verifiable,Cannot verify the internal of an app
+hl7.fhir.us.carin-bb_2.0.0,96,Not Verifiable,Overly broad
+hl7.fhir.us.carin-bb_2.0.0,104,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,106,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,107,Not Verifiable,MAY requirement
+hl7.fhir.us.carin-bb_2.0.0,121,Not Verifiable,Cannot test how client apps do look ups
+hl7.fhir.us.carin-bb_2.0.0,122,Not Verifiable,Cannot confirm if client apps assign value to something
+hl7.fhir.us.carin-bb_2.0.0,123,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,126,Not Verifiable,There's no point in checking that maybe something exists that could exist.
+hl7.fhir.us.carin-bb_2.0.0,137,Not Verifiable,Cannot confirm if client apps assign value to something
+hl7.fhir.us.carin-bb_2.0.0,138,Not Verifiable,Cannot confirm how a client uses values
+hl7.fhir.us.carin-bb_2.0.0,139,Not Verifiable,Cannot confirm if client apps assign value to something
+hl7.fhir.us.carin-bb_2.0.0,140,Not Verifiable,Cannot confirm how a client uses values
+hl7.fhir.us.carin-bb_2.0.0,143,Not Verifiable,Appears to be business logic not a calculation that we can confirm
+hl7.fhir.us.carin-bb_2.0.0,147,Not Verifiable,Cannot confirm how a client uses values
+hl7.fhir.us.carin-bb_2.0.0,154,Not Verifiable,Appears to be business logic not a calculation that we can confirm
+hl7.fhir.us.carin-bb_2.0.0,155,Not Verifiable,Appears to be business logic not a calculation that we can confirm
+hl7.fhir.us.carin-bb_2.0.0,166,Not Verifiable,Cannot know how clients interpret data.
+hl7.fhir.us.carin-bb_2.0.0,167,Not Verifiable,Cannot know how clients interpret data.
+hl7.fhir.us.carin-bb_2.0.0,169,Not Verifiable,Unclear if this should *only* be populated if it's different
+hl7.fhir.us.carin-bb_2.0.0,174,Not Verifiable,"This is a definition, not a requirement."
+hl7.fhir.us.carin-bb_2.0.0,176,Not Verifiable,Cannot know when data was in effect
+hl7.fhir.us.carin-bb_2.0.0,180,Not Verifiable,Cannot confirm how a client uses values
+hl7.fhir.us.carin-bb_2.0.0,181,Not Verifiable,Business rule that we cannot verify
+hl7.fhir.us.carin-bb_2.0.0,182,Not Verifiable,Cannot know 
+hl7.fhir.us.carin-bb_2.0.0,184,Not Verifiable,Cannot confirm how a client uses values
+hl7.fhir.us.carin-bb_2.0.0,185,Not Verifiable,Cannot know 
+hl7.fhir.us.carin-bb_2.0.0,188,Not Verifiable,Cannot confirm how a client uses values