davinci_crd_test_kit 0.14.0 → 0.14.2

data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_sign_group.rb

@@ -4,12 +4,11 @@ require_relative 'verify_request/service_request_required_fields_validation_test
 require_relative 'verify_request/service_request_optional_fields_validation_test'
 require_relative 'verify_request/service_request_context_validation_test'
 require_relative 'verify_response/service_response_validation_test'
-require_relative 'verify_response/card_optional_fields_validation_test'
 require_relative 'verify_response/external_reference_card_validation_test'
 require_relative 'verify_response/launch_smart_app_card_validation_test'
 require_relative 'verify_response/instructions_card_received_test'
-require_relative 'verify_response/coverage_information_system_action_received_test'
 require_relative 'verify_response/coverage_information_system_action_validation_test'
+require_relative 'verify_response/coverage_information_card_absence_test'
 require_relative 'verify_response/coverage_info_configuration_test'
 require_relative 'verify_response/propose_alternate_request_card_validation_test'
 require_relative 'verify_response/additional_orders_validation_test'
@@ -79,6 +78,7 @@ module DaVinciCRDTestKit
 
       group do
         title 'Requests'
+        simulation_verification
 
         test from: :crd_v221_service_request_required_fields_validation,
              config: {
@@ -102,84 +102,11 @@ module DaVinciCRDTestKit
       group do
         title 'Responses'
 
-        test from: :crd_v221_service_response_validation,
-             config: {
-               outputs: {
-                 valid_cards: {
-                   name: :order_sign_valid_cards
-                 },
-                 valid_system_actions: {
-                   name: :order_sign_valid_system_actions
-                 }
-               }
-             }
-        test from: :crd_v221_card_optional_fields_validation,
-             config: {
-               inputs: {
-                 valid_cards: {
-                   name: :order_sign_valid_cards
-                 }
-               },
-               outputs: {
-                 valid_cards_with_links: {
-                   name: :order_sign_valid_cards_with_links
-                 },
-                 valid_cards_with_suggestions: {
-                   name: :order_sign_valid_cards_with_suggestions
-                 }
-               }
-             }
-        test from: :crd_v221_external_reference_card_validation,
-             config: {
-               inputs: {
-                 valid_cards_with_links: {
-                   name: :order_sign_valid_cards_with_links
-                 }
-               }
-             }
-        test from: :crd_v221_launch_smart_app_card_validation,
-             config: {
-               inputs: {
-                 valid_cards_with_links: {
-                   name: :order_sign_valid_cards_with_links
-                 }
-               }
-             }
-        test from: :crd_v221_valid_instructions_card_received,
-             config: {
-               inputs: {
-                 valid_cards: {
-                   name: :order_sign_valid_cards
-                 }
-               }
-             }
-        test from: :crd_v221_coverage_info_system_action_received,
-             config: {
-               inputs: {
-                 valid_system_actions: {
-                   name: :order_sign_valid_system_actions
-                 }
-               },
-               outputs: {
-                 coverage_info: {
-                   name: :order_sign_coverage_info
-                 }
-               }
-             },
-             verifies_requirements: [
-               'hl7.fhir.us.davinci-crd_2.2.1@resp-26'
-             ]
-        test from: :crd_v221_coverage_info_system_action_validation,
-             config: {
-               inputs: {
-                 coverage_info: {
-                   name: :order_sign_coverage_info
-                 }
-               }
-             },
-             verifies_requirements: [
-               'hl7.fhir.us.davinci-crd_2.2.1@resp-25'
-             ]
+        test from: :crd_v221_service_response_validation
+        test from: :crd_v221_external_reference_card_validation
+        test from: :crd_v221_launch_smart_app_card_validation
+        test from: :crd_v221_valid_instructions_card_received
+        test from: :crd_v221_coverage_info_system_action_validation
         test from: :crd_v221_all_responses_include_coverage_information,
              verifies_requirements: [
                'hl7.fhir.us.davinci-crd_2.2.1@hook-16',
@@ -190,47 +117,11 @@ module DaVinciCRDTestKit
                'hl7.fhir.us.davinci-crd_2.2.1@hook-39',
                'hl7.fhir.us.davinci-crd_2.2.1@resp-29'
              ]
-        test from: :crd_v221_propose_alternate_request_card_validation,
-             config: {
-               inputs: {
-                 valid_cards_with_suggestions: {
-                   name: :order_sign_valid_cards_with_suggestions
-                 },
-                 contexts: {
-                   name: :order_sign_contexts
-                 }
-               }
-             }
-        test from: :crd_v221_additional_orders_card_validation,
-             config: {
-               inputs: {
-                 valid_cards_with_suggestions: {
-                   name: :order_sign_valid_cards_with_suggestions
-                 }
-               }
-             }
-        test from: :crd_v221_request_form_completion_response_validation,
-             config: {
-               inputs: {
-                 valid_system_actions: {
-                   name: :order_sign_valid_system_actions
-                 },
-                 valid_cards_with_suggestions: {
-                   name: :order_sign_valid_cards_with_suggestions
-                 }
-               }
-             }
-        test from: :crd_v221_create_or_update_coverage_info_response_validation,
-             config: {
-               inputs: {
-                 valid_system_actions: {
-                   name: :order_sign_valid_system_actions
-                 },
-                 valid_cards_with_suggestions: {
-                   name: :order_sign_valid_cards_with_suggestions
-                 }
-               }
-             }
+        test from: :crd_v221_coverage_information_card_absence
+        test from: :crd_v221_propose_alternate_request_card_validation
+        test from: :crd_v221_additional_orders_card_validation
+        test from: :crd_v221_request_form_completion_response_validation
+        test from: :crd_v221_create_or_update_coverage_info_response_validation
         test from: :crd_v221_coverage_info_configuration
         test from: :crd_v221_unknown_configuration
         test from: :crd_v221_unknown_context

data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_response_group.rb

@@ -0,0 +1,23 @@
+require_relative 'specific_coverage_responses/technical_issues_group'
+require_relative 'specific_coverage_responses/no_member_found_group'
+require_relative 'specific_coverage_responses/coverage_not_found_group'
+require_relative 'specific_coverage_responses/no_active_coverage_group'
+
+module DaVinciCRDTestKit
+  module V221
+    class SpecificCoverageResponseGroup < Inferno::TestGroup
+      title 'Specific Coverage Responses'
+      id :crd_v221_specific_coverage_responses
+
+      description <<~DESCRIPTION
+        This group verifies the ability of a server to return specific
+        coverage-info responses in particular situations.
+      DESCRIPTION
+
+      group from: :crd_v221_server_technical_issues_group
+      group from: :crd_v221_server_no_member_found_group
+      group from: :crd_v221_server_coverage_not_found_group
+      group from: :crd_v221_server_no_active_coverage_group
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/coverage_info_reason_test.rb

@@ -0,0 +1,108 @@
+module DaVinciCRDTestKit
+  module V221
+    # Users of this test need to set config options for coverage_code, reason_code, and optionally require_reason_text
+    class CoverageInfoReasonTest < Inferno::Test
+      id :crd_v221_coverage_info_reason
+      title 'Coverage Information responses have the expected coverage and reason codes'
+
+      description <<~DESCRIPTION
+        This test verifies that the Coverage Information responses received contain Coverage Information extensions
+        with the expected coverage and reason codes.
+      DESCRIPTION
+
+      input :coverage_info
+
+      COVERAGE_INFO_EXTENSION_URL =
+        'http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-coverage-information'.freeze
+
+      run do
+        coverage_info_actions = JSON.parse(coverage_info)
+
+        skip_if coverage_info_actions.blank?, 'No Coverage Information system actions received'
+
+        coverage_info_actions.each_with_index do |action, index|
+          coverage_info_extensions(action['resource']).each do |extension|
+            unless expected_coverage? extension
+              coverage_code = coverage_extension_value(extension)
+              add_message(
+                'error',
+                "Coverage should be `#{expected_coverage_code}`, but found `#{coverage_code}` in action ##{index + 1}"
+              )
+            end
+
+            unless expected_reason? extension
+              reason_code =
+                reason_extension_values(extension)
+                  &.map { |reason| "`#{reason}`" }
+                  &.join(', ') || 'no reason'
+              add_message(
+                'error',
+                "Coverage reason should be `#{expected_reason_code}`, but found #{reason_code} in action ##{index + 1}"
+              )
+
+              next
+            end
+
+            next unless require_reason_text?
+            next if reason_text?(extension)
+
+            add_message(
+              'error',
+              "`#{expected_reason_code}` coverage reason contains no additional details in `text` field " \
+              "in action ##{index + 1}"
+            )
+          end
+        end
+
+        assert_no_error_messages(
+          "Not all coverage info extensions had `#{expected_coverage_code}` coverage " \
+          "with a reason of `#{expected_reason_code}`"
+        )
+      end
+
+      def coverage_info_extensions(resource)
+        resource['extension'].select { |extension| extension['url'] == COVERAGE_INFO_EXTENSION_URL }
+      end
+
+      def coverage_extension_value(coverage_info_extension)
+        coverage_info_extension['extension']
+          .find { |extension| extension['url'] == 'covered' }
+          &.dig('valueCode')
+      end
+
+      def expected_coverage?(coverage_info_extension)
+        coverage_extension_value(coverage_info_extension) == expected_coverage_code
+      end
+
+      def reason_extension_values(coverage_info_extension)
+        coverage_info_extension['extension']
+          .find { |extension| extension['url'] == 'reason' }
+          &.dig('valueCodeableConcept', 'coding')
+          &.map { |coding| coding['code'] }
+      end
+
+      def expected_reason?(coverage_info_extension)
+        reason_extension_values(coverage_info_extension)&.include? expected_reason_code
+      end
+
+      def reason_text?(coverage_info_extension)
+        coverage_info_extension['extension']
+          .find { |extension| extension['url'] == 'reason' }
+          &.dig('valueCodeableConcept', 'text')
+          &.present?
+      end
+
+      def expected_coverage_code
+        config.options[:expected_coverage_code]
+      end
+
+      def expected_reason_code
+        config.options[:expected_reason_code]
+      end
+
+      def require_reason_text?
+        config.options[:require_reason_text] || false
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/coverage_not_found_group.rb

@@ -0,0 +1,116 @@
+require_relative '../interaction/server_invoke_hook_single_request_test'
+require_relative 'coverage_info_reason_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class CoverageNotFoundGroup < Inferno::TestGroup
+      title 'Coverage Not Found'
+      id :crd_v221_server_coverage_not_found_group
+      description %(
+        This group of tests allows the system to demonstrate its ability to respond to a CRD Hook invocation
+        with a `not-covered` coverage determination when the patient can be resolved but coverage cannot be found
+        or cannot be resolved to a single coverage.
+
+        For these tests, provide a hook request body that represents a resolvable patient for whom the CRD Server
+        cannot find coverage or cannot resolve to a single coverage. The tests then verify that a Coverage
+        Information systemAction is received with `not-covered` coverage for `coverage-not-found` reason.
+      )
+
+      config options: { hook_name: COVERAGE_NOT_FOUND_TAG }
+      run_as_group
+
+      group do
+        title 'Interaction'
+
+        test from: :crd_v221_server_invoke_hook_single_request_test,
+             title: 'Inferno invokes the selected hook to elicit coverage not found response',
+             description: <<~DESCRIPTION,
+               This test initiates a POST request to a specified CDS Service using the JSON body provided
+               by the user. The request body should represent a resolvable patient for whom coverage cannot be
+               found or cannot be resolved to a single coverage.
+             DESCRIPTION
+             config: {
+               inputs: {
+                 service_ids: {
+                   name: :coverage_not_found_service_ids,
+                   title: 'Service id to use for the "Coverage Not Found" test',
+                   description: %(
+                     If blank, Inferno will attempt to infer the service id to use by finding a service entry
+                     in the Discovery response for the hook indicated in the provided request body. If it
+                     cannot be inferred, the tests will be skipped.
+                   )
+                 },
+                 service_request_bodies: {
+                   name: :coverage_not_found_request_body,
+                   title: 'Request body to use for the "Coverage Not Found" test',
+                   description: %(
+                     Provide a single JSON request body to submit for the hook invocation. The type of hook
+                     invoked will be inferred based on the `hook` element in the request. The body should be
+                     constructed so that it represents a resolvable patient for whom coverage cannot be found.
+                   )
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Requests'
+        simulation_verification
+
+        test from: :crd_v221_service_request_required_fields_validation,
+             config: {
+               outputs: {
+                 contexts: {
+                   name: :coverage_not_found_contexts
+                 }
+               }
+             }
+        test from: :crd_v221_service_request_context_validation,
+             config: {
+               inputs: {
+                 contexts: {
+                   name: :coverage_not_found_contexts
+                 },
+                 request_body: {
+                   name: :coverage_not_found_request_body
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Responses'
+
+        test from: :crd_v221_service_response_validation
+        test from: :crd_v221_coverage_info_system_action_validation,
+             config: {
+               outputs: {
+                 coverage_info: {
+                   name: :coverage_not_found_coverage_info
+                 }
+               }
+             }
+        test from: :crd_v221_coverage_info_reason,
+             title: 'Coverage Information responses have not-covered coverage for coverage-not-found reason',
+             description: <<~DESCRIPTION,
+               This test verifies that the Coverage Information responses received contain Coverage Information
+               extensions with `not-covered` coverage and a `coverage-not-found` reason.
+             DESCRIPTION
+             config: {
+               inputs: {
+                 coverage_info: {
+                   name: :coverage_not_found_coverage_info
+                 }
+               },
+               options: {
+                 expected_coverage_code: 'not-covered',
+                 expected_reason_code: 'coverage-not-found'
+               }
+             },
+             verifies_requirements: [
+               'hl7.fhir.us.davinci-crd_2.2.1@resp-45'
+             ]
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/no_active_coverage_group.rb

@@ -0,0 +1,115 @@
+require_relative '../interaction/server_invoke_hook_single_request_test'
+require_relative 'coverage_info_reason_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class NoActiveCoverageGroup < Inferno::TestGroup
+      title 'No Active Coverage'
+      id :crd_v221_server_no_active_coverage_group
+      description %(
+        This group of tests allows the system to demonstrate its ability to respond to a CRD Hook invocation
+        with a `not-covered` coverage determination when the patient can be resolved but does not have active
+        coverage.
+
+        For these tests, provide a hook request body that represents a resolvable patient without active
+        coverage. The tests then verify that a Coverage Information systemAction is received with `not-covered`
+        coverage for `no-active-coverage` reason.
+      )
+
+      config options: { hook_name: NO_ACTIVE_COVERAGE_TAG }
+      run_as_group
+
+      group do
+        title 'Interaction'
+
+        test from: :crd_v221_server_invoke_hook_single_request_test,
+             title: 'Inferno invokes the selected hook to elicit no active coverage response',
+             description: <<~DESCRIPTION,
+               This test initiates a POST request to a specified CDS Service using the JSON body provided
+               by the user. The request body should represent a resolvable patient without active coverage.
+             DESCRIPTION
+             config: {
+               inputs: {
+                 service_ids: {
+                   name: :no_active_coverage_service_ids,
+                   title: 'Service id to use for the "No Active Coverage" test',
+                   description: %(
+                     If blank, Inferno will attempt to infer the service id to use by finding a service entry
+                     in the Discovery response for the hook indicated in the provided request body. If it
+                     cannot be inferred, the tests will be skipped.
+                   )
+                 },
+                 service_request_bodies: {
+                   name: :no_active_coverage_request_body,
+                   title: 'Request body to use for the "No Active Coverage" test',
+                   description: %(
+                     Provide a single JSON request body to submit for the hook invocation. The type of hook
+                     invoked will be inferred based on the `hook` element in the request. The body should be
+                     constructed so that it represents a resolvable patient without active coverage.
+                   )
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Requests'
+        simulation_verification
+
+        test from: :crd_v221_service_request_required_fields_validation,
+             config: {
+               outputs: {
+                 contexts: {
+                   name: :no_active_coverage_contexts
+                 }
+               }
+             }
+        test from: :crd_v221_service_request_context_validation,
+             config: {
+               inputs: {
+                 contexts: {
+                   name: :no_active_coverage_contexts
+                 },
+                 request_body: {
+                   name: :no_active_coverage_request_body
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Responses'
+
+        test from: :crd_v221_service_response_validation
+        test from: :crd_v221_coverage_info_system_action_validation,
+             config: {
+               outputs: {
+                 coverage_info: {
+                   name: :no_active_coverage_coverage_info
+                 }
+               }
+             }
+        test from: :crd_v221_coverage_info_reason,
+             title: 'Coverage Information responses have not-covered coverage for no-active-coverage reason',
+             description: <<~DESCRIPTION,
+               This test verifies that the Coverage Information responses received contain Coverage Information
+               extensions with `not-covered` coverage and a `no-active-coverage` reason.
+             DESCRIPTION
+             config: {
+               inputs: {
+                 coverage_info: {
+                   name: :no_active_coverage_coverage_info
+                 }
+               },
+               options: {
+                 expected_coverage_code: 'not-covered',
+                 expected_reason_code: 'no-active-coverage'
+               }
+             },
+             verifies_requirements: [
+               'hl7.fhir.us.davinci-crd_2.2.1@resp-45'
+             ]
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/no_member_found_group.rb

@@ -0,0 +1,117 @@
+require_relative '../interaction/server_invoke_hook_single_request_test'
+require_relative 'coverage_info_reason_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class NoMemberFoundGroup < Inferno::TestGroup
+      title 'No Member Found'
+      id :crd_v221_server_no_member_found_group
+      description %(
+        This group of tests allows the system to demonstrate its ability to respond to a CRD Hook invocation
+        with a `not-covered` coverage determination when it is unable to resolve the patient for a
+        non-technical reason.
+
+        For these tests, provide a hook request body that represents a patient/member the CRD Server cannot
+        resolve for a non-technical reason.
+
+        The tests then verify that a Coverage Information systemAction is received with `not-covered` coverage
+        for `no-member-found` reasons.
+      )
+
+      config options: { hook_name: NO_MEMBER_FOUND_TAG }
+      run_as_group
+
+      group do
+        title 'Interaction'
+
+        test from: :crd_v221_server_invoke_hook_single_request_test,
+             title: 'Inferno invokes the selected hook to elicit unresolved member response',
+             description: <<~DESCRIPTION,
+               This test initiates a POST request to a specified CDS Service using the JSON body provided
+               by the user. The request body should represent an unrecognized member.
+             DESCRIPTION
+             config: {
+               inputs: {
+                 service_ids: {
+                   name: :no_member_found_service_ids,
+                   title: 'Service id to use for the "No Member Found" test',
+                   description: %(
+                     If blank, Inferno will attempt to infer the service id to use by finding a service entry
+                     in the Discovery response for the hook indicated in the provided request body. If it
+                     cannot be inferred, the tests will be skipped.
+                   )
+                 },
+                 service_request_bodies: {
+                   name: :no_member_found_request_body,
+                   title: 'Request body to use for the "No Member Found" test',
+                   description: %(
+                     Provide a single JSON request body to submit for the hook invocation. The type of hook
+                     invoked will be inferred based on the `hook` element in the request. The body should be
+                     constructed so that the CRD Server is unable to resolve the patient/member.
+                   )
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Requests'
+        simulation_verification
+
+        test from: :crd_v221_service_request_required_fields_validation,
+             config: {
+               outputs: {
+                 contexts: {
+                   name: :no_member_found_contexts
+                 }
+               }
+             }
+        test from: :crd_v221_service_request_context_validation,
+             config: {
+               inputs: {
+                 contexts: {
+                   name: :no_member_found_contexts
+                 },
+                 request_body: {
+                   name: :no_member_found_request_body
+                 }
+               }
+             }
+      end
+
+      group do
+        title 'Responses'
+
+        test from: :crd_v221_service_response_validation
+        test from: :crd_v221_coverage_info_system_action_validation,
+             config: {
+               outputs: {
+                 coverage_info: {
+                   name: :no_member_found_coverage_info
+                 }
+               }
+             }
+        test from: :crd_v221_coverage_info_reason,
+             title: 'Coverage Information responses have not-covered coverage for no-member-found reason',
+             description: <<~DESCRIPTION,
+               This test verifies that the Coverage Information responses received contain Coverage Information
+               extensions with `not-covered` coverage and a `no-member-found` reason.
+             DESCRIPTION
+             config: {
+               inputs: {
+                 coverage_info: {
+                   name: :no_member_found_coverage_info
+                 }
+               },
+               options: {
+                 expected_coverage_code: 'not-covered',
+                 expected_reason_code: 'no-member-found'
+               }
+             },
+             verifies_requirements: [
+               'hl7.fhir.us.davinci-crd_2.2.1@resp-44'
+             ]
+      end
+    end
+  end
+end