davinci_pas_test_kit 0.12.0 → 0.12.1

data/lib/davinci_pas_test_kit/{generated/v2.0.1/client_tests/client_pended_pas_response_bundle_validation_test.rb → custom_groups/v2.0.1/client_tests/pas_client_response_bundle_validation_test.rb}

@@ -1,37 +1,43 @@
 require_relative '../../../pas_bundle_validation'
 require_relative '../../../user_input_response'
+require_relative '../../../response_generator'
 
 module DaVinciPASTestKit
   module DaVinciPASV201
-    class ClientPendedPasResponseBundleValidationTest < Inferno::Test
+    class PasClientResponseBundleValidationTest < Inferno::Test
       include DaVinciPASTestKit::PasBundleValidation
       include UserInputResponse
+      include ResponseGenerator
 
-      id :pas_client_v201_pended_pas_response_bundle_validation_test
-      title '[USER INPUT VALIDATION] Response Bundle is valid'
+      id :pas_client_v201_response_bundle_validation_test
+      title '[USER INPUT VERIFICATION] Submit Response Bundle is valid'
       description %(
-        **USER INPUT VALIDATION**: This test validates input provided by the user instead of the system under test.
+        **USER INPUT VERIFICATION**: This test verifies input provided by the tester instead of the system under test.
         Errors encountered will be treated as a skip instead of a failure.
-        
-        This test validates the conformity of the
-        user input to the
-        [PAS Response Bundle](http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-response-bundle) structure.
-        It also checks that other conformance requirements defined in the [PAS Formal
+
+        This test verifies the conformity of the submit response sent by Inferno, which will have been
+        either:
+        - the response body provided by the tester in the corresponding input, or
+        - created by Inferno from the $submit Bundle.
+
+        In either case, this test verifies the conformity of the response body to the
+        [PAS Response Bundle](https://hl7.org/fhir/us/davinci-pas/STU2/StructureDefinition-profile-pas-response-bundle.html)
+        structure. It also checks that other conformance requirements defined in the [PAS Formal
         Specification](https://hl7.org/fhir/us/davinci-pas/STU2/specification.html),
         such as the presence of all referenced instances within the bundle and the
         conformance of those instances to the appropriate profiles, are met.
-        
+
         It verifies the presence of mandatory elements and that elements with
         required bindings contain appropriate values. CodeableConcept element
         bindings will fail if none of their codings have a code/system belonging
         to the bound ValueSet. Quantity, Coding, and code element bindings will
         fail if their code/system are not found in the valueset.
-        
+
         Note that because X12 value sets are not public, elements bound to value
         sets containing X12 codes are not validated.
-        
+
         **Limitations**
-        
+
         Due to recognized errors in the PAS IG around extension context definitions,
         this test may not pass due to spurious errors of the form "The extension
         [extension url] is not allowed at this point". See [this
@@ -39,24 +45,42 @@ module DaVinciPASTestKit
         for additional details.
       )
 
-      def resource_type
-        'Bundle'
-      end
-
       def request_type
         'submit'
       end
 
+      def workflow_tag
+        config.options[:workflow_tag]
+      end
+
+      def target_user_input
+        case workflow_tag
+        when APPROVAL_WORKFLOW_TAG
+          :approval_json_response
+        when DENIAL_WORKFLOW_TAG
+          :denial_json_response
+        when PENDED_WORKFLOW_TAG
+          :pended_json_response
+        end
+      end
+
       run do
-        check_user_inputted_response :pended_json_response
+        load_tagged_requests(workflow_tag, SUBMIT_TAG)
+        skip_if requests.empty?, 'No responses to verify because no submit requests were made.'
+        message = if user_inputted_response? target_user_input
+                    "Invalid response generated from provided input '#{input_title(target_user_input)}':"
+                  else
+                    'Invalid response generated from the submitted claim:'
+                  end
+
         validate_pas_bundle_json(
-          pended_json_response,
+          request.response_body,
           'http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-response-bundle',
           '2.0.1',
           request_type,
           'response_bundle',
           skips: true,
-          message: "Invalid input for '#{input_title(:pended_json_response)}':"
+          message:
         )
       end
     end

data/lib/davinci_pas_test_kit/custom_groups/v2.0.1/client_tests/pas_client_subscription_create_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../urls'
+
+module DaVinciPASTestKit
+  module DaVinciPASV201
+    class PASClientSubscriptionCreateTest < Inferno::Test
+      include URLs
+
+      id :pas_client_v201_subscription_create_test
+      title 'Client submits a Subscription Creation Request'
+      description %(
+        Inferno will wait for a Subscription Creation request
+        and then perform a handshake to activate the Subscription.
+      )
+      input :access_token,
+            title: 'Access Token',
+            description: %(
+              Access token that the client will provide in the Authorization header of each request
+              made during this test.
+            )
+      input :client_endpoint_access_token,
+            optional: true,
+            title: 'Client Notification Access Token',
+            description: %(
+              The bearer token that Inferno will send on requests to the client under test's rest-hook notification
+              endpoint. Not needed if the client under test will create a Subscription with an appropriate header value
+              in the `channel.header` element. If a value for the `authorization` header is provided in
+              `channel.header`, this value will override it.
+            )
+
+      run do
+        wait(
+          identifier: access_token,
+          message: %(
+            **Subscription Creation Test**:
+
+            Submit a POST with a Subscription to:
+
+            `#{fhir_subscription_url}`
+
+            The request must have an `Authorization` header with the value `Bearer #{access_token}`.
+
+            Upon receipt, Inferno will send a handshake request to verify that notifications can be
+            delivered and continue the test with a pass or fail based on the result.
+          )
+        )
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/custom_groups/v2.0.1/client_tests/pas_client_subscription_pas_conformance_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module DaVinciPASTestKit
+  module DaVinciPASV201
+    class SubscriptionPASConformanceTest < Inferno::Test
+      id :pas_client_v201_subscription_pas_conformance_test
+      title 'Client Subscription PAS Conformance Verification'
+      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/STU2/SubscriptionTopic-PASSubscriptionTopic.html), and
+        - Inclusion of filter criteria for the client's organization.
+      )
+
+      run do
+        load_tagged_requests(SUBSCRIPTION_CREATE_TAG)
+        skip_if(requests.none?, 'Inferno did not receive a Subscription creation request')
+        subscription_resource = request.request_body
+
+        assert_valid_json(subscription_resource)
+        subscription = JSON.parse(subscription_resource)
+
+        unless subscription['criteria'] == 'http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic'
+          add_message('error', %(
+            The created Subscription must use the PAS-defined Subscription topic
+            `http://hl7.org/fhir/us/davinci-pas/SubscriptionTopic/PASSubscriptionTopic`
+            in the `Subscription.criteria` element.
+          ))
+        end
+
+        filter_criteria = subscription.dig('_criteria', 'extension')
+          &.select do |ext|
+            ext['url'] == 'http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria'
+          end
+        unless filter_criteria&.length == 1
+          add_message('error', %(
+            The created Subscription must include a single filter on the submitting organization
+            in the `Subscription.criteria.extension` element.
+          ))
+        end
+
+        assert messages.none? { |msg| msg[:type] == 'error' },
+               'The Created Subscription does not conform to PAS requirements - see messages for details.'
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/custom_groups/v2.0.1/pas_client_approval_group.rb

@@ -1,6 +1,8 @@
 require_relative 'client_tests/pas_client_approval_submit_test'
-require_relative 'client_tests/pas_client_approval_submit_response_attest'
-require_relative '../../generated/v2.0.1/client_tests/client_pas_request_bundle_validation_test'
+require_relative 'client_tests/pas_client_response_attest'
+require_relative 'client_tests/pas_client_request_bundle_validation_test'
+require_relative 'client_tests/pas_client_response_bundle_validation_test'
+require_relative '../../tags'
 
 module DaVinciPASTestKit
   module DaVinciPASV201
@@ -13,14 +15,24 @@ module DaVinciPASTestKit
       )
       run_as_group
 
-      test from: :pas_client_v201_approval_submit_test,
-           receives_request: :approval_claim
+      input :approval_json_response, optional: true
 
-      test from: :pas_client_v201_pas_request_bundle_validation_test,
-           uses_request: :approval_claim
-
-      test from: :pas_client_v201_approval_submit_response_attest,
-           uses_request: :approval_claim
+      test from: :pas_client_v201_approval_submit_test
+      test from: :pas_client_v201_request_bundle_validation_test,
+           config: { options: { workflow_tag: APPROVAL_WORKFLOW_TAG } }
+      test from: :pas_client_v201_response_bundle_validation_test,
+           config: { options: { workflow_tag: APPROVAL_WORKFLOW_TAG } }
+      test from: :pas_client_v201_response_attest,
+           title: 'Check that the client registers the request as approved (Attestation)',
+           description: %(
+             This test provides the tester an opportunity to observe their client following
+             the receipt of the approved response and attest that users are able to determine
+             that the response has been approved.
+           ),
+           config: { options: {
+             workflow_tag: APPROVAL_WORKFLOW_TAG,
+             attest_message: "I attest that the client system displays the submitted claim as 'approved' meaning that the user can proceed with ordering or providing the requested service." # rubocop:disable Layout/LineLength
+           } }
     end
   end
 end

data/lib/davinci_pas_test_kit/custom_groups/v2.0.1/pas_client_authentication_group.rb

@@ -23,7 +23,7 @@ module DaVinciPASTestKit
 
         Finally, make a valid token request that includes the specified `client_id`
         to indicated token endpoint. This should be a POST of an `x-www-form-encoded`
-        body containing keys for `grant_type` with a value of `client_crendials` and
+        body containing keys for `grant_type` with a value of `client_credentials` and
         `client_id` with a value of the configured `client_id` value. For example, if
         the `client_id` value was `123`, then the body of the request would be:
 
@@ -38,7 +38,7 @@ module DaVinciPASTestKit
         the "Authorization" HTTP header with prefix "Bearer: ". In this example, the
         Authorization HTTP header would have value:
 
-        ```Bearer: 97e792038d922bc3cf388b608e45c318```
+        ```Bearer 97e792038d922bc3cf388b608e45c318```
       )
       run_as_group
 

data/lib/davinci_pas_test_kit/custom_groups/v2.0.1/pas_client_denial_group.rb

@@ -1,8 +1,9 @@
 require_relative 'client_tests/pas_client_denial_submit_test'
-require_relative 'client_tests/pas_client_denial_submit_response_attest'
-require_relative '../../generated/v2.0.1/client_tests/client_denial_pas_response_bundle_validation_test'
-require_relative '../../generated/v2.0.1/client_tests/client_pas_request_bundle_validation_test'
+require_relative 'client_tests/pas_client_response_attest'
+require_relative 'client_tests/pas_client_response_bundle_validation_test'
+require_relative 'client_tests/pas_client_request_bundle_validation_test'
 require_relative '../../user_input_response'
+require_relative '../../tags'
 
 module DaVinciPASTestKit
   module DaVinciPASV201
@@ -16,26 +17,24 @@ module DaVinciPASTestKit
       )
       run_as_group
 
-      input :denial_json_response,
-            title: 'Claim denied response JSON',
-            type: 'textarea',
-            optional: true,
-            description: %(
-              The response provided will be validated against the PAS Response Bundle profile. If determined to be
-              invalid, a validation message will be returned, and the test group will be skipped.
-            )
+      input :denial_json_response, optional: true
 
-      test from: :pas_client_v201_denial_submit_test,
-           receives_request: :denial_claim,
-           respond_with: :denial_json_response
-
-      test from: :pas_client_v201_denial_pas_response_bundle_validation_test
-
-      test from: :pas_client_v201_pas_request_bundle_validation_test,
-           uses_request: :denial_claim
-
-      test from: :pas_client_v201_denial_submit_response_attest,
-           uses_request: :denial_claim
+      test from: :pas_client_v201_denial_submit_test
+      test from: :pas_client_v201_request_bundle_validation_test,
+           config: { options: { workflow_tag: DENIAL_WORKFLOW_TAG } }
+      test from: :pas_client_v201_response_bundle_validation_test,
+           config: { options: { workflow_tag: DENIAL_WORKFLOW_TAG } }
+      test from: :pas_client_v201_response_attest,
+           title: 'Check that the client registers the request as denied (Attestation)',
+           description: %(
+             This test provides the tester an opportunity to observe their client following
+             the receipt of the denied response and attest that users are able to determine
+             that the response has been denied.
+           ),
+           config: { options: {
+             workflow_tag: DENIAL_WORKFLOW_TAG,
+             attest_message: "I attest that the client system displays the submitted claim as 'denied'."
+           } }
     end
   end
 end

data/lib/davinci_pas_test_kit/custom_groups/v2.0.1/pas_client_pended_group.rb

@@ -1,11 +1,11 @@
 require_relative 'client_tests/pas_client_pended_submit_test'
-require_relative 'client_tests/pas_client_pended_submit_response_attest'
-require_relative 'client_tests/pas_client_pended_inquire_test'
-require_relative 'client_tests/pas_client_pended_inquire_response_attest'
-require_relative '../../generated/v2.0.1/client_tests/client_pended_pas_response_bundle_validation_test'
-require_relative '../../generated/v2.0.1/client_tests/client_pas_request_bundle_validation_test'
-require_relative '../../generated/v2.0.1/client_tests/client_pended_pas_inquiry_request_bundle_validation_test'
+require_relative 'client_tests/pas_client_response_attest'
+require_relative 'client_tests/pas_client_response_bundle_validation_test'
+require_relative 'client_tests/pas_client_inquire_response_bundle_validation_test'
+require_relative 'client_tests/pas_client_request_bundle_validation_test'
+require_relative 'client_tests/pas_client_inquire_request_bundle_validation_test'
 require_relative '../../user_input_response'
+require_relative '../../tags'
 
 module DaVinciPASTestKit
   module DaVinciPASV201
@@ -16,41 +16,107 @@ module DaVinciPASTestKit
       description %(
         Demonstrate the ability of the client to initiate a prior authorization
         request and respond appropriately to a 'pended' decision, including
-        waiting for a notification that an update has been made (not currently
-        implemented) and making an inquiry request to retrieve the final result.
+        waiting for a notification that an update has been made
+        and making an inquiry request to retrieve the final result.
       )
       run_as_group
 
-      input :pended_json_response,
-            title: 'Claim pended response JSON',
-            type: 'textarea',
-            optional: true,
-            description: %(
-              The response provided will be validated against the PAS Response Bundle profile. If determined to be
-              invalid, a validation message will be returned, and the test group will be skipped.
-            )
+      input :pended_json_response, optional: true
+      input :inquire_json_response, optional: true
 
-      test from: :pas_client_v201_pended_submit_test,
-           receives_request: :pended_claim,
-           respond_with: :pended_json_response
+      group do
+        title 'Perform the pended workflow'
+        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 notification that the prior authorization decision has been finalized from Inferno
+            to the client under test.
+          - An `$inquire` request from the client to Inferno where Inferno returns an approved response.
+        )
 
-      test from: :pas_client_v201_pended_pas_response_bundle_validation_test
+        test from: :pas_client_v201_pended_submit_test
+      end
 
-      test from: :pas_client_v201_pas_request_bundle_validation_test,
-           uses_request: :pended_claim
+      group do
+        title 'Verify $submit interaction'
 
-      test from: :pas_client_v201_pended_submit_response_attest,
-           uses_request: :pended_claim
+        test from: :pas_client_v201_request_bundle_validation_test,
+             config: { options: { workflow_tag: PENDED_WORKFLOW_TAG } }
+        test from: :pas_client_v201_response_bundle_validation_test,
+             config: { options: { workflow_tag: PENDED_WORKFLOW_TAG } }
+        test from: :pas_client_v201_response_attest,
+             title: 'Check that the client registers the request as pended (Attestation)',
+             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." # rubocop:disable Layout/LineLength
+             } }
+      end
 
-      test from: :pas_client_v201_pended_inquire_test,
-           uses_request: :pended_claim,
-           receives_request: :pended_inquiry
+      group do
+        title 'Verify notification interaction'
 
-      test from: :pas_client_v201_pended_pas_inquiry_request_bundle_validation_test,
-           uses_request: :pended_inquiry
+        test from: :subscriptions_r4_client_notification_input_verification,
+             title: '[USER INPUT VERIFICATION] Tester-provided 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.
+             ),
+             config: {
+               inputs: {
+                 notification_bundle: { optional: true } # doesn't use the input (bug in Subscriptions)
+               }
+             }
+        test from: :subscriptions_r4_client_notification_input_payload_verification,
+             title: '[USER INPUT VERIFICATION] Tester-provided 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.
+             ),
+             config: {
+               inputs: {
+                 notification_bundle: { optional: true } # doesn't use the input (bug in Subscriptions)
+               }
+             }
+        # test for PAS-specific requirements? Current decision: no, there isn't anything hard in the spec
+        # and testers have to demonstrate and attest that their systems work, which will require some
+        # correspondence.
+        test from: :subscriptions_r4_client_event_notification_verification,
+             title: 'Client accepts the "claim updated" event notification',
+             description: %(
+               This test checks that the client responds appropriately to the event notification request.
+             )
+      end
 
-      test from: :pas_client_v201_pended_inquire_response_attest,
-           uses_request: :pended_inquiry
+      group do
+        title 'Verify $inquire interaction'
+
+        test from: :pas_client_v201_inquire_request_bundle_validation_test,
+             config: { options: { workflow_tag: PENDED_WORKFLOW_TAG } }
+        test from: :pas_client_v201_inquire_response_bundle_validation_test,
+             config: { options: { workflow_tag: PENDED_WORKFLOW_TAG } }
+        test from: :pas_client_v201_response_attest,
+             title: 'Check that the client registers the request as approved (Attestation)',
+             description: %(
+              This test provides the tester an opportunity to observe their client following
+              the receipt of the inquiry response with a final decision and attest that users
+              are able to determine that the response has been approved in full.
+             ),
+             config: { options: {
+               workflow_tag: PENDED_WORKFLOW_TAG,
+               attest_message: "I attest that the client system displays the submitted claim as 'approved' meaning that the user can proceed with ordering or providing the requested service." # rubocop:disable Layout/LineLength
+             } }
+      end
     end
   end
 end