davinci_crd_test_kit 0.14.0 → 0.14.2

data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_select_group.rb

@@ -25,12 +25,18 @@ module DaVinciCRDTestKit
         procedures, labs and other orders). The CRD IG places [additional constraints on the use
         of the order-select hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-select),
         including the profiles that resources in each request must conform to.
+
+        Inferno's simulated `order-select` hook endpoints are available at:
+        - Complete Prefetch: `#{ClientURLs.base_url}#{ORDER_SELECT_PATH}`
+        - Subset Prefetch: `#{ClientURLs.base_url}#{ORDER_SELECT_PREFETCH_SUBSET_PATH}`
       DESCRIPTION
       run_as_group
 
       verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A', 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-B'
 
-      input_order :cds_jwt_iss, :cds_jwk_set
+      input_order :order_select_response_approach,
+                  :order_select_selected_response_types,
+                  :order_select_custom_response_template
 
       config(
         inputs: {
@@ -53,7 +59,9 @@ module DaVinciCRDTestKit
           crd_jwks_keys_json: { name: :order_select_crd_jwks_keys_json }
         },
         options: {
-          hook_name: 'order-select'
+          hook_name: 'order-select',
+          crd_interaction_group: 'hooks-order-select',
+          include_in_cross_hook_analysis: true
         }
       )
 
@@ -63,11 +71,10 @@ module DaVinciCRDTestKit
       end
 
       group do
-        title 'Authorization'
-        test from: :crd_v221_decode_auth_token
-        test from: :crd_v221_retrieve_jwks
-        test from: :crd_v221_token_header
-        test from: :crd_v221_token_payload
+        title 'Response Handling'
+
+        test from: :crd_v221_card_display_attest_test
+        test from: :crd_v221_inferno_response_validation
       end
 
       group do
@@ -92,10 +99,11 @@ module DaVinciCRDTestKit
       end
 
       group do
-        title 'Response Handling'
-
-        test from: :crd_v221_inferno_response_validation
-        test from: :crd_v221_card_display_attest_test
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
       end
     end
   end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_sign_group.rb

@@ -26,12 +26,18 @@ module DaVinciCRDTestKit
         for medications, procedures, labs and other orders). The CRD IG places [additional constraints on the use
         of the order-sign hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-sign),
         including the profiles that resources in each request must conform to.
+
+        Inferno's simulated `order-sign` hook endpoints are available at:
+        - Complete Prefetch: `#{ClientURLs.base_url}#{ORDER_SIGN_PATH}`
+        - Subset Prefetch: `#{ClientURLs.base_url}#{ORDER_SIGN_PREFETCH_SUBSET_PATH}`
       DESCRIPTION
       run_as_group
 
       verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A', 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-B'
 
-      input_order :cds_jwt_iss, :cds_jwk_set
+      input_order :order_sign_response_approach,
+                  :order_sign_selected_response_types,
+                  :order_sign_custom_response_template
 
       config(
         inputs: {
@@ -54,7 +60,9 @@ module DaVinciCRDTestKit
           crd_jwks_keys_json: { name: :order_sign_crd_jwks_keys_json }
         },
         options: {
-          hook_name: 'order-sign'
+          hook_name: 'order-sign',
+          crd_interaction_group: 'hooks-order-sign',
+          include_in_cross_hook_analysis: true
         }
       )
 
@@ -64,11 +72,14 @@ module DaVinciCRDTestKit
       end
 
       group do
-        title 'Authorization'
-        test from: :crd_v221_decode_auth_token
-        test from: :crd_v221_retrieve_jwks
-        test from: :crd_v221_token_header
-        test from: :crd_v221_token_payload
+        title 'Response Handling'
+
+        test from: :crd_v221_card_display_attest_test
+        test from: :crd_v221_inferno_response_validation
+        test from: :crd_v221_client_hook_response_support_coverage_information do
+          title 'Client supports the Coverage Information response type on the order-sign hook'
+          verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-39'
+        end
       end
 
       group do
@@ -93,14 +104,11 @@ module DaVinciCRDTestKit
       end
 
       group do
-        title 'Response Handling'
-
-        test from: :crd_v221_inferno_response_validation
-        test from: :crd_v221_card_display_attest_test
-        test from: :crd_v221_client_hook_response_support_coverage_information do
-          title 'Client supports the Coverage Information response type on the order-sign hook'
-          verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-39'
-        end
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
       end
     end
   end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_registration_group.rb

@@ -12,6 +12,12 @@ module DaVinciCRDTestKit
         and vice-versa. Tests in this group confirm the registration of the partner
         system on both ends.
 
+        Inferno simulates two CRD discovery endpoints for the client to connect to:
+        - Discovery endpoint for services requesting the complete [standard prefetch data set](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#standard-prefetch):
+          `#{ClientURLs.discovery_url}`
+        - Discovery endpoint for services requesting the a subset of the [standard prefetch data set](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#standard-prefetch):
+          `#{ClientURLs.prefetch_subset_discovery_url}`
+
         This group must be run before any other tests in the "Hook Invocation" group because inputs
         provided to this group will be used by Inferno for the remainder of the tests
         to identify client requests and verify behavior. The inputs will appear as locked and

data/lib/davinci_crd_test_kit/client/v2.2.1/client_scenarios_group.rb

@@ -0,0 +1,26 @@
+require_relative 'client_long_running_hook_group'
+require_relative 'client_unknown_content_hook_group'
+require_relative 'client_self_pay_hook_group'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientScenariosGroup < Inferno::TestGroup
+      title 'Scenarios'
+      id :crd_v221_client_scenarios
+      description <<~DESCRIPTION
+        This group checks CRD requirements that pertain to specific scenarios
+        that clients need to handle.
+
+        These scenarios test specific situations and conformance details of requests
+        and responses beyond those required for the scenario and for Inferno to
+        recognize client requests are not checked. Testers are expected to follow
+        the same workflows as used during other tests and should adhere to the
+        same CRD requirements when performing these scenarios.
+      DESCRIPTION
+
+      group from: :crd_v221_client_long_running_hook
+      group from: :crd_v221_client_unknown_content_hook
+      group from: :crd_v221_client_self_pay_hook
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_self_pay_hook_group.rb

@@ -0,0 +1,36 @@
+require_relative 'self_pay/client_self_pay_workflow_test'
+require_relative 'self_pay/client_self_pay_no_request_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientSelfPayHookGroup < Inferno::TestGroup
+      title 'Self-Pay'
+      id :crd_v221_client_self_pay_hook
+      description <<~DESCRIPTION
+        The CRD IG requires clients to invoke hooks on payer services only when the patient
+        record indicates active coverage with the payer associated with the service and there
+        is no recorded indication that the patient intends to bypass insurance coverage, i.e.,
+        the service or product is not flagged as 'self-pay'. During this scenario the tester
+        will perform a workflow that would normally trigger a hook request, but for a service or
+        product that the patient has indicated they intend to self-pay for, and Inferno
+        will verify that no hook requests are made.
+
+        Any hook requests made during these tests will not be checked for conformance
+        or included in the cross-hook analyses around must support and other coverage requirements.
+      DESCRIPTION
+
+      run_as_group
+
+      config(
+        options: {
+          hook_name: ANY_HOOK_TAG,
+          crd_interaction_group: SELF_PAY_GROUP_TAG,
+          include_in_cross_hook_analysis: false
+        }
+      )
+
+      test from: :crd_v221_client_self_pay_workflow
+      test from: :crd_v221_client_self_pay_no_request
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_unknown_content_hook_group.rb

@@ -0,0 +1,34 @@
+require_relative 'unknown_content/client_unknown_content_receive_request_test'
+require_relative 'unknown_content/client_unknown_content_attestation_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientUnknownContentHookGroup < Inferno::TestGroup
+      title 'Unknown Response Content'
+      id :crd_v221_client_unknown_content_hook
+      description <<~DESCRIPTION
+        CRD servers may return content that clients do not recognize, and the CRD IG requires
+        clients to ignore it rather than fail. During this scenario Inferno returns coverage
+        information accompanied by an element within the system action and a custom extension
+        on the response, both with randomly generated names. This content is added at the CRD
+        response level rather than within the FHIR resources carried in the response.
+
+        Hook requests made during these tests will not be checked for conformance
+        or included in the cross-hook analyses around must support and other coverage requirements.
+      DESCRIPTION
+
+      run_as_group
+
+      config(
+        options: {
+          hook_name: ANY_HOOK_TAG,
+          crd_interaction_group: UNKNOWN_CONTENT_GROUP_TAG,
+          include_in_cross_hook_analysis: false
+        }
+      )
+
+      test from: :crd_v221_client_unknown_content_receive_request
+      test from: :crd_v221_client_unknown_content_attestation_test
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/crd_client_suite.rb

@@ -2,7 +2,8 @@ require_relative 'client_fhir_api_group'
 require_relative 'client_hooks_group'
 require_relative 'client_cross_hook_group'
 require_relative 'client_registration_group'
-require_relative 'client_long_running_hook_group'
+require_relative 'client_scenarios_group'
+require_relative 'client_attestations_group'
 require_relative '../endpoints/cds_services_discovery_handler'
 require_relative '../../cross_suite/tags'
 require_relative 'client_urls'
@@ -23,6 +24,11 @@ module DaVinciCRDTestKit
         capabilities of a CRD client as described in [version 2.2.1](https://hl7.org/fhir/us/davinci-crd/2.2.1)
         of the Da Vinci Coverage Requirements Discovery (CRD) Implementation Guide.
 
+        These tests are a **DRAFT** intended to allow CRD implementers to perform
+        preliminary checks of their implementations against the CRD IG requirements and
+        [provide feedback](https://github.com/inferno-framework/davinci-crd-test-kit/issues) on the tests.
+        Future versions of these tests may validate other requirements and may change how these are tested.
+
         Detailed information about this test suite can be found in the
         [client section](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details) of the
         [CRD Test Kit Wiki](https://github.com/inferno-framework/davinci-crd-test-kit/wiki), including:
@@ -109,7 +115,6 @@ module DaVinciCRDTestKit
       CRD_MESSAGE_FILTERS = [
         /\A\S+: \S+: URL value '.*' does not resolve/,
         %r{This element is not allowed by the profile http://hl7\.org/fhir/tools/StructureDefinition/CDSHooksExtensions\|1\.1\.2},
-        /CDSHooksRequest.extension: Unrecognized property/,
         /No definition could be found for URL value/
       ].freeze
 
@@ -162,6 +167,21 @@ module DaVinciCRDTestKit
         end
       end
 
+      fhir_resource_validator :no_custom_extensions do
+        igs('hl7.fhir.us.davinci-crd#2.2.1')
+
+        validation_context do
+          snomedCT '731000124108' # explicit snomedCT expansion parameter
+          extensions [] # no extensions not in the spec
+        end
+
+        exclude_message do |message|
+          CRD_MESSAGE_FILTERS.any? do |match_template|
+            message.message.match?(match_template)
+          end
+        end
+      end
+
       suite_option :us_core_version,
                    title: 'US Core Version',
                    list_options: [
@@ -219,11 +239,12 @@ module DaVinciCRDTestKit
 
         group from: :crd_v221_client_registration
         group from: :crd_v221_client_hooks
+        group from: :crd_v221_client_scenarios
         group from: :crd_v221_client_cross_hook
-        group from: :crd_v221_client_long_running_hook
       end
 
       group from: :crd_v221_client_fhir_api
+      group from: :crd_v221_client_attestations
     end
   end
 end

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_card_must_support_coverage_information_test.rb

@@ -46,7 +46,7 @@ module DaVinciCRDTestKit
       end
 
       run do
-        loaded_requests = requests_to_analyze
+        loaded_requests = load_requests_for_cross_hook_analysis
         skip_if loaded_requests.blank?, 'No hook requests received.'
 
         sorted_cards = sorted_cards_from_requests(loaded_requests)

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_fhirpath_collection_as_comma_delimited_string_test.rb

@@ -1,6 +1,10 @@
+require_relative '../../cross_hook_helper'
+
 module DaVinciCRDTestKit
   module V221
     class ClientFHIRPathCollectionAsCommaDelimitedStringTest < Inferno::Test
+      include CrossHookHelper
+
       title 'Client correctly interprets collections when substituting FHIRPath results in prefetch templates'
       id :crd_v221_client_fhir_path_collection_as_comma_delimited_string
       description <<~DESCRIPTION
@@ -32,17 +36,6 @@ module DaVinciCRDTestKit
              'Perform more complex hook requests and re-run.'
       end
 
-      def find_completeness_tests
-        hooks_group = self.class.parent.parent.groups.find do |group|
-          group.id.to_s.include?('crd_v221_client_hooks')
-        end
-        hooks_group.groups.map do |group|
-          group.groups.flat_map(&:tests).find do |test|
-            test.id.to_s.include?('crd_v221_hook_request_prefetch_complete')
-          end
-        end.compact
-      end
-
       def completeness_tests_demonstrate_collection_token_substitution?(prefetch_completeness_tests)
         results_repo = Inferno::Repositories::Results.new
         results = results_repo.current_results_for_test_session_and_runnables(test_session_id,

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_hook_instances_unique_test.rb

@@ -1,11 +1,9 @@
-require_relative '../../tagged_request_load_helper'
 require_relative '../../multi_request_message_helper'
 require_relative '../../../cross_suite/tags'
 
 module DaVinciCRDTestKit
   module V221
     class ClientHookInstancesUniqueTest < Inferno::Test
-      include TaggedRequestLoadHelper
       include MultiRequestMessageHelper
 
       title 'Client does not reuse hookInstance values'
@@ -21,14 +19,8 @@ module DaVinciCRDTestKit
 
       verifies_requirements 'cds-hooks_3.0.0-ballot@25'
 
-      config(
-        options: {
-          crd_test_group: DUPLICATED_HOOK_INSTANCE_TAG
-        }
-      )
-
       run do
-        duplicated_hook_instance_requests = load_hook_requests
+        duplicated_hook_instance_requests = load_tagged_requests(DUPLICATED_HOOK_INSTANCE_TAG)
         reused_values = duplicated_hook_instance_requests.map.with_index do |request, request_index|
           request_body = parse_json_request_entity(request.request_body, 'Request body', request_index)
           next nil unless request_body.present?

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_location_address_propagation_test.rb

@@ -70,7 +70,11 @@ module DaVinciCRDTestKit
 
         message_prefix = "Parent of prefetched 'Location/#{root_id}'"
         add_message('error', "Location/#{location.id}: #{message_prefix} does not conform to the CRD Location profile.")
-        validator_response_details.each { |issue| add_message(issue.severity, "(#{message_prefix}) #{issue.message}") }
+        validator_response_details.each do |issue|
+          next if issue.filtered
+
+          add_message(issue.severity, "(#{message_prefix}) #{issue.message}")
+        end
       end
 
       def fetched_locations_checked_for_conformance
@@ -78,7 +82,7 @@ module DaVinciCRDTestKit
       end
 
       def loaded_requests
-        @loaded_requests ||= requests_to_analyze
+        @loaded_requests ||= load_requests_for_cross_hook_analysis
       end
 
       def prefetched_location_hash

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_prefetch_complete_and_subset_test.rb

@@ -1,10 +1,12 @@
 require_relative '../../tagged_request_load_helper'
+require_relative '../../cross_hook_helper'
 require_relative '../client_urls'
 
 module DaVinciCRDTestKit
   module V221
     class ClientPrefetchCompleteAndSubsetTest < Inferno::Test
       include TaggedRequestLoadHelper
+      include CrossHookHelper
 
       title 'Client can provide both the complete standard prefetch data set and a subset'
       id :crd_v221_client_prefetch_complete_and_subset
@@ -50,7 +52,7 @@ module DaVinciCRDTestKit
 
       run do
         subset_prefetch_requests, complete_prefetch_requests =
-          requests_to_analyze.partition { |request| request.url.include?(PREFETCH_SUBSET_PREFIX) }
+          load_requests_for_cross_hook_analysis.partition { |request| request.url.include?(PREFETCH_SUBSET_PREFIX) }
         completeness_tests = find_completeness_tests
         check_for_demonstration(subset_prefetch_requests, completeness_tests, :subset)
         check_for_demonstration(complete_prefetch_requests, completeness_tests, :complete)
@@ -59,17 +61,6 @@ module DaVinciCRDTestKit
                 'The client did not demonstrate both complete and subset prefetch capability. See Messages for details.'
       end
 
-      def find_completeness_tests
-        hooks_group = self.class.parent.parent.groups.find do |group|
-          group.id.to_s.include?('crd_v221_client_hooks')
-        end
-        hooks_group.groups.map do |group|
-          group.groups.flat_map(&:tests).find do |test|
-            test.id.to_s.include?('crd_v221_hook_request_prefetch_complete')
-          end
-        end.compact
-      end
-
       def check_for_demonstration(requests, completeness_tests, target_name)
         unless requests.present?
           add_message('error', "No requests made to the service endpoint requesting #{target_name} prefetch data.")

data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/appointment_book_receive_request_test.rb

@@ -1,10 +1,8 @@
-require_relative '../client_urls'
+require_relative 'base_hook_invocation_receive_request_test'
 
 module DaVinciCRDTestKit
   module V221
-    class AppointmentBookReceiveRequestTest < Inferno::Test
-      include ClientURLs
-
+    class AppointmentBookReceiveRequestTest < BaseHookInvocationReceiveRequestTest
       id :crd_v221_appointment_book_request
       title 'Client invokes the appointment-book hook'
       description %(
@@ -19,16 +17,7 @@ module DaVinciCRDTestKit
         by the tester by clicking on the link in the "User Action Required" dialog (NOTE: after
         5 minutes the test will become inactive and unresponsive to anything except cancelation).
       )
-      config options: { accepts_multiple_requests: true }
 
-      input :cds_jwt_iss,
-            title: 'CRD JWT Issuer',
-            description: %(
-              Value of the `iss` claim that must be present in the JWT used to authorize the client's hook
-              request sent as the Bearer token in the `Authorization` header.
-              Run or re-run the "Registration" group to set or change this value.
-            ),
-            locked: true
       input :appointment_book_response_approach,
             title: 'Response generation approach for appointment-book',
             description: %(
@@ -60,34 +49,7 @@ module DaVinciCRDTestKit
             type: 'checkbox',
             default: ['coverage_information', 'external_reference', 'instructions'],
             optional: true,
-            options: {
-              list_options: [
-                {
-                  label: 'External Reference',
-                  value: 'external_reference'
-                },
-                {
-                  label: 'Instructions',
-                  value: 'instructions'
-                },
-                {
-                  label: 'Coverage Information',
-                  value: 'coverage_information'
-                },
-                {
-                  label: 'Request Form Completion',
-                  value: 'request_form_completion'
-                },
-                {
-                  label: 'Create/Update Coverage Information',
-                  value: 'create_update_coverage_info'
-                },
-                {
-                  label: 'Launch SMART Application',
-                  value: 'launch_smart_app'
-                }
-              ]
-            },
+            options: { list_options: RESPONSE_TYPE_OPTIONS },
             enable_when: { input_name: 'appointment_book_response_approach', value: 'mocked' }
       input :appointment_book_custom_response_template,
             title: 'Custom response template for appointment-book hook requests',
@@ -98,58 +60,15 @@ module DaVinciCRDTestKit
             type: 'textarea',
             optional: true,
             enable_when: { input_name: 'appointment_book_response_approach', value: 'custom' }
-      output :continuation_url
-
-      def configured_response_details
-        if appointment_book_response_approach == 'custom'
-          # rubocop:disable Layout/LineLength
-          'When responding, Inferno will evaluate the provided [custom response template](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses) ' \
-            'from the **Custom response template for appointment-book hook requests** input ' \
-            'against the incoming request to create a response.'
-          # rubocop:enable Layout/LineLength
 
-        else
-          # rubocop:disable Layout/LineLength
-          'When responding, Inferno will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses) ' \
-            'the following response types using the incoming request: ' \
-            "\n            - #{selected_response_types_string}"
-          # rubocop:enable Layout/LineLength
-        end
-      end
+      private
 
-      def selected_response_types_string
-        if appointment_book_selected_response_types.present?
-          appointment_book_selected_response_types.join("\n            - ")
-        else
-          'Coverage Information' # primary hook default
-        end
+      def hook_key
+        'appointment_book'
       end
 
-      run do
-        identifier = cds_jwt_iss
-        continuation_url = "#{resume_pass_url}?token=#{identifier}"
-        output(continuation_url:)
-
-        wait(
-          identifier:,
-          message: %(
-            **Invoke the `appointment-book` hook**:
-
-            Invoke the appointment-book hook by sending requests to
-            one or both of the two Inferno simulated CRD servers:
-
-            - Complete Prefetch: `#{appointment_book_url}`
-            - Subset Prefetch: `#{appointment_book_prefetch_subset_url}`
-
-            For Inferno to recognize these requests and associate them with this session,
-            the authentication JWT sent as a Bearer token in the Authorization header
-            must have `#{cds_jwt_iss}` as the `iss` claim in the JWT payload.
-
-            #{configured_response_details}
-
-            [Click here](#{continuation_url}) when you have finished submitting requests.
-          )
-        )
+      def primary_hook?
+        true
       end
     end
   end