ipa_test_kit 0.2.0 → 0.3.1

data/lib/ipa_test_kit/generator/reference_resolution_test_generator.rb

@@ -5,17 +5,18 @@ module IpaTestKit
   class Generator
     class ReferenceResolutionTestGenerator
       class << self
-        def generate(ig_metadata)
+        def generate(ig_metadata, base_output_dir)
           ig_metadata.groups
-            .reject { |group| SpecialCases.exclude_resource? group.resource }
-            .each { |group| new(group).generate }
+            .reject { |group| SpecialCases.exclude_group? group }
+            .each { |group| new(group, base_output_dir).generate }
         end
       end
 
-      attr_accessor :group_metadata
+      attr_accessor :group_metadata, :base_output_dir
 
-      def initialize(group_metadata)
+      def initialize(group_metadata, base_output_dir)
         self.group_metadata = group_metadata
+        self.base_output_dir = base_output_dir
       end
 
       def template
@@ -31,7 +32,7 @@ module IpaTestKit
       end
 
       def output_file_directory
-        File.join(__dir__, '..', 'generated', profile_identifier)
+        File.join(base_output_dir, profile_identifier)
       end
 
       def output_file_name
@@ -43,13 +44,17 @@ module IpaTestKit
       end
 
       def test_id
-        "ipa_010_#{profile_identifier}_reference_resolution_test"
+        "ipa_#{group_metadata.reformatted_version}_#{profile_identifier}_reference_resolution_test"
       end
 
       def class_name
         "#{Naming.upper_camel_case_for_profile(group_metadata)}ReferenceResolutionTest"
       end
 
+      def module_name
+        "Ipa#{group_metadata.reformatted_version.upcase}"
+      end
+
       def resource_type
         group_metadata.resource
       end
@@ -58,7 +63,22 @@ module IpaTestKit
         'scratch_resources[:all]'
       end
 
+      def must_support_references
+        group_metadata.must_supports[:elements]
+          .select { |element| element[:types]&.include?('Reference') }
+      end
+      
+      def must_support_reference_list_string
+        must_support_references
+          .map { |element| "#{' ' * 8}* #{resource_type}.#{element[:path]}" }
+          .uniq
+          .sort
+          .join("\n")
+      end
+
       def generate
+        return if must_support_references.empty?
+
         FileUtils.mkdir_p(output_file_directory)
         File.open(output_file_name, 'w') { |f| f.write(output) }
 

data/lib/ipa_test_kit/generator/resource_list_generator.rb

@@ -2,11 +2,11 @@ module IpaTestKit
   class Generator
     class ResourceListGenerator
       class << self
-        def generate(ig_metadata)
+        def generate(ig_metadata, base_output_dir)
           @ig_metadata = ig_metadata
 
-          FileUtils.mkdir_p(output_file_directory)
-          File.open(output_file_name, 'w') { |f| f.write(output) }
+          FileUtils.mkdir_p(base_output_dir)
+          File.open(File.join(base_output_dir, base_output_file_name), 'w') { |f| f.write(output) }
         end
 
         def resource_list
@@ -17,6 +17,10 @@ module IpaTestKit
           resource_list.map { |resource| "      '#{resource}'" }.join(",\n")
         end
 
+        def module_name
+          "Ipa#{@ig_metadata.reformatted_version.upcase}"
+        end
+
         def read_interaction(group_metadata)
           group_metadata.interactions.find { |interaction| interaction[:code] == 'read' }
         end
@@ -26,20 +30,12 @@ module IpaTestKit
         end
 
         def output
-          @output ||= ERB.new(template).result(binding)
+          ERB.new(template).result(binding)
         end
 
         def base_output_file_name
           "resource_list.rb"
         end
-
-        def output_file_directory
-          File.join(__dir__, '..', 'generated')
-        end
-
-        def output_file_name
-          File.join(output_file_directory, base_output_file_name)
-        end
       end
     end
   end

data/lib/ipa_test_kit/generator/search_definition_metadata_extractor.rb

@@ -1,20 +1,23 @@
+require_relative 'value_extractor'
+
 module IpaTestKit
   class Generator
     class SearchDefinitionMetadataExtractor
-      attr_accessor :ig_resources, :name, :resource, :profile_elements
+      attr_accessor :ig_resources, :name, :resource, :profile_elements, :base_search_params
 
-      def initialize(name, ig_resources, resource, profile_elements)
+      def initialize(name, ig_resources, resource, profile_elements, base_search_params)
         self.name = name
         self.ig_resources = ig_resources
         self.resource = resource
         self.profile_elements = profile_elements
+        self.base_search_params = base_search_params
       end
 
       def search_definition
         @search_definition ||=
           {
-            path: path,
-            full_path: full_path,
+            paths: paths,
+            full_paths: full_paths,
             comparators: comparators,
             values: values,
             type: type,
@@ -25,31 +28,39 @@ module IpaTestKit
       end
 
       def param
-        @param ||= ig_resources.search_param_by_resource_and_name(resource, name)
+        @param ||= ig_resources.search_param_by_resource_and_name(resource, name) || search_base_param_by_resource_and_name(resource, name)
+      end
+
+      def search_base_param_by_resource_and_name(resource, name)
+        search_param = base_search_params['entry'].find{|entry| entry['resource']['code'] == name && (entry['resource']['base'].include?(resource) || entry['resource']['base'].include?('Resource'))}
+        FHIR::SearchParameter.new(search_param['resource'])
       end
 
       def param_hash
         param.source_hash
       end
 
-      def full_path
-        @full_path ||=
+      def full_paths
+        @full_paths ||=
           begin
-            path = param.expression.gsub(/.where\((.*)/, '')
+            path = param.expression.gsub(/\.where\(resolve\(\)[^\)]*\)/, '')
+            path = path.gsub(/.where\((.*)/, '')
             path = path[1..-2] if path.start_with?('(') && path.end_with?(')')
-            as_type = path.scan(/[. ]as[( ]([^)]*)[)]?/).flatten.first
-            path.gsub!(/[. ]as[( ]([^)]*)[)]?/, as_type.upcase_first) if as_type.present?
-            path
+            path.scan(/[. ]as[( ]([^)]*)[)]?/).flatten.map do |as_type|
+              path.gsub!(/[. ]as[( ](#{as_type}[^)]*)[)]?/, as_type.upcase_first) if as_type.present?
+            end
+            path.gsub!("Resource.", "#{resource}.")
+            path.split('|').map(&:strip)
           end
       end
 
-      def path
-        @path ||= full_path.gsub("#{resource}.", '')
+      def paths
+        @paths ||= full_paths.map { |a_path| a_path.gsub("#{resource}.", '')}
       end
 
       def profile_element
         @profile_element ||=
-          profile_elements.find { |element| element.id == full_path }
+          profile_elements.find { |element| full_paths.include?(element.id) }
       end
 
       def comparator_expectation_extensions
@@ -107,74 +118,25 @@ module IpaTestKit
       end
 
       def multiple_or_expectation
-        param_hash['_multipleOr']['extension'].first['valueCode']
+        param_hash['_multipleOr']&.[]('extension')&.first&.[]('valueCode')
       end
 
       def values
-        (
-          values_from_slices +
-          values_from_fixed_codes +
-          values_from_pattern_codeable_concept +
-          values_from_value_set_binding
-        ).uniq.presence || values_from_resource_metadata
-      end
-
-      def slices
-        return [] unless contains_multiple?
-
-        profile_elements.select do |element|
-          element.path == full_path &&
-            element.sliceName.present? &&
-            element.patternCodeableConcept.present?
-        end
+          value_extractor.values_from_slicing(profile_element, type).presence ||
+          value_extractor.values_from_value_set_binding(profile_element).presence ||
+          values_from_resource_metadata(paths).presence || []
       end
 
-      def values_from_slices
-        slices.map do |slice|
-          slice.patternCodeableConcept.coding.first.code
+      def values_from_resource_metadata(paths)
+        if multiple_or_expectation == 'SHALL' || paths.any? { |path| path.downcase.include?('status') }
+          value_extractor.values_from_resource_metadata(paths)
+        else
+          []
         end
       end
 
-      def values_from_fixed_codes
-        return [] unless type == 'CodeableConcept'
-
-        profile_elements
-          .select { |element| element.path == "#{profile_element.path}.coding.code" && element.fixedCode.present? }
-          .map { |element| element.fixedCode }
-      end
-
-      def values_from_pattern_codeable_concept
-        return [] if type != 'CodeableConcept' || profile_element.patternCodeableConcept.blank?
-
-        [profile_element.patternCodeableConcept.coding.first.code]
-      end
-
-      def value_set_binding
-        profile_element&.binding
-      end
-
-      def value_set
-        ig_resources.value_set_by_url(value_set_binding&.valueSet)
-      end
-
-      def bound_systems
-        value_set&.compose&.include&.reject { |code| code.concept.nil? }
-      end
-
-      def values_from_value_set_binding
-        return [] if bound_systems.blank?
-
-        bound_systems.flat_map { |system| system.concept.map { |code| code.code } }.uniq
-      end
-
-      def fhir_metadata
-        FHIR.const_get(resource)::METADATA[path.gsub("#{resource}.", '')]
-      end
-
-      def values_from_resource_metadata
-        return [] if fhir_metadata&.dig('valid_codes').blank?
-
-        fhir_metadata['valid_codes'].values.flatten
+      def value_extractor
+        @value_extractor ||= ValueExactor.new(ig_resources, resource, profile_elements)
       end
     end
   end

data/lib/ipa_test_kit/generator/search_metadata_extractor.rb

@@ -6,13 +6,14 @@ module IpaTestKit
       COMBO_EXTENSION_URL =
         'http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination'.freeze
 
-      attr_accessor :resource_capabilities, :ig_resources, :resource, :profile_elements
+      attr_accessor :resource_capabilities, :ig_resources, :resource, :profile_elements, :base_search_params
 
-      def initialize(resource_capabilities, ig_resources, resource, profile_elements)
+      def initialize(resource_capabilities, ig_resources, resource, profile_elements, base_search_params)
         self.resource_capabilities = resource_capabilities
         self.ig_resources = ig_resources
         self.resource = resource
         self.profile_elements = profile_elements
+        self.base_search_params = base_search_params
       end
 
       def searches
@@ -66,7 +67,7 @@ module IpaTestKit
       def search_definitions
         search_param_names.each_with_object({}) do |name, definitions|
           definitions[name.to_sym] =
-            SearchDefinitionMetadataExtractor.new(name, ig_resources, resource, profile_elements).search_definition
+            SearchDefinitionMetadataExtractor.new(name, ig_resources, resource, profile_elements, base_search_params).search_definition
         end
       end
     end

data/lib/ipa_test_kit/generator/search_test_generator.rb

@@ -5,21 +5,22 @@ module IpaTestKit
   class Generator
     class SearchTestGenerator
       class << self
-        def generate(ig_metadata)
+        def generate(ig_metadata, base_output_dir)
           ig_metadata.groups
-            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .reject { |group| SpecialCases.exclude_group? group }
             .select { |group| group.searches.present? }
             .each do |group|
-              group.searches.each { |search| new(group, search).generate }
+              group.searches.each { |search| new(group, search, base_output_dir).generate }
             end
         end
       end
 
-      attr_accessor :group_metadata, :search_metadata
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir
 
-      def initialize(group_metadata, search_metadata)
+      def initialize(group_metadata, search_metadata, base_output_dir)
         self.group_metadata = group_metadata
         self.search_metadata = search_metadata
+        self.base_output_dir = base_output_dir
       end
 
       def template
@@ -35,7 +36,7 @@ module IpaTestKit
       end
 
       def output_file_directory
-        File.join(__dir__, '..', 'generated', profile_identifier)
+        File.join(base_output_dir, profile_identifier)
       end
 
       def output_file_name
@@ -47,7 +48,7 @@ module IpaTestKit
       end
 
       def test_id
-        "ipa_010_#{profile_identifier}_#{search_identifier}_search_test"
+        "ipa_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_search_test"
       end
 
       def search_identifier
@@ -62,6 +63,10 @@ module IpaTestKit
         "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}SearchTest"
       end
 
+      def module_name
+        "Ipa#{group_metadata.reformatted_version.upcase}"
+      end
+
       def resource_type
         group_metadata.resource
       end
@@ -127,7 +132,7 @@ module IpaTestKit
       end
 
       def optional?
-        conformance_expectation != 'SHALL' || !search_metadata[:must_support_or_mandatory] 
+        conformance_expectation != 'SHALL' || !search_metadata[:must_support_or_mandatory]
       end
 
       def search_definition(name)
@@ -138,11 +143,6 @@ module IpaTestKit
         first_search? && group_metadata.delayed_references.present?
       end
 
-      def possible_status_search?
-        !search_metadata[:names].any? { |name| name.include? 'status' } &&
-          group_metadata.search_definitions.keys.any? { |key| key.to_s.include? 'status' }
-      end
-
       def token_search_params
         @token_search_params ||=
           search_param_names.select do |name|
@@ -178,14 +178,10 @@ module IpaTestKit
         first_search? && search_param_names.include?('patient')
       end
 
-      def test_medication_inclusion_mr?
+      def test_medication_inclusion?
         resource_type == 'MedicationRequest'
       end
 
-      def test_medication_inclusion_ms?
-        resource_type == 'MedicationStatement'
-      end
-
       def test_post_search?
         first_search?
       end
@@ -197,9 +193,7 @@ module IpaTestKit
           properties[:resource_type] = "'#{resource_type}'"
           properties[:search_param_names] = search_param_names_array
           properties[:saves_delayed_references] = 'true' if saves_delayed_references?
-          properties[:possible_status_search] = 'true' if possible_status_search?
-          properties[:test_medication_inclusion_mr] = 'true' if test_medication_inclusion_mr?
-          properties[:test_medication_inclusion_ms] = 'true' if test_medication_inclusion_ms?
+          properties[:test_medication_inclusion] = 'true' if test_medication_inclusion?
           properties[:token_search_params] = token_search_params_string if token_search_params.present?
           properties[:test_reference_variants] = 'true' if test_reference_variants?
           properties[:params_with_comparators] = required_comparators_string if required_comparators.present?
@@ -208,6 +202,15 @@ module IpaTestKit
         end
       end
 
+      def url_version
+        case group_metadata.version
+        when 'v3.1.1'
+          'STU3.1.1'
+        when 'v4.0.0'
+          'STU4'
+        end
+      end
+
       def search_test_properties_string
         search_properties
           .map { |key, value| "#{' ' * 8}#{key}: #{value}" }
@@ -231,7 +234,7 @@ module IpaTestKit
         This test verifies that the server supports searching by reference using
         the form `patient=[id]` as well as `patient=Patient/[id]`. The two
         different forms are expected to return the same number of results. IPA
-        requires that both forms are supported by IPA responders.
+        requires that both forms are supported by IPA Core responders.
         REFERENCE_SEARCH_DESCRIPTION
       end
 
@@ -244,24 +247,14 @@ module IpaTestKit
         FIRST_SEARCH_DESCRIPTION
       end
 
-      def medication_inclusion_mr_description
-        return '' unless test_medication_inclusion_mr?
+      def medication_inclusion_description
+        return '' unless test_medication_inclusion?
 
-        <<~MEDICATION_INCLUSION_MR_DESCRIPTION
+        <<~MEDICATION_INCLUSION_DESCRIPTION
         If any MedicationRequest resources use external references to
         Medications, the search will be repeated with
         `_include=MedicationRequest:medication`.
-        MEDICATION_INCLUSION_MR_DESCRIPTION
-      end
-
-      def medication_inclusion_ms_description
-        return '' unless test_medication_inclusion_ms?
-
-        <<~MEDICATION_INCLUSION_MS_DESCRIPTION
-        If any MedicationStatement resources use external references to
-        Medications, the search will be repeated with
-        `_include=MedicationStatement:medication`.
-        MEDICATION_INCLUSION_MS_DESCRIPTION
+        MEDICATION_INCLUSION_DESCRIPTION
       end
 
       def post_search_description
@@ -271,7 +264,7 @@ module IpaTestKit
         Additionally, this test will check that GET and POST search methods
         return the same number of results. Search by POST is required by the
         FHIR R4 specification, and these tests interpret search by GET as a
-        requirement of IPA v0.1.0.
+        requirement of IPA #{group_metadata.version}.
         POST_SEARCH_DESCRIPTION
       end
 
@@ -287,7 +280,9 @@ module IpaTestKit
         #{first_search_description}
         #{post_search_description}
 
-        [IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+        # TODO: Fix this
+        # [US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/#{url_version}/CapabilityStatement-us-core-server.html)
+
         DESCRIPTION
       end
     end

data/lib/ipa_test_kit/generator/special_cases.rb

@@ -2,13 +2,17 @@ module IpaTestKit
   class Generator
     module SpecialCases
       RESOURCES_TO_EXCLUDE = [
-        'Medication',
-        #'PractitionerRole'
+        'Location'
+      ].freeze
+
+      PROFILES_TO_EXCLUDE = [
+        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-survey',
+        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs'
       ].freeze
 
       class << self
-        def exclude_resource?(resource)
-          RESOURCES_TO_EXCLUDE.include? resource
+        def exclude_group?(group)
+          RESOURCES_TO_EXCLUDE.include?(group&.resource)
         end
       end
     end

data/lib/ipa_test_kit/generator/suite_generator.rb

@@ -5,15 +5,16 @@ module IpaTestKit
   class Generator
     class SuiteGenerator
       class << self
-        def generate(ig_metadata)
-          new(ig_metadata).generate
+        def generate(ig_metadata, base_output_dir)
+          new(ig_metadata, base_output_dir).generate
         end
       end
 
-      attr_accessor :ig_metadata
+      attr_accessor :ig_metadata, :base_output_dir
 
-      def initialize(ig_metadata)
+      def initialize(ig_metadata, base_output_dir)
         self.ig_metadata = ig_metadata
+        self.base_output_dir = base_output_dir
       end
 
       def template
@@ -32,16 +33,32 @@ module IpaTestKit
         "IpaTestSuite"
       end
 
+      def module_name
+        "Ipa#{ig_metadata.reformatted_version.upcase}"
+      end
+
       def output_file_name
-        File.join(__dir__, '..', 'generated', base_output_file_name)
+        File.join(base_output_dir, base_output_file_name)
       end
 
       def suite_id
-        'ipa_010'
+        "ipa_#{ig_metadata.reformatted_version}"
       end
 
       def title
-        'IPA 3.1.1'
+        "International Patient Access (#{ig_metadata.ig_version})"
+      end
+
+      def short_title
+        "IPA #{ig_metadata.ig_version}"
+      end
+
+      def validator_env_name
+        "IPA_#{ig_metadata.reformatted_version.upcase}_VALIDATOR_URL"
+      end
+
+      def ig_link
+        'http://build.fhir.org/ig/HL7/fhir-ipa/'
       end
 
       def generate
@@ -50,7 +67,7 @@ module IpaTestKit
 
       def groups
         ig_metadata.ordered_groups
-          .reject { |group| SpecialCases.exclude_resource? group.resource }
+          .reject { |group| SpecialCases.exclude_group? group }
       end
 
       def group_id_list
@@ -62,6 +79,22 @@ module IpaTestKit
         @group_file_list ||=
           groups.map { |group| group.file_name.delete_suffix('.rb') }
       end
+
+      def capability_statement_file_name
+        "../../custom_groups/#{ig_metadata.ig_version}/capability_statement_group"
+      end
+
+      def capability_statement_group_id
+        "ipa_#{ig_metadata.reformatted_version}_capability_statement"
+      end
+
+      def smart_launch_file_name
+        "../../custom_groups/#{ig_metadata.ig_version}/ipa_smart_launch_group"
+      end
+
+      def smart_launch_group_id
+        "ipa_#{ig_metadata.reformatted_version}_smart_launch"
+      end
     end
   end
 end

data/lib/ipa_test_kit/generator/terminology_binding_metadata_extractor.rb

@@ -27,21 +27,33 @@ module IpaTestKit
         end
       end
 
+      def element_has_optional_binding_slice?(element)
+        element.sliceName.present? && element.min == 0
+      end
+
       def profile_elements_with_bindings
         profile_elements
-          .select { |element| element.binding.present? }
-          .reject { |element| element_has_fixed_value? element }
+          .select { |element| element.binding.present? && element.binding.strength == 'required'}
+          .reject { |element| element_has_fixed_value?(element) || element_has_optional_binding_slice?(element) }
       end
 
+
+
       def element_terminology_bindings
         profile_elements_with_bindings.map do |element|
-          {
+          binding = {
             type: element.type.first.code,
             strength: element.binding.strength,
             # Goal.target.detail has an unbound binding
             system: element.binding.valueSet&.split('|')&.first,
             path: element.path.gsub('[x]', '').gsub("#{resource}.", '')
           }
+
+          if element.sliceName.present? && element.min > 0
+            binding[:required_binding_slice] = true
+          end
+
+          binding
         end
       end
 
@@ -61,6 +73,9 @@ module IpaTestKit
             url = extension_profile_url(extension_profile_element)
             extension = ig_resources.profile_by_url(url)
 
+            # TODO: Temporaray fix for extension defined out of US Core. FI-1623
+            next if extension.nil?
+
             elements = extension.snapshot.element
             elements_with_bindings = elements.select do |element|
               element.binding.present? && !element.id.include?('Extension.extension')