us_core_test_kit 0.6.1 → 0.6.3

data/lib/us_core_test_kit/generator/granular_scope_resource_type_group_generator.rb

@@ -0,0 +1,144 @@
+require_relative 'naming'
+require_relative 'special_cases'
+require_relative '../custom_groups/smart_scopes_constants'
+
+module USCoreTestKit
+  class Generator
+    class GranularScopeResourceTypeGroupGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          return unless ['6', '7'].include? ig_metadata.ig_version[1]
+
+          [1, 2].each do |group_number|
+            groups = ig_metadata.groups.select { |group| group.granular_scope_tests.present? }
+            scopes =
+              SmartScopesConstants
+                .const_get("SMART_GRANULAR_SCOPES_GROUP#{group_number}")[ig_metadata.reformatted_version]
+
+            groups.each do |group_metadata|
+              next if scopes.none? { |scope| scope.start_with? "patient/#{group_metadata.resource}" }
+
+              new(GroupMetadata.new(group_metadata.to_hash), ig_metadata, base_output_dir, group_number).generate
+            end
+          end
+        end
+      end
+
+      attr_accessor :group_metadata, :ig_metadata, :base_output_dir, :group_number
+
+      def initialize(group_metadata, ig_metadata, base_output_dir, group_number)
+        self.group_metadata = group_metadata
+        self.ig_metadata = ig_metadata
+        self.base_output_dir = base_output_dir
+        self.group_number = group_number
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'granular_scope_resource_type_group.rb.erb'))
+      end
+
+      def output
+        @output ||= ERB.new(template).result(binding)
+      end
+
+      def base_output_file_name
+        "#{class_name.underscore}.rb"
+      end
+
+      def base_metadata_file_name
+        "metadata.yml"
+      end
+
+      def class_name
+        "#{resource_type}GranularScope#{group_number}Group"
+      end
+
+      def module_name
+        "USCore#{group_metadata.reformatted_version.upcase}"
+      end
+
+      def title
+        "#{resource_type} Granular Scope Tests"
+      end
+
+      def short_description
+        group_metadata.short_description
+      end
+
+      def output_file_name
+        File.join(base_output_dir, base_output_file_name)
+      end
+
+      def group_dir
+        File.join(base_output_dir, 'granular_scope_tests', resource_type.underscore)
+      end
+
+      def metadata_file_name
+        File.join(group_dir, base_metadata_file_name)
+      end
+
+      def group_id
+        "us_core_#{group_metadata.reformatted_version}_#{resource_type.underscore}_granular_scope_#{group_number}_group"
+      end
+
+      def resource_type
+        group_metadata.resource
+      end
+
+      def generate
+        FileUtils.mkdir_p(group_dir)
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+        group_metadata.id = group_id
+        group_metadata.file_name = base_output_file_name
+        ig_metadata.granular_scope_resource_type_groups[resource_type] <<
+          group_metadata.to_hash.slice(:granular_scope_resource_type_groups, :id, :file_name)
+        File.open(metadata_file_name, 'w') { |f| f.write(YAML.dump(group_metadata.to_hash)) }
+      end
+
+      def test_id_list
+        @test_id_list ||=
+          group_metadata.granular_scope_tests.map { |test| test[:id] }
+      end
+
+      def test_file_list
+        @test_file_list ||=
+          group_metadata.granular_scope_tests.map do |test|
+            "./granular_scope_tests/#{resource_type.underscore}/#{test[:file_name].delete_suffix('.rb')}"
+          end
+      end
+
+      def required_searches
+        group_metadata.searches.select { |search| search[:expectation] == 'SHALL' }
+      end
+
+      def search_param_name_string
+        required_searches
+          .map { |search| search[:names].join(' + ') }
+          .map { |names| "* #{names}" }
+          .join("\n")
+      end
+
+      def scopes
+        SmartScopesConstants.const_get("SMART_GRANULAR_SCOPES_GROUP#{group_number}")[ig_metadata.reformatted_version]
+      end
+
+      def scopes_string
+        scopes
+          .map { |scope| scope.delete_prefix 'patient/' }
+          .select { |scope| scope.start_with? resource_type }
+          .map { |scope| "* `#{scope}`" }
+          .join("\n")
+      end
+
+      def description
+        <<~DESCRIPTION
+          The tests in this group repeat all of the searches from the US Core
+          FHIR API tests, and verify that the resources returned are filtered
+          based on the following granular scopes:
+
+          #{scopes_string}
+        DESCRIPTION
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generator/granular_scope_test_generator.rb

@@ -0,0 +1,164 @@
+require_relative 'naming'
+require_relative 'special_cases'
+require_relative '../custom_groups/smart_scopes_constants'
+
+module USCoreTestKit
+  class Generator
+    class GranularScopeTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          return unless ['6', '7'].include? ig_metadata.ig_version[1]
+
+          scopes =
+            SmartScopesConstants::SMART_GRANULAR_SCOPES_GROUP1[ig_metadata.reformatted_version] +
+            SmartScopesConstants::SMART_GRANULAR_SCOPES_GROUP2[ig_metadata.reformatted_version]
+
+          SmartScopesConstants::SMART_GRANULAR_SCOPE_RESOURCES.each do |resource_type|
+            group = ig_metadata.groups.find { |group| group.resource == resource_type }
+
+            next if scopes.none? { |scope| scope.start_with? "patient/#{group.resource}" }
+
+            group.searches
+              .each { |search| new(group, search, base_output_dir).generate }
+          end
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir, :group_number
+
+      def initialize(group_metadata, search_metadata, base_output_dir)
+        self.group_metadata = group_metadata
+        self.search_metadata = search_metadata
+        self.base_output_dir = base_output_dir
+      end
+
+      def template
+        @template ||= File.read(File.join(__dir__, 'templates', 'granular_scope_test.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, 'granular_scope_tests', resource_type.underscore)
+      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
+        "us_core_#{group_metadata.reformatted_version}_#{resource_type}_#{search_identifier}_granular_scope_test"
+      end
+
+      def search_identifier
+        search_metadata[:names].join('_').tr('-', '_')
+      end
+
+      def search_title
+        search_identifier.camelize
+      end
+
+      def class_name
+        "#{resource_type}#{search_title}GranularScopeTest"
+      end
+
+      def module_name
+        "USCore#{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 search_param_name_string
+        search_metadata[:names].join(' + ')
+      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 search_definition(name)
+        group_metadata.search_definitions[name.to_sym]
+      end
+
+      def array_of_strings(array)
+        quoted_strings = array.map { |element| "'#{element}'" }
+        "[#{quoted_strings.join(', ')}]"
+      end
+
+      def search_properties
+        {}.tap do |properties|
+          properties[:resource_type] = "'#{resource_type}'"
+          properties[:search_param_names] = search_param_names_array
+        end
+      end
+
+      def url_version
+        case group_metadata.version
+        when 'v3.1.1'
+          'STU3.1.1'
+        when 'v4.0.0'
+          'STU4'
+        end
+      end
+
+      def search_test_properties_string
+        search_properties
+          .map { |key, value| "#{' ' * 8}#{key}: #{value}" }
+          .join(",\n")
+      end
+
+      def generate
+        FileUtils.mkdir_p(output_file_directory)
+        File.open(output_file_name, 'w') { |f| f.write(output) }
+
+        group_metadata.add_granular_scope_test(
+          id: test_id,
+          file_name: base_output_file_name
+        )
+      end
+
+      def description
+        <<~DESCRIPTION.gsub(/\n{3,}/, "\n\n")
+          This test repeats all #{resource_type} searches by
+          #{search_param_name_string} and verifies that the results have been
+          filtered based on the granted granular scopes.
+        DESCRIPTION
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generator/group_metadata.rb

@@ -12,6 +12,7 @@ module USCoreTestKit
         :profile_version,
         :title,
         :short_description,
+        :is_delayed,
         :interactions,
         :operations,
         :searches,
@@ -24,23 +25,12 @@ module USCoreTestKit
         :bindings,
         :references,
         :tests,
+        :granular_scope_tests,
         :id,
         :file_name,
         :delayed_references
       ].freeze
 
-      NON_USCDI_RESOURCES = {
-        'Encounter' => ['v311', 'v400'],
-        'Location' => ['v311', 'v400', 'v501', 'v610'],
-        'Organization' => ['v311', 'v400', 'v501', 'v610'],
-        'Practitioner' => ['v311', 'v400', 'v501', 'v610'],
-        'PractitionerRole' => ['v311', 'v400', 'v501', 'v610'],
-        'Provenance' => ['v311', 'v400', 'v501', 'v610'],
-        'RelatedPerson' => ['v501', 'v610'],
-        'Specimen' => ['v610']
-      }.freeze
-
-
       ATTRIBUTES.each { |name| attr_accessor name }
 
       def initialize(metadata)
@@ -52,9 +42,15 @@ module USCoreTestKit
       end
 
       def delayed?
-        return false if resource == 'Patient'
+        @is_delayed ||= if resource == 'Patient'
+                          false
+                        else
+                          no_patient_searches? || non_uscdi_resource?
+                        end
+      end
 
-        no_patient_searches? || non_uscdi_resource?
+      def exclude_search_tests?
+        delayed? && !searchable_delayed_resource
       end
 
       def no_patient_searches?
@@ -62,7 +58,11 @@ module USCoreTestKit
       end
 
       def non_uscdi_resource?
-        NON_USCDI_RESOURCES.key?(resource) && NON_USCDI_RESOURCES[resource].include?(reformatted_version)
+        SpecialCases::NON_USCDI_RESOURCES.key?(resource) && SpecialCases::NON_USCDI_RESOURCES[resource].include?(reformatted_version)
+      end
+
+      def searchable_delayed_resource?
+        SpecialCases::SEARCHABLE_DELAYED_RESOURCES.key?(resource) && SpecialCases::SEARCHABLE_DELAYED_RESOURCES[resource].include?(reformatted_version)
       end
 
       def add_test(id:, file_name:)
@@ -80,6 +80,15 @@ module USCoreTestKit
         end
       end
 
+      def add_granular_scope_test(id:, file_name:)
+        self.granular_scope_tests ||= []
+
+        self.granular_scope_tests << {
+          id:,
+          file_name:
+        }
+      end
+
       def to_hash
         ATTRIBUTES.each_with_object({}) { |key, hash| hash[key] = send(key) unless send(key).nil? }
       end

data/lib/us_core_test_kit/generator/group_metadata_extractor.rb

@@ -94,30 +94,9 @@ module USCoreTestKit
       end
 
       ### BEGIN SPECIAL CASES ###
-
-      ALL_VERSION_CATEGORY_FIRST_PROFILES = [
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-test',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-imaging',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-screening-assessment',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sdoh-assessment',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-social-history',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-survey',
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-simple-observation'
-      ]
-
-      VERSION_SPECIFIC_CATEGORY_FIRST_PROFILES = {
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis' => ['v610'],
-        'http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns' => ['v610']
-      }
-
       def category_first_profile?
-        ALL_VERSION_CATEGORY_FIRST_PROFILES.include?(profile_url) ||
-        VERSION_SPECIFIC_CATEGORY_FIRST_PROFILES[profile_url]&.include?(reformatted_version)
+        SpecialCases::ALL_VERSION_CATEGORY_FIRST_PROFILES.include?(profile_url) ||
+        SpecialCases::VERSION_SPECIFIC_CATEGORY_FIRST_PROFILES[profile_url]&.include?(reformatted_version)
       end
 
       def first_search_params
@@ -229,8 +208,16 @@ module USCoreTestKit
       end
 
       def search_metadata_extractor
-        @search_metadata_extractor ||=
-          SearchMetadataExtractor.new(resource_capabilities, ig_resources, resource, profile_elements)
+        @search_metadata_extractor ||= SearchMetadataExtractor.new(
+          resource_capabilities,
+          ig_resources,
+          profile_elements,
+          {
+            resource: resource,
+            profile_url: profile_url,
+            must_supports: must_supports
+          }
+        )
       end
 
       def searches

data/lib/us_core_test_kit/generator/ig_metadata.rb

@@ -38,10 +38,21 @@ module USCoreTestKit
         end
       end
 
+      def granular_scope_resource_type_groups
+        @granular_scope_resource_type_groups ||=
+          Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      def granular_scope_groups
+        @granular_scope_groups ||= []
+      end
+
       def to_hash
         {
-          ig_version: ig_version,
-          groups: groups.map(&:to_hash)
+          ig_version:,
+          groups: groups.map(&:to_hash),
+          granular_scope_resource_type_groups:,
+          granular_scope_groups:
         }
       end
     end

data/lib/us_core_test_kit/generator/ig_metadata_extractor.rb

@@ -64,7 +64,9 @@ module USCoreTestKit
         metadata.groups =
           resources_in_capability_statement.flat_map do |resource|
             resource.supportedProfile&.map do |supported_profile|
+              supported_profile = supported_profile.split('|').first
               next if supported_profile == 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire'
+
               GroupMetadataExtractor.new(resource, supported_profile, metadata, ig_resources).group_metadata
             end
           end.compact

data/lib/us_core_test_kit/generator/must_support_metadata_extractor.rb

@@ -3,6 +3,7 @@ require_relative 'must_support_metadata_extractor_us_core_3'
 require_relative 'must_support_metadata_extractor_us_core_4'
 require_relative 'must_support_metadata_extractor_us_core_5'
 require_relative 'must_support_metadata_extractor_us_core_6'
+require_relative 'must_support_metadata_extractor_us_core_7'
 
 module USCoreTestKit
   class Generator
@@ -36,7 +37,7 @@ module USCoreTestKit
       end
 
       def all_must_support_elements
-        profile_elements.select { |element| element.mustSupport || is_uscdi_requirement_element?(element) }
+        profile_elements.select { |element| (element.mustSupport || is_uscdi_requirement_element?(element))}
       end
 
       def must_support_extension_elements
@@ -77,7 +78,8 @@ module USCoreTestKit
       def pattern_slices
         must_support_pattern_slice_elements.map do |current_element|
           {
-            name: current_element.id,
+            slice_id: current_element.id,
+            slice_name: current_element.sliceName,
             path: current_element.path.gsub("#{resource}.", '')
           }.tap do |metadata|
             discriminator = discriminators(sliced_element(current_element)).first
@@ -89,7 +91,6 @@ module USCoreTestKit
               else
                 current_element
               end
-
             metadata[:discriminator] =
               if pattern_element.patternCodeableConcept.present?
                 {
@@ -156,7 +157,8 @@ module USCoreTestKit
           type_code = type_element.type.first.code
 
           {
-            name: current_element.id,
+            slice_id: current_element.id,
+            slice_name: current_element.sliceName,
             path: current_element.path.gsub("#{resource}.", ''),
             discriminator: {
               type: 'type',
@@ -179,7 +181,8 @@ module USCoreTestKit
       def value_slices
         must_support_value_slice_elements.map do |current_element|
           {
-            name: current_element.id,
+            slice_id: current_element.id,
+            slice_name: current_element.sliceName,
             path: current_element.path.gsub("#{resource}.", ''),
             discriminator: {
               type: 'value'
@@ -209,18 +212,23 @@ module USCoreTestKit
       end
 
       def plain_must_support_elements
-        all_must_support_elements - must_support_extension_elements - must_support_slice_elements
+        plain_must_supports = 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?
+        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?
+        elsif element.patternIdentifier.present? && !element_part_of_slice_discrimination?(element)
           metadata[:fixed_value] = element.patternIdentifier.system
           metadata[:path] += '.system'
         end
@@ -254,17 +262,25 @@ module USCoreTestKit
       end
 
       def handle_type_must_support_target_profiles(type, metadata)
-        index = 0
+        # US Core 3.1.1 profiles do not have US Core target profiles.
+        # Vital Sign proifles from FHIR R4 (version 4.0.1) do not have US Core target profiles either.
+        return if ['3.1.1', '4.0.1'].include?(profile.version)
+
         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)
+        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
-          index += 1
         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
 
@@ -283,7 +299,7 @@ module USCoreTestKit
       def must_support_elements
         plain_must_support_elements.each_with_object([]) do |current_element, must_support_elements_metadata|
           {
-            path: current_element.path.gsub("#{resource}.", '')
+            path: current_element.id.gsub("#{resource}.", '')
           }.tap do |current_metadata|
             if is_uscdi_requirement_element?(current_element)
               current_metadata[:uscdi_only] = true
@@ -317,7 +333,7 @@ module USCoreTestKit
 
       def handle_special_cases
         remove_vital_sign_component
-        remove_blood_pressure_value
+        remove_blood_pressure_value_data_absent_reason
         remove_observation_data_absent_reason
 
         case profile.version
@@ -329,6 +345,8 @@ module USCoreTestKit
           MustSupportMetadataExtractorUsCore5.new(profile, @must_supports).handle_special_cases
         when '6.1.0'
           MustSupportMetadataExtractorUsCore6.new(profile, @must_supports).handle_special_cases
+        when '7.0.0-ballot'
+          MustSupportMetadataExtractorUsCore7.new(profile, @must_supports).handle_special_cases
         end
       end
 
@@ -340,12 +358,14 @@ module USCoreTestKit
       end
 
       def is_blood_pressure?
-        ['observation-bp', 'USCoreBloodPressureProfile'].include?(profile.name)
+        ['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
-        if is_vital_sign? && !is_blood_pressure? && profile.name != 'USCorePulseOximetryProfile'
+        return if is_blood_pressure? || profile.name == 'USCorePulseOximetryProfile'
+
+        if is_vital_sign?
           @must_supports[:elements].delete_if do |element|
             element[:path].start_with?('component')
           end
@@ -353,14 +373,22 @@ module USCoreTestKit
       end
 
       # Exclude Observation.value[x] from observation-bp
-      def remove_blood_pressure_value
-        if is_blood_pressure?
-          @must_supports[:elements].delete_if do |element|
-            element[:path].start_with?('value[x]') || element[:original_path]&.start_with?('value[x]')
-          end
-          @must_supports[:slices].delete_if do |slice|
-            slice[:path].start_with?('value[x]')
-          end
+      def remove_blood_pressure_value_data_absent_reason
+        return unless is_blood_pressure?
+
+        pattern = /component(:[^.]+)?\.dataAbsentReason/
+
+        @must_supports[:elements].delete_if do |element|
+          element[:path].start_with?('value[x]') ||
+          element[:original_path]&.start_with?('value[x]') ||
+          element[:path] == ('dataAbsentReason') ||
+          (
+            pattern.match?(element[:path]) && ['3.1.1', '4.0.0'].include?(ig_resources.ig.version)
+          )
+        end
+
+        @must_supports[:slices].delete_if do |slice|
+          slice[:path].start_with?('value[x]')
         end
       end
 
@@ -368,10 +396,15 @@ module USCoreTestKit
       # 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.
       def remove_observation_data_absent_reason
+        return if is_blood_pressure?
+
+        pattern = /(component(:[^.]+)?\.)?dataAbsentReason/
+
         if profile.type == 'Observation'
           @must_supports[:elements].delete_if do |element|
-            ['dataAbsentReason', 'component.dataAbsentReason'].include?(element[:path])
+            pattern.match?(element[:path])
           end
         end
       end