carin_for_blue_button_test_kit 0.9.0

data/lib/carin_for_blue_button_test_kit/generator/must_support_metadata_extractor.rb

@@ -0,0 +1,326 @@
+require_relative 'value_extractor'
+
+module CarinForBlueButtonTestKit
+  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
+        }
+
+        @must_supports
+      end
+
+      def all_must_support_elements
+        profile_elements.select { |element| element.mustSupport }
+      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
+          }
+        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 }
+      end
+
+      def discriminators(slice)
+        slice.slicing.discriminator
+      end
+
+      def must_support_pattern_slice_elements
+        must_support_slice_elements.select do |element|
+            if !(sliced_element(element).slicing.nil?)
+                discriminators(sliced_element(element)).first.type == 'pattern'
+            end
+        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)
+
+                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
+          end
+        end
+      end
+
+      def must_support_type_slice_elements
+        must_support_slice_elements.select do |element|
+            if !(sliced_element(element).slicing.nil?)
+                discriminators(sliced_element(element)).first.type == 'type'
+            end
+        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
+            }
+          }
+        end
+      end
+
+      def must_support_value_slice_elements
+        must_support_slice_elements.select do |element|
+            if !(sliced_element(element).slicing.nil?)
+                discriminators(sliced_element(element)).first.type == 'value'
+            end
+        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
+          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[:type] = [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|
+            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 is_vital_sign?
+        [
+          'http://hl7.org/fhir/StructureDefinition/vitalsigns',
+          'http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs'
+        ].include?(profile.baseDefinition)
+      end
+
+      def is_blood_pressure?
+        ['observation-bp', 'USCoreBloodPressureProfile'].include?(profile.name)
+      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_device_carrier
+        if profile.type == 'Device'
+          @must_supports[:elements].delete_if do |element|
+            ['udiCarrier.carrierAIDC', 'udiCarrier.carrierHRF'].include?(element[:path])
+          end
+        end
+      end
+
+      def remove_document_reference_attachment_data_url
+        if profile.type == 'DocumentReference'
+          @must_supports[:elements].delete_if do |element|
+            ['content.attachment.data', 'content.attachment.url'].include?(element[:path])
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generator/must_support_test_generator.rb

@@ -0,0 +1,131 @@
+require_relative 'naming'
+
+module CarinForBlueButtonTestKit
+  class Generator
+    class MustSupportTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.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', '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
+        "c4bb_#{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
+        "CARIN4BB#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def specific_resource_type
+        case profile_identifier
+        when 'explanation_of_benefit_inpatient_institutional'
+          return "ExplanationOfBenefitInpatientInstitutional"
+        when 'explanation_of_benefit_oral'
+          return "ExplanationOfBenefitOral"
+        when 'explanation_of_benefit_outpatient_institutional'
+          return "ExplanationOfBenefitOutpatientInstitutional"
+        when 'explanation_of_benefit_pharmacy'
+          return "ExplanationOfBenefitPharmacy"
+        when 'explanation_of_benefit_professional_non_clinician'
+          return "ExplanationOfBenefitProfessionalNonClinician"
+        else
+          return self.resource_type
+        end
+      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

data/lib/carin_for_blue_button_test_kit/generator/naming.rb

@@ -0,0 +1,36 @@
+module CarinForBlueButtonTestKit
+    class Generator
+      module Naming
+        COVERAGE = 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage'
+        EXPLANATION_OF_BENEFIT = 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-ExplanationOfBenefit'
+        ORGANIZATION = 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization'
+        PATIENT = 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient'
+        PRACTITIONER = 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner'
+        RELATED_PERSON = 'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson'
+  
+        class << self
+          def resources_with_multiple_profiles
+            ['ExplanationOfBenefit']
+          end
+  
+          def resource_has_multiple_profiles?(resource)
+            resources_with_multiple_profiles.include? resource
+          end
+  
+          def snake_case_for_profile(group_metadata)
+            resource = group_metadata.resource
+            return resource.underscore unless resource_has_multiple_profiles?(resource)
+  
+            group_metadata.name
+              .delete_prefix('C4BB_')
+              .underscore
+          end
+  
+          def upper_camel_case_for_profile(group_metadata)
+            snake_case_for_profile(group_metadata).camelize
+          end
+        end
+      end
+    end
+  end
+  

data/lib/carin_for_blue_button_test_kit/generator/read_test_generator.rb

@@ -0,0 +1,109 @@
+require_relative 'naming'
+
+module CarinForBlueButtonTestKit
+  class Generator
+    class ReadTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+            .select { |group| read_interaction(group).present? }
+            .each { |group| new(group, base_output_dir).generate }
+        end
+
+        def read_interaction(group_metadata)
+          group_metadata.interactions.find { |interaction| interaction[:code] == 'read' }
+        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', 'read.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
+        "c4bb_#{group_metadata.reformatted_version}_#{profile_identifier}_read_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ReadTest"
+      end
+
+      def module_name
+        "CARIN4BB#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def resource_type
+         return group_metadata.resource
+      end
+
+      def specific_resource_type
+        case profile_identifier
+        when 'explanation_of_benefit_inpatient_institutional'
+          return "ExplanationOfBenefitInpatientInstitutional"
+        when 'explanation_of_benefit_oral'
+          return "ExplanationOfBenefitOral"
+        when 'explanation_of_benefit_outpatient_institutional'
+          return "ExplanationOfBenefitOutpatientInstitutional"
+        when 'explanation_of_benefit_pharmacy'
+          return "ExplanationOfBenefitPharmacy"
+        when 'explanation_of_benefit_professional_non_clinician'
+          return "ExplanationOfBenefitProfessionalNonClinician"
+        else
+          return self.resource_type
+        end
+      end
+
+      def resource_collection_string
+        if group_metadata.delayed? && resource_type != 'Provenance'
+          "scratch.dig(:references, '#{resource_type}')"
+        else
+          'all_scratch_resources'
+        end
+      end
+
+      def conformance_expectation
+        read_interaction[:expectation]
+      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/carin_for_blue_button_test_kit/generator/resource_list_generator.rb

@@ -0,0 +1,43 @@
+module CarinForBlueButtonTestKit
+    class Generator
+      class ResourceListGenerator
+        class << self
+          def generate(ig_metadata, base_output_dir)
+            @ig_metadata = ig_metadata
+  
+            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          
+            @ig_metadata.groups.map(&:title).uniq
+          end
+  
+          def resource_list_string
+            resource_list.map { |resource| "      '#{resource}'" }.join(",\n")
+          end
+  
+          def module_name
+            "CARIN4BB#{@ig_metadata.reformatted_version.upcase}"
+          end
+  
+          def read_interaction(group_metadata)
+            group_metadata.interactions.find { |interaction| interaction[:code] == 'read' }
+          end
+  
+          def template
+            @template ||= File.read(File.join(__dir__, 'templates', 'resource_list.rb.erb'))
+          end
+  
+          def output
+            ERB.new(template).result(binding)
+          end
+  
+          def base_output_file_name
+            "resource_list.rb"
+          end
+        end
+      end
+    end
+  end
+