davinci_crd_test_kit 0.13.0 → 0.14.1

data/lib/davinci_crd_test_kit/{suggestion_actions_validation.rb → cross_suite/suggestion_actions_validation.rb}

@@ -1,21 +1,46 @@
-require_relative 'server_hook_request_validation'
+require_relative 'hook_request_field_validation'
+
 module DaVinciCRDTestKit
   module SuggestionActionsValidation
-    include DaVinciCRDTestKit::ServerHookRequestValidation
-
-    def action_required_fields
-      { 'type' => String, 'description' => String }
-    end
+    include HookRequestFieldValidation
 
-    def action_fields_validation(action)
+    def action_fields_validation(action, ig_version: 'v201')
       action_required_fields.each do |field, type|
         validate_presence_and_type(action, field, type, 'Action')
       end
 
-      action_type_field_validation(action)
+      action_type_field_validation(action, ig_version:)
+    end
+
+    def actions_check(actions, contexts = nil, ig_version: 'v201')
+      create_actions_resource_types = extract_resource_types_by_action(actions, 'create')
+
+      actions.each do |action|
+        case action['type']
+        when 'create', 'update'
+          create_or_update_action_check(action, contexts, ig_version:)
+        when 'delete'
+          delete_action_check(action, create_actions_resource_types, contexts)
+        end
+      end
+    end
+
+    def action_resource_type_check(action, expected_resource_types) # rubocop:disable Naming/PredicateMethod
+      resource_type = if ['create', 'update'].include?(action['type'])
+                        FHIR.from_contents(action['resource'].to_json)&.resourceType
+                      else
+                        action['resourceId']&.split('/')&.first
+                      end
+      expected_resource_types.include?(resource_type)
     end
 
-    def action_type_field_validation(action)
+    private
+
+    def action_required_fields
+      { 'type' => String, 'description' => String }
+    end
+
+    def action_type_field_validation(action, ig_version: 'v201')
       return unless action['type']
 
       allowed_types = ['create', 'update', 'delete']
@@ -30,7 +55,7 @@ module DaVinciCRDTestKit
       if ['create', 'update'].include?(type)
         action_resource_field_validation(action, type)
       else
-        action_resource_id_field_validation(action)
+        action_resource_id_field_validation(action, ig_version:)
       end
     end
 
@@ -46,13 +71,9 @@ module DaVinciCRDTestKit
       add_message('error', "`Action.resource` must be a FHIR resource: `#{action}`.")
     end
 
-    def action_resource_id_field_validation(action)
-      validate_presence_and_type(action, 'resourceId', Array, '`delete` Action')
-      return unless action['resourceId'].is_a?(Array)
-
-      action['resourceId'].each do |ref|
-        resource_reference_check(ref, 'Action.resourceId item')
-      end
+    def action_resource_id_field_validation(action, ig_version: 'v201')
+      validate_presence_and_type(action, 'resourceId', String, '`delete` Action')
+      resource_reference_check(action['resourceId'], 'Action.resourceId', ig_version:)
     end
 
     def draft_orders_bundle_entry_refs(contexts)
@@ -62,37 +83,23 @@ module DaVinciCRDTestKit
       end
     end
 
-    def action_resource_type_check(action, expected_resource_types)
-      resource_types = if ['create', 'update'].include?(action['type'])
-                         [FHIR.from_contents(action['resource'].to_json).resourceType]
-                       else
-                         action['resourceId'].map { |ref| ref.split('/').first }
-                       end
-      resource_types.all? { |resource_type| expected_resource_types.include?(resource_type) }
-    end
-
     def extract_resource_types_by_action(actions, action_type)
       actions.each_with_object([]) do |act, resource_types|
         resource_types << act['resource']['resourceType'] if act['type'] == action_type
       end
     end
 
-    def actions_check(actions, contexts = nil)
-      create_actions_resource_types = extract_resource_types_by_action(actions, 'create')
+    def create_or_update_action_check(action, contexts, ig_version: 'v201')
+      resource = FHIR.from_contents(action['resource'].to_json)
+      resource_is_valid?(resource:, profile_url: structure_definition_map(ig_version)[resource.resourceType])
 
-      actions.each do |action|
-        case action['type']
-        when 'create', 'update'
-          create_or_update_action_check(action, contexts)
-        when 'delete'
-          delete_action_check(action, create_actions_resource_types, contexts)
-        end
+      if action['resourceId'].present?
+        add_message(
+          'error',
+          "`resourceId` should not be populated for create and update actions. In Action `#{action}`"
+        )
       end
-    end
 
-    def create_or_update_action_check(action, contexts)
-      resource = FHIR.from_contents(action['resource'].to_json)
-      resource_is_valid?(resource:, profile_url: structure_definition_map[resource.resourceType])
       return unless action['type'] == 'update' && contexts
 
       ref = "#{resource.resourceType}/#{resource.id}"
@@ -103,21 +110,34 @@ module DaVinciCRDTestKit
       add_message('error', error_msg)
     end
 
-    def delete_action_check(action, create_actions_resource_types, contexts)
-      action['resourceId'].each do |ref|
-        unless draft_orders_bundle_entry_refs(contexts).include?(ref)
-          error_msg = '`Action.resourceId` must reference FHIR resource from the `draftOrders` entry. ' \
-                      "#{ref} is not in `draftOrders`. In Action `#{action}`"
-          add_message('error', error_msg)
-          next
-        end
+    def questionnaire_creation_check(action)
+      return unless action.dig('resource', 'resourceType') == 'Questionnaire'
 
-        resource_type = ref.split('/').first
-        next if create_actions_resource_types.include?(resource_type)
+      extension_value = action.dig('extension', 'davinci-crd.if-none-exist')
+
+      if extension_value.nil?
+        add_message('error', '`davinci-crd.if-none-exist` extension is not present.')
+      elsif !extension_value.is_a? String
+        add_message('error', '`davinci-crd.if-none-exist` extension is not a string.')
+      elsif extension_value.blank?
+        add_message('error', '`davinci-crd.if-none-exist` extension is an empty string.')
+      end
+    end
 
-        error_msg = "There's no `create` action for the proposed order being deleted: `#{ref}`. In Action `#{action}`"
+    def delete_action_check(action, create_actions_resource_types, contexts)
+      ref = action['resourceId']
+      unless draft_orders_bundle_entry_refs(contexts).include?(ref)
+        error_msg = '`Action.resourceId` must reference FHIR resource from the `draftOrders` entry. ' \
+                    "#{ref} is not in `draftOrders`. In Action `#{action}`"
         add_message('error', error_msg)
+        return
       end
+
+      resource_type = ref.split('/').first
+      return if create_actions_resource_types.include?(resource_type)
+
+      error_msg = "There's no `create` action for the proposed order being deleted: `#{ref}`. In Action `#{action}`"
+      add_message('error', error_msg)
     end
   end
 end

data/lib/davinci_crd_test_kit/cross_suite/tags.rb

@@ -0,0 +1,46 @@
+module DaVinciCRDTestKit
+  APPOINTMENT_BOOK_TAG = 'appointment-book'.freeze
+  ENCOUNTER_START_TAG = 'encounter-start'.freeze
+  ENCOUNTER_DISCHARGE_TAG = 'encounter-discharge'.freeze
+  ORDER_DISPATCH_TAG = 'order-dispatch'.freeze
+  ORDER_SELECT_TAG = 'order-select'.freeze
+  ORDER_SIGN_TAG = 'order-sign'.freeze
+  DISCOVERY_TAG = 'cds_discovery'.freeze
+  ANY_HOOK_TAG = 'any_hook'.freeze
+  DATA_FETCH_TAG = 'data_fetch'.freeze
+  PAYER_ORG_FETCH_TAG = 'payer_org'.freeze
+  PARENT_LOCATION_FETCH_TAG = 'parent_location'.freeze
+  HOOK_INSTANCE_TAG_PREFIX = 'hi_'.freeze
+  HOOK_INSTANCE_DATA_FETCH_TAG_PREFIX = 'hi_data_fetch_'.freeze
+  LONG_RUNNING_GROUP_TAG = 'long_running_request'.freeze
+  DUPLICATED_HOOK_INSTANCE_TAG = 'duplicate_hook_instance'.freeze
+  COVERAGE_INFO_DISABLED_TAG = 'coverage-info-disabled'.freeze
+  TECHNICAL_ISSUES_TAG = 'technical-issues'.freeze
+  NO_MEMBER_FOUND_TAG = 'no-member-found'.freeze
+  COVERAGE_NOT_FOUND_TAG = 'coverage-not-found'.freeze
+  NO_ACTIVE_COVERAGE_TAG = 'no-active-coverage'.freeze
+  UNKNOWN_CONFIGURATION_TAG = 'unknown-configuration'.freeze
+  UNKNOWN_CONTEXT_TAG = 'unknown-context'.freeze
+  UNKNOWN_ELEMENT_TAG = 'unknown-element'.freeze
+
+  ALL_HOOK_TAGS = [
+    APPOINTMENT_BOOK_TAG,
+    ENCOUNTER_START_TAG,
+    ENCOUNTER_DISCHARGE_TAG,
+    ORDER_DISPATCH_TAG,
+    ORDER_SELECT_TAG,
+    ORDER_SIGN_TAG
+  ].freeze
+
+  module TagMethods
+    def hook_instance_tag(hook_instance)
+      "#{HOOK_INSTANCE_TAG_PREFIX}#{hook_instance}"
+    end
+
+    def hook_instance_data_fetch_tag(hook_instance)
+      "#{HOOK_INSTANCE_DATA_FETCH_TAG_PREFIX}#{hook_instance}"
+    end
+
+    module_function :hook_instance_tag, :hook_instance_data_fetch_tag
+  end
+end

data/lib/davinci_crd_test_kit/metadata.rb

@@ -6,9 +6,10 @@ module DaVinciCRDTestKit
     title 'Da Vinci Coverage Requirements Discovery (CRD) Test Kit'
     description <<~DESCRIPTION
       The Da Vinci Coverage Requirements Discovery (CRD) Test Kit tests the
-      conformance of client and server systems to [version 2.0.1 of the Da Vinci
-      Coverage Requirements Discovery (CRD) Implementation
-      Guide](https://hl7.org/fhir/us/davinci-crd/STU2).
+      conformance of client and server systems to versions of the
+      Da Vinci Coverage Requirements Discovery (CRD) FHIR Implementation Guide (IG), including
+      - [Da Vinci Coverage Requirements Discovery (CRD) STU 2.0.1](https://hl7.org/fhir/us/davinci-crd/STU2), and
+      - [Da Vinci Coverage Requirements Discovery (CRD) STU 2.2.1](https://hl7.org/fhir/us/davinci-crd/2.2.1)
 
       <!-- break -->
 
@@ -20,51 +21,16 @@ module DaVinciCRDTestKit
       requirements and may change how these are tested.
 
       Additional details on the IG requirements that underlie this test kit can be
-      found in this [CRD testing note](https://github.com/inferno-framework/davinci-crd-test-kit/blob/main/docs/crd-testing-notes.md). The document
-      includes the requirements extracted from the IG and specified the ones that are
-      not testable.
+      found in the [Specification Requirements display within the testing UI](https://inferno-framework.github.io/docs/user-interface.html#specification-requirements)
+      and other artifacts of Inferno's [requirements tracking tools](https://inferno-framework.github.io/docs/advanced-test-features/requirements.html).
 
-      ## Test Scope and Limitations
+      ## Additional Details
 
-      Documentation of the current tests and their limitations can be found in each
-      suite's (client and server) description when the tests are run.
+      Additional details about design, scope, and limitations of the suites within this
+      test kit can be found on the [CRD Test Kit Wiki](https://github.com/inferno-framework/davinci-crd-test-kit/wiki)
 
-      ### Test Scope
-
-      At a high-level, the tests check:
-
-      - **Client Suite**:
-        - The ability of a CRD client to initiate CDS Hooks calls.
-        - The ability of a CRD client to support the FHIR interactions defined in the
-          implementation guide.
-      - **Server Suite**:
-        - The ability of a CRD server to return a valid response when invoking its
-          discovery endpoint.
-        - The ability of a CRD server to return a valid response when invoking a
-          supported hook, including producing the required response types across all
-          hooks invoked.
-
-      ### Limitations
-
-      - **Client Suite**:
-        - This suite does not implement any payer business logic, so the responses to
-          hook calls are simple hard-coded responses.
-        - The tests cannot verify that a client is able to consume the received
-          decision support. Testers should consider this requirement to be verified
-          through attestation and should not represent their systems as having passed
-          these tests if this requirement is not met.
-        - Hook configuration is not tested.
-      - **Server Suite**:
-        - Inferno is unable to determine what requests will result in specific kinds
-          of responses from the server under test (e.g., what will result in
-          Instructions being returned vs. Coverage Information). As a result, the
-          tester must supply the request bodies that will cause the system under test
-          to return the desired response types.
-        - The ability of a CRD server to request additional FHIR resources is not
-          tested.
-        - Hook configuration is not tested.
     DESCRIPTION
-    suite_ids [:crd_client, :crd_server]
+    suite_ids [:crd_client, :crd_client_v221, :crd_server, :crd_server_v221]
     tags ['Da Vinci', 'CRD']
     last_updated LAST_UPDATED
     version VERSION