us_quality_core_test_kit 0.1.0 → 0.1.2

data/lib/us_quality_core_test_kit/generator/must_support_metadata_extractor.rb

@@ -2,11 +2,330 @@
 
 require_relative 'value_extractor'
 
-require 'us_core_test_kit/generator/must_support_metadata_extractor'
-
 module USQualityCoreTestKit
   class Generator
-    class MustSupportMetadataExtractor < USCoreTestKit::Generator::MustSupportMetadataExtractor
+    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 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 must_support_extension_elements
+        all_must_support_elements.select { |element| element.path.end_with? 'extension' }
+      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_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?
+              profile_elements.find { |element| element.id == "#{current_element.id}.#{type_path}" }
+            else
+              current_element
+            end
+
+          type_code = type_element.type.first.code
+
+          discriminator = {
+            type: 'type',
+            code: type_code.upcase_first
+          }
+
+          discriminator[:path] = type_path unless type_path.empty?
+
+          {
+            slice_id: current_element.id,
+            slice_name: current_element.sliceName,
+            path: current_element.path.gsub("#{resource}.", ''),
+            discriminator: discriminator
+          }.tap do |metadata|
+            metadata[:uscdi_only] = true if uscdi_requirement_element?(current_element)
+          end
+        end
+      end
+
+      def must_support_value_slice_elements
+        must_support_slice_elements.select do |element|
+          # 'pattern' is deparected in FHIR R5
+          # 'pattern' type is used in US Core v7 and all earlier versions.
+          # Since US Core v8, all 'patten' types are moved to 'value' type
+          %w[value pattern].include?(discriminators(sliced_element(element)).first.type)
+        end
+      end
+
+      def value_slices
+        must_support_value_slice_elements.map do |current_element|
+          {
+            slice_id: current_element.id,
+            slice_name: current_element.sliceName,
+            path: current_element.path.gsub("#{resource}.", '')
+          }.tap do |metadata|
+            fixed_values = []
+            pattern_value = {}
+
+            discriminators(sliced_element(current_element)).each do |discriminator|
+              discriminator_path = discriminator.path
+              discriminator_path = '' if discriminator_path == '$this'
+              pattern_element =
+                if discriminator_path.present?
+                  sliced_target_path = "#{current_element.path}.#{discriminator_path}"
+
+                  profile_elements.find do |element|
+                    element.id.starts_with?(current_element.id) &&
+                      element.path == sliced_target_path
+                  end
+                else
+                  current_element
+                end
+
+              if pattern_element.fixedCode.present? || pattern_element.fixedUri.present?
+                fixed_values << {
+                  path: discriminator.path,
+                  value: pattern_element.fixedUri || pattern_element.fixedCode
+                }
+              elsif pattern_value.present?
+                raise StandardError, "Found more than one pattern slices for the same element #{pattern_element}."
+              else
+                pattern_value = save_pattern_slice(pattern_element, discriminator_path, metadata)
+              end
+            end
+
+            if !fixed_values.empty?
+              metadata[:discriminator] = {
+                type: 'value',
+                values: fixed_values
+              }
+            elsif pattern_value.present?
+              metadata[:discriminator] = pattern_value
+            end
+
+            metadata[:uscdi_only] = true if uscdi_requirement_element?(current_element)
+          end
+        end
+      end
+
+      def save_pattern_slice(pattern_element, discriminator_path, metadata)
+        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.codings_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
+      end
+
+      def plain_must_support_elements
+        all_must_support_elements - must_support_extension_elements - must_support_slice_elements
+      end
+
+      def element_part_of_slice_discrimination?(element)
+        must_support_slice_elements.any? { |ms_slice| element.id.include?(ms_slice.id) }
+      end
+
+      def handle_fixed_values(metadata, element)
+        if element.fixedUri.present?
+          metadata[:fixed_value] = element.fixedUri
+        elsif element.patternCodeableConcept.present? && !element_part_of_slice_discrimination?(element)
+          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? && !element_part_of_slice_discrimination?(element)
+          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)
+        type.code == 'Reference'
+      end
+
+      def get_type_must_support_metadata(current_metadata, current_element)
+        current_element.type.map do |type|
+          next unless 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.compact
+      end
+
+      def handle_type_must_support_target_profiles(type, metadata)
+        target_profiles = []
+
+        if type.targetProfile&.length == 1
+          target_profiles << type.targetProfile.first
+        else
+          type.source_hash['_targetProfile']&.each_with_index do |hash, index|
+            if hash.present?
+              element = FHIR::Element.new(hash)
+              target_profiles << type.targetProfile[index] if type_must_support_extension?(element.extension)
+            end
+          end
+        end
+
+        # remove target_profile for FHIR Base resource type.
+        target_profiles.delete_if { |reference| reference.start_with?('http://hl7.org/fhir/StructureDefinition') }
+        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
+
+        return unless 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
+
+      #### SPECIAL CASE ####
+
+      def vital_sign?
+        [
+          'http://hl7.org/fhir/StructureDefinition/vitalsigns',
+          'http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs'
+        ].include?(profile.baseDefinition)
+      end
+
+      def blood_pressure?
+        %w[bp us-core-blood-pressure us-core-average-blood-pressure].include?(profile.id)
+      end
+
+      # Exclude Observation.component from vital sign profiles except observation-bp and observation-pulse-ox
+
+      def remove_vital_sign_component
+        return if blood_pressure? || profile.name == 'USCorePulseOximetryProfile'
+
+        return unless vital_sign?
+
+        @must_supports[:elements].delete_if do |element|
+          element[:path].start_with?('component')
+        end
+      end
+
+      # Exclude Observation.value[x] from observation-bp
+
+      def remove_blood_pressure_value_data_absent_reason
+        return unless blood_pressure?
+
+        @must_supports[:elements].delete_if do |element|
+          element[:path].start_with?('value[x]') ||
+            element[:original_path]&.start_with?('value[x]') ||
+            element[:path] == ('dataAbsentReason')
+        end
+
+        @must_supports[:slices].delete_if do |slice|
+          slice[:path].start_with?('value[x]')
+        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'
+      # Since US Core 5.0.1, Blood Pressure profile restores component.dataAbsentReason as MustSupport.
+      # US Quality Core Test Kit has to keep this as there are still profiles either are us-core or inherit from us-core
+
+      def remove_observation_data_absent_reason
+        return if blood_pressure?
+
+        pattern = /(component(:[^.]+)?\.)?dataAbsentReason/
+
+        return unless profile.type == 'Observation'
+
+        @must_supports[:elements].delete_if do |element|
+          pattern.match?(element[:path])
+        end
+      end
+
       def uscdi_plus_quality_element?(element)
         !element.mustSupport && element.extension.any? do |extension|
           extension.url.downcase.ends_with? 'uscdiplusquality'
@@ -23,20 +342,26 @@ module USQualityCoreTestKit
 
       def all_must_support_elements
         profile_elements.select do |element|
-          element.mustSupport || uscdi_plus_quality_element?(element) || is_uscdi_requirement_element?(element)
+          element.mustSupport || uscdi_plus_quality_element?(element) || uscdi_requirement_element?(element)
         end
       end
 
       def must_support_extensions
-        super.map do |extension|
-          profile_element = must_support_extension_elements.find { |e| e.id == extension[:id] }
+        must_support_extension_elements.map do |element|
+          metadata = {
+            id: element.id,
+            path: element.path.gsub("#{resource}.", ''),
+            url: element.type.first.profile.first
+          }
+
+          metadata[:uscdi_only] = true if uscdi_requirement_element?(element)
 
-          add_us_quality_coreuscdi_plus_quality_flag(profile_element, extension)
+          add_us_quality_coreuscdi_plus_quality_flag(element, metadata)
         end
       end
 
       def must_support_slices
-        super.map do |slice|
+        (type_slices + value_slices).map do |slice|
           profile_element = must_support_slice_elements.find { |e| e.id == slice[:slice_id] }
 
           add_us_quality_coreuscdi_plus_quality_flag(profile_element, slice)
@@ -44,7 +369,38 @@ module USQualityCoreTestKit
       end
 
       def must_support_elements
-        ms_elements = super
+        ms_elements =
+          plain_must_support_elements.each_with_object([]) do |current_element, must_support_elements_metadata|
+            {
+              path: current_element.id.gsub("#{resource}.", '')
+            }.tap do |current_metadata|
+              if current_element.id.include?(':') && !current_element.id.include?('extension')
+                slice_name = current_element.id.match(/:(\w+)/)[1]
+
+                next if must_support_slice_elements.none? { |slice| slice.sliceName == slice_name }
+              end
+
+              current_metadata[:uscdi_only] = true if uscdi_requirement_element?(current_element)
+
+              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(&: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 << current_metadata
+              end
+            end
+          end.uniq
+
         return ms_elements unless profile.url.include?('us-quality-core')
 
         ms_elements.map do |element|
@@ -58,6 +414,7 @@ module USQualityCoreTestKit
       end
 
       # Aligns US Core v6.1.0 must support requirements to [USCDI v3.1](https://isp.healthit.gov/united-states-core-data-interoperability-uscdi#uscdi-v3-1)
+
       def remove_patient_gender_identity
         return unless profile.type == 'Patient'
         return unless @must_supports && @must_supports[:extensions]

data/lib/us_quality_core_test_kit/generator/must_support_test_generator.rb

@@ -1,13 +1,64 @@
 # frozen_string_literal: true
 
-require 'us_core_test_kit/generator/must_support_test_generator'
-
 require_relative 'naming'
 require_relative 'special_cases'
 
 module USQualityCoreTestKit
   class Generator
-    class MustSupportTestGenerator < USCoreTestKit::Generator::MustSupportTestGenerator
+    class MustSupportTestGenerator
+      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 output
+        @output ||= ERB.new(template, trim_mode: '-').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 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 generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.write(output_file_name, output)
+
+        group_metadata.add_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+
       class << self
         def generate(ig_metadata, base_output_dir)
           ig_metadata.groups

data/lib/us_quality_core_test_kit/generator/provenance_revinclude_search_test_generator.rb

@@ -1,13 +1,159 @@
 # frozen_string_literal: true
 
-require 'us_core_test_kit/generator/provenance_revinclude_search_test_generator'
-
 require_relative 'naming'
 require_relative 'special_cases'
 
 module USQualityCoreTestKit
   class Generator
-    class ProvenanceRevincludeSearchTestGenerator < USCoreTestKit::Generator::ProvenanceRevincludeSearchTestGenerator
+    class ProvenanceRevincludeSearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .reject { |group| SpecialCases.exclude_group? group }
+                     .select { |group| group.revincludes.include? 'Provenance:target' }
+                     .each { |group| new(group, group.searches.first, base_output_dir).generate }
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir
+
+      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 output
+        @output ||= ERB.new(template, trim_mode: '-').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 search_identifier
+        'provenance_revinclude'
+      end
+
+      def search_title
+        search_identifier.camelize
+      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_param_name
+        (search_metadata[:names] - [:patient]).first
+      end
+
+      def search_param_name_string
+        "#{search_metadata[:names].join(' + ')} + revInclude:Provenance:target"
+      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|
+            %w[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 search_properties
+        {}.tap do |properties|
+          properties[:fixed_value_search] = 'true' if fixed_value_search?
+          properties[:resource_type] = "'#{resource_type}'"
+          properties[:search_param_names] = search_param_names_array
+          properties[:possible_status_search] = 'true' if possible_status_search?
+        end
+      end
+
+      def search_test_properties_string
+        search_properties
+          .map { |key, value| "#{' ' * 8}#{key}: #{value}" }
+          .join(",\n")
+      end
+
+      def generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.write(output_file_name, output)
+
+        group_metadata.add_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+
       def template
         @template ||= File.read(File.join(__dir__, 'templates', 'provenance_revinclude_search.rb.erb'))
       end