davinci_pas_test_kit 0.15.1 → 0.16.0

data/lib/davinci_pas_test_kit/client/v2.0.1/workflows/pas_client_inquire_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 DaVinciPASV201
     class PasClientInquireRequestBundleValidationTest < Inferno::Test
       include DaVinciPASTestKit::PasBundleValidation
+      include DaVinciPASTestKit::ClientBundleValidationHelper
 
       id :pas_client_v201_inquire_request_bundle_validation_test
-      title 'Inquire Request Bundle is valid'
+      title '$inquire request Bundles have the correct structure and content'
       description %(
-        This test verifies the conformity of the client's request body to the
+        This test verifies the conformity of each of the PAS client's `$inquire` request bodies to the
         [PAS Inquiry Request Bundle](http://hl7.org/fhir/us/davinci-pas/STU2/StructureDefinition-profile-pas-inquiry-request-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),
@@ -37,30 +39,22 @@ module DaVinciPASTestKit
                             'hl7.fhir.us.davinci-pas_2.0.1@125', 'hl7.fhir.us.davinci-pas_2.0.1@126',
                             'hl7.fhir.us.davinci-pas_2.0.1@127', 'hl7.fhir.us.davinci-pas_2.0.1@128'
 
-      def request_type_tag
-        INQUIRE_TAG
+      def operation_name
+        'inquire'
       end
 
-      def workflow_tag
-        config.options[:workflow_tag]
+      def message_direction_name
+        'request'
       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 inquire requests received.'
+      def ig_version
+        '2.0.1'
+      end
 
-        validate_pas_bundle_json(
-          request.request_body,
-          'http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-inquiry-request-bundle',
-          '2.0.1',
-          'inquire',
-          'request_bundle',
-          message: 'The Bundle provided for the Claim/$inquire operation is invalid:'
-        )
+      run do
+        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.0.1/workflows/pas_client_inquire_response_bundle_validation_test.rb

@@ -1,21 +1,21 @@
 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 DaVinciPASV201
     class PasClientInquireResponseBundleValidationTest < Inferno::Test
       include DaVinciPASTestKit::PasBundleValidation
       include UserInputResponse
-      include ResponseGenerator
+      include DaVinciPASTestKit::ClientBundleValidationHelper
 
       id :pas_client_v201_inquire_response_bundle_validation_test
-      title 'Inquire Response Bundle is valid'
+      title '$inquire response Bundles have the correct structure and content'
       description %(
-        **USER INPUT VERIFICATION**: This test verifies input provided by the tester instead of the system under test.
+        This test verifies input provided by the tester instead of the PAS client.
         Errors encountered will be treated as a skip instead of a failure.
 
-        This test verifies the conformity of the inquire response sent by Inferno, which will have been
+        This test verifies the conformity of each `$inquire` 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 $inquire Bundle.
@@ -33,8 +33,11 @@ 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.
 
         **Limitations**
 
@@ -46,12 +49,16 @@ module DaVinciPASTestKit
       )
       simulation_verification
 
-      def request_type
+      def operation_name
         'inquire'
       end
 
-      def workflow_tag
-        config.options[:workflow_tag]
+      def message_direction_name
+        'response'
+      end
+
+      def ig_version
+        '2.0.1'
       end
 
       def target_user_input
@@ -63,26 +70,19 @@ module DaVinciPASTestKit
         end
       end
 
-      run do
-        load_tagged_requests(workflow_tag, INQUIRE_TAG)
-        skip_if requests.empty?, 'No responses to verify because no inquire 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-inquiry-response-bundle',
-          '2.0.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/client/v2.0.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 DaVinciPASV201
@@ -11,15 +12,16 @@ module DaVinciPASTestKit
       include SessionIdentification
       include UserInputResponse
       include PasBundleValidation
+      include SubscriptionSetupRequirement
 
       id :pas_client_v201_pended_submit_test
-      title 'Client submits a claim and reacts to a pended response'
+      title 'PAS client submits a claim and reacts to a pended response'
       description %(
-        Inferno will wait for a prior authorization submission request
-        from the client. Upon receipt, Inferno will respond with the
+        During this test, Inferno will wait for a prior authorization submission request
+        from the PAS client. Upon receipt, Inferno will respond with the
         provided pended response. Subsequently, Inferno will send a
         notification that the claim has been finalized and expect the
-        client under test to send a follow-up inquiry.
+        PAS client to send a follow-up inquiry.
       )
       verifies_requirements 'hl7.fhir.us.davinci-pas_2.0.1@58', 'hl7.fhir.us.davinci-pas_2.0.1@62',
                             'hl7.fhir.us.davinci-pas_2.0.1@67', 'hl7.fhir.us.davinci-pas_2.0.1@70',
@@ -27,14 +29,14 @@ module DaVinciPASTestKit
                             'hl7.fhir.us.davinci-pas_2.0.1@153', 'hl7.fhir.us.davinci-pas_2.0.1@202',
                             'hl7.fhir.us.davinci-pas_2.0.1@203'
 
-      config options: { accepts_multiple_requests: true }
+      config options: { accepts_multiple_requests: true, submit_enabled: true, inquire_enabled: 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.
+              PAS Subscription to tell the PAS 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
@@ -69,8 +71,8 @@ module DaVinciPASTestKit
             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
+              The bearer token that Inferno will send on requests to the PAS client's rest-hook notification
+              endpoint. Not needed if the PAS client 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.
             )
@@ -92,13 +94,7 @@ module DaVinciPASTestKit
       inquire_respond_with :inquire_json_response
 
       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,
@@ -141,42 +137,55 @@ module DaVinciPASTestKit
         wait(
           identifier: wait_identifier,
           timeout: 600,
-          message: %(
-            **Pended Workflow Test**:
+          message: <<~MESSAGE
+            **Pended Scenario Test**:
 
-            1. Submit a PAS request to
+            Inferno will wait while the tester uses the PAS client to complete the following steps:
 
-            `#{submit_endpoint}`
+            1. Submit a PAS request to Inferno's `$submit` endpoint. Inferno will return a pended response.
+            2. Within 5-10 seconds, Inferno will send a notification indicating that the ClaimResponse has
+               been finalized to the endpoint provided on the Subscription during the _Subscription Setup_ tests.
+            3. Once the notification has been received, submit a PAS inquiry request to Inferno's `$inquire`
+               endpoint. Inferno will return an approval response.
 
-            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.
+            Inferno will later ask testers to attest that the PAS client marked the request as pended after
+            step 1 (submit) and before step 2 (notification), so testers should check their PAS client's state
+            between these steps in order to faithfully answer the attestation.
 
-            2. Within 5-10 seconds, Inferno will send a notification indicating that the ClaimResponse has been
-               finalized. 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.
+            [Click here](#{confirmation_url}) once the PAS client has completed these steps.
 
-            3. Once the notification has been received, submit a PAS inquiry request to
+            ### Endpoints
 
-            `#{inquire_endpoint}`
+            - $submit: `#{submit_endpoint}`
+            - $inquire: `#{inquire_endpoint}`
 
-            If the optional '**#{input_title(:inquire_json_response)}**' input is populated, it will
-            be returned, updated with current timestamps. Otherwise, an approval response will
-            be generated by Inferno using the received Claim.
+            ### Authentication and Identification
 
-            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.
+            #{auth_description_for_wait(client_id)}
 
-            Once the client has completed these steps,
-            [click here to complete the test](#{confirmation_url})
-            and continue Inferno's evaluation of the interaction.
-          )
+            ### Responses
+
+            #{response_description_for_wait(user_inputted_response?(:pended_json_response),
+                                            input_title(:pended_json_response),
+                                            '$submit')}
+
+            #{response_description_for_wait(user_inputted_response?(:inquire_json_response),
+                                            input_title(:inquire_json_response),
+                                            '$inquire')}
+
+            #{notification_description_for_wait}
+          MESSAGE
         )
       end
+
+      def notification_description_for_wait
+        if notification_bundle.present?
+          "Inferno will send the content of the '**#{input_title(:notification_bundle)}**' input as the " \
+            'notification, updated with current timestamps.'
+        else
+          'Inferno will send a notification generated from the pended response.'
+        end
+      end
     end
   end
 end

data/lib/davinci_pas_test_kit/client/v2.0.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 DaVinciPASV201
     class PasClientRequestBundleValidationTest < Inferno::Test
       include DaVinciPASTestKit::PasBundleValidation
+      include DaVinciPASTestKit::ClientBundleValidationHelper
 
       id :pas_client_v201_request_bundle_validation_test
-      title 'Submit Request Bundle is valid'
+      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/STU2/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/STU2/specification.html),
@@ -39,30 +41,22 @@ module DaVinciPASTestKit
                             'hl7.fhir.us.davinci-pas_2.0.1@81', 'hl7.fhir.us.davinci-pas_2.0.1@85',
                             'hl7.fhir.us.davinci-pas_2.0.1@86'
 
-      def workflow_tag
-        config.options[:workflow_tag]
+      def operation_name
+        'submit'
       end
 
-      def request_type_tag
-        SUBMIT_TAG
+      def message_direction_name
+        'request'
       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.'
+      def ig_version
+        '2.0.1'
+      end
 
-        validate_pas_bundle_json(
-          request.request_body,
-          'http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-request-bundle',
-          '2.0.1',
-          'submit',
-          'request_bundle',
-          message: 'The Bundle provided for the Claim/$submit operation is invalid:'
-        )
+      run do
+        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.0.1/workflows/pas_client_response_bundle_validation_test.rb

@@ -1,21 +1,21 @@
 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 DaVinciPASV201
     class PasClientResponseBundleValidationTest < Inferno::Test
       include DaVinciPASTestKit::PasBundleValidation
       include UserInputResponse
-      include ResponseGenerator
+      include DaVinciPASTestKit::ClientBundleValidationHelper
 
       id :pas_client_v201_response_bundle_validation_test
-      title 'Submit Response Bundle is valid'
+      title '$submit response Bundles have the correct structure and content'
       description %(
-        **USER INPUT VERIFICATION**: This test verifies input provided by the tester instead of the system under test.
+        This test verifies input provided by the tester instead of the PAS client.
         Errors encountered will be treated as a skip instead of a failure.
 
-        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.
@@ -33,8 +33,11 @@ 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.
 
         **Limitations**
 
@@ -46,12 +49,16 @@ module DaVinciPASTestKit
       )
       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.0.1'
       end
 
       def target_user_input
@@ -67,26 +74,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.0.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/client/v2.2.1/attestations/attestation_instructions.rb

@@ -0,0 +1,10 @@
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    ATTESTATION_INPUT_INSTRUCTIONS = %(
+      Testers are responsible for confirming that the PAS client meets all requirements associated with a test
+      before selecting "Yes" on the attestation input with the same name as the test. The text of the
+      attested requirement(s) for each input can be reviewed by clicking the "View Specification Requirements" link
+      in the "About" tab of the test with the same name.
+    ).freeze
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/attestations/client_data_element_expectations_attestation_test.rb

@@ -0,0 +1,44 @@
+require_relative 'attestation_instructions'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class DataElementExpectationsAttestationTest < Inferno::Test
+      id :pas_client_v221_data_element_expectations_attestation
+      ATTESTATION_TITLE = 'PAS client does not set additional expectations for data elements'.freeze
+      title ATTESTATION_TITLE
+      description %(
+        During this test, the tester will confirm that the PAS client does not set additional expectations
+        for data elements beyond what is required by PAS.
+        To see the specifics of the attested requirements, click the "View Specification Requirements" link for this
+        test.
+      )
+      attestation
+      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@conf-14', 'hl7.fhir.us.davinci-pas_2.2.1@conf-15',
+                            'hl7.fhir.us.davinci-pas_2.2.1@conf-16-A'
+      input_instructions ATTESTATION_INPUT_INSTRUCTIONS
+
+      input :data_element_expectations_attestation,
+            title: ATTESTATION_TITLE,
+            description: %(
+              I attest that the PAS client does not set additional expectations for
+              data elements beyond what is required by PAS.
+            ),
+            type: 'radio',
+            default: 'false',
+            options: {
+              list_options: [
+                { label: 'Yes', value: 'true' },
+                { label: 'No', value: 'false' }
+              ]
+            }
+      input :data_element_expectations_attestation_note,
+            title: 'Notes, if applicable:',
+            type: 'textarea',
+            optional: true
+
+      run do
+        assert data_element_expectations_attestation == 'true'
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/attestations/client_provider_review_attestation_test.rb

@@ -0,0 +1,45 @@
+require_relative 'attestation_instructions'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class ProviderReviewAttestationTest < Inferno::Test
+      id :pas_client_v221_provider_review_attestation
+      ATTESTATION_TITLE = 'PAS client allows but does not require providers to review information before ' \
+                          'submitting'.freeze
+      title ATTESTATION_TITLE
+      description %(
+        During this test, the tester will confirm that the PAS client allows but does not require providers
+        to review submission details before sending PAS prior authorization requests.
+        To see the specifics of the attested requirements, click the "View Specification Requirements" link for this
+        test.
+      )
+      attestation
+      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@priv-1-A', 'hl7.fhir.us.davinci-pas_2.2.1@priv-1-B',
+                            'hl7.fhir.us.davinci-pas_2.2.1@use-5'
+      input_instructions ATTESTATION_INPUT_INSTRUCTIONS
+
+      input :provider_review_attestation,
+            title: ATTESTATION_TITLE,
+            description: %(
+              I attest that the PAS client allows but does not require providers to review
+              submission details before sending PAS prior authorization requests.
+            ),
+            type: 'radio',
+            default: 'false',
+            options: {
+              list_options: [
+                { label: 'Yes', value: 'true' },
+                { label: 'No', value: 'false' }
+              ]
+            }
+      input :provider_review_attestation_note,
+            title: 'Notes, if applicable:',
+            type: 'textarea',
+            optional: true
+
+      run do
+        assert provider_review_attestation == 'true'
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/v2.2.1/attestations/client_security_attestation_test.rb

@@ -0,0 +1,42 @@
+require_relative 'attestation_instructions'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class ClientSecurityAttestationTest < Inferno::Test
+      id :pas_client_v221_security_attestation
+      ATTESTATION_TITLE = 'PAS client adheres to security and privacy requirements'.freeze
+      title ATTESTATION_TITLE
+      description %(
+        During this test, the tester will confirm that the PAS client adheres to security and
+        privacy requirements including those defined in the HRex specification. To see the specifics
+        of the attested requirements, click the "View Specification Requirements" link for this test.
+      )
+      attestation
+      verifies_requirements 'hl7.fhir.us.davinci-pas_2.2.1@spec-4'
+      input_instructions ATTESTATION_INPUT_INSTRUCTIONS
+
+      input :security_attestation,
+            title: ATTESTATION_TITLE,
+            description: %(
+              I attest that the PAS client adheres to security and
+              privacy requirements including those defined in the HRex specification.
+            ),
+            type: 'radio',
+            default: 'false',
+            options: {
+              list_options: [
+                { label: 'Yes', value: 'true' },
+                { label: 'No', value: 'false' }
+              ]
+            }
+      input :security_attestation_note,
+            title: 'Notes, if applicable:',
+            type: 'textarea',
+            optional: true
+
+      run do
+        assert security_attestation == 'true'
+      end
+    end
+  end
+end