davinci_crd_test_kit 0.13.0 → 0.14.1

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

@@ -0,0 +1,83 @@
+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
+    class InstructionsCardReceivedTest < Inferno::Test
+      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/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.
+
+        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 :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
+        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
+end

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

@@ -0,0 +1,88 @@
+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
+    class LaunchSmartAppCardValidationTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerTestHelper
+      include DaVinciCRDTestKit::ServerHookHelper
+      include DaVinciCRDTestKit::CardsIdentification
+      include DaVinciCRDTestKit::ResponseLogicalModelValidation
+
+      title 'Launch SMART Application cards are valid'
+      id :crd_v221_launch_smart_app_card_validation
+      description %(
+        This test verifies the presence of valid Launch SMART Application 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#launch-smart-application-response-type),
+        Launch SMART Application cards must contain links with the type set to
+        `smart`. This test checks for the presence of any Launch SMART
+        Application cards by verifying:
+        - The existence of a `links` array within each card.
+        - That every link in the `links` array of a card is of type `smart`.
+
+        The test will be skipped if no Launch SMART Application cards are found
+        within the returned valid cards.
+      )
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-72'
+
+      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 launch_smart_app_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| launch_smart_app_response_type? card }
+      rescue JSON::ParserError
+        []
+      end
+
+      run do
+        load_tagged_requests(tested_hook_name)
+
+        launch_smart_app_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 = launch_smart_app_cards(request)
+
+          launch_smart_app_count += cards.length
+
+          perform_response_logical_model_validation(
+            cards,
+            nil,
+            request.request_body,
+            index,
+            '2.2.1'
+          )
+        end
+
+        skip_if launch_smart_app_count.zero?,
+                "#{tested_hook_name} hook responses do not contain any Launch SMART App cards."
+
+        no_error_validation('Not all Launch SMART App cards were valid. See messages for more information.')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require_relative 'all_responses_include_coverage_information_test'
+require_relative 'hook_request_resource_resolution'
+
+module DaVinciCRDTestKit
+  module V221
+    class OrderDispatchCoverageInformationTest < AllResponsesIncludeCoverageInformationTest
+      include HookRequestResourceResolution
+
+      id :crd_v221_order_dispatch_coverage_information
+
+      input :invoked_hook
+
+      input :mock_ehr_bundle
+
+      def order_resources(hook_call_body)
+        references = hook_call_body.dig('context', 'dispatchedOrders')
+        resources = []
+        unmatched_references = []
+
+        Array(references).each do |reference|
+          resource = find_resource_by_reference(hook_call_body, reference)
+
+          if resource.present?
+            resources << resource
+          else
+            unmatched_references << reference
+          end
+        end
+
+        skip_if unmatched_references.present?,
+                'The following `dispatchedOrders` are not included in the Mock EHR Data input or prefetch: ' \
+                "#{unmatched_references.join(', ')}"
+
+        resources
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+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
+    class ProposeAlternateRequestCardValidationTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerTestHelper
+      include DaVinciCRDTestKit::ServerHookHelper
+      include DaVinciCRDTestKit::CardsIdentification
+      include DaVinciCRDTestKit::ResponseLogicalModelValidation
+
+      title 'Propose Alternate Request cards are valid'
+      id :crd_v221_propose_alternate_request_card_validation
+      description %( This test validates that all [Propose Alternate
+        Request](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#propose-alternate-request-response-type)
+        cards received are valid. It checks for the presence of a card's
+        suggestion with a single action with `Action.type` of `update` or a card
+        with at least two actions, one with `Action.type` of `delete` and the
+        other with `Action.type` of `create`.
+      )
+      optional
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-3',
+                            'hl7.fhir.us.davinci-crd_2.2.1@resp-55',
+                            'hl7.fhir.us.davinci-crd_2.2.1@resp-56'
+
+      input :invoked_hook
+
+      def body_has_no_cards?(body)
+        !body.is_a?(Hash) ||
+          body['cards'].blank? ||
+          !body['cards'].is_a?(Array) ||
+          !body['cards'].all?(Hash)
+      end
+
+      def alternate_request_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| propose_alternative_request_response_type? card }
+      rescue JSON::ParserError
+        []
+      end
+
+      run do
+        load_tagged_requests(tested_hook_name)
+
+        alternate_request_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 = alternate_request_cards(request)
+
+          alternate_request_count += cards.length
+
+          perform_response_logical_model_validation(
+            cards,
+            nil,
+            request.request_body,
+            index,
+            '2.2.1'
+          )
+        end
+
+        skip_if alternate_request_count.zero?,
+                "#{tested_hook_name} hook responses do not contain any Propose Alternate Request cards."
+
+        no_error_validation('Not all Propose Alternate Request cards were valid. See messages for more information')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require_relative '../../../cross_suite/cards_validation'
+require_relative '../../../cross_suite/response_logical_model_validation'
+require_relative '../../server_hook_helper'
+
+module DaVinciCRDTestKit
+  module V221
+    class ServiceResponseValidationTest < Inferno::Test
+      include DaVinciCRDTestKit::CardsValidation
+      include DaVinciCRDTestKit::ResponseLogicalModelValidation
+      include DaVinciCRDTestKit::ServerHookHelper
+
+      title 'Service responses contain valid cards and systemActions'
+      id :crd_v221_service_response_validation
+      description %(
+        This test validates the responses against the [CRD v2.2.1 logical
+        models](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/artifacts.html#4).
+
+        This test implements [corrections to errors in the logical
+        models](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Logical-Model-Validation-Changes).
+      )
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@resp-4',
+                            'hl7.fhir.us.davinci-crd_2.2.1@resp-5',
+                            'hl7.fhir.us.davinci-crd_2.2.1@resp-13'
+
+      input :invoked_hook
+
+      run do
+        load_tagged_requests(tested_hook_name)
+
+        skip_if requests.blank?, "No #{tested_hook_name} request was made in a previous test as expected."
+
+        successful_requests = requests.select { |request| request.status == 200 }
+
+        skip_if successful_requests.empty?, 'All service requests were unsuccessful.'
+
+        info do
+          unsuccessful_count = (requests - successful_requests).length
+
+          assert unsuccessful_count.zero?, "#{unsuccessful_count} out of #{requests.length} requests were unsuccessful"
+        end
+
+        successful_requests.each_with_index do |request, index|
+          service_response = JSON.parse(request.response_body)
+
+          conforms_to_logical_model?(
+            service_response,
+            'http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponseBase|2.2.1',
+            message_prefix: "Request #{index}: "
+          )
+        rescue JSON::ParserError
+          add_message('error', "Invalid JSON: server response #{index + 1} is not valid JSON.")
+        end
+
+        messages.reject! do |message|
+          message[:type] == 'error' && message[:message].end_with?('Resource requires an id, but none is present')
+        end
+
+        no_error_validation('Some service responses are not valid. Check messages for issues found.')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require_relative '../../../cross_suite/cards_identification'
+require_relative '../../server_hook_helper'
+require_relative '../server_urls'
+
+module DaVinciCRDTestKit
+  module V221
+    class UnknownCDSHooksElementsTest < Inferno::Test
+      include DaVinciCRDTestKit::CardsIdentification
+      include DaVinciCRDTestKit::ServerHookHelper
+      include DaVinciCRDTestKit::V221::ServerURLs
+
+      title 'Server ignores unknown CDS Hooks elements'
+      id :crd_v221_unknown_cds_hooks_elements
+      description %(
+        If a request resulted in a successful response with a coverage
+        information system action, a follow-up request is made with an element
+        with a random key and value added to the CDS hooks request. This test
+        verifes that this follow-up request also resulted in a successful
+        response with a coverage information system action to verify that
+        unknown CDS Hooks elements are ignored.
+      )
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@found-33'
+
+      def primary_hook?
+        ['appointment-book', 'order-sign', 'order-dispatch'].include? tested_hook_name
+      end
+
+      def parsed_body(json)
+        JSON.parse(json)
+      rescue JSON::ParserError
+        nil
+      end
+
+      run do
+        load_tagged_requests(tested_hook_name, UNKNOWN_ELEMENT_TAG)
+
+        if requests.empty?
+          message = "No successful #{tested_hook_name} response contained a coverage-info action."
+          if primary_hook?
+            skip message
+          else
+            omit message
+          end
+        end
+
+        requests.each do |request|
+          unless request.status == 200
+            add_message(
+              'error',
+              "Server request returned HTTP #{request.status} for a request with an unknown CDS Hooks element; " \
+              'expected HTTP 200.'
+            )
+            next
+          end
+
+          response_body = parsed_body(request.response_body)
+          unless response_body.is_a?(Hash)
+            add_message('error', 'Server response to a request with an unknown CDS Hooks element was not valid JSON.')
+            next
+          end
+
+          next if coverage_info_system_action_response?(response_body)
+
+          add_message(
+            'error',
+            'Server response to a request with an unknown CDS Hooks element did not contain ' \
+            'a coverage information system action.'
+          )
+        end
+
+        assert_no_error_messages(
+          'Responses to requests with an unknown CDS Hooks element were not valid. Check messages for details.'
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require_relative '../../../cross_suite/cards_identification'
+require_relative '../../server_hook_helper'
+require_relative '../server_urls'
+
+module DaVinciCRDTestKit
+  module V221
+    class UnknownConfigurationTest < Inferno::Test
+      include DaVinciCRDTestKit::CardsIdentification
+      include DaVinciCRDTestKit::ServerHookHelper
+      include DaVinciCRDTestKit::V221::ServerURLs
+
+      title 'Server ignores unknown configuration information'
+      id :crd_v221_unknown_configuration
+      description %(
+        If a request resulted in a successful response with a coverage
+        information system action, a follow-up request is made with a random
+        configuration key set to `true`. This test verifes that this follow-up
+        request also resulted in a successful response with a coverage
+        information system action to verify that unknown configuration values
+        are ignored.
+      )
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@dev-17'
+
+      def primary_hook?
+        ['appointment-book', 'order-sign', 'order-dispatch'].include? tested_hook_name
+      end
+
+      def parsed_body(json)
+        JSON.parse(json)
+      rescue JSON::ParserError
+        nil
+      end
+
+      run do
+        load_tagged_requests(tested_hook_name, UNKNOWN_CONFIGURATION_TAG)
+
+        if requests.empty?
+          message = "No successful #{tested_hook_name} response contained a coverage-info action."
+          if primary_hook?
+            skip message
+          else
+            omit message
+          end
+        end
+
+        requests.each do |request|
+          unless request.status == 200
+            add_message(
+              'error',
+              "Server request returned HTTP #{request.status} for a request with an unknown configuration option; " \
+              'expected HTTP 200.'
+            )
+            next
+          end
+
+          response_body = parsed_body(request.response_body)
+          unless response_body.is_a?(Hash)
+            add_message('error', 'Server response to a request with an unknown configuration value was not valid JSON.')
+            next
+          end
+
+          next if coverage_info_system_action_response?(response_body)
+
+          add_message(
+            'error',
+            'Server response to a request with an unknown configuration value did not contain ' \
+            'a coverage information system action.'
+          )
+        end
+
+        assert_no_error_messages(
+          'Responses to requests with unknown configuration were not valid. Check messages for details.'
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require_relative '../../../cross_suite/cards_identification'
+require_relative '../../server_hook_helper'
+require_relative '../server_urls'
+
+module DaVinciCRDTestKit
+  module V221
+    class UnknownContextTest < Inferno::Test
+      include DaVinciCRDTestKit::CardsIdentification
+      include DaVinciCRDTestKit::ServerHookHelper
+      include DaVinciCRDTestKit::V221::ServerURLs
+
+      title 'Server ignores unknown context information'
+      id :crd_v221_unknown_context
+      description %(
+        If a request resulted in a successful response with a coverage
+        information system action, a follow-up request is made with a random
+        context key set to a random value. This test verifes that this follow-up
+        request also resulted in a successful response with a coverage
+        information system action to verify that unknown context values are
+        ignored.
+      )
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-23'
+
+      def primary_hook?
+        ['appointment-book', 'order-sign', 'order-dispatch'].include? tested_hook_name
+      end
+
+      def parsed_body(json)
+        JSON.parse(json)
+      rescue JSON::ParserError
+        nil
+      end
+
+      run do
+        load_tagged_requests(tested_hook_name, UNKNOWN_CONTEXT_TAG)
+
+        if requests.empty?
+          message = "No successful #{tested_hook_name} response contained a coverage-info action."
+          if primary_hook?
+            skip message
+          else
+            omit message
+          end
+        end
+
+        requests.each do |request|
+          unless request.status == 200
+            add_message(
+              'error',
+              "Server request returned HTTP #{request.status} for a request with an unknown context option; " \
+              'expected HTTP 200.'
+            )
+            next
+          end
+
+          response_body = parsed_body(request.response_body)
+          unless response_body.is_a?(Hash)
+            add_message('error', 'Server response to a request with an unknown context element was not valid JSON.')
+            next
+          end
+
+          next if coverage_info_system_action_response?(response_body)
+
+          add_message(
+            'error',
+            'Server response to a request with an unknown context element did not contain ' \
+            'a coverage information system action.'
+          )
+        end
+
+        assert_no_error_messages(
+          'Responses to requests with unknown context were not valid. Check messages for details.'
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require_relative '../../server_hook_helper'
+require_relative '../../../cross_suite/tags'
+
+module DaVinciCRDTestKit
+  module V221
+    class VerifyResponseWithoutBillingOptionsTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerHookHelper
+
+      title 'Server does not require the billing-options extension'
+      id :verify_response_without_billing_options
+      description <<~DESCRIPTION
+        The IG states that, "CRD servers **SHALL NOT** depend on the
+        billing-options extension being present in order to provide a response."
+
+        This test verifies that a successful response was received for a request
+        without any billing-options extensions.
+      DESCRIPTION
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@billopt-2'
+
+      BILLING_OPTIONS_URL = 'http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-billing-options'.freeze
+
+      run do
+        ALL_HOOK_TAGS.each do |tag|
+          load_tagged_requests(tag)
+        end
+
+        skip_if requests.blank?, 'No requests were made in a previous test as expected.'
+
+        successful_requests = requests.select { |request| request.status == 200 }
+        skip_if successful_requests.empty?, 'All service requests were unsuccessful.'
+
+        requests_without_billing_options =
+          successful_requests.reject { |request| request.request_body.include? BILLING_OPTIONS_URL }
+
+        skip_if requests_without_billing_options.blank?,
+                'All successful requests included the billing options extension. ' \
+                'Provide service call inputs which do not include the billing options extension ' \
+                'to verify that the server does not require the extension.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require_relative '../../server_hook_helper'
+require_relative '../../../cross_suite/tags'
+
+module DaVinciCRDTestKit
+  module V221
+    class VerifyResponseWithoutConfigurationTest < Inferno::Test
+      include DaVinciCRDTestKit::ServerHookHelper
+
+      title 'Server does not require configuration options'
+      id :verify_response_without_configuration
+      description <<~DESCRIPTION
+        The IG states that, "CRD Servers SHALL NOT require the inclusion of
+        configuration information in a hook call (i.e. no hook invocation is
+        permitted to fail because configuration information was not included)."
+
+        This test verifies that a successful response was received for a request
+        without any configuration options.
+      DESCRIPTION
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@dev-15'
+
+      CONFIGURATION_KEY = 'davinci-crd.configuration'.freeze
+
+      run do
+        ALL_HOOK_TAGS.each do |tag|
+          load_tagged_requests(tag)
+        end
+
+        skip_if requests.blank?, 'No requests were made in a previous test as expected.'
+
+        successful_requests = requests.select { |request| request.status == 200 }
+        skip_if successful_requests.empty?, 'All service requests were unsuccessful.'
+
+        requests_without_configuration_options =
+          successful_requests.reject { |request| request.request_body.include? CONFIGURATION_KEY }
+
+        skip_if requests_without_configuration_options.blank?,
+                'All successful requests included configuration options. ' \
+                'Provide service call inputs which do not include any configuration options ' \
+                'to verify that the server does not require them.'
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/version.rb

@@ -1,4 +1,4 @@
 module DaVinciCRDTestKit
-  VERSION = '0.13.0'.freeze
-  LAST_UPDATED = '2025-07-22'.freeze # TODO: update next release
+  VERSION = '0.14.1'.freeze
+  LAST_UPDATED = '2026-07-13'.freeze # TODO: update next release
 end