davinci_crd_test_kit 0.13.0 → 0.14.0

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_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_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_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.0'.freeze
+  LAST_UPDATED = '2026-06-02'.freeze # TODO: update next release
 end

data/lib/davinci_crd_test_kit.rb

@@ -1,3 +1,5 @@
 require_relative 'davinci_crd_test_kit/metadata'
-require_relative 'davinci_crd_test_kit/crd_server_suite'
-require_relative 'davinci_crd_test_kit/crd_client_suite'
+require_relative 'davinci_crd_test_kit/server/v2.0.1/crd_server_suite'
+require_relative 'davinci_crd_test_kit/server/v2.2.1/crd_server_suite'
+require_relative 'davinci_crd_test_kit/client/v2.0.1/crd_client_suite'
+require_relative 'davinci_crd_test_kit/client/v2.2.1/crd_client_suite'