au_core_test_kit 1.4.0 → 1.4.3

data/lib/au_core_test_kit/generators/custom_identifier_search/generator.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'inferno_suite_generator'
+
+require_relative '../special_cases'
+
+module InfernoSuiteGenerator
+  class Generator
+    class SpecialIdentifierSearchTestGenerator < InfernoSuiteGenerator::Generator::SearchTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir, absolute_template_path)
+          eligible_groups(ig_metadata).each do |group|
+            generate_for_group(group, ig_metadata, base_output_dir, absolute_template_path)
+          end
+        end
+
+        private
+
+        def eligible_groups(ig_metadata)
+          ig_metadata.groups
+                     .reject { |group| SpecialCases.exclude_group? group }
+                     .select { |group| supported_group_names.include?(group.name) }
+                     .select { |group| group.searches.present? }
+        end
+
+        def supported_group_names
+          %w[au_core_patient au_core_practitioner au_core_organization au_core_practitionerrole]
+        end
+
+        def generate_for_group(group, ig_metadata, base_output_dir, absolute_template_path)
+          group.searches.each do |search|
+            next unless search[:names].include?('identifier')
+
+            generation_context = {
+              group_metadata: group,
+              search_metadata: search,
+              base_output_dir:,
+              ig_metadata:,
+              absolute_template_path:
+            }
+            identifiers_for_group(group.name).each do |special_identifier|
+              new(generation_context.merge(special_identifier:)).generate
+            end
+          end
+        end
+
+        def identifiers_for_group(group_name)
+          case group_name
+          when 'au_core_patient'
+            SpecialCases.patient_au_identifiers
+          when 'au_core_practitioner'
+            SpecialCases.practitioner_au_identifiers
+          when 'au_core_practitionerrole'
+            SpecialCases.practitionerrole_au_identifiers
+          when 'au_core_organization'
+            SpecialCases.organization_au_identifiers
+          end
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir, :special_identifier, :absolute_template_path, :ig_metadata
+
+      def initialize(options)
+        super(options[:group_metadata], options[:search_metadata], options[:base_output_dir], options[:ig_metadata])
+        self.special_identifier = options[:special_identifier]
+        self.absolute_template_path = options[:absolute_template_path]
+      end
+
+      def template
+        @template ||= File.read(absolute_template_path)
+      end
+
+      def test_id
+        "au_core_#{group_metadata.reformatted_version}_#{profile_identifier}_#{search_identifier}_#{special_identifier[:display].delete('-').downcase}_search_test"
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}#{search_title}#{special_identifier[:display].delete('-')}SearchTest"
+      end
+
+      def optional?
+        true
+      end
+
+      def search_properties
+        {}.tap do |properties|
+          properties[:resource_type] = "'#{resource_type}'"
+          properties[:search_param_names] = search_param_names_array
+          properties[:token_search_params] = token_search_params_string if token_search_params.present?
+          properties[:target_identifier] = special_identifier
+        end
+      end
+
+      def title
+        "Server returns valid results for #{resource_type} search by identifier (#{special_identifier[:display]})"
+      end
+
+      def description
+        <<~DESCRIPTION.gsub(/\n{3,}/, "\n\n")
+          A server SHOULD support searching by
+          #{search_param_name_string} (#{special_identifier[:display]}) on the #{resource_type} resource. This test
+          will pass if resources are returned and match the search criteria. If
+          none are returned, the test is skipped.
+
+          [AU Core Server CapabilityStatement](http://hl7.org.au/fhir/core/#{url_version}/CapabilityStatement-au-core-server.html)
+        DESCRIPTION
+      end
+    end
+  end
+end

data/lib/au_core_test_kit/generators/custom_identifier_search/special_identifier_search_test.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'inferno_suite_generator/test_modules/search_test'
+require 'inferno_suite_generator/core/search_test_properties'
+require 'inferno_suite_generator/utils/assert_helpers'
+
+module InfernoSuiteGenerator
+  class SpecialIdentifierSearchTest < Inferno::Test
+    include InfernoSuiteGenerator::SearchTest
+    extend Forwardable
+    include AssertHelpers
+
+    SearchTestProperties = InfernoSuiteGenerator::SearchTestProperties
+
+    def_delegators 'self.class', :metadata, :provenance_metadata, :properties
+    def_delegators 'properties',
+                   :resource_type,
+                   :search_param_names,
+                   :saves_delayed_references?,
+                   :first_search?,
+                   :fixed_value_search?,
+                   :possible_status_search?,
+                   :test_medication_inclusion?,
+                   :test_post_search?,
+                   :token_search_params,
+                   :test_reference_variants?,
+                   :params_with_comparators,
+                   :multiple_or_search_params,
+                   :optional_multiple_or_search_params,
+                   :multiple_and_search_params,
+                   :optional_multiple_and_search_params,
+                   :target_identifier
+
+    def all_search_params
+      @all_search_params ||=
+        patient_id_list.each_with_object({}) do |patient_id, params|
+          params[patient_id] ||= []
+          new_params = [search_params_with_values(search_param_names, patient_id)]
+          new_params.reject! do |n_params|
+            n_params.any? { |_key, value| value.blank? }
+          end
+          params[patient_id].concat(new_params)
+        end
+    end
+
+    def search_params_with_values(search_param_names, patient_id, include_system: false)
+      resources = scratch_resources_for_patient(patient_id)
+
+      return default_search_params if resources.empty?
+
+      resources.each_with_object({}) do |resource, outer_params|
+        results_from_one_resource = search_param_names.each_with_object({}) do |name, params|
+          value = search_param_value(name, resource, include_system:)
+          params[name] = value
+        end
+
+        outer_params.merge!(results_from_one_resource)
+        # stop if all parameter values are found
+        return outer_params if outer_params.all? { |_key, value| value.present? }
+      end
+    end
+
+    def default_search_params(search_param_names, patient_id)
+      search_param_names.each_with_object({}) do |name, params|
+        value = patient_id_param?(name) ? patient_id : nil
+        params[name] = value
+      end
+    end
+
+    def get_resource_identifiers(resource, target_identifier)
+      resource.identifier.filter { |ident| ident.system == target_identifier[:url] }
+    end
+
+    def search_param_value(_name, resource, include_system: false)
+      search_value = nil
+      resource_identifiers = get_resource_identifiers(resource, target_identifier)
+      if resource_identifiers.length.positive?
+        resource_identifier = resource_identifiers.first
+        search_value = include_system ? "#{resource_identifier.system}|#{resource_identifier.value}" : resource_identifier.value.to_s
+      end
+      search_value&.gsub(',', '\\,')
+    end
+
+    def ensure_special_identifier_prerequisites!
+      conditional_skip_with_msg scratch_resources[:all].empty?, no_resources_skip_message
+      conditional_skip_with_msg !any_valid_search_params?(all_search_params), unable_to_resolve_params_message
+    end
+
+    def perform_special_identifier_searches
+      all_search_params.flat_map do |patient_id, params_list|
+        params_list.flat_map { |params| perform_search_with_system(params, patient_id) }
+      end
+    end
+
+    def run_special_identifier_search_test
+      ensure_special_identifier_prerequisites!
+      resources_returned = perform_special_identifier_searches
+      conditional_skip_with_msg resources_returned.empty?, no_resources_skip_message
+    end
+  end
+end

data/lib/au_core_test_kit/generators/medication_inclusion_test/generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'inferno_suite_generator'
+
+module InfernoSuiteGenerator
+  class Generator
+    class MedicationInclusionTestGenerator < InfernoSuiteGenerator::Generator::ValidationTestGenerator
+      class << self
+        def generate(ig_metadata, base_output_dir, absolute_template_path)
+          medication_request_group = ig_metadata.groups.find { |group| group.resource == 'MedicationRequest' }
+          new(medication_request_group, ig_metadata, base_output_dir, absolute_template_path).generate
+        end
+      end
+
+      attr_accessor :group_metadata, :search_metadata, :base_output_dir, :special_identifier, :absolute_template_path, :ig_metadata
+
+      def initialize(group_metadata, ig_metadata, base_output_dir, absolute_template_path)
+        super(group_metadata, ig_metadata, nil, base_output_dir:)
+        self.absolute_template_path = absolute_template_path
+      end
+
+      def class_name
+        "#{Naming.upper_camel_case_for_profile(group_metadata)}MedicationInclusionValidationTest"
+      end
+
+      def title
+        'Medication resources returned during previous tests conform to the AU Core Medication'
+      end
+
+      def description
+        %(
+This test verifies resources returned from previous tests conform to
+the [AU Core Medication](http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication).
+
+It verifies the presence of mandatory elements and that elements with
+required bindings contain appropriate values. CodeableConcept element
+bindings will fail if none of their codings have a code/system belonging
+to the bound ValueSet. Quantity, Coding, and code element bindings will
+fail if their code/system are not found in the valueset.
+
+      )
+      end
+
+      def resource_type
+        'Medication'
+      end
+
+      def profile_identifier
+        'medication'
+      end
+
+      def profile_url
+        'http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication'
+      end
+
+      def test_id
+        "au_core_#{group_metadata.reformatted_version}_medication_request_medication_validation_test"
+      end
+    end
+  end
+end

data/lib/au_core_test_kit/generators/special_cases.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module InfernoSuiteGenerator
+  class Generator
+    module SpecialCases
+      RESOURCES_TO_EXCLUDE = %w[
+        Medication
+        DiagnosticReport
+      ].freeze
+
+      PROFILES_TO_EXCLUDE = [].freeze
+
+      PATIENT_IDENTIFIERS = [
+        { display: 'IHI', url: 'http://ns.electronichealth.net.au/id/hi/ihi/1.0' },
+        { display: 'Medicare', url: 'http://ns.electronichealth.net.au/id/medicare-number' },
+        { display: 'DVA', url: 'http://ns.electronichealth.net.au/id/dva' }
+      ].freeze
+
+      PRACTITIONER_IDENTIFIERS = [
+        { display: 'HPI-I', url: 'http://ns.electronichealth.net.au/id/hi/hpii/1.0' }
+      ].freeze
+
+      PRACTITIONER_ROLE_IDENTIFIERS = [
+        { display: 'Medicare', url: 'http://ns.electronichealth.net.au/id/medicare-provider-number' }
+      ].freeze
+
+      ORGANIZATION_IDENTIFIERS = [
+        { display: 'HPI-O', url: 'http://ns.electronichealth.net.au/id/hi/hpio/1.0' },
+        { display: 'ABN', url: 'http://hl7.org.au/id/abn' }
+      ].freeze
+
+      # In the current implementation (2024.10.16/1.0.0-ci-build) there is no way
+      # to get information on what search/combo search parameters SHOULD be supported
+      # with the _include parameter. This information exists only in narratives.
+
+      # https://build.fhir.org/ig/hl7au/au-fhir-core/StructureDefinition-au-core-medicationrequest.html#mandatory-search-parameters
+      # https://build.fhir.org/ig/hl7au/au-fhir-core/StructureDefinition-au-core-practitionerrole.html#mandatory-search-parameters
+      # https://github.com/hl7au/au-fhir-core-inferno/issues/199
+
+      SEARCH_PARAMS_FOR_INCLUDE_BY_RESOURCE = {
+        'MedicationStatement' => [
+          ['medication']
+        ],
+        'MedicationRequest' => [
+          ['patient'],
+          %w[patient intent],
+          %w[patient intent status],
+          ['_id'],
+          %w[patient intent authoredon]
+        ],
+        'PractitionerRole' => [
+          ['identifier'],
+          ['practitioner'],
+          ['_id'],
+          ['specialty']
+        ]
+      }.freeze
+
+      MULTIPLE_OR_AND_SEARCH_BY_TARGET_RESOURCE = {
+        'PractitionerRole' => [['practitioner']]
+      }.freeze
+
+      class << self
+        def exclude_group?(group)
+          case group.version
+          when 'v1.0.0'
+            %w[Medication RelatedPerson].include?(group.resource)
+          else
+            RESOURCES_TO_EXCLUDE.include?(group.resource)
+          end
+        end
+
+        def patient_au_identifiers
+          PATIENT_IDENTIFIERS
+        end
+
+        def practitioner_au_identifiers
+          PRACTITIONER_IDENTIFIERS
+        end
+
+        def practitionerrole_au_identifiers
+          PRACTITIONER_ROLE_IDENTIFIERS
+        end
+
+        def organization_au_identifiers
+          ORGANIZATION_IDENTIFIERS
+        end
+
+        def search_params_for_include_by_resource
+          SEARCH_PARAMS_FOR_INCLUDE_BY_RESOURCE
+        end
+
+        def multiple_or_and_search_by_target_resource
+          MULTIPLE_OR_AND_SEARCH_BY_TARGET_RESOURCE
+        end
+      end
+    end
+  end
+end

data/lib/au_core_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AUCoreTestKit
-  VERSION = '1.4.0'
+  VERSION = '1.4.3'
 end

data/lib/au_core_test_kit.rb

@@ -5,3 +5,5 @@ require_relative 'au_core_test_kit/custom_suites/validation_suite'
 require_relative 'au_core_test_kit/generated/v1.0.0/au_core_test_suite'
 
 require_relative 'au_core_test_kit/generated/v2.0.0/au_core_test_suite'
+
+require_relative 'au_core_test_kit/generated/v2.1.0-draft/au_core_test_suite'