davinci_pas_test_kit 0.14.1 → 0.15.0

data/lib/davinci_pas_test_kit/client/v2.2.1/pas_client_operation_failure_group.rb

@@ -0,0 +1,45 @@
+require_relative 'error_handling/pas_client_operation_failure_submit_test'
+require_relative 'error_handling/pas_client_operation_outcome_validation_test'
+require_relative 'workflows/pas_client_response_attest'
+require_relative '../../cross_suite/tags'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientOperationFailureGroup < Inferno::TestGroup
+      id :pas_client_v221_operation_failure_group
+      title 'Operation Failure'
+      description %(
+        During these tests, the client will initiate a prior authorization
+        request and show it can respond appropriately to an operation failure response —
+        a non-2XX HTTP status code accompanied by an OperationOutcome resource.
+      )
+      run_as_group
+
+      input :operation_failure_operation_outcome
+      input :operation_failure_http_status, optional: true
+
+      input_order :operation_failure_operation_outcome,
+                  :operation_failure_http_status,
+                  :client_id,
+                  :session_url_path
+
+      test from: :pas_client_v221_operation_failure_submit_test
+      test from: :pas_client_v221_operation_outcome_validation_test
+      test from: :pas_client_v221_response_attest,
+           title: 'PAS client handles the operation failure appropriately',
+           description: %(
+             This test provides the tester an opportunity to observe their client following
+             the receipt of the operation failure response and attest that the error details
+             from the OperationOutcome were made available to the appropriate users (e.g.,
+             technical staff, not the clinical end user).
+           ),
+           config: { options: {
+             workflow_tag: OPERATION_FAILURE_WORKFLOW_TAG,
+             attest_message: 'I attest that the client system handles the operation failure response ' \
+                             'appropriately: the OperationOutcome details are available to technical staff ' \
+                             'for review and the clinical end user is informed that the submission could ' \
+                             'not be processed.'
+           } }
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/pas_client_pended_group.rb

@@ -0,0 +1,125 @@
+require_relative 'workflows/pas_client_pended_submit_test'
+require_relative 'workflows/pas_client_response_attest'
+require_relative 'workflows/pas_client_response_bundle_validation_test'
+require_relative 'workflows/pas_client_request_bundle_validation_test'
+require_relative '../../pas_notification_conformance_test'
+require_relative '../user_input_response'
+require_relative '../../cross_suite/tags'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientPendedGroup < Inferno::TestGroup
+      include UserInputResponse
+
+      id :pas_client_v221_pended_group
+      title 'Pended Workflow'
+      description %(
+        During these tests, the client will initiate a prior authorization
+        request and show it can respond appropriately to a 'pended' decision, including
+        waiting for a full-resource notification that contains the final decision.
+        In v2.2.1, the notification includes all details so no follow-up `$inquire`
+        request is needed.
+      )
+      run_as_group
+
+      input :pended_json_response, optional: true
+
+      input_order :pended_json_response,
+                  :client_id,
+                  :session_url_path
+
+      group do
+        title 'Interaction'
+        description %(
+          All interactions for the pended prior authorization request workflow
+          between Inferno and the client under test will be performed during this test
+          including
+          - A `$submit` request from the client to Inferno where Inferno returns a pended response.
+          - A full-resource notification that the prior authorization decision has been finalized
+            from Inferno to the client under test.
+        )
+
+        test from: :pas_client_v221_pended_submit_test
+      end
+
+      group do
+        title '$submit Conformance and Handling'
+
+        test from: :pas_client_v221_request_bundle_validation_test,
+             config: { options: { workflow_tag: PENDED_WORKFLOW_TAG } }
+        test from: :pas_client_v221_response_bundle_validation_test,
+             config: { options: { workflow_tag: PENDED_WORKFLOW_TAG } }
+        test from: :pas_client_v221_response_attest,
+             title: 'PAS client displays the request as "pended"',
+             description: %(
+              This test provides the tester an opportunity to observe their client following
+              the receipt of the pended response and attest that users are able to determine
+              that the response has been pended and a decision will be forthcoming.
+             ),
+             config: { options: {
+               workflow_tag: PENDED_WORKFLOW_TAG,
+               attest_message: "I attest that following the receipt of the 'pended' response to the submitted " \
+                               'claim, the client system indicates to users that a final decision on request ' \
+                               'has not yet been made.'
+             } }
+      end
+
+      group do
+        title 'Notification Conformance and Handling'
+
+        test from: :subscriptions_r4_client_notification_input_verification,
+             title: 'Inferno\'s event notification Bundle is conformant',
+             description: %(
+               This test checks that the notification Bundle sent to the client, which will be either
+               the tester-provided notification Bundle in the **Claim updated notification JSON** input
+               or mocked by Inferno based on details in the Subscription and submitted Claim, is conformant
+               to Subscription Backport IG requirements.
+             ),
+             simulation_verification: true,
+             config: {
+               inputs: {
+                 notification_bundle: { optional: true } # doesn't use the input (bug in Subscriptions)
+               }
+             }
+        test from: :subscriptions_r4_client_notification_input_payload_verification,
+             title: 'Inferno\'s event notification Bundle matches the Subscription',
+             description: %(
+               This test checks that the notification Bundle sent to the client, which will be either
+               the tester-provided notification Bundle in the **Claim updated notification JSON** input
+               or mocked by Inferno based on details in the Subscription and submitted Claim, matches the details
+               requested in the Subscription provided during the **2.1** "PAS Subscription Setup" tests.
+             ),
+             simulation_verification: true,
+             config: {
+               inputs: {
+                 notification_bundle: { optional: true } # doesn't use the input (bug in Subscriptions)
+               }
+             }
+        test from: :pas_notification_pas_conformance_test,
+             title: 'Inferno\'s notification conforms to PAS-specific requirements',
+             simulation_verification: true
+        test from: :subscriptions_r4_client_event_notification_verification,
+             title: 'PAS client accepts the "claim updated" event notification',
+             description: %(
+               This test checks that the client responds appropriately to the event notification request.
+             ) do
+               verifies_requirements(*SubscriptionsTestKit::SubscriptionsR5BackportR4Client::EventNotificationVerificationTest.verifies_requirements,
+                                     'hl7.fhir.us.davinci-pas_2.2.1@spec-8')
+             end
+        test from: :pas_client_v221_response_attest,
+             title: 'PAS client displays the final decision as "approved"',
+             description: %(
+              This test provides the tester an opportunity to observe their client following
+              the receipt of the full-resource notification containing the approved final decision
+              and attest that users are able to determine that the request has been approved.
+             ),
+             config: { options: {
+               workflow_tag: PENDED_WORKFLOW_TAG,
+               attest_message: "I attest that the client system displays the submitted claim as 'approved' based " \
+                               'on the full-resource notification, meaning that the user can proceed with ' \
+                               'ordering or providing the requested service.'
+             } }
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/pas_client_processing_error_group.rb

@@ -0,0 +1,44 @@
+require_relative 'error_handling/pas_client_processing_error_submit_test'
+require_relative 'error_handling/pas_client_processing_error_response_validation_test'
+require_relative 'workflows/pas_client_request_bundle_validation_test'
+require_relative 'workflows/pas_client_response_attest'
+require_relative '../../cross_suite/tags'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientProcessingErrorGroup < Inferno::TestGroup
+      id :pas_client_v221_processing_error_group
+      title 'Processing Errors'
+      description %(
+        During these tests, the client will initiate a prior authorization
+        request and show it can respond appropriately to a response containing
+        one or more ClaimResponse.error entries.
+      )
+      run_as_group
+
+      input :processing_error_response
+
+      input_order :processing_error_response,
+                  :client_id,
+                  :session_url_path
+
+      test from: :pas_client_v221_processing_error_submit_test
+      test from: :pas_client_v221_request_bundle_validation_test,
+           config: { options: { workflow_tag: PROCESSING_ERROR_WORKFLOW_TAG } }
+      test from: :pas_client_v221_processing_error_response_validation_test
+      test from: :pas_client_v221_response_attest,
+           title: 'PAS client handles the processing errors appropriately',
+           description: %(
+             This test provides the tester an opportunity to observe their client following
+             the receipt of the response containing ClaimResponse.error entries and attest
+             that the processing error details were made available to the appropriate users.
+           ),
+           config: { options: {
+             workflow_tag: PROCESSING_ERROR_WORKFLOW_TAG,
+             attest_message: 'I attest that the client system handles the processing error response ' \
+                             'appropriately: the ClaimResponse error details are surfaced to the ' \
+                             'appropriate users so that corrective action can be taken.'
+           } }
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/pas_client_registration_group.rb

@@ -0,0 +1,65 @@
+require 'udap_security_test_kit'
+require 'smart_app_launch_test_kit'
+require_relative '../pas_client_options'
+require_relative 'registration/configuration_smart_display_test'
+require_relative 'registration/configuration_udap_display_test'
+require_relative 'registration/configuration_other_display_test'
+require_relative 'registration/other_auth_attest_test'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientRegistrationGroup < Inferno::TestGroup
+      id :pas_client_v221_registration
+      title 'Client Registration'
+      description %(
+        Register the client under test with Inferno's simulated PAS Server,
+        including configuration of the system under test to make requests against
+        Inferno's simulated PAS endpoints and enable authentication and authorization of PAS requests.
+      )
+      run_as_group
+
+      # smart registration tests
+      test from: :smart_client_registration_bsca_verification,
+           title: 'PAS client registers with Inferno as a SMART confidential asymmetric client',
+           required_suite_options: {
+             client_type: PASClientOptions::SMART_BACKEND_SERVICES_CONFIDENTIAL_ASYMMETRIC
+           }
+      test from: :pas_client_v221_reg_config_smart_display,
+           required_suite_options: {
+             client_type: PASClientOptions::SMART_BACKEND_SERVICES_CONFIDENTIAL_ASYMMETRIC
+           }
+
+      # udap registration tests
+      test from: :udap_client_registration_interaction,
+           title: 'PAS client invokes the registration endpoint to register as a UDAP client',
+           required_suite_options: {
+             client_type: PASClientOptions::UDAP_CLIENT_CREDENTIALS
+           },
+           config: {
+             options: { endpoint_suite_id: :davinci_pas_client_suite_v221 }
+           }
+      test from: :udap_client_registration_cc_verification,
+           title: 'PAS client registered using the UDAP client credentials grant type',
+           required_suite_options: {
+             client_type: PASClientOptions::UDAP_CLIENT_CREDENTIALS
+           },
+           config: {
+             options: { endpoint_suite_id: :davinci_pas_client_suite_v221 }
+           }
+      test from: :pas_client_v221_reg_config_udap_display,
+           required_suite_options: {
+             client_type: PASClientOptions::UDAP_CLIENT_CREDENTIALS
+           }
+
+      # other registration tests
+      test from: :pas_client_v221_reg_other_auth_attest,
+           required_suite_options: {
+             client_type: PASClientOptions::OTHER_AUTH
+           }
+      test from: :pas_client_v221_reg_config_other_display,
+           required_suite_options: {
+             client_type: PASClientOptions::OTHER_AUTH
+           }
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/pas_client_subscription_setup_group.rb

@@ -0,0 +1,31 @@
+require 'subscriptions_test_kit'
+require_relative 'subscription/pas_client_subscription_create_test'
+require_relative '../pas_client_subscription_pas_conformance_test'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientSubscriptionSetupGroup < Inferno::TestGroup
+      id :pas_client_v221_subscription_setup
+      title 'Subscription Setup'
+      description %(
+        These tests verify that the client can create a Subscription instance
+        that will tell the Payer how to notify the client when pended claims
+        are updated.
+      )
+      run_as_group
+
+      test from: :pas_client_v221_subscription_create_test
+      test from: :pas_client_subscription_pas_conformance_test,
+           description: %(
+             This test verifies that the Subscription created by the client under test
+             is conformant to PAS requirements on the Subscription, including
+             - The use of the [PAS-defined Subscription
+               Topic](https://hl7.org/fhir/us/davinci-pas/2.2.1/SubscriptionTopic-PASSubscriptionTopic.html), and
+             - Inclusion of filter criteria for the client's organization.
+           ),
+           config: { options: { ig_version: 'v2.2.1' } }
+      test from: :subscriptions_r4_client_handshake_notification_verification,
+           title: "PAS client responds correctly to Inferno's Subscription handshake"
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/pas_client_workflows_group.rb

@@ -0,0 +1,25 @@
+require_relative 'pas_client_approval_group'
+require_relative 'pas_client_denial_group'
+require_relative 'pas_client_pended_group'
+require_relative 'pas_client_claim_updates_group'
+require_relative 'pas_client_modification_group'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientWorkflowsGroup < Inferno::TestGroup
+      id :pas_client_v221_workflows
+      title 'PAS Workflows'
+      description %(
+        The workflow tests verify that the client can participate in complete end-to-end prior
+        authorization interactions, initiating requests and reacting appropriately to the
+        responses returned.
+      )
+
+      group from: :pas_client_v221_approval_group
+      group from: :pas_client_v221_denial_group
+      group from: :pas_client_v221_pended_group
+      group from: :pas_client_v221_claim_updates_group
+      group from: :pas_client_v221_modification_group
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/registration/configuration_other_display_test.rb

@@ -0,0 +1,12 @@
+require_relative '../../registration/abstract_configuration_other_display_test'
+require_relative '../urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class RegistrationConfigurationOtherDisplay < AbstractRegistrationConfigurationOtherDisplay
+      include URLs
+
+      id :pas_client_v221_reg_config_other_display
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/registration/configuration_smart_display_test.rb

@@ -0,0 +1,12 @@
+require_relative '../../registration/abstract_configuration_smart_display_test'
+require_relative '../urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class RegistrationConfigurationSMARTDisplay < AbstractRegistrationConfigurationSMARTDisplay
+      include URLs
+
+      id :pas_client_v221_reg_config_smart_display
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/registration/configuration_udap_display_test.rb

@@ -0,0 +1,12 @@
+require_relative '../../registration/abstract_configuration_udap_display_test'
+require_relative '../urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class RegistrationConfigurationUDAPDisplay < AbstractRegistrationConfigurationUDAPDisplay
+      include URLs
+
+      id :pas_client_v221_reg_config_udap_display
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/registration/other_auth_attest_test.rb

@@ -0,0 +1,12 @@
+require_relative '../../registration/abstract_other_auth_attest_test'
+require_relative '../urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class RegistrationOtherAuthAttest < AbstractRegistrationOtherAuthAttest
+      include URLs
+
+      id :pas_client_v221_reg_other_auth_attest
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/subscription/pas_client_subscription_create_test.rb

@@ -0,0 +1,14 @@
+require_relative '../../abstract_subscription_create_test'
+require_relative '../urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientSubscriptionCreateTest < AbstractSubscriptionCreateTest
+      include URLs
+
+      id :pas_client_v221_subscription_create_test
+
+      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@spec-8'
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/urls.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../client_urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    module URLs
+      include ClientURLs
+
+      def suite_id
+        DaVinciPASTestKit::DaVinciPASV221::ClientSuite.id
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/workflows/pas_client_approval_submit_test.rb

@@ -0,0 +1,12 @@
+require_relative '../../abstract_approval_submit_test'
+require_relative '../urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class PASClientApprovalSubmitTest < AbstractApprovalSubmitTest
+      include URLs
+
+      id :pas_client_v221_approval_submit_test
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/workflows/pas_client_claim_update_cancel_request_test.rb

@@ -0,0 +1,33 @@
+require_relative 'pas_client_claim_update_validation_utils'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    # Checks that the cancel-entire-request update carries a certificationType extension with code 3
+    # (Cancel) in Claim.extension, as described in the IG's "updating authorization requests" narrative.
+    # This behavior has no numbered conformance statement to link, so there is no verifies_requirements
+    # annotation.
+    class PASClientClaimUpdateCancelRequestTest < Inferno::Test
+      include ClaimUpdateValidationUtils
+
+      id :pas_client_v221_claim_update_cancel_request_test
+      title 'Claims canceling the entire request carry a top-level certificationType extension with code 3'
+      description %(
+        To [cancel the entire request](https://hl7.org/fhir/us/davinci-pas/2.2.1/en/specification.html#updating-authorization-requests),
+        clients send a [certificationType extension](https://hl7.org/fhir/us/davinci-pas/2.2.1/en/StructureDefinition-extension-certificationType.html)
+        with a code of 3 (Cancel) in the `Claim.extension` element of a PAS Claim Update; no items are needed to
+        cancel the entire authorization. This test checks the cancel-entire-request update and confirms it
+        carries that extension.
+      )
+
+      run do
+        bundle = claim_update_bundle(CLAIM_UPDATE_CANCEL_ALL_TAG)
+        claim = first_claim(bundle)
+        skip_if claim.nil?, 'No cancel-entire-request update was received to verify.'
+
+        assert certification_type_cancel?(claim),
+               'The cancel-entire-request update must include a certificationType extension with a code of 3 ' \
+               '(Cancel) in Claim.extension.'
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/workflows/pas_client_claim_update_cancelled_entries_test.rb

@@ -0,0 +1,50 @@
+require_relative 'pas_client_claim_update_validation_utils'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    # spec-69
+    class PASClientClaimUpdateCancelledEntriesTest < Inferno::Test
+      include ClaimUpdateValidationUtils
+
+      id :pas_client_v221_claim_update_cancelled_entries_test
+      title 'Canceled entries carry the infoCancelled modifier extension'
+      description %(
+        The PAS IG [requires](https://hl7.org/fhir/us/davinci-pas/2.2.1/en/conformancedetails.html#ci-c-spec-69)
+        that item and supportingInfo entries removed from the request include the infoCancelled modifier
+        extension with a valueBoolean of `true`. This test checks each Claim Update for entries marked as
+        canceled and confirms the infoCancelled modifier extension is present and `true`.
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@spec-69',
+                            'hl7.fhir.us.davinci-pas_2.2.1@prof-7',
+                            'hl7.fhir.us.davinci-pas_2.2.1@prof-8'
+
+      run do
+        steps = received_claim_update_steps
+        skip_if steps.empty?, 'No Claim Update requests were received to verify.'
+
+        cancelled_entries = steps.flat_map do |step|
+          (Array(step[:claim].item) + Array(step[:claim].supportingInfo))
+            .select { |entry| cancellation_marked?(entry) }
+            .map { |entry| { step:, entry: } }
+        end
+
+        skip_if cancelled_entries.empty?,
+                'No canceled item or supportingInfo entries were received to verify (the modify-and-cancel ' \
+                'update is expected to cancel an item).'
+
+        cancelled_entries.each do |cancelled|
+          entry = cancelled[:entry]
+          next if info_cancelled?(entry)
+
+          add_message('error',
+                      "A canceled #{entry_kind(entry)} (sequence #{entry.sequence}) in the " \
+                      "#{cancelled[:step][:label]} must include the infoCancelled modifier extension with a " \
+                      'valueBoolean of true.')
+        end
+
+        assert_no_error_messages('One or more canceled entries did not carry the infoCancelled modifier ' \
+                                 'extension. See Messages for details.')
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/workflows/pas_client_claim_update_cancelled_items_certtype_test.rb

@@ -0,0 +1,47 @@
+require_relative 'pas_client_claim_update_validation_utils'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    # spec-70
+    class PASClientClaimUpdateCancelledItemsCertificationTypeTest < Inferno::Test
+      include ClaimUpdateValidationUtils
+
+      id :pas_client_v221_claim_update_cancelled_items_certtype_test
+      title 'Canceled items carry a certificationType extension with code 3'
+      description %(
+        The PAS IG [requires](https://hl7.org/fhir/us/davinci-pas/2.2.1/en/conformancedetails.html#ci-c-spec-70)
+        that canceled items additionally contain a certificationType extension with a code of 3 (Cancel) in the
+        `Claim.item.extension` element. This test checks each Claim Update for canceled items and confirms the
+        certificationType Cancel extension is present.
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@spec-70', 'hl7.fhir.us.davinci-pas_2.2.1@prof-7'
+
+      run do
+        steps = received_claim_update_steps
+        skip_if steps.empty?, 'No Claim Update requests were received to verify.'
+
+        cancelled_items = steps.flat_map do |step|
+          Array(step[:claim].item)
+            .select { |item| cancellation_marked?(item) }
+            .map { |item| { step:, item: } }
+        end
+
+        skip_if cancelled_items.empty?,
+                'No canceled items were received to verify (the modify-and-cancel update is expected to ' \
+                'cancel an item).'
+
+        cancelled_items.each do |cancelled|
+          item = cancelled[:item]
+          next if certification_type_cancel?(item)
+
+          add_message('error',
+                      "A canceled item (sequence #{item.sequence}) in the #{cancelled[:step][:label]} must " \
+                      'contain a certificationType extension with a code of 3 (Cancel) in Claim.item.extension.')
+        end
+
+        assert_no_error_messages('One or more canceled items did not carry a certificationType extension with ' \
+                                 'code 3 (Cancel). See Messages for details.')
+      end
+    end
+  end
+end