carin_for_blue_button_test_kit 0.9.0

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0/practitioner_group.rb

@@ -0,0 +1,81 @@
+require_relative 'practitioner/practitioner_read_test'
+    require_relative 'practitioner/practitioner_validation_test'
+    require_relative 'practitioner/practitioner_must_support_test'
+    
+    module CarinForBlueButtonTestKit
+      module CARIN4BBV200
+        class PractitionerGroup < Inferno::TestGroup
+          title 'Practitioner Tests'
+          short_description 'Verify support for the server capabilities required by the C4BB Practitioner.'
+          description %(
+      # Background
+
+The CARIN for Blue Button Practitioner sequence verifies that the system under test is
+able to provide correct responses for Practitioner queries. These queries
+must contain resources conforming to the C4BB Practitioner as
+specified in the CARIN for Blue Button v2.0.0 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
+Practitioner 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 Practitioner 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 Practitioner](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner). 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_v200_practitioner
+          run_as_group
+    
+          def self.metadata
+            @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'practitioner', 'metadata.yml'), aliases: true))
+          end
+      
+          test from: :c4bb_v200_practitioner_read_test
+          test from: :c4bb_v200_practitioner_validation_test
+          test from: :c4bb_v200_practitioner_must_support_test
+        end
+      end
+    end
+    

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0/related_person/related_person_must_support_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../must_support_test'
+require_relative './related_person_read_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200
+    class RelatedPersonMustSupportTest < Inferno::Test
+      include CarinForBlueButtonTestKit::MustSupportTest
+      include CarinForBlueButtonTestKit::CARIN4BBV200
+
+      title 'All must support elements are provided in the RelatedPerson resources returned'
+      description %(
+        CARIN for Blue Button Responders SHALL be capable of populating all data elements as
+        part of the query results as specified by the CARIN for Blue Button Capability
+        Statement. This test will look through the RelatedPerson resources
+        found previously for the following must support elements:
+
+        * RelatedPerson.active
+        * RelatedPerson.address
+        * RelatedPerson.meta
+        * RelatedPerson.meta.lastUpdated
+        * RelatedPerson.name
+        * RelatedPerson.patient
+        * RelatedPerson.relationship
+        * RelatedPerson.telecom
+      )
+
+      id :c4bb_v200_related_person_must_support_test
+
+      def resource_type
+        'RelatedPerson'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:related_person_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0/related_person/related_person_read_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../../read_test'
+require 'json'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200
+    class RelatedPersonReadTest < Inferno::Test
+      include CarinForBlueButtonTestKit::ReadTest
+
+      title 'Server returns correct RelatedPerson resource from RelatedPerson read interaction'
+      description 'A server SHALL support the RelatedPerson read interaction.'
+
+      id :c4bb_v200_related_person_read_test
+
+      input :related_person_ids,
+        title: "related_person IDs",
+        type: 'text',
+        description: "related_person Resource ID"
+
+      input_order :url, :smart_credentials, :related_person_ids
+
+      def resource_type
+        'RelatedPerson'
+      end
+
+      def scratch_resources
+        scratch[:related_person_resources] ||= {}
+      end
+
+      def related_person_id_list
+        return [nil] unless respond_to? :related_person_ids
+        related_person_ids.split(',').map(&:strip)
+      end
+
+      run do
+        perform_read_test(related_person_id_list)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0/related_person/related_person_validation_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../validation_test'
+require_relative './related_person_read_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200
+    class RelatedPersonValidationTest < Inferno::Test
+      include CarinForBlueButtonTestKit::ValidationTest
+      include CarinForBlueButtonTestKit::CARIN4BBV200
+
+      id :c4bb_v200_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[:related_person_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/related_person_group.rb

@@ -0,0 +1,81 @@
+require_relative 'related_person/related_person_read_test'
+    require_relative 'related_person/related_person_validation_test'
+    require_relative 'related_person/related_person_must_support_test'
+    
+    module CarinForBlueButtonTestKit
+      module CARIN4BBV200
+        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 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_v200_related_person
+          run_as_group
+    
+          def self.metadata
+            @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'related_person', 'metadata.yml'), aliases: true))
+          end
+      
+          test from: :c4bb_v200_related_person_read_test
+          test from: :c4bb_v200_related_person_validation_test
+          test from: :c4bb_v200_related_person_must_support_test
+        end
+      end
+    end
+    

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0/resource_list.rb

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

data/lib/carin_for_blue_button_test_kit/generator/group_generator.rb

@@ -0,0 +1,210 @@
+require_relative 'naming'
+
+module CarinForBlueButtonTestKit
+  class Generator
+    class GroupGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.ordered_groups
+            .each { |group| new(group, base_output_dir).generate }
+        end
+      end
+
+      attr_accessor :group_metadata, :base_output_dir
+
+      def initialize(group_metadata, base_output_dir)
+        self.group_metadata = group_metadata
+        self.base_output_dir = base_output_dir
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'group.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def base_metadata_file_name
+        "metadata.yml"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}Group"
+      end
+
+      def module_name
+        "CARIN4BB#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def title
+        group_metadata.title
+      end
+
+      def short_description
+        group_metadata.short_description
+      end
+
+      def output_file_name
+        File.join(base_output_dir, base_output_file_name)
+      end
+
+      def metadata_file_name
+        File.join(base_output_dir, profile_identifier, base_metadata_file_name)
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def group_id
+        "c4bb_#{group_metadata.reformatted_version}_#{profile_identifier}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def search_validation_resource_type
+        text = "#{resource_type} resources"
+        text
+      end
+
+      def profile_name
+        group_metadata.profile_name
+      end
+
+      def profile_url
+        group_metadata.profile_url
+      end
+
+
+      def optional?
+        resource_type == 'QuestionnaireResponse'
+      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)) }
+      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
+
+        @test_id_list
+      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
+      end
+
+      def required_searches
+        if !group_metadata.searches.nil? && !is_eob_subgroup?
+            group_metadata.searches.select { |search| search[:expectation] == 'SHALL' }
+        else
+            []
+        end
+      end
+
+      def search_param_name_string
+        required_searches
+          .map { |search| search[:names].join(' + ') }
+          .map { |names| "* #{names}" }
+          .join("\n")
+      end
+
+      def search_description
+        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.
+        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.
+        DESCRIPTION
+      end
+
+      def is_eob_subgroup?
+        base_output_file_name.match(/benefit_.+_group/)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generator/group_metadata.rb

@@ -0,0 +1,87 @@
+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
+        end
+  
+        def no_patient_searches?
+          searches.none? { |search| search[:names].include? 'patient' }
+        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
+        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
+