carin_for_blue_button_test_kit 0.9.1 → 0.11.0

data/lib/carin_for_blue_button_test_kit/date_search_validator.rb

@@ -1,109 +1,113 @@
 # frozen_string_literal: true
 
 module CarinForBlueButtonTestKit
-    module DateSearchValidation
-      def get_fhir_datetime_range(datetime)
-        range = { start: DateTime.xmlschema(datetime), end: nil }
-        range[:end] =
-          if /^\d{4}$/.match?(datetime) # YYYY
-            range[:start].next_year - 1.seconds
-          elsif /^\d{4}-\d{2}$/.match?(datetime) # YYYY-MM
-            range[:start].next_month - 1.seconds
-          elsif /^\d{4}-\d{2}-\d{2}$/.match?(datetime) # YYYY-MM-DD
-            range[:start].next_day - 1.seconds
-          else # YYYY-MM-DDThh:mm:ss+zz:zz
-            range[:start]
-          end
-        range
-      end
-  
-      def get_fhir_period_range(period)
-        range = { start: nil, end: nil }
-        range[:start] = DateTime.xmlschema(period[:start]) unless period[:start].nil?
-        return range if period[:end].nil?
-  
-        period_end_beginning = DateTime.xmlschema(period[:end])
-        range[:end] =
-          if /^\d{4}$/.match?(period[:end]) # YYYY
-            period_end_beginning.next_year - 1.seconds
-          elsif /^\d{4}-\d{2}$/.match?(period[:end]) # YYYY-MM
-            period_end_beginning.next_month - 1.seconds
-          elsif /^\d{4}-\d{2}-\d{2}$/.match?(period[:end]) # YYYY-MM-DD
-            period_end_beginning.next_day - 1.seconds
-          else # YYYY-MM-DDThh:mm:ss+zz:zz
-            period_end_beginning
-          end
-        range
-      end
-  
-      def fhir_date_comparer(search_range, target_range, comparator, extend_start = false, extend_end = false)
-        # Implicitly, a missing lower boundary is "less than" any actual date. A missing upper boundary is "greater than" any actual date.
-        case comparator
-        when 'eq' # the range of the search value fully contains the range of the target value
-          !target_range[:start].nil? && !target_range[:end].nil? && search_range[:start] <= target_range[:start] && search_range[:end] >= target_range[:end]
-        when 'ne' # the range of the search value does not fully contain the range of the target value
-          target_range[:start].nil? || target_range[:end].nil? || search_range[:start] > target_range[:start] || search_range[:end] < target_range[:end]
-        when 'gt' #  the range above the search value intersects (i.e. overlaps) with the range of the target value
-          target_range[:end].nil? || search_range[:end] < target_range[:end] || (search_range[:end] < (target_range[:end] + 1) && extend_end)
-        when 'lt' # the range below the search value intersects (i.e. overlaps) with the range of the target value
-          target_range[:start].nil? || search_range[:start] > target_range[:start] || (search_range[:start] > (target_range[:start] - 1) && extend_start)
-        when 'ge'
-          fhir_date_comparer(search_range, target_range, 'gt', extend_start, extend_end) || fhir_date_comparer(search_range, target_range, 'eq')
-        when 'le'
-          fhir_date_comparer(search_range, target_range, 'lt', extend_start, extend_end) || fhir_date_comparer(search_range, target_range, 'eq')
-        when 'sa' # the range above the search value contains the range of the target value
-          !target_range[:start].nil? && search_range[:end] < target_range[:start]
-        when 'eb' # the range below the search value contains the range of the target value
-          !target_range[:end].nil? && search_range[:start] > target_range[:end]
-        when 'ap' # the range of the search value overlaps with the range of the target value
-          if target_range[:start].nil? || target_range[:end].nil?
-            (target_range[:start].nil? && search_range[:start] < target_range[:end]) ||
-              (target_range[:end].nil? && search_range[:end] > target_range[:start])
-          else
-            (search_range[:start] >= target_range[:start] && search_range[:start] <= target_range[:end]) ||
-              (search_range[:end] >= target_range[:start] && search_range[:end] <= target_range[:end])
-          end
-        end
-      end
-  
-      def validate_date_search(search_value, target_value)
-        if target_value.class == Hash
-          validate_period_search(search_value, target_value)
+  module DateSearchValidation
+    def get_fhir_datetime_range(datetime)
+      range = { start: DateTime.xmlschema(datetime), end: nil }
+      range[:end] = case datetime
+                    when /^\d{4}$/ # YYYY
+                      range[:start].next_year - 1.seconds
+                    when /^\d{4}-\d{2}$/ # YYYY-MM
+                      range[:start].next_month - 1.seconds
+                    when /^\d{4}-\d{2}-\d{2}$/ # YYYY-MM-DD
+                      range[:start].next_day - 1.seconds
+                    else # YYYY-MM-DDThh:mm:ss+zz:zz
+                      range[:start]
+                    end
+      range
+    end
+
+    def get_fhir_period_range(period)
+      range = { start: nil, end: nil }
+      range[:start] = DateTime.xmlschema(period.start) unless period.start.nil?
+      return range if period.end.nil?
+
+      period_end_beginning = DateTime.xmlschema(period.end)
+      range[:end] = case period.end
+                    when /^\d{4}$/ # YYYY
+                      period_end_beginning.next_year - 1.seconds
+                    when /^\d{4}-\d{2}$/ # YYYY-MM
+                      period_end_beginning.next_month - 1.seconds
+                    when /^\d{4}-\d{2}-\d{2}$/ # YYYY-MM-DD
+                      period_end_beginning.next_day - 1.seconds
+                    else # YYYY-MM-DDThh:mm:ss+zz:zz
+                      period_end_beginning
+                    end
+      range
+    end
+
+    def fhir_date_comparer(search_range, target_range, comparator, extend_start = false, extend_end = false)
+      # Implicitly, a missing lower boundary is "less than" any actual date. A missing upper boundary is "greater than" any actual date.
+      case comparator
+      when 'eq' # the range of the search value fully contains the range of the target value
+        !target_range[:start].nil? && !target_range[:end].nil? && search_range[:start] <= target_range[:start] && search_range[:end] >= target_range[:end]
+      when 'ne' # the range of the search value does not fully contain the range of the target value
+        target_range[:start].nil? || target_range[:end].nil? || search_range[:start] > target_range[:start] || search_range[:end] < target_range[:end]
+      when 'gt' #  the range above the search value intersects (i.e. overlaps) with the range of the target value
+        target_range[:end].nil? || search_range[:end] < target_range[:end] || (search_range[:end] < (target_range[:end] + 1) && extend_end)
+      when 'lt' # the range below the search value intersects (i.e. overlaps) with the range of the target value
+        target_range[:start].nil? || search_range[:start] > target_range[:start] || (search_range[:start] > (target_range[:start] - 1) && extend_start)
+      when 'ge'
+        fhir_date_comparer(search_range, target_range, 'gt', extend_start,
+                           extend_end) || fhir_date_comparer(search_range, target_range, 'eq')
+      when 'le'
+        fhir_date_comparer(search_range, target_range, 'lt', extend_start,
+                           extend_end) || fhir_date_comparer(search_range, target_range, 'eq')
+      when 'sa' # the range above the search value contains the range of the target value
+        !target_range[:start].nil? && search_range[:end] < target_range[:start]
+      when 'eb' # the range below the search value contains the range of the target value
+        !target_range[:end].nil? && search_range[:start] > target_range[:end]
+      when 'ap' # the range of the search value overlaps with the range of the target value
+        if target_range[:start].nil? || target_range[:end].nil?
+          (target_range[:start].nil? && search_range[:start] < target_range[:end]) ||
+            (target_range[:end].nil? && search_range[:end] > target_range[:start])
         else
-          validate_datetime_search(search_value, target_value)
+          (search_range[:start] >= target_range[:start] && search_range[:start] <= target_range[:end]) ||
+            (search_range[:end] >= target_range[:start] && search_range[:end] <= target_range[:end])
         end
       end
-  
-      def validate_datetime_search(search_value, target_value)
-        comparator = search_value[0..1]
-        if ['eq', 'ge', 'gt', 'le', 'lt', 'ne', 'sa', 'eb', 'ap'].include? comparator
-          search_value = search_value[2..-1]
-        else
-          comparator = 'eq'
-        end
-        search_is_date = is_date?(search_value)
-        target_is_date = is_date?(target_value)
-        search_range = get_fhir_datetime_range(search_value)
-        target_range = get_fhir_datetime_range(target_value)
-        fhir_date_comparer(search_range, target_range, comparator, !search_is_date && target_is_date, !search_is_date && target_is_date)
+    end
+
+    def validate_date_search(search_value, target_value)
+      if target_value.kind_of?(FHIR::Model)
+        validate_period_search(search_value, target_value)
+      else
+        validate_datetime_search(search_value, target_value)
       end
-  
-      def validate_period_search(search_value, target_value)
-        comparator = search_value[0..1]
-        if ['eq', 'ge', 'gt', 'le', 'lt', 'ne', 'sa', 'eb', 'ap'].include? comparator
-          search_value = search_value[2..-1]
-        else
-          comparator = 'eq'
-        end
-        search_is_date = is_date?(search_value)
-        search_range = get_fhir_datetime_range(search_value)
-        target_range = get_fhir_period_range(target_value)
-        fhir_date_comparer(search_range, target_range, comparator, !search_is_date && is_date?(target_value.start), !search_is_date && is_date?(target_value.end))
+    end
+
+    def validate_datetime_search(search_value, target_value)
+      comparator = search_value[0..1]
+      if %w[eq ge gt le lt ne sa eb ap].include? comparator
+        search_value = search_value[2..]
+      else
+        comparator = 'eq'
       end
-  
-      def is_date?(value)
-       /^\d{4}(-\d{2})?(-\d{2})?$/.match?(value) # YYYY or YYYY-MM or YYYY-MM-DD
+      search_is_date = is_date?(search_value)
+      target_is_date = is_date?(target_value)
+      search_range = get_fhir_datetime_range(search_value)
+      target_range = get_fhir_datetime_range(target_value)
+      fhir_date_comparer(search_range, target_range, comparator, !search_is_date && target_is_date,
+                         !search_is_date && target_is_date)
+    end
+
+    def validate_period_search(search_value, target_value)
+      comparator = search_value[0..1]
+      if %w[eq ge gt le lt ne sa eb ap].include? comparator
+        search_value = search_value[2..]
+      else
+        comparator = 'eq'
       end
+
+      search_is_date = is_date?(search_value)
+      search_range = get_fhir_datetime_range(search_value)
+      target_range = get_fhir_period_range(target_value)
+      fhir_date_comparer(search_range, target_range, comparator, !search_is_date && is_date?(target_value.start),
+                         !search_is_date && is_date?(target_value.end))
+    end
+
+    def is_date?(value)
+      /^\d{4}(-\d{2})?(-\d{2})?$/.match?(value) # YYYY or YYYY-MM or YYYY-MM-DD
     end
   end
-  
+end

data/lib/carin_for_blue_button_test_kit/fhir_resource_navigation.rb

@@ -1,73 +1,72 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module CarinForBlueButtonTestKit
-    module FHIRResourceNavigation
-      DAR_EXTENSION_URL = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'.freeze
-  
-      def resolve_path(elements, path)
-        elements = Array.wrap(elements)
-        return elements if path.blank?
-        
-        paths = path.split('.')
-        segment = paths.first
-        remaining_path = paths.drop(1).join('.')
-
-        elements.flat_map do |element|
-          child = get_next_value(element, segment)
-          resolve_path(child, remaining_path)
-        end.compact
+  module FHIRResourceNavigation
+    DAR_EXTENSION_URL = 'http://hl7.org/fhir/StructureDefinition/data-absent-reason'
 
-      end
-  
-      def find_a_value_at(element, path, include_dar: false)
-        return nil if element.nil?
+    def resolve_path(elements, path)
+      elements = Array.wrap(elements)
+      return elements if path.blank?
 
-        elements = Array.wrap(element)
+      paths = path.split('.')
+      segment = paths.first
+      remaining_path = paths.drop(1).join('.')
 
-        if path.empty?
-          unless include_dar
-            elements = elements.reject do |el|
-              el.respond_to?(:extension) && el.extension.any? { |ext| ext.url == DAR_EXTENSION_URL}
-            end
-          end
+      elements.flat_map do |element|
+        child = get_next_value(element, segment)
+        resolve_path(child, remaining_path)
+      end.compact
+    end
+
+    def find_a_value_at(element, path, include_dar: false, &block)
+      return nil if element.nil?
 
-          return elements.find { |el| yield(el) } if block_given?
-          
-          return elements.first
+      elements = Array.wrap(element)
+
+      if path.empty?
+        unless include_dar
+          elements = elements.reject do |el|
+            el.respond_to?(:extension) && el.extension.any? { |ext| ext.url == DAR_EXTENSION_URL }
+          end
         end
-  
-        path_segments = path.split('.')
-        segment = path_segments.shift.delete_suffix('[x]').to_sym
-        
-        no_elements_present =
-          elements.none? do |element|
+
+        return elements.find(&block) if block_given?
+
+        return elements.first
+      end
+
+      path_segments = path.split('.')
+      segment = path_segments.shift.delete_suffix('[x]').to_sym
+
+      no_elements_present =
+        elements.none? do |element|
           child = get_next_value(element, segment)
           child.present? || child == false
         end
-  
-        return nil if no_elements_present
 
-        remaining_path = path_segments.join('.')
-        elements.each do |element|
-          child = get_next_value(element, segment)
-          element_found =
-            if block_given?
-              find_a_value_at(child, remaining_path, include_dar: include_dar) { |value_found| yield(value_found) }
-            else
-              find_a_value_at(child, remaining_path, include_dar: include_dar)
-            end
-  
-          return element_found if element_found.present? || element_found == false
-        end
-  
-        nil
-      end
-  
-      def get_next_value(element, property)
-        element[property.to_s.strip]
-      rescue NoMethodError
-        nil
+      return nil if no_elements_present
+
+      remaining_path = path_segments.join('.')
+      elements.each do |element|
+        child = get_next_value(element, segment)
+        element_found = if block_given?
+                          find_a_value_at(child, remaining_path, include_dar:, &block)
+                        else
+                          find_a_value_at(child, remaining_path, include_dar:)
+                        end
+
+        return element_found if element_found.present? || element_found == false
       end
+
+      nil
+    end
+
+    def get_next_value(element, property)
+      element.send(property)
+    rescue NoMethodError
+      nil
     end
   end
-  
+end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/c4bb_test_suite.rb

@@ -3,21 +3,23 @@ require 'smart_app_launch_test_kit'
 require_relative '../../version'
 
 require_relative '../../capability_statement/capability_statement_group'
+require_relative '../../custom_groups/v1.1.0/c4bb_smart_launch_group'
 
 require_relative 'patient_group'
+require_relative 'eob_group'
 require_relative 'coverage_group'
-require_relative 'explanation_of_benefit_group'
-require_relative 'explanation_of_benefit_inpatient_institutional_group'
-require_relative 'explanation_of_benefit_outpatient_institutional_group'
-require_relative 'explanation_of_benefit_pharmacy_group'
-require_relative 'explanation_of_benefit_professional_non_clinician_group'
 require_relative 'organization_group'
 require_relative 'practitioner_group'
 
 module CarinForBlueButtonTestKit
   module CARIN4BBV110
-    class C4BBTestKit < Inferno::TestSuite
+    class C4BBTestSuite < Inferno::TestSuite
       title 'CARIN IG for Blue Button® v1.1.0'
+      description %(
+        The CARIN for Blue Button test suite validates system conformance to the HL7® FHIR® [CARIN for Blue Button® Implementation Guide](http://hl7.org/fhir/us/carin-bb/STU1.1).
+
+        
+      )
       version VERSION
       links [
         {
@@ -36,71 +38,53 @@ module CarinForBlueButtonTestKit
           end
       end
 
-      validator do
-        url ENV.fetch('V110_VALIDATOR_URL', 'http://validator_service:4567')
-      end
-
       id :c4bb_v110
 
-      input :url,
-        title: 'FHIR Endpoint',
-        description: 'URL of the FHIR endpoint'
-      input :smart_credentials,
-        title: 'OAuth Credentials',
-        type: :oauth_credentials,
-        optional: true
-
-      # SMART Test Suite requirement
-      group from: :smart_discovery,
-        run_as_group: true
-      group from: :smart_standalone_launch,
-        run_as_group: true,
-        config: {
-          outputs: {
-            patient_id: { name: :patient_ids },
-            smart_credentials: { name: :smart_credentials }
-          }
-        },
-        description: %(
-          # Background
-
-          The [Standalone
-          Launch Sequence](https://www.hl7.org/fhir/smart-app-launch/1.0.0/index.html#standalone-launch-sequence)
-          allows an app, like Inferno, to be launched independent of an
-          existing EHR session. It is one of the two launch methods described in
-          the SMART App Launch Framework alongside EHR Launch. The app will
-          request authorization for the provided scope from the authorization
-          endpoint, ultimately receiving an authorization token which can be used
-          to gain access to resources on the FHIR server.
-
-          # Test Methodology
+      VALIDATION_MESSAGE_FILTERS = [
+        /\A\S+: \S+: URL value '.*' does not resolve/
+      ].freeze
 
-          Inferno will redirect the user to the authorization endpoint so that
-          they can provide any required credentials and authorize the application.
-          Upon successful authorization, Inferno will exchange the authorization
-          code provided for an access token.
+      fhir_resource_validator do
+        igs 'igs/carin4bb-110.tgz'
 
-          For more information on the #{title}:
+        exclude_message do |message|
+          VALIDATION_MESSAGE_FILTERS.any? { |filter| filter.match? message.message }
+        end
+      end
 
-          * [Standalone Launch Sequence](https://www.hl7.org/fhir/smart-app-launch/1.0.0/index.html#standalone-launch-sequence)
-        )
+      input :url,
+        title: 'FHIR Endpoint',
+        description: 'URL of the FHIR endpoint'
 
       fhir_client do
         url :url
         oauth_credentials :smart_credentials
       end
 
-      group from: :capability_statement_group
-  
-      group from: :c4bb_v110_patient
-      group from: :c4bb_v110_coverage
-      group from: :c4bb_v110_explanation_of_benefit
-      group from: :c4bb_v110_explanation_of_benefit_inpatient_institutional
-      group from: :c4bb_v110_explanation_of_benefit_outpatient_institutional
-      group from: :c4bb_v110_explanation_of_benefit_pharmacy
-      group from: :c4bb_v110_explanation_of_benefit_professional_non_clinician
-      group from: :c4bb_v110_organization
-      group from: :c4bb_v110_practitioner
+      group from: :c4bb_v110_smart_launch
+
+      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_credentials,
+            title: 'OAuth Credentials',
+            type: :oauth_credentials,
+            optional: true
+        input_order :url, :smart_credentials
+
+        group from: :capability_statement_group
+    
+        group from: :c4bb_v110_patient
+        group from: :c4bb_v110_eob
+        group from: :c4bb_v110_coverage
+        group from: :c4bb_v110_organization
+        group from: :c4bb_v110_practitioner
+      end
     end
   end
 end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/coverage/metadata.yml

@@ -4,6 +4,7 @@
 :version: v1.1.0
 :reformatted_version: v110
 :resource: Coverage
+:conformance_expectation: SHALL
 :profile_url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage
 :profile_name: C4BB Coverage
 :profile_version: 1.1.0
@@ -15,7 +16,22 @@
   :expectation: SHALL
 :operations: []
 :searches: []
-:search_definitions: {}
+:search_definitions:
+  :payor:
+    :paths:
+    - payor
+    :full_paths:
+    - Coverage.payor
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :target_paths:
+    - :path: payor
+      :target:
+      - Organization
+      - Patient
+      - RelatedPerson
+    :contains_multiple: false
 :include_params:
 - Coverage:payor
 :revincludes: []
@@ -134,11 +150,11 @@
   - http://hl7.org/fhir/StructureDefinition/Contract
 :tests:
 - :id: c4bb_v110_coverage_read_test
-  :file_name: coverage_read_test.rb
+  :file_name: read_test.rb
 - :id: c4bb_v110_coverage_validation_test
-  :file_name: coverage_validation_test.rb
+  :file_name: validation_test.rb
 - :id: c4bb_v110_coverage_must_support_test
-  :file_name: coverage_must_support_test.rb
+  :file_name: must_support_test.rb
 :id: c4bb_v110_coverage
 :file_name: coverage_group.rb
 :delayed_references:

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/coverage/{coverage_must_support_test.rb → must_support_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../must_support_test'
-require_relative './coverage_read_test'
+require_relative './read_test'
 require_relative '../../../generator/group_metadata'
 
 module CarinForBlueButtonTestKit
@@ -15,7 +15,7 @@ module CarinForBlueButtonTestKit
         Statement. This test will look through the Coverage resources
         found previously for the following must support elements:
 
-        * Coverage.beneficiary
+                * Coverage.beneficiary
         * Coverage.class
         * Coverage.class.name
         * Coverage.class.value

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/coverage/{coverage_read_test.rb → read_test.rb}

@@ -10,14 +10,13 @@ module CarinForBlueButtonTestKit
       description 'A server SHALL support the Coverage read interaction.'
 
       id :c4bb_v110_coverage_read_test
-
-      input :coverage_ids,
-        title: "coverage IDs",
+      
+      input :additional_coverage_ids,
+        title: "Additional coverage IDs",
         type: 'text',
-        description: "coverage Resource ID"
-
-      input_order :url, :smart_credentials, :coverage_ids
-
+        description: "coverage Resource ID. This is optional, but must be provided if executing only the Coverage test group.",
+        optional: true
+      
       def resource_type
         'Coverage'
       end
@@ -26,13 +25,13 @@ module CarinForBlueButtonTestKit
         scratch[:coverage_resources] ||= {}
       end
 
-      def coverage_id_list
-        return [nil] unless respond_to? :coverage_ids
-        coverage_ids.split(',').map(&:strip)
+      def resource_ids
+        return [] unless respond_to? :additional_coverage_ids
+        additional_coverage_ids.split(',').map(&:strip)
       end
 
       run do
-        perform_read_test(coverage_id_list)
+        perform_read_test(scratch.dig(:references, 'Coverage'))
       end
     end
   end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/coverage/{coverage_validation_test.rb → validation_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../validation_test'
-require_relative './coverage_read_test'
+require_relative './read_test'
 
 module CarinForBlueButtonTestKit
   module CARIN4BBV110
@@ -9,8 +9,7 @@ module CarinForBlueButtonTestKit
 
       id :c4bb_v110_coverage_validation_test
       title 'Coverage resources returned during previous tests conform to the C4BB Coverage'
-      description %(
-This test verifies resources returned from the first search conform to
+      description %(This test verifies resources returned from the first search conform to
 the [C4BB Coverage](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage).
 Systems must demonstrate at least one valid example in order to pass this test.
 
@@ -23,7 +22,7 @@ fail if their code/system are not found in the valueset.
       )
 
       output :dar_code_found, :dar_extension_found
-      
+
       def resource_type
         'Coverage'
       end