davinci_crd_test_kit 0.14.0 → 0.14.2

data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/create_or_update_coverage_info_response_validation_test.rb

@@ -1,74 +1,118 @@
 require_relative '../../server_test_helper'
-require_relative '../../../cross_suite/suggestion_actions_validation'
 require_relative '../../server_hook_helper'
 require_relative '../../../cross_suite/cards_identification'
-require_relative '../../../cross_suite/cards_validation'
+require_relative '../../../cross_suite/response_logical_model_validation'
 
 module DaVinciCRDTestKit
   module V221
     class CreateOrUpdateCoverageInfoResponseValidationTest < Inferno::Test
       include DaVinciCRDTestKit::ServerTestHelper
-      include DaVinciCRDTestKit::SuggestionActionsValidation
       include DaVinciCRDTestKit::ServerHookHelper
       include DaVinciCRDTestKit::CardsIdentification
-      include DaVinciCRDTestKit::CardsValidation
+      include DaVinciCRDTestKit::ResponseLogicalModelValidation
 
       title 'Create or Update Coverage Information cards and system actions are valid'
       id :crd_v221_create_or_update_coverage_info_response_validation
       description %(
-        This test validates the Create or Update Coverage Information cards or system actions received from the
-        CRD service, as per the specifications outlined in the [Da Vinci CRD Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#create-or-update-coverage-information).
+        This test validates the Create or Update Coverage Information cards or
+        system actions received from the CRD service, as per the specifications
+        outlined in the [Da Vinci CRD Implementation
+        Guide](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#update-coverage-records-response-type).
 
         - **Checking for Presence:**
-          The test first checks if any Create or Update Coverage Information cards or system actions are present in
-          the returned valid cards or valid system actions.
-          - **For cards**: it ensures there are cards with a `suggestions` array containing a single suggestion,
-          and the `actions` array of that suggestion has one `create` or `update` action for the `Coverage` resource.
-          - **For system actions**: it checks for the presence of `create` or `update` actions for the `Coverage`
-          resource.
+          The test first checks if any Create or Update Coverage Information
+          cards or system actions are present in the returned valid cards or
+          valid system actions.
+          - **For cards**: it ensures there are cards with a `suggestions` array
+            containing a single suggestion, and the `actions` array of that
+            suggestion has one `create` or `update` action for the `Coverage`
+            resource.
+          - **For system actions**: it checks for the presence of `create` or
+            `update` actions for the `Coverage` resource.
 
         - **Validating:**
-        If any Create or Update Coverage Information cards or system actions are found, each `Coverage` resource is
-        validated against the base FHIR Coverage resource.
+          If any Create or Update Coverage Information cards or system actions
+          are found, each `Coverage` resource is validated against the base FHIR
+          Coverage resource.
 
-        If no Create or Update Coverage Information cards or system actions are received, the test is skipped.
+          If no Create or Update Coverage Information cards or system actions
+          are received, the test is skipped.
       )
 
-      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-71'
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-3',
+                            'hl7.fhir.us.davinci-crd_2.2.1@resp-71'
+
+      input :invoked_hook
 
       optional
-      input :valid_cards_with_suggestions, :valid_system_actions
+
+      def body_has_no_cards?(body)
+        !body.is_a?(Hash) ||
+          body['cards'].blank? ||
+          !body['cards'].is_a?(Array) ||
+          !body['cards'].all?(Hash)
+      end
+
+      def update_coverage_cards(request)
+        return [] if request.status != 200
+
+        response_body = JSON.parse(request.response_body)
+
+        return [] if body_has_no_cards?(response_body)
+
+        response_body['cards'].select { |card| create_or_update_coverage_card_response_type? card }
+      rescue JSON::ParserError
+        []
+      end
+
+      def body_has_no_system_actions?(body)
+        !body.is_a?(Hash) ||
+          body['systemActions'].blank? ||
+          !body['systemActions'].is_a?(Array) ||
+          !body['systemActions'].all?(Hash)
+      end
+
+      def update_coverage_actions(request)
+        return [] if request.status != 200
+
+        response_body = JSON.parse(request.response_body)
+
+        return [] if body_has_no_system_actions?(response_body)
+
+        response_body['systemActions'].select { |action| create_or_update_coverage_action_response_type? action }
+      rescue JSON::ParserError
+        []
+      end
 
       run do
-        parsed_cards = parse_json(valid_cards_with_suggestions)
-        parsed_actions = parse_json(valid_system_actions)
+        load_tagged_requests(tested_hook_name)
 
-        create_or_update_coverage_info_cards = parsed_cards.select do |card|
-          create_or_update_coverage_card_response_type?(card)
-        end
-        create_or_update_coverage_info_actions = parsed_actions.select do |action|
-          create_or_update_coverage_action_response_type?(action)
-        end
+        update_coverage_count = 0
 
-        skip_msg = "#{tested_hook_name} hook response does not contain any Create or Update Coverage Information " \
-                   'cards or system actions.'
-        skip_if create_or_update_coverage_info_cards.blank? && create_or_update_coverage_info_actions.blank?, skip_msg
+        successful_requests = requests.select { |request| request.status == 200 }
 
-        if create_or_update_coverage_info_actions.present?
-          actions_check(create_or_update_coverage_info_actions, ig_version: 'v221')
-        end
+        skip_if successful_requests.blank?,
+                'No successful hook responses were received'
 
-        if create_or_update_coverage_info_cards.present?
-          create_or_update_coverage_info_cards.each do |card|
-            actions_check(card['suggestions'].first['actions'].select do |action|
-                            create_or_update_coverage_action_response_type?(action)
-                          end, ig_version: 'v221')
+        requests.each_with_index do |request, index|
+          cards = update_coverage_cards(request)
+          actions = update_coverage_actions(request)
 
-            create_or_update_coverage_check(card)
-          end
+          update_coverage_count += cards.length + actions.length
+
+          perform_response_logical_model_validation(
+            cards,
+            actions,
+            request.request_body,
+            index,
+            '2.2.1'
+          )
         end
 
-        no_error_validation('Some Create or Update Coverage Information received are not valid.')
+        skip_if update_coverage_count.zero?,
+                "#{tested_hook_name} hook responses do not contain any Update Coverage Records cards or system actions."
+
+        no_error_validation('Not all Update Coverage Records responses were valid. See messages for more information.')
       end
     end
   end

data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/external_reference_card_validation_test.rb

@@ -1,7 +1,7 @@
 require_relative '../../server_test_helper'
 require_relative '../../server_hook_helper'
 require_relative '../../../cross_suite/cards_identification'
-require_relative '../../../cross_suite/cards_validation'
+require_relative '../../../cross_suite/response_logical_model_validation'
 
 module DaVinciCRDTestKit
   module V221
@@ -9,38 +9,80 @@ module DaVinciCRDTestKit
       include DaVinciCRDTestKit::ServerTestHelper
       include DaVinciCRDTestKit::ServerHookHelper
       include DaVinciCRDTestKit::CardsIdentification
-      include DaVinciCRDTestKit::CardsValidation
+      include DaVinciCRDTestKit::ResponseLogicalModelValidation
 
       title 'External Reference cards are valid'
       id :crd_v221_external_reference_card_validation
       description %(
-        This test verifies the presence of valid External Reference cards within the list of valid cards
-        returned by the CRD service.
-        As per the [Da Vinci CRD Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#external-reference),
-        External Reference cards must contain links with the type set to `absolute`.
-        This test checks for the presence of any External Reference cards by verifying:
+        This test verifies the presence of valid External Reference cards within
+        the CRD service responses.
+
+        As per the [Da Vinci CRD Implementation
+        Guide](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#external-reference-response-type),
+        External Reference cards must contain links with the type set to
+        `absolute`. This test checks for the presence of any External Reference
+        cards by verifying:
         - The presence of a `links` array within each card.
         - That every link in the `links` array of a card is of type `absolute`.
+
+        The test will be skipped if no External Reference cards are found within
+        the returned valid cards.
       )
 
-      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-22'
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-19',
+                            'hl7.fhir.us.davinci-crd_2.2.1@resp-22'
+
+      input :invoked_hook
 
-      input :valid_cards_with_links
       optional
 
+      def body_has_no_cards?(body)
+        !body.is_a?(Hash) ||
+          body['cards'].blank? ||
+          !body['cards'].is_a?(Array) ||
+          !body['cards'].all?(Hash)
+      end
+
+      def external_reference_cards(request)
+        return [] if request.status != 200
+
+        response_body = JSON.parse(request.response_body)
+
+        return [] if body_has_no_cards?(response_body)
+
+        response_body['cards'].select { |card| external_reference_response_type? card }
+      rescue JSON::ParserError
+        []
+      end
+
       run do
-        parsed_cards = parse_json(valid_cards_with_links)
-        external_reference_cards = parsed_cards.select { |card| external_reference_response_type?(card) }
+        load_tagged_requests(tested_hook_name)
+
+        external_reference_count = 0
+
+        successful_requests = requests.select { |request| request.status == 200 }
 
-        skip_if external_reference_cards.blank?,
-                "#{tested_hook_name} hook response does not contain any External Reference cards."
+        skip_if successful_requests.blank?,
+                'No successful hook responses were received'
 
-        external_reference_cards.each do |card|
-          external_reference_card_check(card)
+        requests.each_with_index do |request, index|
+          cards = external_reference_cards(request)
+
+          external_reference_count += cards.length
+
+          perform_response_logical_model_validation(
+            cards,
+            nil,
+            request.request_body,
+            index,
+            '2.2.1'
+          )
         end
 
-        assert messages.blank?,
-               'Not all External Reference cards were valid. See messages for more information.'
+        skip_if external_reference_count.zero?,
+                "#{tested_hook_name} hook responses do not contain any External Reference cards."
+
+        no_error_validation('Not all External Reference cards were valid. See messages for more information.')
       end
     end
   end

data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/form_completion_response_validation_test.rb

@@ -1,38 +1,42 @@
 require_relative '../../server_test_helper'
-require_relative '../../../cross_suite/suggestion_actions_validation'
 require_relative '../../server_hook_helper'
 require_relative '../../../cross_suite/cards_identification'
-require_relative '../../../cross_suite/cards_validation'
+require_relative '../../../cross_suite/response_logical_model_validation'
 
 module DaVinciCRDTestKit
   module V221
     class FormCompletionResponseValidationTest < Inferno::Test
       include DaVinciCRDTestKit::ServerTestHelper
-      include DaVinciCRDTestKit::SuggestionActionsValidation
       include DaVinciCRDTestKit::ServerHookHelper
       include DaVinciCRDTestKit::CardsIdentification
-      include DaVinciCRDTestKit::CardsValidation
+      include DaVinciCRDTestKit::ResponseLogicalModelValidation
 
       title 'Request Form Completion cards and system actions are valid'
       id :crd_v221_request_form_completion_response_validation
       description %(
-        This test validates the Request Form Completion cards or system actions received from the CRD service,
-        as per the specifications outlined in the [Da Vinci CRD Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion).
+        This test validates the Request Form Completion cards or system actions
+        received from the CRD service, as per the specifications outlined in the
+        [Da Vinci CRD Implementation
+        Guide](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#request-form-completion-response-type).
 
         - **Checking for Presence:**
-          The test begins by verifying whether any Request Form Completion cards or system actions are present.
-          - **For cards:** It ensures that there are cards with `suggestions` containing `create` actions
-          for the `Task` resource, specifically:
+          The test begins by verifying whether any Request Form Completion cards
+          or system actions are present.
+          - **For cards:** It ensures that there are cards with `suggestions`
+            containing `create` actions for the `Task` resource, specifically:
             - The `Task` must have a `code` of `complete-questionnaire`.
-            - The `Task` should include an input of type `text` (`Task.input.type.text`) labeled as `questionnaire`
-            and associated with a valid canonical URL (`Task.input.valueCanonical`).
-          - **For system actions:** It checks for the presence of `create` actions for the `Task` resource with
-          the characteristics described above.
+            - The `Task` should include an input of type `text`
+              (`Task.input.type.text`) labeled as `questionnaire` and associated
+              with a valid canonical URL (`Task.input.valueCanonical`).
+          - **For system actions:** It checks for the presence of `create`
+            actions for the `Task` resource with the characteristics described
+            above.
 
         - **Validating:**
-          If any Request Form Completion cards or system actions are found, the test proceeds to validate them.
-          Each `Task` resource is validated against the [CRD Questionnaire Task
-          profile](http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-taskquestionnaire).
+          If any Request Form Completion cards or system actions are found, the
+          test proceeds to validate them. Each `Task` resource is validated
+          against the [CRD Questionnaire Task
+          profile](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-taskquestionnaire.html).
           Additionally, if any actions for the creation of a `Questionnaire` are
           found, the test verifies that they include the
           `davinci-crd.if-none-exist` extension.
@@ -41,50 +45,81 @@ module DaVinciCRDTestKit
       )
 
       verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@dev-20',
+                            'hl7.fhir.us.davinci-crd_2.2.1@resp-3',
                             'hl7.fhir.us.davinci-crd_2.2.1@resp-62',
                             'hl7.fhir.us.davinci-crd_2.2.1@resp-65'
 
+      input :invoked_hook
+
       optional
-      input :valid_cards_with_suggestions, :valid_system_actions
+
+      def body_has_no_cards?(body)
+        !body.is_a?(Hash) ||
+          body['cards'].blank? ||
+          !body['cards'].is_a?(Array) ||
+          !body['cards'].all?(Hash)
+      end
+
+      def form_completion_cards(request)
+        return [] if request.status != 200
+
+        response_body = JSON.parse(request.response_body)
+
+        return [] if body_has_no_cards?(response_body)
+
+        response_body['cards'].select { |card| form_completion_card_response_type? card }
+      rescue JSON::ParserError
+        []
+      end
+
+      def body_has_no_system_actions?(body)
+        !body.is_a?(Hash) ||
+          body['systemActions'].blank? ||
+          !body['systemActions'].is_a?(Array) ||
+          !body['systemActions'].all?(Hash)
+      end
+
+      def form_completion_actions(request)
+        return [] if request.status != 200
+
+        response_body = JSON.parse(request.response_body)
+
+        return [] if body_has_no_system_actions?(response_body)
+
+        response_body['systemActions'].select { |action| form_completion_action_response_type? action }
+      rescue JSON::ParserError
+        []
+      end
 
       run do
-        parsed_cards = parse_json(valid_cards_with_suggestions)
-        parsed_actions = parse_json(valid_system_actions)
+        load_tagged_requests(tested_hook_name)
 
-        form_completion_cards = parsed_cards.select { |card| form_completion_card_response_type?(card) }
-        form_completion_actions = parsed_actions.select { |action| form_completion_action_response_type?(action) }
+        form_completion_count = 0
 
-        skip_if form_completion_cards.blank? && form_completion_actions.blank?,
-                "#{tested_hook_name} hook response does not contain any Request Form Completion cards " \
-                'or system actions.'
+        successful_requests = requests.select { |request| request.status == 200 }
 
-        actions_check(form_completion_actions, ig_version: 'v221') if form_completion_actions.present?
+        skip_if successful_requests.blank?,
+                'No successful hook responses were received'
 
-        if form_completion_cards.present?
-          form_completion_cards.each do |card|
-            actions =
-              card['suggestions']
-                .flat_map { |suggestion| suggestion['actions'] }
-                .compact
-                .select { |action| form_completion_action_response_type? action }
+        requests.each_with_index do |request, index|
+          cards = form_completion_cards(request)
+          actions = form_completion_actions(request)
 
-            actions_check(actions, ig_version: 'v221')
+          form_completion_count += cards.length + actions.length
 
-            form_completion_check(card)
-          end
+          perform_response_logical_model_validation(
+            cards,
+            actions,
+            request.request_body,
+            index,
+            '2.2.1'
+          )
         end
 
-        questionnaire_create_actions =
-          parsed_actions.select { |action| create_questionnaire_action_response_type?(action) } +
-          form_completion_cards
-            .flat_map { |card| card['suggestions'] }
-            .flat_map { |suggestion| suggestion['actions'] }
-            .compact
-            .select { |action| create_questionnaire_action_response_type?(action) }
-
-        questionnaire_create_actions.each { |action| questionnaire_creation_check(action) }
+        skip_if form_completion_count.zero?,
+                "#{tested_hook_name} hook responses do not contain any Request Form Completion cards or system actions."
 
-        no_error_validation('Some Request Form Completion received are not valid.')
+        no_error_validation('Not all Request Form Completion responses were valid. See messages for more information.')
       end
     end
   end

data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/hook_request_resource_resolution.rb

@@ -34,6 +34,43 @@ module DaVinciCRDTestKit
           fallback_source_resource(request_body, target_type, target_id)
       end
 
+      def only_coverage_information_changed?(source_resource_hash, updated_resource_hash)
+        return true if coverage_information_extension_only_payload?(updated_resource_hash)
+
+        source_without_coverage_info = normalize_value(strip_coverage_info_extensions(source_resource_hash))
+        updated_without_coverage_info = normalize_value(strip_coverage_info_extensions(updated_resource_hash))
+
+        source_without_coverage_info == updated_without_coverage_info
+      end
+
+      def coverage_information_extension_only_payload?(resource_hash)
+        return false unless resource_hash.is_a?(Hash)
+
+        strip_coverage_info_extensions(resource_hash).keys.all? { |key| ['resourceType', 'id', 'meta'].include?(key) }
+      end
+
+      def strip_coverage_info_extensions(resource_hash)
+        normalized_hash = resource_hash.deep_dup
+        return normalized_hash unless normalized_hash['extension'].is_a?(Array)
+
+        normalized_hash['extension'] = normalized_hash['extension'].reject do |extension|
+          extension['url'] == DaVinciCRDTestKit::CardsIdentification::COVERAGE_INFO_EXT_URL
+        end
+        normalized_hash.delete('extension') if normalized_hash['extension'].empty?
+        normalized_hash
+      end
+
+      def normalize_value(value)
+        case value
+        when Hash
+          value.transform_values { |child| normalize_value(child) }
+        when Array
+          value.map { |child| normalize_value(child) }.sort_by(&:to_json)
+        else
+          value
+        end
+      end
+
       def find_appointment_book_resource(request_body, target_type, target_id)
         appointments_bundle = request_body.dig('context', 'appointments')
         find_resource_in_bundle(appointments_bundle, target_type, target_id) ||

data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/instructions_card_received_test.rb

@@ -1,6 +1,7 @@
 require_relative '../../server_test_helper'
 require_relative '../../server_hook_helper'
 require_relative '../../../cross_suite/cards_identification'
+require_relative '../../../cross_suite/response_logical_model_validation'
 
 module DaVinciCRDTestKit
   module V221
@@ -8,24 +9,74 @@ module DaVinciCRDTestKit
       include DaVinciCRDTestKit::ServerTestHelper
       include DaVinciCRDTestKit::ServerHookHelper
       include DaVinciCRDTestKit::CardsIdentification
+      include DaVinciCRDTestKit::ResponseLogicalModelValidation
 
       title 'Instructions cards are valid'
       id :crd_v221_valid_instructions_card_received
       description %(
-        This test validates that an [Instructions](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#instructions)
+        This test validates that an
+        [Instructions](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#instructions-response-type)
         card was received. It does so by:
-        - Checking for the presence of a valid card that does not contain the `links` field and the `suggestions` field.
+        - Checking for the presence of a valid card that does not contain the
+          `links` field and the `suggestions` field.
+
+        The test will be skipped if no Instructions cards are found within the
+        returned valid cards.
       )
 
       verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-24'
 
-      input :valid_cards
+      input :invoked_hook
+
       optional
 
+      def body_has_no_cards?(body)
+        !body.is_a?(Hash) ||
+          body['cards'].blank? ||
+          !body['cards'].is_a?(Array) ||
+          !body['cards'].all?(Hash)
+      end
+
+      def instructions_cards(request)
+        return [] if request.status != 200
+
+        response_body = JSON.parse(request.response_body)
+
+        return [] if body_has_no_cards?(response_body)
+
+        response_body['cards'].select { |card| instructions_response_type? card }
+      rescue JSON::ParserError
+        []
+      end
+
       run do
-        parsed_cards = parse_json(valid_cards)
-        instructions_card = parsed_cards.find { |card| instructions_response_type?(card) }
-        assert instructions_card, "#{tested_hook_name} hook response did not contain an Instructions card."
+        load_tagged_requests(tested_hook_name)
+
+        instructions_count = 0
+
+        successful_requests = requests.select { |request| request.status == 200 }
+
+        skip_if successful_requests.blank?,
+                'No successful hook responses were received'
+
+        requests.each_with_index do |request, index|
+          cards = instructions_cards(request)
+
+          instructions_count += cards.length
+
+          perform_response_logical_model_validation(
+            cards,
+            nil,
+            request.request_body,
+            index,
+            '2.2.1'
+          )
+        end
+
+        skip_if instructions_count.zero?,
+                "#{tested_hook_name} hook responses do not contain any Instructions cards."
+
+        no_error_validation('Not all Instructions cards were valid. See messages for more information.')
       end
     end
   end