davinci_pas_test_kit 0.15.2 → 0.16.0

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

@@ -3,6 +3,7 @@ require_relative '../../client_input_descriptions'
 require_relative '../../user_input_response'
 require_relative '../../../cross_suite/pas_bundle_validation'
 require_relative '../../session_identification'
+require_relative '../../subscription_setup_requirement'
 
 module DaVinciPASTestKit
   module DaVinciPASV221
@@ -11,55 +12,24 @@ module DaVinciPASTestKit
       include SessionIdentification
       include UserInputResponse
       include PasBundleValidation
+      include SubscriptionSetupRequirement
 
       id :pas_client_v221_pended_submit_test
-      title 'PAS Client submits a claim and receives a final decision via a notification'
+      title 'PAS client submits a claim using the $submit operation'
       description %(
-        Inferno will wait for a prior authorization submission request
-        from the client. Upon receipt, Inferno will respond with the
-        provided pended response. Subsequently, Inferno will send a
-        full-resource notification containing the final decision.
-        In v2.2.1, no follow-up `$inquire` request is needed as the
-        notification includes all details.
+        During this test, Inferno will wait for a prior authorization submission request
+        from the PAS client using the `$submit` operation. Upon receipt, Inferno will respond
+        with a [tester-provided](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses)
+        or [Inferno-mocked](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses)
+        pended response. Inferno will not respond to `$inquire` operation requests during
+        this test.
       )
 
-      config options: { accepts_multiple_requests: true }
-      input :notification_bundle,
-            title: 'Claim updated notification JSON',
-            type: 'textarea',
-            optional: true,
-            description: %(
-              If provided, this JSON will be sent as the notification for the
-              PAS Subscription to tell the client that a decision has been made on the pended claim.
-              Before sending, Inferno will update the provided notification with details that the tester cannot
-              know ahead of time, including timestamps corresponding to the notification trigger time, and the id of
-              the triggering ClaimResponse if Inferno mocks that ClaimResponse because it is not provided by the
-              tester through the *Claim pended response JSON* input.
-              If not provided, a notification will be generated from the returned ClaimResponse.
-              In either case the response will be validated to ensure that the notification
-              is conformant. For v2.2.1, the notification will be a full-resource notification
-              containing the complete ClaimResponse.
-            )
       input :pended_json_response,
             title: 'Claim pended response JSON',
             type: 'textarea',
             optional: true,
-            description: %(
-              If provided, this JSON will be sent in response to $submit requests during this test
-              to indicate that the request has been pended awaiting a final decision.
-              It will be updated to make creation timestamps current.
-              If not provided, a pended response will be generated from the submitted Claim.
-              In either case the response will be validated against the PAS Response Bundle profile.
-            )
-      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.
-            )
+            description: DaVinciPASTestKit.user_response_input_description('$submit', 'pended', 'Pended Response')
       input :client_id,
             title: 'Client Id',
             type: 'text',
@@ -74,16 +44,10 @@ module DaVinciPASTestKit
             description: INPUT_SESSION_URL_PATH_LOCKED
 
       submit_respond_with :pended_json_response
-      output :confirmation_url
+      config options: { submit_enabled: true, suppress_notifications: true } # handling notification separately
 
       run do
-        load_tagged_requests(SUBSCRIPTION_CREATE_TAG)
-        skip_if requests.empty?, # NOTE: subscription needed ahead of time to support notification generation
-                %(
-                  Pended workflow tests cannot proceed because no Subscription exists to receive notifications
-                  for pended claims. Run the _PAS Subscription Setup_ tests to provide a Subscription for use
-                  in delivering notifications before re-running the pended workflow tests.
-                )
+        require_unmodified_subscription
 
         if user_inputted_response? :pended_json_response
           assert_valid_json pended_json_response,
@@ -95,52 +59,35 @@ module DaVinciPASTestKit
           ))
         end
 
-        if notification_bundle.present?
-          assert_valid_json notification_bundle,
-                            "Input '#{input_title(:notification_bundle)}' must be valid JSON"
-        else
-          add_message('info', %(
-            No notification body provided in input '#{input_title(:notification_bundle)}'. When sending a
-            notification finalizing a pended $submit response, the notification body will be generated by Inferno
-            from the submitted Claim.
-          ))
-        end
-
         wait_identifier = session_wait_identifier(client_id, session_url_path)
         submit_endpoint = session_endpoint_url(:submit, client_id, session_url_path)
-        confirmation_url = "#{resume_pass_url}?token=#{wait_identifier}"
-        output(confirmation_url:)
 
         wait(
           identifier: wait_identifier,
-          timeout: 600,
-          message: %(
-            **Pended Workflow Test**:
+          message: <<~MESSAGE
+            **Pended Scenario Test**:
+
+            Inferno will wait while the tester uses the PAS client to submit a PAS request to
+            Inferno. The tests will automatically continue once a request has been received.
 
-            1. Submit a PAS request to
+            ### Endpoints
+
+            Submit a PAS request to
 
             `#{submit_endpoint}`
 
-            If the optional '**#{input_title(:pended_json_response)}**' input is populated, it will
-            be returned, updated with current timestamps. Otherwise, a pended response will
-            be generated by Inferno using the received Claim.
-
-            2. Within 5-10 seconds, Inferno will send a full-resource notification indicating that the
-               ClaimResponse has been finalized. The notification will contain the complete updated
-               ClaimResponse. If the optional '**#{input_title(:notification_bundle)}**' input is populated
-                Inferno will send it as a notification. Otherwise, a notification will be generated
-                from Inferno. In either case, the notification will be delivered to the endpoint provided on the
-                Subscription during the _PAS Subscription Setup_ tests.
-
-            Note that Inferno will ask testers to attest to correct behavior of the system between these steps,
-            i.e., that the system marked the pended prior auth request appropriately after step 1 (submit) but
-            before step 2 (notification). Thus testers should check their system state as appropriate in order
-            to be able to faithfully answer the attestations.
-
-            Once the client has completed these steps,
-            [click here to complete the test](#{confirmation_url})
-            and continue Inferno's evaluation of the interaction.
-          )
+            ### Authentication and Identification
+
+            #{auth_description_for_wait(client_id)}
+
+            ### Responses
+
+            #{response_description_for_wait(user_inputted_response?(:pended_json_response),
+                                            input_title(:pended_json_response),
+                                            '$submit')}
+
+            Inferno will not respond to `$inquire` requests during this test.
+          MESSAGE
         )
       end
     end

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

@@ -1,14 +1,16 @@
 require_relative '../../../cross_suite/pas_bundle_validation'
+require_relative '../../client_bundle_validation_helper'
 
 module DaVinciPASTestKit
   module DaVinciPASV221
     class PasClientRequestBundleValidationTest < Inferno::Test
       include DaVinciPASTestKit::PasBundleValidation
+      include DaVinciPASTestKit::ClientBundleValidationHelper
 
       id :pas_client_v221_request_bundle_validation_test
       title '$submit request Bundles have the correct structure and content'
       description %(
-        This test verifies the conformity of the client's submit request body to the
+        This test verifies the conformity of each of the PAS client's `$submit` request bodies to the
         [PAS Request Bundle](http://hl7.org/fhir/us/davinci-pas/2.2.1/StructureDefinition-profile-pas-request-bundle.html)
         structure. It also checks that other conformance requirements defined in the [PAS Formal
         Specification](https://hl7.org/fhir/us/davinci-pas/2.2.1/specification.html),
@@ -24,32 +26,25 @@ module DaVinciPASTestKit
         Note that because X12 value sets are not public, elements bound to value
         sets containing X12 codes are not validated.
       )
-      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@spec-1'
+      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@spec-1', 'hl7.fhir.us.davinci-pas_2.2.1@prof-1',
+                            'hl7.fhir.us.davinci-pas_2.2.1@prof-2', 'hl7.fhir.us.davinci-pas_2.2.1@prof-3'
 
-      def workflow_tag
-        config.options[:workflow_tag]
+      def operation_name
+        'submit'
       end
 
-      def request_type_tag
-        SUBMIT_TAG
+      def message_direction_name
+        'request'
+      end
+
+      def ig_version
+        '2.2.1'
       end
 
       run do
-        if workflow_tag.present?
-          load_tagged_requests(request_type_tag, workflow_tag)
-        else
-          load_tagged_requests(request_type_tag)
-        end
-        skip_if !request.present?, 'No submit requests received.'
-
-        validate_pas_bundle_json(
-          request.request_body,
-          'http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-request-bundle',
-          '2.2.1',
-          'submit',
-          'request_bundle',
-          message: 'The Bundle provided for the Claim/$submit operation is invalid:'
-        )
+        failed = non_conformant_bundles
+        assert failed.empty?,
+               "Non-conformant request Bundles detected: #{failed.join(', ')}. Check messages for issues found."
       end
     end
   end

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

@@ -1,18 +1,18 @@
 require_relative '../../../cross_suite/pas_bundle_validation'
 require_relative '../../user_input_response'
-require_relative '../../response_generator'
+require_relative '../../client_bundle_validation_helper'
 
 module DaVinciPASTestKit
   module DaVinciPASV221
     class PasClientResponseBundleValidationTest < Inferno::Test
       include DaVinciPASTestKit::PasBundleValidation
       include UserInputResponse
-      include ResponseGenerator
+      include DaVinciPASTestKit::ClientBundleValidationHelper
 
       id :pas_client_v221_response_bundle_validation_test
       title '$submit response Bundles have the correct structure and content'
       description %(
-        This test verifies the conformity of the submit response sent by Inferno, which will have been
+        This test verifies the conformity of each `$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.
@@ -30,17 +30,24 @@ module DaVinciPASTestKit
         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.
+        Note that:
+        - To ensure that the PAS client is driving its behavior only based on standard
+          PAS information, custom extensions are not allowed within the responses.
+        - Because X12 value sets are not public, elements bound to value
+          sets containing X12 codes are not validated.
       )
       simulation_verification
 
-      def request_type
+      def operation_name
         'submit'
       end
 
-      def workflow_tag
-        config.options[:workflow_tag]
+      def message_direction_name
+        'response'
+      end
+
+      def ig_version
+        '2.2.1'
       end
 
       def target_user_input
@@ -58,26 +65,19 @@ module DaVinciPASTestKit
         end
       end
 
-      run do
-        load_tagged_requests(workflow_tag, SUBMIT_TAG)
-        skip_if requests.empty?, 'No responses to verify because no submit requests were made.'
-        message = if workflow_tag == MUST_SUPPORT_WORKFLOW_TAG
-                    'Invalid must support response bundle provided:'
-                  elsif 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
+      def failed_entities_description
+        if user_inputted_response? target_user_input
+          "built from tester-provided response in '#{input_title(target_user_input)}'"
+        else
+          'generated from the submitted claim'
+        end
+      end
 
-        validate_pas_bundle_json(
-          request.response_body,
-          'http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-response-bundle',
-          '2.2.1',
-          request_type,
-          'response_bundle',
-          skips: true,
-          message:
-        )
+      run do
+        failed = non_conformant_bundles
+        skip_if failed.present?,
+                "Non-conformant response Bundles #{failed_entities_description}: #{failed.join(', ')}. " \
+                'Check messages for issues found.'
       end
     end
   end

data/lib/davinci_pas_test_kit/cross_suite/generated/v2.0.1/task/metadata.yml

@@ -192,9 +192,5 @@
 :tests:
 - :id: pas_server_v201_submit_response_must_support_task
   :file_name: server_submit_response_must_support_task_test.rb
-- :id: pas_client_v201_submit_response_must_support_task
-  :file_name: client_submit_response_must_support_task_test.rb
 - :id: pas_server_v201_inquire_response_must_support_task
   :file_name: server_inquire_response_must_support_task_test.rb
-- :id: pas_client_v201_inquire_response_must_support_task
-  :file_name: client_inquire_response_must_support_task_test.rb

data/lib/davinci_pas_test_kit/cross_suite/generated/v2.2.1/metadata.yml

@@ -4861,7 +4861,6 @@
     - :path: content.attachment
     - :path: content.attachment.contentType
     - :path: content.attachment.data
-    - :path: content.attachment.url
     - :path: content.format
     - :path: context
     - :path: context.encounter

data/lib/davinci_pas_test_kit/cross_suite/generated/v2.2.1/task/metadata.yml

@@ -233,9 +233,5 @@
 :tests:
 - :id: pas_server_v221_submit_response_must_support_task
   :file_name: server_submit_response_must_support_task_test.rb
-- :id: pas_client_v221_submit_response_must_support_task
-  :file_name: client_submit_response_must_support_task_test.rb
 - :id: pas_server_v221_inquire_response_must_support_task
   :file_name: server_inquire_response_must_support_task_test.rb
-- :id: pas_client_v221_inquire_response_must_support_task
-  :file_name: client_inquire_response_must_support_task_test.rb