ipa_test_kit 0.2.0

data/lib/ipa_test_kit/generator/must_support_metadata_extractor.rb

@@ -0,0 +1,221 @@
+module IpaTestKit
+  class Generator
+    class MustSupportMetadataExtractor
+      attr_accessor :profile_elements, :profile, :resource
+
+      def initialize(profile_elements, profile, resource)
+        self.profile_elements = profile_elements
+        self.profile = profile
+        self.resource = resource
+      end
+
+      def must_supports
+        {
+          extensions: must_support_extensions,
+          slices: must_support_slices,
+          elements: must_support_elements
+        }
+      end
+
+      # exclude component from vital sign profiles except observation-bp and observation-pulse-ox
+      # observation-bp is excluded by profile.name != 'observation-bp'
+      # observation-plux-ox is excluded by profile.baseDefinition == 'http://hl7.org/fhir/StructureDefinition/vitalsigns'
+      def vital_signs_component?(element)
+        profile.baseDefinition == 'http://hl7.org/fhir/StructureDefinition/vitalsigns' &&
+          profile.name != 'observation-bp' &&
+          element.path.include?('component')
+      end
+
+      def blood_pressure_value?(element)
+        profile.name == 'observation-bp' && element.path.include?('Observation.value[x]')
+      end
+
+      # ONC 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      
+      def data_absent_reason?(element)
+        profile.type == 'Observation' && ['Observation.dataAbsentReason', 'Observation.component.dataAbsentReason'].include?(element.path)
+      end
+
+      def all_must_support_elements
+        profile_elements
+          .select { |element| element.mustSupport }
+          .reject do |element|
+            # TODO: Can special cases be moved out of here?
+            vital_signs_component?(element) || blood_pressure_value?(element) || data_absent_reason?(element)
+          end
+      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|
+          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.patternIdentifier.present?
+                {
+                  type: 'patternIdentifier',
+                  path: discriminator_path,
+                  system: pattern_element.patternIdentifier.system
+                }
+              else
+                raise StandardError, 'Unsupported discriminator pattern type'
+              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
+            }
+          }
+        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
+
+              binding.pry if fixed_element.nil?
+              {
+                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 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|
+            path = current_element.path.gsub("#{resource}.", '')
+            current_metadata[:path] = path
+
+            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.uniq
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generator/must_support_test_generator.rb

@@ -0,0 +1,86 @@
+require_relative 'naming'
+require_relative 'special_cases'
+
+module IpaTestKit
+  class Generator
+    class MustSupportTestGenerator
+      class << self
+        def generate(ig_metadata)
+          ig_metadata.groups
+            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .each { |group| new(group).generate }
+        end
+      end
+
+      attr_accessor :group_metadata
+
+      def initialize(group_metadata)
+        self.group_metadata = group_metadata
+      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(__dir__, '..', 'generated', 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
+        "ipa_010_#{profile_identifier}_must_support_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}MustSupportTest"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def resource_collection_string
+        'all_scratch_resources'
+      end
+
+      def must_support_list_string
+        slice_names = group_metadata.must_supports[:slices].map { |slice| slice[:name] }
+        element_names = group_metadata.must_supports[:elements].map { |slice| "#{resource_type}.#{slice[:path]}" }
+        extension_names = group_metadata.must_supports[:extensions].map { |slice| slice[:id] }
+        (slice_names + element_names + extension_names)
+          .sort
+          .map { |name| "      * #{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/ipa_test_kit/generator/naming.rb

@@ -0,0 +1,46 @@
+module IpaTestKit
+  class Generator
+    module Naming
+      ALLERGY_INTOLERANCE = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance'
+      CONDITION = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition'
+      DOCUMENT_REFERENCE = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference'
+      IMMUNIZATION = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization'
+      MEDICATION = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication'
+      MEDICATION_REQUEST = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest'
+      MEDICATION_STATEMENT = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement'
+      OBSERVATION = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation'
+      BMI = 'http://hl7.org/fhir/StructureDefinition/bmi'
+      OXYGEN_SAT = 'http://hl7.org/fhir/StructureDefinition/oxygensat'
+      HEAD_CIRCUMFERENCE = 'http://hl7.org/fhir/StructureDefinition/headcircum'
+      PATIENT = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient'
+      PRACTITIONER = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner'
+      PRACTITIONER_ROLE = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole'
+      PROVENANCE = 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-provenance'
+
+      class << self
+        def resources_with_multiple_profiles
+          ['Observation']
+        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)
+
+          return 'head_circumference' if group_metadata.profile_url == HEAD_CIRCUMFERENCE
+
+          group_metadata.name
+            .delete_prefix('ipa_')
+            .underscore
+        end
+
+        def upper_camel_case_for_profile(group_metadata)
+          snake_case_for_profile(group_metadata).camelize
+        end
+      end
+    end
+  end
+end

data/lib/ipa_test_kit/generator/provenance_revinclude_search_test_generator.rb

@@ -0,0 +1,186 @@
+require_relative 'naming'
+require_relative 'special_cases'
+
+module IpaTestKit
+  class Generator
+    class ProvenanceRevincludeSearchTestGenerator
+      class << self
+        def generate(ig_metadata)
+          ig_metadata.groups
+            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .select { |group| group.revincludes.include? 'Provenance:target' }
+            .each { |group| new(group, group.searches.first).generate }
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata
+
+      def initialize(group_metadata, search_metadata)
+        self.group_metadata = group_metadata
+        self.search_metadata = search_metadata
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'provenance_revinclude_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(__dir__, '..', 'generated', profile_identifier)
+      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
+        "ipa_010_#{profile_identifier}_#{search_identifier}_search_test"
+      end
+
+      def search_identifier
+        'provenance_revinclude'
+      end
+
+      def search_title
+        search_identifier.camelize
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}SearchTest"
+      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?
+        search_metadata[:names] != ['patient'] &&
+          !group_metadata.delayed? && resource_type != 'Patient'
+      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 needs_patient_id?
+        search_metadata[:names].include?('patient') ||
+          (resource_type == 'Patient' && search_metadata[:names].include?('_id'))
+      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 patient_id_param?(param)
+      #   param[:name] == 'patient' ||
+      #     (resource_type == 'Patient' && param[:name] == '_id')
+      # 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 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.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/ipa_test_kit/generator/read_test_generator.rb

@@ -0,0 +1,89 @@
+require_relative 'naming'
+require_relative 'special_cases'
+
+module IpaTestKit
+  class Generator
+    class ReadTestGenerator
+      class << self
+        def generate(ig_metadata)
+          ig_metadata.groups
+            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .select { |group| read_interaction(group).present? }
+            .each { |group| new(group).generate }
+        end
+
+        def read_interaction(group_metadata)
+          group_metadata.interactions.find { |interaction| interaction[:code] == 'read' }
+        end
+      end
+
+      attr_accessor :group_metadata
+
+      def initialize(group_metadata)
+        self.group_metadata = group_metadata
+      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(__dir__, '..', 'generated', 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
+        "ipa_010_#{profile_identifier}_read_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ReadTest"
+      end
+
+      def resource_type
+        group_metadata.resource
+      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/ipa_test_kit/generator/reference_resolution_test_generator.rb

@@ -0,0 +1,72 @@
+require_relative 'naming'
+require_relative 'special_cases'
+
+module IpaTestKit
+  class Generator
+    class ReferenceResolutionTestGenerator
+      class << self
+        def generate(ig_metadata)
+          ig_metadata.groups
+            .reject { |group| SpecialCases.exclude_resource? group.resource }
+            .each { |group| new(group).generate }
+        end
+      end
+
+      attr_accessor :group_metadata
+
+      def initialize(group_metadata)
+        self.group_metadata = group_metadata
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'reference_resolution.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(__dir__, '..', 'generated', profile_identifier)
+      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
+        "ipa_010_#{profile_identifier}_reference_resolution_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}ReferenceResolutionTest"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def resource_collection_string
+        'scratch_resources[:all]'
+      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