davinci_plan_net_test_kit 0.9.0

data/lib/davinci_plan_net_test_kit/generator/include_search_test_generator.rb

@@ -0,0 +1,205 @@
+require_relative 'naming'
+require_relative 'special_cases'
+
+module DaVinciPlanNetTestKit
+  class Generator
+    class IncludeSearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+            .reject { |group| SpecialCases.exclude_group? group }
+            .select { |group| !group.include_params.empty? }
+            .each do |group|
+              group.include_params.each { |include_param| new(group, group.searches.first, base_output_dir, include_param).generate }
+            end
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir, :include_param
+
+      def initialize(group_metadata, search_metadata, base_output_dir, include_param)
+        self.group_metadata = group_metadata
+        self.search_metadata = search_metadata
+        self.base_output_dir = base_output_dir
+        self.include_param = include_param
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'include_search.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def output_file_directory
+        File.join(base_output_dir, profile_identifier.downcase)
+      end
+
+      def output_file_name
+        File.join(output_file_directory, base_output_file_name)
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "davinci_plan_net_#{group_metadata.reformatted_version}_include_#{profile_identifier}_#{search_identifier}_search_test"
+      end
+
+      def search_identifier
+        include_param.gsub(/[-:]/, '_').underscore
+      end
+
+      def search_title
+        search_identifier.camelize
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}Include#{search_title}SearchTest"
+      end
+
+      def module_name
+        "DaVinciPlanNet#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def search_params
+        @search_params ||=
+          search_metadata[:names].map do |name|
+            {
+              name: name,
+              path: search_definition(name)[:path]
+            }
+          end
+      end
+
+      def first_search?
+        group_metadata.searches.first == search_metadata
+      end
+
+      def fixed_value_search?
+        #TODO
+        false
+      end
+
+      def fixed_value_search_param_name
+        #TODO
+      end
+
+      def include_param_string
+        "_include=#{include_param}"
+      end
+
+      def include_param_resource
+        res_type = group_metadata.search_definitions[:"#{include_param.split(/:/)[1]}"][:type]
+        res_type = group_metadata.search_definitions[:"#{include_param.split(/:/)[1]}"][:target] if res_type == "Reference"
+        res_type
+      end
+
+      def inc_param_sp
+        include_param.split(/:/)[1]
+      end
+
+      def search_param_names
+        search_params.map { |param| param[:name] }
+      end
+
+      def search_param_names_array
+        array_of_strings(search_param_names)
+      end
+
+      def path_for_value(path)
+        path == 'class' ? 'local_class' : path
+      end
+
+      def required_comparators_for_param(name)
+        search_definition(name)[:comparators].select { |_comparator, expectation| expectation == 'SHALL' }
+      end
+
+      def required_comparators
+        @required_comparators ||=
+          search_param_names.each_with_object({}) do |name, comparators|
+            required_comparators = required_comparators_for_param(name)
+            comparators[name] = required_comparators if required_comparators.present?
+          end
+      end
+
+      def search_definition(name)
+        group_metadata.search_definitions[name.to_sym]
+      end
+
+      def saves_delayed_references?
+        first_search? && group_metadata.delayed_references.present?
+      end
+
+      def possible_status_search?
+        !search_metadata[:names].include?('status') && group_metadata.search_definitions.key?(:status)
+      end
+
+      def token_search_params
+        @token_search_params ||=
+          search_param_names.select do |name|
+            ['Identifier', 'CodeableConcept', 'Coding'].include? group_metadata.search_definitions[name.to_sym][:type]
+          end
+      end
+
+      def token_search_params_string
+        array_of_strings(token_search_params)
+      end
+
+      def required_comparators_string
+        array_of_strings(required_comparators.keys)
+      end
+
+      def array_of_strings(array)
+        quoted_strings = array.map { |element| "'#{element}'" }
+        "[#{quoted_strings.join(', ')}]"
+      end
+
+      def a_or_an(name)
+        ['a','e','i','o','u'].include?(name.first.downcase) ? "an #{name}" : "a #{name}"
+      end
+
+      def input_name
+        "#{search_identifier.downcase}_input"
+      end
+
+      def search_properties
+        {}.tap do |properties|
+          properties[:fixed_value_search] = 'true' if fixed_value_search?
+          properties[:resource_type] = "'#{resource_type}'"
+          properties[:search_param_names] = []
+          properties[:possible_status_search] = 'true' if possible_status_search?
+          properties[:include_param] = "'#{include_param}'"
+          properties[:inc_param_sp] = "'#{inc_param_sp}'"
+          properties[:additional_resource_type] = "'#{include_param_resource}'"
+        end
+      end
+
+      def search_test_properties_string
+        search_properties
+          .map { |key, value| "#{' ' * 10}#{key}: #{value}" }
+          .join(",\n")
+      end
+
+      def generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+
+        group_metadata.add_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+    end
+  end
+end

data/lib/davinci_plan_net_test_kit/generator/must_support_metadata_extractor.rb

@@ -0,0 +1,337 @@
+require_relative 'value_extractor'
+require_relative 'must_support_metadata_extractor_us_core_3'
+
+
+module DaVinciPlanNetTestKit
+  class Generator
+    class MustSupportMetadataExtractor
+      attr_accessor :profile_elements, :profile, :resource, :ig_resources
+
+      def initialize(profile_elements, profile, resource, ig_resources)
+        self.profile_elements = profile_elements
+        self.profile = profile
+        self.resource = resource
+        self.ig_resources = ig_resources
+      end
+
+      def must_supports
+        @must_supports = {
+          extensions: must_support_extensions,
+          slices: must_support_slices,
+          elements: must_support_elements
+        }
+
+        handle_special_cases
+
+        @must_supports
+      end
+
+      def is_uscdi_requirement_element?(element)
+        element.extension.any? do |extension|
+          extension.url == 'http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement' &&
+          extension.valueBoolean
+        end && !element.mustSupport
+      end
+
+      def all_must_support_elements
+        profile_elements.select { |element| element.mustSupport || is_uscdi_requirement_element?(element) }
+      end
+
+      def must_support_extension_elements
+        all_must_support_elements.select { |element| element.path.end_with? 'extension' }
+      end
+
+      def must_support_extensions
+        must_support_extension_elements.map do |element|
+          {
+            id: element.id,
+            url: element.type.first.profile.first
+          }.tap do |metadata|
+            if is_uscdi_requirement_element?(element)
+              metadata[:uscdi_only] = true
+            end
+          end
+        end
+      end
+
+      def must_support_slice_elements
+        all_must_support_elements.select { |element| !element.path.end_with?('extension') && element.sliceName.present? }
+      end
+
+      def sliced_element(slice)
+        profile_elements.find { |element| element.id == slice.path || element.id == slice.id.sub(":#{slice.sliceName}", '') }
+      end
+
+      def discriminators(slice)
+        slice.slicing.discriminator
+      end
+
+      def must_support_pattern_slice_elements
+        must_support_slice_elements.select do |element|
+          discriminators(sliced_element(element)).first.type == 'pattern'
+        end
+      end
+
+      def pattern_slices
+        must_support_pattern_slice_elements.map do |current_element|
+          {
+            name: current_element.id,
+            path: current_element.path.gsub("#{resource}.", '')
+          }.tap do |metadata|
+            discriminator = discriminators(sliced_element(current_element)).first
+            discriminator_path = discriminator.path
+            discriminator_path = '' if discriminator_path == '$this'
+            pattern_element =
+              if discriminator_path.present?
+                profile_elements.find { |element| element.id == "#{current_element.id}.#{discriminator_path}" }
+              else
+                current_element
+              end
+
+            metadata[:discriminator] =
+              if pattern_element.patternCodeableConcept.present?
+                {
+                  type: 'patternCodeableConcept',
+                  path: discriminator_path,
+                  code: pattern_element.patternCodeableConcept.coding.first.code,
+                  system: pattern_element.patternCodeableConcept.coding.first.system
+                }
+              elsif pattern_element.patternCoding.present?
+                {
+                  type: 'patternCoding',
+                  path: discriminator_path,
+                  code: pattern_element.patternCoding.code,
+                  system: pattern_element.patternCoding.system
+                }
+              elsif pattern_element.patternIdentifier.present?
+                {
+                  type: 'patternIdentifier',
+                  path: discriminator_path,
+                  system: pattern_element.patternIdentifier.system
+                }
+              elsif pattern_element.binding&.strength == 'required' &&
+                    pattern_element.binding&.valueSet.present?
+
+                value_extractor = ValueExactor.new(ig_resources, resource, profile_elements)
+
+                values = value_extractor.values_from_value_set_binding(pattern_element).presence ||
+                         value_extractor.values_from_resource_metadata([metadata[:path]]).presence || []
+
+                {
+                  type: 'requiredBinding',
+                  path: discriminator_path,
+                  values: values
+                }
+              else
+                raise StandardError, 'Unsupported discriminator pattern type'
+              end
+
+            if is_uscdi_requirement_element?(current_element)
+              metadata[:uscdi_only] = true
+            end
+          end
+        end
+      end
+
+      def must_support_type_slice_elements
+        must_support_slice_elements.select do |element|
+          discriminators(sliced_element(element)).first.type == 'type'
+        end
+      end
+
+      def type_slices
+        must_support_type_slice_elements.map do |current_element|
+          discriminator = discriminators(sliced_element(current_element)).first
+          type_path = discriminator.path
+          type_path = '' if type_path == '$this'
+          type_element =
+            if type_path.present?
+              elements.find { |element| element.id == "#{current_element.id}.#{type_path}" }
+            else
+              current_element
+            end
+
+          type_code = type_element.type.first.code
+
+          {
+            name: current_element.id,
+            path: current_element.path.gsub("#{resource}.", ''),
+            discriminator: {
+              type: 'type',
+              code: type_code.upcase_first
+            }
+          }.tap do |metadata|
+            if is_uscdi_requirement_element?(current_element)
+              metadata[:uscdi_only] = true
+            end
+          end
+        end
+      end
+
+      def must_support_value_slice_elements
+        must_support_slice_elements.select do |element|
+          discriminators(sliced_element(element)).first.type == 'value'
+        end
+      end
+
+      def value_slices
+        must_support_value_slice_elements.map do |current_element|
+          {
+            name: current_element.id,
+            path: current_element.path.gsub("#{resource}.", ''),
+            discriminator: {
+              type: 'value'
+            }
+          }.tap do |metadata|
+            metadata[:discriminator][:values] = discriminators(sliced_element(current_element)).map do |discriminator|
+              fixed_element = profile_elements.find do |element|
+                element.id.starts_with?(current_element.id) &&
+                  element.path == "#{current_element.path}.#{discriminator.path}"
+              end
+
+              {
+                path: discriminator.path,
+                value: fixed_element.fixedUri || fixed_element.fixedCode
+              }
+            end
+
+            if is_uscdi_requirement_element?(current_element)
+              metadata[:uscdi_only] = true
+            end
+          end
+        end
+      end
+
+      def must_support_slices
+        pattern_slices + type_slices + value_slices
+      end
+
+      def plain_must_support_elements
+        all_must_support_elements - must_support_extension_elements - must_support_slice_elements
+      end
+
+      def handle_fixed_values(metadata, element)
+        if element.fixedUri.present?
+          metadata[:fixed_value] = element.fixedUri
+        elsif element.patternCodeableConcept.present?
+          metadata[:fixed_value] = element.patternCodeableConcept.coding.first.code
+          metadata[:path] += '.coding.code'
+        elsif element.fixedCode.present?
+          metadata[:fixed_value] = element.fixedCode
+        elsif element.patternIdentifier.present?
+          metadata[:fixed_value] = element.patternIdentifier.system
+          metadata[:path] += '.system'
+        end
+      end
+
+      def type_must_support_extension?(extensions)
+        extensions&.any? do |extension|
+          extension.url == 'http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support' &&
+          extension.valueBoolean
+        end
+      end
+
+      def save_type_code?(type)
+        'Reference' == type.code
+      end
+
+      def get_type_must_support_metadata(current_metadata, current_element)
+        current_element.type.map do |type|
+          if type_must_support_extension?(type.extension)
+            metadata =
+            {
+              path: "#{current_metadata[:path].delete_suffix('[x]')}#{type.code.upcase_first}",
+              original_path: current_metadata[:path]
+            }
+            metadata[:types] = [type.code] if save_type_code?(type)
+            handle_type_must_support_target_profiles(type, metadata) if type.code == 'Reference'
+
+            metadata
+          end
+        end.compact
+      end
+
+      def handle_type_must_support_target_profiles(type, metadata)
+        index = 0
+        target_profiles = []
+
+        type.source_hash['_targetProfile']&.each do |hash|
+          if hash.present?
+            element = FHIR::Element.new(hash)
+            target_profiles << type.targetProfile[index] if type_must_support_extension?(element.extension)
+          end
+          index += 1
+        end
+
+        metadata[:target_profiles] = target_profiles if target_profiles.present?
+      end
+
+      def handle_choice_type_in_sliced_element(current_metadata, must_support_elements_metadata)
+        choice_element_metadata = must_support_elements_metadata.find do |metadata|
+          metadata[:original_path].present? &&
+          current_metadata[:path].include?( metadata[:original_path] )
+        end
+
+        if choice_element_metadata.present?
+          current_metadata[:original_path] = current_metadata[:path]
+          current_metadata[:path] = current_metadata[:path].sub(choice_element_metadata[:original_path], choice_element_metadata[:path])
+        end
+      end
+
+      def must_support_elements
+        plain_must_support_elements.each_with_object([]) do |current_element, must_support_elements_metadata|
+          {
+            path: current_element.path.gsub("#{resource}.", '')
+          }.tap do |current_metadata|
+            if is_uscdi_requirement_element?(current_element)
+              current_metadata[:uscdi_only] = true
+            end
+
+            type_must_support_metadata = get_type_must_support_metadata(current_metadata, current_element)
+
+            if type_must_support_metadata.any?
+              must_support_elements_metadata.concat(type_must_support_metadata)
+            else
+              handle_choice_type_in_sliced_element(current_metadata, must_support_elements_metadata)
+
+              supported_types = current_element.type.select { |type| save_type_code?(type) }.map { |type| type.code }
+              current_metadata[:types] = supported_types if supported_types.present?
+
+              handle_type_must_support_target_profiles(current_element.type.first, current_metadata) if current_element.type.first&.code == 'Reference'
+
+              handle_fixed_values(current_metadata, current_element)
+
+              must_support_elements_metadata.delete_if do |metadata|
+                metadata[:path] == current_metadata[:path] && metadata[:fixed_value].blank?
+              end
+
+              must_support_elements_metadata << current_metadata
+            end
+          end
+        end.uniq
+      end
+
+      #### SPECIAL CASE ####
+
+      def handle_special_cases
+
+        case profile.version
+        when '1.1.0'
+          MustSupportMetadataExtractorUsCore3.new(profile, @must_supports).handle_special_cases
+        end
+      end
+
+      # ONC and US Core 4.0.0 both clarified that health IT developers that always provide HL7 FHIR "observation" values
+      # are not required to demonstrate Health IT Module support for "dataAbsentReason" elements.
+      # Remove MS check for dataAbsentReason and component.dataAbsentReason from vital sign profiles and observation lab profile
+      # Smoking status profile does not have MS on dataAbsentReason. It is safe to use profile.type == 'Observation'
+      def remove_observation_data_absent_reason
+        if profile.type == 'Observation'
+          @must_supports[:elements].delete_if do |element|
+            ['dataAbsentReason', 'component.dataAbsentReason'].include?(element[:path])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/davinci_plan_net_test_kit/generator/must_support_metadata_extractor_us_core_3.rb

@@ -0,0 +1,25 @@
+module DaVinciPlanNetTestKit
+  class Generator
+    class MustSupportMetadataExtractorUsCore3
+      attr_accessor :profile, :must_supports
+
+      def initialize(profile, must_supports)
+        self.profile = profile
+        self.must_supports = must_supports
+      end
+
+      def handle_special_cases
+        add_must_support_choices
+      end
+
+      def add_must_support_choices
+        choices = []
+          # fill with Plan Net add_must_support_choices
+
+        must_supports[:choices] = choices if choices.present?
+      end
+
+      
+    end
+  end
+end

data/lib/davinci_plan_net_test_kit/generator/must_support_test_generator.rb

@@ -0,0 +1,116 @@
+require_relative 'naming'
+require_relative 'special_cases'
+
+module DaVinciPlanNetTestKit
+  class Generator
+    class MustSupportTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+            .reject { |group| SpecialCases.exclude_group? group }
+            .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', 'must_support.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def output_file_directory
+        File.join(base_output_dir, profile_identifier)
+      end
+
+      def output_file_name
+        File.join(output_file_directory, base_output_file_name)
+      end
+
+      def read_interaction
+        self.class.read_interaction(group_metadata)
+      end
+
+      def profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "davinci_plan_net_#{group_metadata.reformatted_version}_#{profile_identifier}_must_support_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}MustSupportTest"
+      end
+
+      def module_name
+        "DaVinciPlanNet#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def resource_collection_string
+        'all_scratch_resources'
+      end
+
+      def must_support_list_string
+        build_must_support_list_string(false)
+      end
+
+      def uscdi_list_string
+        build_must_support_list_string(true)
+      end
+
+      def build_must_support_list_string(uscdi_only)
+        slice_names = group_metadata.must_supports[:slices]
+          .select { |slice| slice[:uscdi_only].presence == uscdi_only.presence }
+          .map { |slice| slice[:name] }
+
+        element_names = group_metadata.must_supports[:elements]
+          .select { |element| element[:uscdi_only].presence == uscdi_only.presence }
+          .map { |element| "#{resource_type}.#{element[:path]}" }
+
+        extension_names = group_metadata.must_supports[:extensions]
+          .select { |extension| extension[:uscdi_only].presence == uscdi_only.presence }
+          .map { |extension| extension[:id] }
+
+        group_metadata.must_supports[:choices]&.each do |choice|
+          next unless choice[:uscdi_only].presence == uscdi_only.presence && choice.key?(:paths)
+
+          choice[:paths].each { |path| element_names.delete("#{resource_type}.#{path}") }
+          element_names << choice[:paths].map { |path| "#{resource_type}.#{path}" }.join(' or ')
+        end
+
+        (slice_names + element_names + extension_names)
+          .uniq
+          .sort
+          .map { |name| "#{' ' * 8}* #{name}" }
+          .join("\n")
+      end
+
+      def generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+
+        group_metadata.add_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+    end
+  end
+end