davinci_pas_test_kit 0.15.1 → 0.16.0

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

@@ -0,0 +1,42 @@
+require_relative 'attestation_instructions'
+
+module DaVinciPASTestKit
+  module DaVinciPASV221
+    class ClientSubscriptionErrorRecoveryAttestationTest < Inferno::Test
+      id :pas_client_v221_subscription_error_recovery_attestation
+      ATTESTATION_TITLE = 'PAS client can recover from Subscription errors'.freeze
+      title ATTESTATION_TITLE
+      description %(
+        During this test, the tester will confirm that the PAS client can detect and recover
+        from Subscription errors and take steps to restore notification delivery. To see the specifics
+        of the attested requirements, click the "View Specification Requirements" link for this test.
+      )
+      attestation
+      verifies_requirements 'hl7.fhir.uv.subscriptions_1.1.0@81', 'hl7.fhir.uv.subscriptions_1.1.0@82'
+      input_instructions ATTESTATION_INPUT_INSTRUCTIONS
+
+      input :subscription_error_recovery_attestation,
+            title: ATTESTATION_TITLE,
+            description: %(
+              I attest that the PAS client can detect and recover
+              from Subscription errors and take steps to restore notification delivery.
+            ),
+            type: 'radio',
+            default: 'false',
+            options: {
+              list_options: [
+                { label: 'Yes', value: 'true' },
+                { label: 'No', value: 'false' }
+              ]
+            }
+      input :subscription_error_recovery_attestation_note,
+            title: 'Notes, if applicable:',
+            type: 'textarea',
+            optional: true
+
+      run do
+        assert subscription_error_recovery_attestation == 'true'
+      end
+    end
+  end
+end

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

@@ -1,21 +1,27 @@
 require 'subscriptions_test_kit'
 require 'udap_security_test_kit'
 require 'smart_app_launch_test_kit'
+require_relative '../../cross_suite/validator_configuration'
 require_relative '../../cross_suite/validator_suppressions'
 require_relative '../../cross_suite/tags'
+require_relative '../../cross_suite/pas_constants'
 require_relative '../endpoints/claim_endpoint'
 require_relative '../endpoints/token_endpoint'
 require_relative '../endpoints/subscription_create_endpoint'
+require_relative '../endpoints/subscription_read_endpoint'
 require_relative '../endpoints/subscription_status_endpoint'
+require_relative '../endpoints/subscription_update_endpoint'
+require_relative '../endpoints/subscription_delete_endpoint'
 require_relative '../metadata/mock_pas_server'
 require_relative '../pas_client_options'
 require_relative 'pas_client_workflows_group'
 require_relative 'pas_client_must_support_group'
 require_relative 'pas_client_subscription_setup_group'
+require_relative 'pas_client_subscription_update_delete_group'
 require_relative 'pas_client_registration_group'
 require_relative 'pas_client_auth_smart_group'
 require_relative 'pas_client_auth_udap_group'
-require_relative 'pas_client_error_handling_group'
+require_relative 'pas_client_attestations_group'
 require_relative '../client_input_descriptions'
 
 module DaVinciPASTestKit
@@ -39,12 +45,12 @@ module DaVinciPASTestKit
         - [What testers need to successfully execute these tests](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Client-Instructions-v2.2.1#pre-execution-setup-and-required-information),
         - [Minimal](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Client-Instructions-v2.2.1#quick-start)
           and [complete](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Client-Instructions-v2.2.1#additional-testing-options)
-          instructions for executing against a client system, and
+          instructions for executing against a PAS client, and
         - How to [interpret test results](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Client-Instructions-v2.2.1#interpreting-results).
       DESCRIPTION
 
       suite_summary <<~SUMMARY
-        The Da Vinci PAS Client v2.2.1 Test Suite tests the conformance of client systems
+        The Da Vinci PAS Client v2.2.1 Test Suite tests the conformance of PAS clients
         to [version 2.2.1 of the Da Vinci Prior Authorization Support (PAS)
         Implementation Guide](https://hl7.org/fhir/us/davinci-pas/2.2.1).
       SUMMARY
@@ -82,12 +88,29 @@ module DaVinciPASTestKit
       )
 
       fhir_resource_validator do
-        igs('hl7.fhir.us.davinci-pas#2.2.1', 'hl7.fhir.us.core#6.1.0')
+        igs(*V221_VALIDATOR_IGS)
 
         exclude_message do |message|
-          # Messages expected of the form `<ResourceType>: <FHIRPath>: <message>`
-          # We strip `<ResourceType>: <FHIRPath>: ` for the sake of matching
-          SUPPRESSED_MESSAGES.match?(message.message.sub(/\A\S+: \S+: /, ''))
+          V221_SUPPRESSED_MESSAGES.match?(message.message.sub(VALIDATOR_MESSAGE_LOCATION_PREFIX, ''))
+        end
+
+        validation_context do
+          snomedCT SNOMED_CT_US_EDITION
+        end
+      end
+
+      # Used to verify responses sent by Inferno, which may be tester-provided, to
+      # ensure they don't contain extensions not defined in the PAS IG or its dependencies.
+      fhir_resource_validator NO_CUSTOM_EXTENSIONS_VALIDATOR do
+        igs(*V221_VALIDATOR_IGS)
+
+        exclude_message do |message|
+          V221_SUPPRESSED_MESSAGES.match?(message.message.sub(VALIDATOR_MESSAGE_LOCATION_PREFIX, ''))
+        end
+
+        validation_context do
+          snomedCT SNOMED_CT_US_EDITION
+          extensions [] # no extensions not in the spec
         end
       end
 
@@ -108,6 +131,26 @@ module DaVinciPASTestKit
                      }
                    ]
 
+      # Inferno selects the first listed option by default.
+      suite_option :us_core_version,
+                   title: 'US Core Version',
+                   description: 'The US Core version whose profiles are used to validate supporting ' \
+                                'information resources that have no PAS profile.',
+                   list_options: [
+                     {
+                       label: 'US Core 3.1.1',
+                       value: PASConstants::US_CORE_VERSION_3_1_1
+                     },
+                     {
+                       label: 'US Core 6.1.0',
+                       value: PASConstants::US_CORE_VERSION_6_1_0
+                     },
+                     {
+                       label: 'US Core 7.0.0',
+                       value: PASConstants::US_CORE_VERSION_7_0_0
+                     }
+                   ]
+
       route(:get, UDAPSecurityTestKit::UDAP_DISCOVERY_PATH, lambda { |_env|
         UDAPSecurityTestKit::MockUDAPServer.udap_server_metadata(id)
       })
@@ -134,8 +177,12 @@ module DaVinciPASTestKit
       suite_endpoint :post, SESSION_INQUIRE_PATH, ClaimEndpoint
       suite_endpoint :post, FHIR_SUBSCRIPTION_PATH, SubscriptionCreateEndpoint
       suite_endpoint :post, SESSION_FHIR_SUBSCRIPTION_PATH, SubscriptionCreateEndpoint
-      suite_endpoint :get, FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionsTestKit::SubscriptionReadEndpoint
-      suite_endpoint :get, SESSION_FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionsTestKit::SubscriptionReadEndpoint
+      suite_endpoint :get, FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionReadEndpoint
+      suite_endpoint :put, FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionUpdateEndpoint
+      suite_endpoint :delete, FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionDeleteEndpoint
+      suite_endpoint :get, SESSION_FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionReadEndpoint
+      suite_endpoint :put, SESSION_FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionUpdateEndpoint
+      suite_endpoint :delete, SESSION_FHIR_SUBSCRIPTION_INSTANCE_PATH, SubscriptionDeleteEndpoint
       suite_endpoint :post, FHIR_SUBSCRIPTION_INSTANCE_STATUS_PATH, SubscriptionStatusEndpoint
       suite_endpoint :post, SESSION_FHIR_SUBSCRIPTION_INSTANCE_STATUS_PATH, SubscriptionStatusEndpoint
       suite_endpoint :get, FHIR_SUBSCRIPTION_INSTANCE_STATUS_PATH, SubscriptionStatusEndpoint
@@ -177,7 +224,8 @@ module DaVinciPASTestKit
         PASClientOptions.recursive_remove_input(self, :session_url_path)
         config(inputs: { client_id: { optional: false } })
       end
-      group from: :pas_client_v221_error_handling_group, id: :pas_client_v221_error_handling_smart do
+      group from: :pas_client_v221_subscription_update_delete,
+            id: :pas_client_v221_subscription_update_delete_smart do
         required_suite_options client_type: PASClientOptions::SMART_BACKEND_SERVICES_CONFIDENTIAL_ASYMMETRIC
         PASClientOptions.recursive_remove_input(self, :session_url_path)
         config(inputs: { client_id: { optional: false } })
@@ -199,7 +247,8 @@ module DaVinciPASTestKit
         PASClientOptions.recursive_remove_input(self, :session_url_path)
         config(inputs: { client_id: { optional: false } })
       end
-      group from: :pas_client_v221_error_handling_group, id: :pas_client_v221_error_handling_udap do
+      group from: :pas_client_v221_subscription_update_delete,
+            id: :pas_client_v221_subscription_update_delete_udap do
         required_suite_options client_type: PASClientOptions::UDAP_CLIENT_CREDENTIALS
         PASClientOptions.recursive_remove_input(self, :session_url_path)
         config(inputs: { client_id: { optional: false } })
@@ -221,7 +270,8 @@ module DaVinciPASTestKit
         PASClientOptions.recursive_remove_input(self, :client_id)
         config(inputs: { session_url_path: { optional: false } })
       end
-      group from: :pas_client_v221_error_handling_group, id: :pas_client_v221_error_handling_no_auth do
+      group from: :pas_client_v221_subscription_update_delete,
+            id: :pas_client_v221_subscription_update_delete_no_auth do
         required_suite_options client_type: PASClientOptions::OTHER_AUTH
         PASClientOptions.recursive_remove_input(self, :client_id)
         config(inputs: { session_url_path: { optional: false } })
@@ -235,6 +285,8 @@ module DaVinciPASTestKit
             required_suite_options: {
               client_type: PASClientOptions::UDAP_CLIENT_CREDENTIALS
             }
+
+      group from: :pas_client_v221_attestations
     end
   end
 end

data/lib/davinci_pas_test_kit/client/v2.2.1/error_handling/pas_client_operation_failure_submit_test.rb

@@ -14,7 +14,7 @@ module DaVinciPASTestKit
       id :pas_client_v221_operation_failure_submit_test
       title 'PAS client submits a claim and receives an OperationOutcome response'
       description %(
-        Inferno will wait for a prior authorization submission request from the client.
+        During this test, Inferno will wait for a prior authorization submission request from the PAS client.
         Upon receipt, Inferno will return the provided OperationOutcome with the configured
         HTTP status code (default 400).
       )
@@ -23,8 +23,8 @@ module DaVinciPASTestKit
             title: 'Operation Failure OperationOutcome JSON',
             type: 'textarea',
             description: %(
-              Inferno will return this OperationOutcome JSON in response to the $submit request
-              during this test.
+              Inferno will return exactly this OperationOutcome JSON in response
+              to the $submit request during the *Operation Failure* group.
             )
       input :operation_failure_http_status,
             title: 'Operation Failure HTTP Status Code',
@@ -32,8 +32,10 @@ module DaVinciPASTestKit
             optional: true,
             default: '400',
             description: %(
-              The HTTP status code Inferno will use when returning the OperationOutcome to the client.
-              Must be a 4XX or 5XX value. Defaults to 400 if not provided or outside that range.
+              The HTTP status code Inferno will use when returning the Operation Failure
+              OperationOutcome to the PAS client. If provided, the value must be in the 4XX or
+              5XX range. Inferno will return 400 if this input is not provided or the
+              provided value is outside that range.
             )
       input :client_id,
             title: 'Client Id',
@@ -49,6 +51,7 @@ module DaVinciPASTestKit
             description: INPUT_SESSION_URL_PATH_LOCKED
 
       submit_respond_with :operation_failure_operation_outcome
+      config options: { submit_enabled: true }
 
       run do
         assert_valid_json operation_failure_operation_outcome,
@@ -59,16 +62,23 @@ module DaVinciPASTestKit
 
         wait(
           identifier: wait_identifier,
-          message: %(
-            **Operation Failure Workflow Test**:
+          message: <<~MESSAGE
+            **Operation Failure Scenario Test**:
+
+            Inferno will wait while the tester uses the PAS client to submit a PAS request to
+            Inferno. Inferno will respond with exactly the provided OperationOutcome and HTTP status.
+            The tests will automatically continue once a request has been received.
+
+            ### Endpoints
 
             Submit a PAS request to
 
             `#{submit_endpoint}`
 
-            Inferno will respond with the provided OperationOutcome and HTTP status
-            **#{operation_failure_http_status.present? ? operation_failure_http_status : '400'}**.
-          )
+            ### Authentication and Identification
+
+            #{auth_description_for_wait(client_id)}
+          MESSAGE
         )
       end
     end

data/lib/davinci_pas_test_kit/client/v2.2.1/error_handling/pas_client_operation_outcome_validation_test.rb

@@ -1,4 +1,5 @@
 require_relative '../../../cross_suite/tags'
+require_relative '../../../cross_suite/validator_configuration'
 
 module DaVinciPASTestKit
   module DaVinciPASV221
@@ -7,10 +8,14 @@ module DaVinciPASTestKit
       title 'Response OperationOutcome has the correct structure and content'
       description %(
         This test verifies the validity of the OperationOutcome returned by Inferno during the
-        Operation Failure workflow. The OperationOutcome is validated against the base FHIR R4
+        Operation Failure scenario. The OperationOutcome is validated against the base FHIR R4
         OperationOutcome resource definition — no PAS-specific profile is required.
 
-        Per IG §7.2.5, when a 4XX response is returned, an OperationOutcome SHALL be included
+        To ensure that the PAS client is driving its behavior only based on standard
+        PAS information, custom extensions are not allowed within the response.
+
+        The PAS IG [requires](https://hl7.org/fhir/us/davinci-pas/2.2.1/en/specification.html#prior-authorization-transaction-error-handling)
+        that when a 4XX response is returned, an OperationOutcome **SHALL** be included
         that details why the bundle could not be processed.
       )
       simulation_verification
@@ -29,9 +34,10 @@ module DaVinciPASTestKit
         skip_if !operation_outcome.is_a?(FHIR::OperationOutcome),
                 "Expected an OperationOutcome but received #{operation_outcome.resourceType}."
 
-        skip_if !resource_is_valid?(resource: operation_outcome),
-                'The OperationOutcome returned during the Operation Failure workflow is not conformant ' \
-                'with the base FHIR R4 OperationOutcome resource definition.'
+        skip_if !resource_is_valid?(resource: operation_outcome, validator: NO_CUSTOM_EXTENSIONS_VALIDATOR),
+                'The OperationOutcome returned during the Operation Failure scenario is not conformant ' \
+                'with the base FHIR R4 OperationOutcome resource definition or contains custom extensions. ' \
+                'See Messages for details.'
       end
     end
   end

data/lib/davinci_pas_test_kit/client/v2.2.1/error_handling/pas_client_processing_error_response_validation_test.rb

@@ -11,16 +11,20 @@ module DaVinciPASTestKit
       id :pas_client_v221_processing_error_response_validation_test
       title '$submit response Bundle has the correct structure and contains error entries'
       description %(
-        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 PAS Response Bundle returned by Inferno during the
-        Processing Error workflow. The bundle is validated against the
+        Processing Error scenario. The bundle is validated against the
         [PAS Response Bundle](https://hl7.org/fhir/us/davinci-pas/2.2.1/StructureDefinition-profile-pas-response-bundle.html)
         profile. Additionally, it checks that the ClaimResponse contains at least one error entry,
         as required by the processing error scenario.
 
-        Per IG §7.2.5, business errors that are a part of processing the 278 payload are
+        To ensure that the PAS client is driving its behavior only based on standard
+        PAS information, custom extensions are not allowed within the response.
+
+        The PAS IG [requires](https://hl7.org/fhir/us/davinci-pas/2.2.1/en/specification.html#prior-authorization-transaction-error-handling)
+        that business errors that are a part of processing the 278 payload are
         represented in the mapping to the response bundle via the ClaimResponse error capability.
       )
       simulation_verification
@@ -33,17 +37,22 @@ module DaVinciPASTestKit
         response_body = request.response_body
         skip_if response_body.blank?, 'The Processing Error response body is empty.'
 
-        validate_pas_bundle_json(
-          response_body,
-          'http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-response-bundle',
-          '2.2.1',
-          'submit',
-          'response_bundle',
-          skips: true,
-          message: "Invalid processing error response bundle provided in 'Processing Error Response Bundle JSON' input:"
-        )
+        message = "Invalid processing error response bundle provided in 'Processing Error Response Bundle JSON' input:"
+        begin
+          JSON.parse(response_body)
+        rescue JSON::ParserError, TypeError
+          skip "#{message} Invalid JSON.".strip
+        end
 
         bundle = FHIR.from_contents(response_body)
+        skip_if !bundle.is_a?(FHIR::Bundle),
+                "#{message} Unexpected resource type: expected Bundle, but received #{bundle&.resourceType}.".strip
+
+        messages.concat(perform_no_custom_extensions_validation(bundle, 'submit', 'response', '2.2.1',
+                                                                echoed_from: request.request_body))
+        skip_if error_messages?,
+                "#{message} Bundle and/or entry resources are not conformant. Check messages for issues found.".strip
+
         claim_response = bundle&.entry&.find { |e| e&.resource&.resourceType == 'ClaimResponse' }&.resource
         skip_if claim_response&.error.blank?,
                 'The ClaimResponse in the Processing Error response bundle contains no error entries. ' \

data/lib/davinci_pas_test_kit/client/v2.2.1/error_handling/pas_client_processing_error_submit_test.rb

@@ -14,7 +14,7 @@ module DaVinciPASTestKit
       id :pas_client_v221_processing_error_submit_test
       title 'PAS client submits a claim and receives a response containing processing errors'
       description %(
-        Inferno will wait for a prior authorization submission request from the client.
+        During this test, Inferno will wait for a prior authorization submission request from the PAS client.
         Upon receipt, Inferno will return the provided response bundle containing one or
         more ClaimResponse.error entries.
       )
@@ -23,8 +23,10 @@ module DaVinciPASTestKit
             title: 'Processing Error Response Bundle JSON',
             type: 'textarea',
             description: %(
-              Inferno will return this PAS Response Bundle JSON in response to the $submit request
-              during this test. The bundle must contain at least one ClaimResponse.error entry.
+              Inferno will [instantiate](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Controlling-Simulated-Responses#response-instantiation)
+              this PAS Response Bundle JSON and return it as the response
+              to the `$submit` request received during the *Processing Errors* group.
+              The bundle must contain at least one ClaimResponse.error entry.
             )
       input :client_id,
             title: 'Client Id',
@@ -40,6 +42,7 @@ module DaVinciPASTestKit
             description: INPUT_SESSION_URL_PATH_LOCKED
 
       submit_respond_with :processing_error_response
+      config options: { submit_enabled: true }
 
       run do
         assert_valid_json processing_error_response,
@@ -50,16 +53,24 @@ module DaVinciPASTestKit
 
         wait(
           identifier: wait_identifier,
-          message: %(
-            **Processing Error Workflow Test**:
+          message: <<~MESSAGE
+            **Processing Error Scenario Test**:
+
+            Inferno will wait while the tester uses the PAS client to submit a PAS request to
+            Inferno. Inferno will [instantiate](https://github.com/inferno-framework/davinci-pas-test-kit/wiki/Controlling-Simulated-Responses#response-instantiation)
+            the provided Processing Error Response Bundle and respond with it.
+            The tests will automatically continue once a request has been received.
+
+            ### Endpoints
 
             Submit a PAS request to
 
             `#{submit_endpoint}`
 
-            Inferno will respond with the provided PAS Response Bundle containing
-            ClaimResponse.error entries.
-          )
+            ### Authentication and Identification
+
+            #{auth_description_for_wait(client_id)}
+          MESSAGE
         )
       end
     end