davinci_pas_test_kit 0.14.1 → 0.15.0

data/lib/davinci_pas_test_kit/client/abstract_approval_submit_test.rb

@@ -0,0 +1,75 @@
+require_relative 'client_input_descriptions'
+require_relative 'user_input_response'
+require_relative 'session_identification'
+
+module DaVinciPASTestKit
+  # abstract test, needs to be extended to include a version-specific URLs module
+  class AbstractApprovalSubmitTest < Inferno::Test
+    include UserInputResponse
+    include SessionIdentification
+
+    id :pas_client_approval_submit_test
+    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 generate and send a
+      response with an approved status.
+    )
+
+    input :approval_json_response,
+          title: 'Claim approved 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 approved.
+            It will be updated to make creation timestamps current.
+            If not provided, an approval response will be generated from the submitted Claim.
+            In either case, the response will be validated against the PAS Response Bundle profile.
+          )
+    input :client_id,
+          title: 'Client Id',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_CLIENT_ID_LOCKED
+    input :session_url_path,
+          title: 'Session-specific URL path extension',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_SESSION_URL_PATH_LOCKED
+
+    submit_respond_with :approval_json_response
+
+    run do
+      if user_inputted_response? :approval_json_response
+        assert_valid_json approval_json_response,
+                          'Input "Claim approved response JSON" must be valid JSON'
+      else
+        add_message('info', %(
+          No approved response provided in input '#{input_title(:approval_json_response)}'. Any responses to $submit
+          requests 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)
+
+      wait(
+        identifier: wait_identifier,
+        message: %(
+          **Approval Workflow Test**:
+
+          Submit a PAS request to
+
+          `#{submit_endpoint}`
+
+          If the optional '**#{input_title(:approval_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.
+        )
+      )
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/abstract_denial_submit_test.rb

@@ -0,0 +1,74 @@
+require_relative 'client_input_descriptions'
+require_relative 'user_input_response'
+require_relative 'session_identification'
+
+module DaVinciPASTestKit
+  # abstract test, needs to be extended to include a version-specific URLs module
+  class AbstractDenialSubmitTest < Inferno::Test
+    include SessionIdentification
+    include UserInputResponse
+
+    id :pas_client_denial_submit_test
+    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 denial response.
+    )
+
+    input :denial_json_response,
+          title: 'Claim denied 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 denied.
+            It will be updated to make creation timestamps current.
+            If not provided, a denial response will be generated from the submitted Claim.
+            In either case, the response will be validated against the PAS Response Bundle profile.
+          )
+    input :client_id,
+          title: 'Client Id',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_CLIENT_ID_LOCKED
+    input :session_url_path,
+          title: 'Session-specific URL path extension',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_SESSION_URL_PATH_LOCKED
+    submit_respond_with :denial_json_response
+
+    run do
+      if user_inputted_response? :denial_json_response
+        assert_valid_json denial_json_response,
+                          'Input "Claim denied response JSON" must be valid JSON'
+      else
+        add_message('info', %(
+          No denied response provided in input '#{input_title(:denial_json_response)}'. Any responses to $submit
+          requests 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)
+
+      wait(
+        identifier: wait_identifier,
+        message: %(
+          **Denial Workflow Test**:
+
+          Submit a PAS request to
+
+          `#{submit_endpoint}`
+
+          If the optional '**#{input_title(:denial_json_response)}**' input is populated, it will
+          be returned, updated with current timestamps. Otherwise, a denial response will
+          be generated by Inferno using the received Claim.
+        )
+      )
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/abstract_gather_must_support_test.rb

@@ -0,0 +1,160 @@
+require_relative 'client_input_descriptions'
+require_relative 'session_identification'
+
+module DaVinciPASTestKit
+  # abstract test, needs to be extended to include a version-specific URLs module
+  class AbstractGatherMustSupportTest < Inferno::Test
+    include SessionIdentification
+
+    id :pas_client_gather_must_support
+    title 'PAS client submits Claims using the $submit and $inquire operations to demonstrate coverage of must ' \
+          'support elements'
+    description %(
+      This test allows the client to send both $submit and $inquire requests for Inferno to evaluate
+      coverage of must support elements in both requests and responses. Any requests made during
+      previous workflow tests will also be considered.
+
+      Because Inferno's mocked responses do not cover all must support elements, in order to pass
+      these tests testers will need to provide response bundles for Inferno to return when
+      responding to $submit and $inquire requests. Each response input takes a single entry or a
+      JSON list of entries, where each entry is either a FHIR Bundle or a wrapper object pairing
+      a Bundle with selection criteria. For each request, Inferno will respond with the Bundle of
+      the first entry whose criteria are all met, generating a default response if none match.
+      See the input descriptions for details on the wrapper format, the supported criteria, and
+      on substituting values from the request into the returned response.
+
+      This enables testers to verify that their client can handle responses containing all required
+      must support elements.
+    )
+
+    input :client_id,
+          title: 'Client Id',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_CLIENT_ID_LOCKED
+    input :session_url_path,
+          title: 'Session-specific URL path extension',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_SESSION_URL_PATH_LOCKED
+    input :ms_submit_responses,
+          title: 'Must Support $submit Response Bundles',
+          type: 'textarea',
+          optional: true,
+          description: %(
+            An optional JSON value specifying response Bundles for Inferno to return when
+            responding to $submit requests during must support testing. Provide a single entry
+            or a list of entries, where each entry is either a FHIR Bundle or a wrapper object
+            of the form `{"criteria": {...}, "bundle": {...}}` pairing a FHIR Bundle with the
+            selection criteria that a request must meet for that Bundle to be returned.
+
+            For each request, Inferno will respond with the Bundle of the first entry whose
+            criteria are all met. An entry with no criteria (including a bare Bundle) matches
+            any request, and an entry with multiple criteria must meet all of them. If no entry
+            matches, or none are provided, Inferno will generate a default response. Supported
+            `criteria` keys:
+
+            - `requestRange`: a string of comma-separated request numbers or ranges, e.g.,
+              `"1-2,4"`. Met when the number of $submit requests received during this test,
+              counting this one, is among the listed values.
+            - `fhirpath`: a FHIRPath expression evaluated against the incoming request Bundle.
+              Met when the expression evaluates to a single truthy value.
+
+            A Bundle may also contain tokens of the form `{{fhirpath}}`, e.g.,
+            `{{Bundle.entry.first().resource.id}}`. Inferno replaces each token in the returned
+            Bundle with the result of evaluating the FHIRPath expression against the incoming
+            request Bundle.
+          )
+    input :ms_inquire_responses,
+          title: 'Must Support $inquire Response Bundles',
+          type: 'textarea',
+          optional: true,
+          description: %(
+            An optional JSON value specifying response Bundles for Inferno to return when
+            responding to $inquire requests during must support testing. Provide a single entry
+            or a list of entries, where each entry is either a FHIR Bundle or a wrapper object
+            of the form `{"criteria": {...}, "bundle": {...}}` pairing a FHIR Bundle with the
+            selection criteria that a request must meet for that Bundle to be returned.
+
+            For each request, Inferno will respond with the Bundle of the first entry whose
+            criteria are all met. An entry with no criteria (including a bare Bundle) matches
+            any request, and an entry with multiple criteria must meet all of them. If no entry
+            matches, or none are provided, Inferno will generate a default response. Supported
+            `criteria` keys:
+
+            - `requestRange`: a string of comma-separated request numbers or ranges, e.g.,
+              `"1-2,4"`. Met when the number of $inquire requests received during this test,
+              counting this one, is among the listed values.
+            - `fhirpath`: a FHIRPath expression evaluated against the incoming request Bundle.
+              Met when the expression evaluates to a single truthy value.
+
+            A Bundle may also contain tokens of the form `{{fhirpath}}`, e.g.,
+            `{{Bundle.entry.first().resource.id}}`. Inferno replaces each token in the returned
+            Bundle with the result of evaluating the FHIRPath expression against the incoming
+            request Bundle.
+          )
+    config options: { accepts_multiple_requests: true }
+    output :confirmation_url
+
+    run do
+      wait_identifier = session_wait_identifier(client_id, session_url_path)
+      submit_endpoint = session_endpoint_url(:submit, client_id, session_url_path)
+      inquire_endpoint = session_endpoint_url(:inquire, client_id, session_url_path)
+      confirmation_url = "#{resume_pass_url}?token=#{wait_identifier}"
+      output(confirmation_url:)
+
+      wait(
+        identifier: wait_identifier,
+        message: %(
+          The client system may now make multiple $submit and $inquire requests before continuing.
+          These requests should cumulatively demonstrate coverage of all required profiles and all
+          must support elements within those profiles, as specified by the DaVinci Prior Authorization
+          Support implementation guide.
+
+          For the $submit operation the required profiles include:
+          - PAS Request Bundle
+          - PAS Claim Update
+          - PAS Coverage
+          - PAS Beneficiary Patient
+          - PAS Subscriber Patient
+          - PAS Insurer Organization
+          - PAS Requestor Organization
+          - PAS Practitioner
+          - PAS PractitionerRole
+          - PAS Encounter
+          - At least one of the following request profiles
+            - PAS Device Request
+            - PAS Medication Request
+            - PAS Nutrition Order
+            - PAS Service Request
+
+          For the $inquire operation the required profiles include:
+          - PAS Inquiry Request Bundle
+          - PAS Claim Inquiry
+          - PAS Coverage
+          - PAS Beneficiary Patient
+          - PAS Subscriber Patient
+          - PAS Insurer Organization
+          - PAS Requestor Organization
+          - PAS Practitioner
+          - PAS PractitionerRole
+
+          If you would like Inferno to respond with specific response bundles (to demonstrate
+          must support coverage on responses), provide them in the input fields above.
+
+          Submit PAS $submit requests to
+
+          `#{submit_endpoint}`
+
+          Submit PAS $inquire requests to
+
+          `#{inquire_endpoint}`
+
+          and [click here](#{confirmation_url}) when done.
+        )
+      )
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/abstract_modification_submit_test.rb

@@ -0,0 +1,78 @@
+require_relative 'client_input_descriptions'
+require_relative 'user_input_response'
+require_relative 'session_identification'
+
+module DaVinciPASTestKit
+  # abstract test, needs to be extended to include a version-specific URLs module
+  class AbstractModificationSubmitTest < Inferno::Test
+    include UserInputResponse
+    include SessionIdentification
+
+    id :pas_client_modification_submit_test
+    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 generate and send a
+      response in which the payer authorizes items that differ from those
+      that were requested (a "payer modification").
+    )
+
+    input :modification_json_response,
+          title: 'Claim modified 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 payer authorized items that differ from those requested.
+            It will be updated to make creation timestamps current.
+            If not provided, a payer modification response will be generated from the submitted Claim,
+            marking each item as modified (adjudication status A6) and adding a corresponding
+            `ClaimResponse.addItem` describing what was actually authorized.
+            In either case, the response will be validated against the PAS Response Bundle profile.
+          )
+    input :client_id,
+          title: 'Client Id',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_CLIENT_ID_LOCKED
+    input :session_url_path,
+          title: 'Session-specific URL path extension',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_SESSION_URL_PATH_LOCKED
+
+    submit_respond_with :modification_json_response
+
+    run do
+      if user_inputted_response? :modification_json_response
+        assert_valid_json modification_json_response,
+                          'Input "Claim modified response JSON" must be valid JSON'
+      else
+        add_message('info', %(
+          No modified response provided in input '#{input_title(:modification_json_response)}'. Any responses to
+          $submit requests 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)
+
+      wait(
+        identifier: wait_identifier,
+        message: %(
+          **Payer Modification Workflow Test**:
+
+          Submit a PAS request to
+
+          `#{submit_endpoint}`
+
+          If the optional '**#{input_title(:modification_json_response)}**' input is populated, it will
+          be returned, updated with current timestamps. Otherwise, a payer modification response will
+          be generated by Inferno using the received Claim.
+        )
+      )
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/abstract_response_attest.rb

@@ -0,0 +1,64 @@
+module DaVinciPASTestKit
+  # abstract test, needs to be extended to include a version-specific URLs module
+  class AbstractResponseAttest < Inferno::Test
+    id :pas_client_response_attest
+    title 'PAS client reacts appropriately to the response'
+    description %(
+      This test provides the tester an opportunity to observe their client following
+      the receipt of response and attest that users are able to see the appropriate
+      updates to the corresponding prior authorization request in their system.
+    )
+    attestation
+
+    def workflow_tag
+      config.options[:workflow_tag]
+    end
+
+    def attest_message
+      config.options[:attest_message]
+    end
+
+    def workflow_name
+      case workflow_tag
+      when APPROVAL_WORKFLOW_TAG
+        'Approval'
+      when DENIAL_WORKFLOW_TAG
+        'Denial'
+      when PENDED_WORKFLOW_TAG
+        'Pended'
+      when MODIFICATION_WORKFLOW_TAG
+        'Payer Modification'
+      when MUST_SUPPORT_WORKFLOW_TAG
+        'Must Support'
+      when OPERATION_FAILURE_WORKFLOW_TAG
+        'Operation Failure'
+      when PROCESSING_ERROR_WORKFLOW_TAG
+        'Processing Error'
+      end
+    end
+
+    output :attest_true_url
+    output :attest_false_url
+
+    run do
+      identifier = test_session_id
+      attest_true_url = "#{resume_pass_url}?token=#{identifier}"
+      output(attest_true_url:)
+      attest_false_url = "#{resume_fail_url}?token=#{identifier}"
+      output(attest_false_url:)
+
+      wait(
+        identifier:,
+        message: %(
+          **#{workflow_name} Workflow Test**:
+
+          #{attest_message}
+
+          [Click here](#{attest_true_url}) if the above statement is **true**.
+
+          [Click here](#{attest_false_url}) if the above statement is **false**.
+        )
+      )
+    end
+  end
+end

data/lib/davinci_pas_test_kit/client/abstract_subscription_create_test.rb

@@ -0,0 +1,57 @@
+require_relative 'client_input_descriptions'
+require_relative 'session_identification'
+
+module DaVinciPASTestKit
+  # abstract test, needs to be extended to include a version-specific URLs module
+  class AbstractSubscriptionCreateTest < Inferno::Test
+    include SessionIdentification
+
+    id :pas_client_subscription_create_test
+    title 'PAS 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 :client_id,
+          title: 'Client Id',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_CLIENT_ID_LOCKED
+    input :session_url_path,
+          title: 'Session-specific URL path extension',
+          type: 'text',
+          optional: true,
+          locked: true,
+          description: INPUT_SESSION_URL_PATH_LOCKED
+    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, including handshake notifications sent after Subscription creation. 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 = session_wait_identifier(client_id, session_url_path)
+      subscription_endpoint = session_endpoint_url(:subscription, client_id, session_url_path)
+
+      wait(
+        identifier: wait_identifier,
+        message: %(
+          **Subscription Creation Test**:
+
+          Submit a POST with a Subscription to:
+
+          `#{subscription_endpoint}`
+
+          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

data/lib/davinci_pas_test_kit/{urls.rb → client/client_urls.rb}

@@ -2,11 +2,14 @@
 
 require 'udap_security_test_kit'
 require 'smart_app_launch_test_kit'
+require_relative '../cross_suite/base_urls'
 
 module DaVinciPASTestKit
   SESSION_PATH_PLACEHOLDER = '/:session_path'
   FHIR_PATH = '/fhir'
   SESSION_FHIR_PATH = SESSION_PATH_PLACEHOLDER + FHIR_PATH
+  FHIR_METADATA_PATH = "#{FHIR_PATH}/metadata".freeze
+  SESSION_FHIR_METADATA_PATH = SESSION_PATH_PLACEHOLDER + FHIR_METADATA_PATH
   SUBMIT_PATH = "#{FHIR_PATH}/Claim/$submit".freeze
   SESSION_SUBMIT_PATH = SESSION_PATH_PLACEHOLDER + SUBMIT_PATH
   INQUIRE_PATH = "#{FHIR_PATH}/Claim/$inquire".freeze
@@ -19,14 +22,11 @@ module DaVinciPASTestKit
   SESSION_FHIR_SUBSCRIPTION_INSTANCE_STATUS_PATH = SESSION_PATH_PLACEHOLDER + FHIR_SUBSCRIPTION_INSTANCE_STATUS_PATH
   FHIR_SUBSCRIPTION_RESOURCE_STATUS_PATH = "#{FHIR_SUBSCRIPTION_PATH}/$status".freeze
   SESSION_FHIR_SUBSCRIPTION_RESOURCE_STATUS_PATH = SESSION_PATH_PLACEHOLDER + FHIR_SUBSCRIPTION_RESOURCE_STATUS_PATH
-  RESUME_PASS_PATH = '/resume_pass'
-  RESUME_FAIL_PATH = '/resume_fail'
-  RESUME_SKIP_PATH = '/resume_skip'
 
-  module URLs
-    def base_url
-      @base_url ||= "#{Inferno::Application['base_url']}/custom/#{suite_id}"
-    end
+  # URLs used by client tests
+  # suite_id still not provided since not specific to a suite, yet
+  module ClientURLs
+    include BaseURLs
 
     def fhir_base_url
       @fhir_base_url ||= base_url + FHIR_PATH
@@ -68,18 +68,6 @@ module DaVinciPASTestKit
       base_url + SESSION_FHIR_SUBSCRIPTION_PATH.gsub(SESSION_PATH_PLACEHOLDER, "/#{session_path}")
     end
 
-    def resume_pass_url
-      @resume_pass_url ||= base_url + RESUME_PASS_PATH
-    end
-
-    def resume_fail_url
-      @resume_fail_url ||= base_url + RESUME_FAIL_PATH
-    end
-
-    def resume_skip_url
-      @resume_skip_url ||= base_url + RESUME_SKIP_PATH
-    end
-
     def udap_discovery_url
       @udap_discovery_url ||= base_url + UDAPSecurityTestKit::UDAP_DISCOVERY_PATH
     end
@@ -91,9 +79,5 @@ module DaVinciPASTestKit
     def registration_url
       @registration_url ||= base_url + UDAPSecurityTestKit::REGISTRATION_PATH
     end
-
-    def suite_id
-      self.class.suite.id
-    end
   end
 end