us_quality_core_test_kit 0.1.2 → 0.2.0

data/lib/us_quality_core_test_kit/generator/document_reference_custodian_test_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module USQualityCoreTestKit
+  class Generator
+    class DocumentReferenceCustodianTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .select { |group| group.resource == 'DocumentReference' }
+                     .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', 'document_reference_custodian_test.rb.erb'))
+      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 profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "us_quality_core_#{group_metadata.reformatted_version}_#{profile_identifier}_custodian_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}DocumentReferenceCustodianTest"
+      end
+
+      def module_name
+        "USQualityCore#{group_metadata.reformatted_version.upcase}"
+      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
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/group_generator.rb

@@ -143,7 +143,7 @@ module USQualityCoreTestKit
 
           ## Profile Validation
           Each resource returned from the first search is expected to conform to
-          the [#{profile_name} Profile](#{profile_url}). Each element is checked against
+          the [#{profile_name}](#{profile_url}). Each element is checked against
           teminology binding and cardinality requirements.
 
           Elements with a required binding are validated against their bound

data/lib/us_quality_core_test_kit/generator/group_metadata_extractor.rb

@@ -98,7 +98,10 @@ module USQualityCoreTestKit
       end
 
       def profile_name
-        profile.title.gsub('  ', ' ')
+        profile_name = profile.title.gsub('  ', ' ')
+        # This covers both US Core title style: "US Core Patient Profile" and
+        # US Quality Core title style: "US Quality Core Patient"
+        profile_name.end_with?(' Profile') ? profile_name : "#{profile_name} Profile"
       end
 
       def profile_version
@@ -200,6 +203,10 @@ module USQualityCoreTestKit
           SpecialCases::VERSION_SPECIFIC_CATEGORY_FIRST_PROFILES[profile_url]&.include?(reformatted_version)
       end
 
+      def do_not_perform_profile?
+        SpecialCases::DO_NOT_PERFORM_PROFILES.include?(profile_url)
+      end
+
       def first_search_params
         @first_search_params ||=
           if category_first_profile?
@@ -211,11 +218,13 @@ module USQualityCoreTestKit
               %w[patient code]
             end
           elsif resource == 'MedicationRequest'
-            %w[patient intent do-not-perform]
-          elsif %w[DeviceRequest ServiceRequest].include?(resource)
+            do_not_perform_profile? ? %w[patient intent do-not-perform] : %w[patient intent]
+          elsif do_not_perform_profile?
             %w[patient do-not-perform]
           elsif %w[CareTeam Immunization MedicationAdministration MedicationDispense Procedure Task].include?(resource)
             %w[patient status]
+          elsif resource == 'Communication'
+            %w[subject status]
           else
             ['patient']
           end
@@ -245,6 +254,10 @@ module USQualityCoreTestKit
       def mark_mandatory_and_must_support_searches
         searches.each do |search|
           search[:names_not_must_support_or_mandatory] = search[:names].reject do |name|
+            # Treat the ServiceRequest do-not-perform search parameter as required. See:
+            # https://github.com/onc-healthit/us-quality-core/issues/39
+            next true if resource == 'ServiceRequest' && name == 'do-not-perform'
+
             full_paths = search_definitions[name.to_sym][:full_paths]
             any_must_support_elements = must_supports[:elements].any? do |element|
               full_must_support_paths = ["#{resource}.#{element[:original_path]}", "#{resource}.#{element[:path]}"]
@@ -272,7 +285,9 @@ module USQualityCoreTestKit
             end
 
             any_mandatory_elements = mandatory_elements.any? do |element|
-              full_paths.include?(element)
+              full_paths.any? do |path|
+                mandatory_element_matches_search_path?(element, path)
+              end
             end
 
             any_must_support_elements || any_must_support_slices || any_mandatory_elements
@@ -282,6 +297,19 @@ module USQualityCoreTestKit
         end
       end
 
+      def mandatory_element_matches_search_path?(element, path)
+        # Extension search parameters identify an extension with a FHIRPath
+        # filter (for example, `modifierExtension.where(url='...').value`),
+        # while the snapshot records the mandatory value as
+        # `modifierExtension.value[x]`. Remove the filter and normalize choice
+        # elements before comparing the paths.
+        normalized_path = path.gsub(/\.where\(url\s*=\s*'[^']+'\)/, '').gsub('[x]', '')
+        normalized_element = element.gsub('[x]', '')
+
+        normalized_path == normalized_element ||
+          (element.end_with?('[x]') && normalized_path.start_with?(normalized_element))
+      end
+
       def search_metadata_extractor
         @search_metadata_extractor ||= SearchMetadataExtractor.new(
           resource_capabilities,

data/lib/us_quality_core_test_kit/generator/ig_metadata_extractor.rb

@@ -23,7 +23,7 @@ module USQualityCoreTestKit
       end
 
       def add_metadata_from_ig
-        metadata.ig_version = "v#{ig_resources.ig.version}".delete('-ballot')
+        metadata.ig_version = "v#{ig_resources.ig.version}"
       end
 
       def resources_in_capability_statement

data/lib/us_quality_core_test_kit/generator/interpreter_required_extension_test_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module USQualityCoreTestKit
+  class Generator
+    class InterpreterRequiredExtensionTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir)
+          ig_metadata.groups
+                     .select { |group| group.resource == 'Encounter' }
+                     .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', 'interpreter_required_extension_test.rb.erb'))
+      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 profile_identifier
+        Naming.snake_case_for_profile(group_metadata)
+      end
+
+      def test_id
+        "us_quality_core_#{group_metadata.reformatted_version}_interpreter_required_extension_test"
+      end
+
+      def class_name
+        'InterpreterRequiredExtensionTest'
+      end
+
+      def module_name
+        "USQualityCore#{group_metadata.reformatted_version.upcase}"
+      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
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/must_support_metadata_extractor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'value_extractor'
+require_relative 'must_support_metadata_extractor_v1'
 
 module USQualityCoreTestKit
   class Generator
@@ -34,11 +35,15 @@ module USQualityCoreTestKit
       end
 
       def must_support_extension_elements
-        all_must_support_elements.select { |element| element.path.end_with? 'extension' }
+        all_must_support_elements.select { |element| extension_element?(element) }
       end
 
       def must_support_slice_elements
-        all_must_support_elements.select { |element| !element.path.end_with?('extension') && element.sliceName.present? }
+        all_must_support_elements.select { |element| !extension_element?(element) && element.sliceName.present? }
+      end
+
+      def extension_element?(element)
+        element.type.any? { |type| type.code == 'Extension' }
       end
 
       def sliced_element(slice)
@@ -81,9 +86,7 @@ module USQualityCoreTestKit
             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
 
@@ -141,8 +144,6 @@ module USQualityCoreTestKit
             elsif pattern_value.present?
               metadata[:discriminator] = pattern_value
             end
-
-            metadata[:uscdi_only] = true if uscdi_requirement_element?(current_element)
           end
         end
       end
@@ -327,16 +328,13 @@ module USQualityCoreTestKit
       end
 
       def uscdi_plus_quality_element?(element)
-        !element.mustSupport && element.extension.any? do |extension|
-          extension.url.downcase.ends_with? 'uscdiplusquality'
-        end
-      end
+        return false if element.mustSupport
 
-      def add_us_quality_coreuscdi_plus_quality_flag(profile_element, metadata_element)
-        if uscdi_plus_quality_element?(profile_element)
-          metadata_element.merge(us_quality_coreuscdi_plus_quality: true)
-        else
-          metadata_element
+        element.extension.any? do |extension|
+          extension.url.downcase.end_with?(
+            'uscdiplusquality',
+            'us-quality-core-uscdi-quality-extension'
+          )
         end
       end
 
@@ -347,24 +345,34 @@ module USQualityCoreTestKit
       end
 
       def must_support_extensions
-        must_support_extension_elements.map do |element|
+        must_support_extension_elements.map do |profile_element|
           metadata = {
-            id: element.id,
-            path: element.path.gsub("#{resource}.", ''),
-            url: element.type.first.profile.first
+            id: profile_element.id,
+            path: profile_element.path.gsub("#{resource}.", ''),
+            url: profile_element.type.first.profile.first
           }
 
-          metadata[:uscdi_only] = true if uscdi_requirement_element?(element)
+          if uscdi_plus_quality_element?(profile_element)
+            metadata[:uscdi_plus_quality] = true
+          elsif uscdi_requirement_element?(profile_element)
+            metadata[:uscdi_only] = true
+          end
 
-          add_us_quality_coreuscdi_plus_quality_flag(element, metadata)
+          metadata
         end
       end
 
       def must_support_slices
-        (type_slices + value_slices).map do |slice|
-          profile_element = must_support_slice_elements.find { |e| e.id == slice[:slice_id] }
+        (type_slices + value_slices).map do |metadata|
+          profile_element = must_support_slice_elements.find { |e| e.id == metadata[:slice_id] }
 
-          add_us_quality_coreuscdi_plus_quality_flag(profile_element, slice)
+          if uscdi_plus_quality_element?(profile_element)
+            metadata[:uscdi_plus_quality] = true
+          elsif uscdi_requirement_element?(profile_element)
+            metadata[:uscdi_only] = true
+          end
+
+          metadata
         end
       end
 
@@ -380,8 +388,6 @@ module USQualityCoreTestKit
                 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?
@@ -403,13 +409,19 @@ module USQualityCoreTestKit
 
         return ms_elements unless profile.url.include?('us-quality-core')
 
-        ms_elements.map do |element|
+        ms_elements.map do |metadata|
           profile_element = plain_must_support_elements.find do |e|
             path = e.id.gsub("#{resource}.", '')
-            [element[:path], element[:original_path]].include?(path)
+            [metadata[:path], metadata[:original_path]].include?(path)
+          end
+
+          if uscdi_plus_quality_element?(profile_element)
+            metadata[:uscdi_plus_quality] = true
+          elsif uscdi_requirement_element?(profile_element)
+            metadata[:uscdi_only] = true
           end
 
-          add_us_quality_coreuscdi_plus_quality_flag(profile_element, element)
+          metadata
         end
       end
 
@@ -427,6 +439,11 @@ module USQualityCoreTestKit
         remove_vital_sign_component
         remove_blood_pressure_value_data_absent_reason
         remove_observation_data_absent_reason
+
+        # if (profile.url.start_with?('http://hl7.org/fhir/us/quality-core') && profile.version.start_with?('1.0.0')) ||
+        #   (profile.url.start_with?('http://hl7.org/fhir/us/core') && profile.version == '9.0.0')
+        MustSupportMetadataExtractorV1.new(profile, @must_supports).handle_special_cases
+        # end
       end
     end
   end

data/lib/us_quality_core_test_kit/generator/must_support_metadata_extractor_v1.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module USQualityCoreTestKit
+  class Generator
+    class MustSupportMetadataExtractorV1
+      attr_accessor :profile, :must_supports
+
+      def initialize(profile, must_supports)
+        self.profile = profile
+        self.must_supports = must_supports
+      end
+
+      def handle_special_cases
+        add_must_support_choices
+        add_patient_uscdi_elements
+        update_patient_previous_name_address
+        remove_practitioner_address
+      end
+
+      def add_must_support_choices
+        choices = []
+
+        case profile.type
+        when 'DocumentReference'
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0368
+          choices << { paths: ['content.attachment.data', 'content.attachment.url'] }
+        when 'Encounter'
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0375
+          choices << { paths: %w[reasonCode reasonReference] }
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0379
+          choices << { paths: ['location.location', 'serviceProvider'] }
+        when 'Goal'
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0387
+          choices << { paths: ['startDate', 'target.dueDate'] }
+        when 'MedicationRequest'
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0408
+          choices << { paths: %w[reportedBoolean reportedReference] }
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0411
+          choices << {
+            paths: %w[reasonCode reasonReference],
+            uscdi_plus_quality: true
+          }
+        when 'Procedure', 'ServiceRequest'
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0484
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0518
+          choices << {
+            paths: %w[reasonCode reasonReference],
+            uscdi_plus_quality: true
+          }
+        when 'Specimen'
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0524
+          choices << { paths: %w[accessionIdentifier identifier] }
+        end
+
+        must_supports[:choices] = choices if choices.present?
+      end
+
+      def add_patient_uscdi_elements
+        return unless profile.type == 'Patient'
+
+        must_supports[:elements].each do |element|
+          path = element[:path]
+
+          # Though telecom.system, telecom.value, telecom.use, and communication.language are marked as MustSupport since US Core v4.0.0,
+          # their parent elements telecom, and communication are not MustSupport but listed under "Additional USCDI requirements"
+          # According to the updated FHIR spec that "When a child element is defined as Must Support and the parent element isn't,
+          # a system must support the child if it support the parent, but there's no expectation that the system must support the parent.",
+          # We add uscdi_only tag to these elements
+          next unless path.include?('telecom.') || path.include?('communication.')
+
+          element[:uscdi_plus_quality] = true
+          # temporary remove this logic because US Quality Core may have different logic here
+          # elsif path == 'deceased[x]'
+          # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0465
+          # element[:original_path] = element[:path]
+          # element[:path] = 'deceasedDateTime'
+        end
+      end
+
+      # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0466
+      # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0467
+      def update_patient_previous_name_address
+        return unless profile.type == 'Patient'
+
+        name_period_exists = false
+        name_use_exists = false
+        address_period_exists = false
+        address_use_exists = false
+
+        must_supports[:elements].each do |element|
+          case element[:path]
+          when 'name.period'
+            element[:path] = 'name.period.end'
+            element[:uscdi_plus_quality] = true
+            name_period_exists = true
+          when 'name.use'
+            element[:fixed_value] = 'old'
+            element[:uscdi_plus_quality] = true
+            name_use_exists = true
+          when 'address.period'
+            element[:path] = 'address.period.end'
+            element[:uscdi_plus_quality] = true
+            address_period_exists = true
+          when 'address.use'
+            element[:fixed_value] = 'old'
+            element[:uscdi_plus_quality] = true
+            address_use_exists = true
+          end
+        end
+
+        unless name_period_exists
+          must_supports[:elements] << {
+            path: 'name.period.end',
+            uscdi_plus_quality: true
+          }
+        end
+
+        unless name_use_exists
+          must_supports[:elements] << {
+            path: 'name.use',
+            fixed_value: 'old',
+            uscdi_plus_quality: true
+          }
+        end
+
+        unless address_period_exists
+          must_supports[:elements] << {
+            path: 'address.period.end',
+            uscdi_plus_quality: true
+          }
+        end
+
+        unless address_use_exists
+          must_supports[:elements] << {
+            path: 'address.use',
+            fixed_value: 'old',
+            uscdi_plus_quality: true
+          }
+        end
+
+        must_supports[:choices] ||= []
+
+        must_supports[:choices] << {
+          paths: ['address.period.end', 'address.use'],
+          uscdi_plus_quality: true
+        }
+
+        must_supports[:choices] << {
+          paths: ['name.period.end', 'name.use'],
+          uscdi_plus_quality: true
+        }
+      end
+
+      # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0474
+      # https://hl7.org/fhir/us/core/STU9/requirements.html#CONF-0475
+      def remove_practitioner_address
+        return unless profile.type == 'Practitioner'
+
+        must_supports[:elements].delete_if { |element| element[:path].start_with?('address') }
+      end
+    end
+  end
+end

data/lib/us_quality_core_test_kit/generator/must_support_test_generator.rb

@@ -91,22 +91,22 @@ module USQualityCoreTestKit
         build_must_support_list_string(true)
       end
 
-      def build_must_support_list_string(us_quality_coreuscdi_plus_quality)
+      def build_must_support_list_string(uscdi_plus_quality)
         slice_names = group_metadata.must_supports[:slices]
-                                    .select { |slice| slice[:us_quality_coreuscdi_plus_quality].presence == us_quality_coreuscdi_plus_quality.presence }
+                                    .select { |slice| slice[:uscdi_plus_quality].presence == uscdi_plus_quality.presence }
                                     .map { |slice| slice[:slice_id] }
 
         element_names = group_metadata.must_supports[:elements]
-                                      .select { |element| element[:us_quality_coreuscdi_plus_quality].presence == us_quality_coreuscdi_plus_quality.presence }
+                                      .select { |element| element[:uscdi_plus_quality].presence == uscdi_plus_quality.presence }
                                       .map { |element| "#{resource_type}.#{element[:path]}" }
 
         extension_names = group_metadata.must_supports[:extensions]
-                                        .select { |extension| extension[:us_quality_coreuscdi_plus_quality].presence == us_quality_coreuscdi_plus_quality.presence }
+                                        .select { |extension| extension[:uscdi_plus_quality].presence == uscdi_plus_quality.presence }
                                         .map { |extension| extension[:id] }
 
         choice_names = []
         group_metadata.must_supports[:choices]&.map do |choice|
-          next unless choice[:us_quality_coreuscdi_plus_quality].presence == us_quality_coreuscdi_plus_quality.presence
+          next unless choice[:uscdi_plus_quality].presence == uscdi_plus_quality.presence
 
           combined = []
           if choice.key?(:paths)