carin_for_blue_button_test_kit 0.9.1 → 0.10.0

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/related_person/validation_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../validation_test'
+require_relative './read_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class RelatedPersonValidationTest < Inferno::Test
+      include CarinForBlueButtonTestKit::ValidationTest
+      include CarinForBlueButtonTestKit::CARIN4BBV200DEVNONFINANCIAL
+
+      id :c4bb_v200devnonfinancial_related_person_validation_test
+      title 'RelatedPerson resources returned during previous tests conform to the C4BB RelatedPerson'
+      description %(This test verifies resources returned from the first search conform to
+the [C4BB RelatedPerson](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson).
+Systems must demonstrate at least one valid example in order to pass this test.
+
+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.
+
+      )
+
+      output :dar_code_found, :dar_extension_found
+
+      def resource_type
+        'RelatedPerson'
+      end
+
+      def scratch_resources
+        scratch[:relatedperson_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson',
+                                '2.0.0',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/related_person_group.rb

@@ -0,0 +1,86 @@
+require_relative 'related_person/id_search_test'
+require_relative 'related_person/lastupdated_search_test'
+require_relative 'related_person/read_test'
+require_relative 'related_person/validation_test'
+require_relative 'related_person/must_support_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class RelatedPersonGroup < Inferno::TestGroup
+      title 'RelatedPerson Tests'
+      short_description 'Verify support for the server capabilities required by the C4BB RelatedPerson.'
+      description %(
+# Background
+
+The CARIN for Blue Button RelatedPerson sequence verifies that the system under test is
+able to provide correct responses for RelatedPerson queries. These queries
+must contain resources conforming to the C4BB RelatedPerson as
+specified in the CARIN for Blue Button v2.0.0-dev-nonfinancial Implementation Guide.
+
+# Testing Methodology
+## Searching
+This test sequence will first perform each required search associated
+with this resource. This sequence will perform searches with the
+following parameters:
+
+* _id
+
+### Search Parameters
+The first search uses the selected patient(s) from the prior launch
+sequence. Any subsequent searches will look for its parameter values
+from the results of the first search. For example, the `identifier`
+search in the patient sequence is performed by looking for an existing
+`Patient.identifier` from any of the resources returned in the `_id`
+search. If a value cannot be found this way, the search is skipped.
+
+### Search Validation
+Inferno will retrieve up to the first 20 bundle pages of the reply for
+RelatedPerson resources and save them for subsequent tests.
+Each resource is then checked to see if it matches the searched
+parameters in accordance with [FHIR search
+guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+for example, if a Patient search for `gender=male` returns a `female`
+patient.
+
+
+## Must Support
+Each profile contains elements marked as "must support". This test
+sequence expects to see each of these elements at least once. If at
+least one cannot be found, the test will fail. The test will look
+through the RelatedPerson resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [C4BB RelatedPerson](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson). Each element is checked against
+terminology binding and cardinality requirements.
+
+Elements with a required binding are validated against their bound
+ValueSet. If the code/system in the element is not part of the ValueSet,
+then the test will fail.
+
+## Reference Validation
+At least one instance of each external reference in elements marked as
+"must support" within the resources provided by the system must resolve.
+The test will attempt to read each reference found and will fail if no
+read succeeds.
+
+      )
+
+      id :c4bb_v200devnonfinancial_related_person
+      run_as_group
+      optional
+      
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'related_person', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :c4bb_v200devnonfinancial_related_person__id_search_test
+      test from: :c4bb_v200devnonfinancial_related_person__lastUpdated_search_test
+      test from: :c4bb_v200devnonfinancial_related_person_read_test
+      test from: :c4bb_v200devnonfinancial_related_person_validation_test
+      test from: :c4bb_v200devnonfinancial_related_person_must_support_test
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/resource_list.rb

@@ -0,0 +1,24 @@
+module CarinForBlueButtonTestKit
+    module CARIN4BBV200DEVNONFINANCIAL
+      module ResourceList
+        RESOURCE_LIST = [
+          'Coverage',
+      'Explanation Of Benefit',
+      'ExplanationOfBenefit Inpatient Institutional',
+      'ExplanationOfBenefit Inpatient Institutional - Non-Financial',
+      'ExplanationOfBenefit Outpatient Institutional',
+      'ExplanationOfBenefit Outpatient Institutional - Non-Financial',
+      'ExplanationOfBenefit Oral',
+      'ExplanationOfBenefit Oral - Non-Financial',
+      'ExplanationOfBenefit Pharmacy',
+      'ExplanationOfBenefit Pharmacy - Non-Financial',
+      'ExplanationOfBenefit Professional NonClinician',
+      'ExplanationOfBenefit Professional NonClinician - Non-Financial',
+      'Organization',
+      'Patient',
+      'Practitioner',
+      'RelatedPerson'
+        ].freeze
+        end
+    end
+end

data/lib/carin_for_blue_button_test_kit/generator/group_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'naming'
 
 module CarinForBlueButtonTestKit
@@ -5,8 +7,9 @@ module CarinForBlueButtonTestKit
     class GroupGenerator
       class << self
         def generate(ig_metadata, base_output_dir)
+          @@eob_subgroups = ig_metadata.eob_subgroups
           ig_metadata.ordered_groups
-            .each { |group| new(group, base_output_dir).generate }
+                     .each { |group| new(group, base_output_dir).generate }
         end
       end
 
@@ -30,7 +33,7 @@ module CarinForBlueButtonTestKit
       end
 
       def base_metadata_file_name
-        "metadata.yml"
+        'metadata.yml'
       end
 
       def class_name
@@ -70,8 +73,7 @@ module CarinForBlueButtonTestKit
       end
 
       def search_validation_resource_type
-        text = "#{resource_type} resources"
-        text
+        "#{resource_type} resources"
       end
 
       def profile_name
@@ -82,50 +84,72 @@ module CarinForBlueButtonTestKit
         group_metadata.profile_url
       end
 
-
       def optional?
-        resource_type == 'QuestionnaireResponse'
+        group_metadata.conformance_expectation != 'SHALL'
       end
 
       def generate
-        File.open(output_file_name, 'w') { |f| f.write(output) }
-        group_metadata.id = group_id
-        group_metadata.file_name = base_output_file_name
-        File.open(metadata_file_name, 'w') { |f| f.write(YAML.dump(group_metadata.to_hash)) }
+        if !is_eob_subgroup?
+          File.open(output_file_name, 'w') { |f| f.write(output) }
+          group_metadata.id = group_id
+          group_metadata.file_name = base_output_file_name
+          File.open(metadata_file_name, 'w') { |f| f.write(YAML.dump(group_metadata.to_hash)) }
+        end
       end
 
       def test_id_list
         @test_id_list ||=
           group_metadata.tests.map { |test| test[:id] }
-        
-        # Remove calls to search tests for EOB subgroups (all subgroup search tests handled in EOB root tests)
-        if is_eob_subgroup?
-          @test_id_list = @test_id_list.select { |test_name| !test_name.include?("search_test") }
-        end
 
+        # Remove calls to search tests for EOB subgroups and merge EOB subgroup tests with the EOB root tests
+        @test_id_list = @test_id_list.reject { |test_name| test_name.include?('search_test') } if is_eob_subgroup?
+
+        @test_id_list.concat(eob_subgroups_test_id_list) if is_eob_root_group?
         @test_id_list
       end
 
+      def eob_subgroups_test_id_list
+        test_id_list = []
+        @@eob_subgroups.each do |group|
+          test_id_list.concat(group.tests.map { |test| test[:id] })
+        end
+
+        test_id_list.reject { |test_name| test_name.include?('search_test') }
+                    .reject { |test_name| test_name.include?('read_test') }
+      end
+
       def test_file_list
         @test_file_list ||=
           group_metadata.tests.map do |test|
             name_without_suffix = test[:file_name].delete_suffix('.rb')
             name_without_suffix.start_with?('..') ? name_without_suffix : "#{profile_identifier}/#{name_without_suffix}"
           end
-        
+
         # Remove calls to search tests for EOB subgroups (all subgroup search tests handled in EOB root tests)
-        if is_eob_subgroup?
-          @test_file_list = @test_file_list.select { |test_name| !test_name.include?("search_test") }
-        end
+        @test_file_list = @test_file_list.reject { |test_name| test_name.include?('search_test') } if is_eob_subgroup?
 
+        @test_file_list = @test_file_list.concat(eob_subgroups_test_file_list) if is_eob_root_group?
         @test_file_list
       end
 
+      def eob_subgroups_test_file_list
+        test_file_list = []
+        @@eob_subgroups.each do |group|
+          list = group.tests.map do |test|
+            name_without_suffix = test[:file_name].delete_suffix('.rb')
+            name_without_suffix.start_with?('..') ? name_without_suffix : "#{Naming.snake_case_for_profile(group)}/#{name_without_suffix}"
+          end
+          test_file_list.concat(list)
+        end
+        test_file_list.reject { |test_name| test_name.include?('search_test') }
+                      .reject { |test_name| test_name.include?('read_test') }
+      end
+
       def required_searches
         if !group_metadata.searches.nil? && !is_eob_subgroup?
-            group_metadata.searches.select { |search| search[:expectation] == 'SHALL' }
+          group_metadata.searches.select { |search| search[:expectation] == 'SHALL' }
         else
-            []
+          []
         end
       end
 
@@ -140,70 +164,74 @@ module CarinForBlueButtonTestKit
         return '' if required_searches.blank?
 
         <<~SEARCH_DESCRIPTION
-        ## Searching
-        This test sequence will first perform each required search associated
-        with this resource. This sequence will perform searches with the
-        following parameters:
-
-        #{search_param_name_string}
-
-        ### Search Parameters
-        The first search uses the selected patient(s) from the prior launch
-        sequence. Any subsequent searches will look for its parameter values
-        from the results of the first search. For example, the `identifier`
-        search in the patient sequence is performed by looking for an existing
-        `Patient.identifier` from any of the resources returned in the `_id`
-        search. If a value cannot be found this way, the search is skipped.
-
-        ### Search Validation
-        Inferno will retrieve up to the first 20 bundle pages of the reply for
-        #{search_validation_resource_type} and save them for subsequent tests.
-        Each resource is then checked to see if it matches the searched
-        parameters in accordance with [FHIR search
-        guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
-        for example, if a Patient search for `gender=male` returns a `female`
-        patient.
+          ## Searching
+          This test sequence will first perform each required search associated
+          with this resource. This sequence will perform searches with the
+          following parameters:
+
+          #{search_param_name_string}
+
+          ### Search Parameters
+          The first search uses the selected patient(s) from the prior launch
+          sequence. Any subsequent searches will look for its parameter values
+          from the results of the first search. For example, the `identifier`
+          search in the patient sequence is performed by looking for an existing
+          `Patient.identifier` from any of the resources returned in the `_id`
+          search. If a value cannot be found this way, the search is skipped.
+
+          ### Search Validation
+          Inferno will retrieve up to the first 20 bundle pages of the reply for
+          #{search_validation_resource_type} and save them for subsequent tests.
+          Each resource is then checked to see if it matches the searched
+          parameters in accordance with [FHIR search
+          guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+          for example, if a Patient search for `gender=male` returns a `female`
+          patient.
         SEARCH_DESCRIPTION
       end
 
       def description
         <<~DESCRIPTION
-        # Background
-
-        The CARIN for Blue Button #{title} sequence verifies that the system under test is
-        able to provide correct responses for #{resource_type} queries. These queries
-        must contain resources conforming to the #{profile_name} as
-        specified in the CARIN for Blue Button #{group_metadata.version} Implementation Guide.
-
-        # Testing Methodology
-        #{search_description}
-
-        ## Must Support
-        Each profile contains elements marked as "must support". This test
-        sequence expects to see each of these elements at least once. If at
-        least one cannot be found, the test will fail. The test will look
-        through the #{resource_type} resources found in the first test for these
-        elements.
-
-        ## Profile Validation
-        Each resource returned from the first search is expected to conform to
-        the [#{profile_name}](#{profile_url}). Each element is checked against
-        terminology binding and cardinality requirements.
-
-        Elements with a required binding are validated against their bound
-        ValueSet. If the code/system in the element is not part of the ValueSet,
-        then the test will fail.
-
-        ## Reference Validation
-        At least one instance of each external reference in elements marked as
-        "must support" within the resources provided by the system must resolve.
-        The test will attempt to read each reference found and will fail if no
-        read succeeds.
+          # Background
+
+          The CARIN for Blue Button #{title} sequence verifies that the system under test is
+          able to provide correct responses for #{resource_type} queries. These queries
+          must contain resources conforming to the #{profile_name} as
+          specified in the CARIN for Blue Button #{group_metadata.version} Implementation Guide.
+
+          # Testing Methodology
+          #{search_description}
+
+          ## Must Support
+          Each profile contains elements marked as "must support". This test
+          sequence expects to see each of these elements at least once. If at
+          least one cannot be found, the test will fail. The test will look
+          through the #{resource_type} resources found in the first test for these
+          elements.
+
+          ## Profile Validation
+          Each resource returned from the first search is expected to conform to
+          the [#{profile_name}](#{profile_url}). Each element is checked against
+          terminology binding and cardinality requirements.
+
+          Elements with a required binding are validated against their bound
+          ValueSet. If the code/system in the element is not part of the ValueSet,
+          then the test will fail.
+
+          ## Reference Validation
+          At least one instance of each external reference in elements marked as
+          "must support" within the resources provided by the system must resolve.
+          The test will attempt to read each reference found and will fail if no
+          read succeeds.
         DESCRIPTION
       end
 
       def is_eob_subgroup?
-        base_output_file_name.match(/benefit_.+_group/)
+        base_output_file_name.match(/eob_.+_group/)
+      end
+
+      def is_eob_root_group?
+        resource_type == 'ExplanationOfBenefit' && !is_eob_subgroup?
       end
     end
   end

data/lib/carin_for_blue_button_test_kit/generator/group_metadata.rb

@@ -1,87 +1,89 @@
+# frozen_string_literal: true
+
 module CarinForBlueButtonTestKit
-    class Generator
-      class GroupMetadata
-        ATTRIBUTES = [
-          :name,
-          :class_name,
-          :version,
-          :reformatted_version,
-          :resource,
-          :profile_url,
-          :profile_name,
-          :profile_version,
-          :title,
-          :short_description,
-          :interactions,
-          :operations,
-          :searches,
-          :search_definitions,
-          :include_params,
-          :revincludes,
-          :required_concepts,
-          :must_supports,
-          :mandatory_elements,
-          :bindings,
-          :references,
-          :tests,
-          :id,
-          :file_name,
-          :delayed_references
-        ].freeze
-  
-        ATTRIBUTES.each { |name| attr_accessor name }
-  
-        def initialize(metadata)
-          metadata.each do |key, value|
-            raise "Unknown attribute #{key}" unless ATTRIBUTES.include? key
-  
-            instance_variable_set(:"@#{key}", value)
-          end
-        end
-  
-        def delayed?
-          return false if resource == 'Patient'
-  
-          true
+  class Generator
+    class GroupMetadata
+      ATTRIBUTES = %i[
+        name
+        class_name
+        version
+        reformatted_version
+        resource
+        conformance_expectation
+        profile_url
+        profile_name
+        profile_version
+        title
+        short_description
+        interactions
+        operations
+        searches
+        search_definitions
+        include_params
+        revincludes
+        required_concepts
+        must_supports
+        mandatory_elements
+        bindings
+        references
+        tests
+        id
+        file_name
+        delayed_references
+      ].freeze
+
+      ATTRIBUTES.each { |name| attr_accessor name }
+
+      def initialize(metadata)
+        metadata.each do |key, value|
+          raise "Unknown attribute #{key}" unless ATTRIBUTES.include? key
+
+          instance_variable_set(:"@#{key}", value)
         end
-  
-        def no_patient_searches?
-          searches.none? { |search| search[:names].include? 'patient' }
+      end
+
+      def delayed?
+        return false if resource == 'Patient'
+        no_patient_searches?
+      end
+
+      def no_patient_searches?
+        searches.none? { |search| search[:names].include? 'patient' }
+      end
+
+      def add_test(id:, file_name:)
+        self.tests ||= []
+
+        test_metadata = {
+          id:,
+          file_name:
+        }
+
+        if !delayed? && !id.include?('include') && id.include?('patient_search')
+          self.tests.unshift(test_metadata)
+
+        else
+          self.tests << test_metadata
         end
-  
-        def add_test(id:, file_name:)
-          self.tests ||= []
-  
-          test_metadata = {
-            id: id,
-            file_name: file_name
-          }
-  
-          if delayed? && id.include?('read')
-            self.tests.unshift(test_metadata)
-          else
-            self.tests << test_metadata
+      end
+
+      def to_hash
+        ATTRIBUTES.each_with_object({}) { |key, hash| hash[key] = send(key) unless send(key).nil? }
+      end
+
+      def add_delayed_references(delayed_profiles, ig_resources)
+        self.delayed_references =
+          references
+            .select { |reference| (reference[:profiles] & delayed_profiles).present? }
+            .map do |reference|
+            profile_urls = (reference[:profiles] & delayed_profiles)
+            delayed_resources = profile_urls.map { |url| ig_resources.resource_for_profile(url) }
+            {
+              path: reference[:path].gsub("#{resource}.", ''),
+              resources: delayed_resources
+            }
           end
-        end
-  
-        def to_hash
-          ATTRIBUTES.each_with_object({}) { |key, hash| hash[key] = send(key) unless send(key).nil? }
-        end
-  
-        def add_delayed_references(delayed_profiles, ig_resources)
-          self.delayed_references =
-            references
-              .select { |reference| (reference[:profiles] & delayed_profiles).present? }
-              .map do |reference|
-                profile_urls = (reference[:profiles] & delayed_profiles)
-                delayed_resources = profile_urls.map { |url| ig_resources.resource_for_profile(url) }
-                {
-                  path: reference[:path].gsub("#{resource}.", ''),
-                  resources: delayed_resources
-                }
-              end
-        end
       end
     end
   end
-  
+end