davinci_dtr_test_kit 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 940914e499d108663302b9df9fac473315dff874b8e6d1f7afa354a0fb02b412
-  data.tar.gz: 878e70bfea50b8458ad08cbe7ad4834ae05c1c34c21a883dd1cdce883d1c3500
+  metadata.gz: 3449c737f53b2443bc81890e9788ff4aad6837c70865512e58b5a5d3809ad96e
+  data.tar.gz: 4b2775168992e4887e5e330178138bd918a225bf9d57f2b7425a021acc7ee7c1
 SHA512:
-  metadata.gz: 4b6888ef1ce9334ced832a2816c614ae4fd846c376181fcb7ff698e4069afe197db2f7305ff0100de94518ef22cd6d043ddd6516e965839e4acc7d836b9d98e2
-  data.tar.gz: 5a4003c46adfd4f682979ef22bdf7d97dbff6c7be12416e744851eada2ece766f4dbceaa77a01468d7a5f2a4567f65e1d5885dcabfca1d42eddbc66ef575dafe
+  metadata.gz: e6107a0cf03478d3bdc9c9b155af0664b8d39b9a3819e563c3dcf45bc69b34d80a83b0be270022be6d75aeb95a6b2b9b85d486c00693a9ad3e4f0605e2d504ee
+  data.tar.gz: 69701c0a2b4a2a69ae16d5e8dd1b79fd9d27fddf0230d02dc6793be32752d965f01688d3661df72cfdddc9a208b252fda1303f516b5aa6458d33631383fc17f2

data/lib/davinci_dtr_test_kit/client_groups/dinner_static/dtr_dinner_questionnaire_package_request_test.rb

@@ -0,0 +1,134 @@
+require 'base64'
+require_relative '../../urls'
+
+module DaVinciDTRTestKit
+  class DTRDinnerQuestionnairePackageRequestTest < Inferno::Test
+    include URLs
+
+    id :dtr_dinner_questionnaire_package_request
+    title 'Invoke the DTR Questionnaire Package operation'
+    description %(
+      Inferno will wait for a DTR questionnaire package request from the client. Upon receipt, Inferno will generate and
+      send a response.
+    )
+    input :smart_app_launch,
+          type: 'radio',
+          title: 'SMART App Launch',
+          description: 'How will the DTR SMART App launch?',
+          options: { list_options: [{ label: 'EHR Launch from Inferno', value: 'ehr' },
+                                    { label: 'Standalone Launch', value: 'standalone' }] }
+    input :client_id
+    input :launch_uri,
+          optional: true,
+          description: 'Required if "Launch from Inferno" is selected'
+    input :smart_patient_id,
+          optional: true,
+          title: 'SMART App Launch Patient ID (Dinner Static)',
+          type: 'text',
+          description: %(
+            Patient instance `id` to be provided by Inferno as the `patient` as a part of the SMART App
+            Launch.
+          ),
+          default: 'pat015'
+    input :smart_fhir_context,
+          optional: true,
+          title: 'SMART App Launch fhirContext (Dinner Static)',
+          type: 'textarea',
+          description: %(
+            References to be provided by Inferno as the `fhirContext` as a part of the SMART App
+            Launch. These references help determine the behavior of the app. Referenced instances
+            may be provided in the "EHR-available resources" input.
+          ),
+          default: JSON.pretty_generate([{ reference: 'Coverage/cov015' },
+                                         { reference: 'DeviceRequest/devreqe0470' }])
+    input :ehr_bundle,
+          optional: true,
+          title: 'EHR-available resources (Dinner Static)',
+          type: 'textarea',
+          description: %(
+            Resources available from the EHR needed to drive the dinner static workflow.
+            Formatted as a FHIR bundle that contains resources, each with an `id` property populated. Each
+            instance present will be available for retrieval from Inferno at the endpoint:
+            
+            ```
+            [fhir-base]/[resource type]/[instance id]
+            ```
+          )
+
+    def example_client_jwt_payload_part
+      Base64.strict_encode64({ inferno_client_id: client_id }.to_json).delete('=')
+    end
+
+    run do
+      # validate relevant inputs and provide warnings if they are bad
+      warning do
+        if smart_fhir_context
+          assert_valid_json(smart_fhir_context,
+                            'The **SMART App Launch fhirContext** input is not valid JSON, so it will not be included in
+                            the access token response.')
+        end
+      end
+
+      warning do
+        if ehr_bundle
+          assert_valid_json(ehr_bundle,
+                            'The **EHR-available resources** input is not valid JSON, so no tester-specified instances
+                              will be available to access from Inferno.')
+          assert(FHIR.from_contents(ehr_bundle).is_a?(FHIR::Bundle),
+                 'The **EHR-available resources** input does not contain a FHIR Bundle, so no tester-specified instances
+                 will be available to access from Inferno.')
+        end
+      end
+
+      launch_prompt = if smart_app_launch == 'ehr'
+                        %(Launch the DTR SMART App from Inferno by right clicking
+                          [this link](#{launch_uri}?iss=#{fhir_base_url}&launch=#{launch_uri})
+                          and selecting or "Open in new window" or "Open in new tab".)
+                      else
+                        %(Launch the SMART App from your EHR.)
+                      end
+      inferno_prompt_cont = %(As the DTR app steps through the launch steps, Inferno will wait and respond to the app's
+                              requests for SMART configuration, authorization and access token.)
+
+      wait(
+        identifier: client_id,
+        message: %(
+          ### SMART App Launch
+
+          #{launch_prompt}
+
+          #{inferno_prompt_cont if smart_app_launch == 'ehr'}
+
+          Then, Inferno will expect the SMART App to invoke the DTR Questionnaire Package operation by sending a POST
+          request to
+
+          `#{questionnaire_package_url}`
+
+          A questionnaire package generated by Inferno will be returned.
+
+          ### Pre-population
+
+          Inferno will then wait for the client to complete Questionnaire pre-population. The client should make FHIR
+          GET requests using service base path:
+
+          `#{fhir_base_url}`
+
+          ### Request Identification
+
+          In order to identify requests for this session, Inferno will look for
+          an `Authorization` header with value:
+
+          ```
+          Bearer eyJhbGcmOiJub25lIn0.#{example_client_jwt_payload_part}.
+          ```
+
+          ### Continuing the Tests
+
+          When the DTR application has finished loading the Questionnaire,
+          including any clinical data requests to support pre-population,
+          [Click here](#{resume_pass_url}?client_id=#{client_id}) to continue.
+        )
+      )
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/client_groups/dinner_static/dtr_questionnaire_response_save_test.rb

@@ -9,11 +9,11 @@ module DaVinciDTRTestKit
     description %(
       Inferno, acting as the EHR, will wait for a request to save the QuestionnaireResponse from the client.
     )
-    input :access_token
+    input :client_id
 
     run do
       wait(
-        identifier: access_token,
+        identifier: client_id,
         message: %(
           Complete the questionnaire, leaving the following items unmodified, because a subsequent test will expect
           their pre-populated values:

data/lib/davinci_dtr_test_kit/client_groups/dinner_static/dtr_smart_app_questionnaire_workflow_group.rb

@@ -1,4 +1,4 @@
-require_relative '../shared/dtr_questionnaire_package_request_test'
+require_relative 'dtr_dinner_questionnaire_package_request_test'
 require_relative '../shared/dtr_questionnaire_package_request_validation_test'
 require_relative 'prepopulation_attestation_test'
 require_relative 'prepopulation_override_attestation_test'
@@ -17,6 +17,7 @@ module DaVinciDTRTestKit
       demonstrate their ability to:
 
       1. Fetch the static questionnaire package
+         ([DinnerOrderStatic](https://github.com/inferno-framework/davinci-dtr-test-kit/blob/main/lib/davinci_dtr_test_kit/fixtures/dinner_static/questionnaire_dinner_order_static.json))
       2. Render and pre-populate the questionnaire appropriately, including:
          - fetch additional data needed for pre-population
          - pre-populate data as directed by the questionnaire
@@ -36,7 +37,7 @@ module DaVinciDTRTestKit
       run_as_group
 
       # Test 1: wait for the $questionnaire-package request
-      test from: :dtr_questionnaire_package_request
+      test from: :dtr_dinner_questionnaire_package_request
       # Test 2: validate the $questionnaire-package body
       test from: :dtr_questionnaire_package_request_validation
     end

data/lib/davinci_dtr_test_kit/client_groups/dinner_static/prepopulation_attestation_test.rb

@@ -9,19 +9,19 @@ module DaVinciDTRTestKit
     description %(
       Validate that pre-population of patient name information occurs as expected.
     )
-    input :access_token
+    input :client_id
 
     run do
       wait(
-        identifier: access_token,
+        identifier: client_id,
         message: %(
           I attest that the client application pre-populates the following questions with the respective values:
           - Last Name: Oster
           - First Name: William
 
-          [Click here](#{resume_pass_url}?token=#{access_token}) if the above statement is **true**.
+          [Click here](#{resume_pass_url}?client_id=#{client_id}) if the above statement is **true**.
 
-          [Click here](#{resume_fail_url}?token=#{access_token}) if the above statement is **false**.
+          [Click here](#{resume_fail_url}?client_id=#{client_id}) if the above statement is **false**.
         )
       )
     end

data/lib/davinci_dtr_test_kit/client_groups/dinner_static/prepopulation_override_attestation_test.rb

@@ -9,20 +9,20 @@ module DaVinciDTRTestKit
     description %(
       Validate that the user can edit a pre-populated item and replace it with another value.
     )
-    input :access_token
+    input :client_id
 
     run do
       wait(
-        identifier: access_token,
+        identifier: client_id,
         message: %(
           I attest that
 
           1. The client pre-populated an answer for question 'Location'.
           2. I have changed the answer to a different value.
 
-          [Click here](#{resume_pass_url}?token=#{access_token}) if the above statement is **true**.
+          [Click here](#{resume_pass_url}?client_id=#{client_id}) if the above statement is **true**.
 
-          [Click here](#{resume_fail_url}?token=#{access_token}) if the above statement is **false**.
+          [Click here](#{resume_fail_url}?client_id=#{client_id}) if the above statement is **false**.
         )
       )
     end

data/lib/davinci_dtr_test_kit/client_groups/dinner_static/rendering_enabled_questions_attestation_test.rb

@@ -10,19 +10,19 @@ module DaVinciDTRTestKit
       Validate that the rendering of the questionnaire includes only the "What would you like on..."
       question appropriate for the dinner selection, if made.
     )
-    input :access_token
+    input :client_id
 
     run do
       wait(
-        identifier: access_token,
+        identifier: client_id,
         message: %(
           I attest that the client application does not display any "What would you like on..."
           questions until I have selected a dinner choice and then only displays the
           "What would you like on..." question relevant for the dinner request:
 
-          [Click here](#{resume_pass_url}?token=#{access_token}) if the above statement is **true**.
+          [Click here](#{resume_pass_url}?client_id=#{client_id}) if the above statement is **true**.
 
-          [Click here](#{resume_fail_url}?token=#{access_token}) if the above statement is **false**.
+          [Click here](#{resume_fail_url}?client_id=#{client_id}) if the above statement is **false**.
         )
       )
     end

data/lib/davinci_dtr_test_kit/client_groups/resp_assist_device/dtr_questionnaire_package_group.rb

@@ -1,4 +1,4 @@
-require_relative '../shared/dtr_questionnaire_package_request_test'
+require_relative 'dtr_resp_questionnaire_package_request_test'
 require_relative '../shared/dtr_questionnaire_package_request_validation_test'
 
 module DaVinciDTRTestKit
@@ -10,7 +10,7 @@ module DaVinciDTRTestKit
     )
     run_as_group
 
-    test from: :dtr_questionnaire_package_request
+    test from: :dtr_resp_questionnaire_package_request
     test from: :dtr_questionnaire_package_request_validation
   end
 end

data/lib/davinci_dtr_test_kit/client_groups/resp_assist_device/dtr_questionnaire_rendering_attestation_test.rb

@@ -10,21 +10,21 @@ module DaVinciDTRTestKit
       Thist test provides the tester an opportunity to observe their client application following the receipt of the
       questionnaire pacakage and attest that the application renders the questionnaire.
     )
-    input :access_token
+    input :client_id
 
     run do
       load_tagged_requests QUESTIONNAIRE_PACKAGE_TAG
       skip_if request.blank?, 'A Questionnaire Package request must be made prior to running this test'
 
       wait(
-        identifier: access_token,
+        identifier: client_id,
         message: %(
           I attest that the client application displays the questionnaire and respects the following rendering style:
           - The "Signature" field label is rendered with green text
 
-          [Click here](#{resume_pass_url}?token=#{access_token}) if the above statement is **true**.
+          [Click here](#{resume_pass_url}?client_id=#{client_id}) if the above statement is **true**.
 
-          [Click here](#{resume_fail_url}?token=#{access_token}) if the above statement is **false**.
+          [Click here](#{resume_fail_url}?client_id=#{client_id}) if the above statement is **false**.
         )
       )
     end

data/lib/davinci_dtr_test_kit/client_groups/resp_assist_device/dtr_questionnaire_response_save_test.rb

@@ -9,11 +9,11 @@ module DaVinciDTRTestKit
     description %(
       Inferno, acting as the EHR, will wait for a request to save the QuestionnaireResponse from the client.
     )
-    input :access_token
+    input :client_id
 
     run do
       wait(
-        identifier: access_token,
+        identifier: client_id,
         message: %(
           Complete the questionnaire, leaving the following items unmodified, because a subsequent test will expect
           their pre-populated values:

data/lib/davinci_dtr_test_kit/client_groups/resp_assist_device/dtr_resp_questionnaire_package_request_test.rb

@@ -0,0 +1,132 @@
+require_relative '../../urls'
+
+module DaVinciDTRTestKit
+  class DTRRespQuestionnairePackageRequestTest < Inferno::Test
+    include URLs
+
+    id :dtr_resp_questionnaire_package_request
+    title 'Invoke the DTR Questionnaire Package operation'
+    description %(
+      Inferno will wait for a DTR questionnaire package request from the client. Upon receipt, Inferno will generate and
+      send a response.
+    )
+    input :smart_app_launch,
+          type: 'radio',
+          title: 'SMART App Launch',
+          description: 'How will the DTR SMART App launch?',
+          options: { list_options: [{ label: 'EHR Launch from Inferno', value: 'ehr' },
+                                    { label: 'Standalone Launch', value: 'standalone' }] }
+    input :client_id
+    input :launch_uri,
+          optional: true,
+          description: 'Required if "Launch from Inferno" is selected'
+    input :smart_patient_id,
+          optional: true,
+          title: 'SMART App Launch Patient ID (Respiratory Assist Device)',
+          type: 'text',
+          description: %(
+            Patient instance `id` to be provided by Inferno as the `patient` as a part of the SMART App
+            Launch.
+          ),
+          default: 'pat015'
+    input :smart_fhir_context,
+          optional: true,
+          title: 'SMART App Launch fhirContext (Respiratory Assist Device)',
+          type: 'textarea',
+          description: %(
+            References to be provided by Inferno as the `fhirContext` as a part of the SMART App
+            Launch. These references help determine the behavior of the app. Referenced instances
+            may be provided in the "EHR-available resources" input.
+          ),
+          default: JSON.pretty_generate([{ reference: 'Coverage/cov015' },
+                                         { reference: 'DeviceRequest/devreqe0470' }])
+    input :ehr_bundle,
+          optional: true,
+          title: 'EHR-available resources (Respiratory Assist Device)',
+          type: 'textarea',
+          description: %(
+            Resources available from the EHR needed to drive the respiratory assist device workflow.
+            Formatted as a FHIR bundle that contains resources, each with an `id` property populated. Each
+            instance present will be available for retrieval from Inferno at the endpoint
+
+            ```
+            [fhir-base]/[resource type]/[instance id]
+            ```
+          )
+
+    def example_client_jwt_payload_part
+      Base64.strict_encode64({ inferno_client_id: client_id }.to_json).delete('=')
+    end
+
+    run do
+      # validate relevant inputs and provide warnings if they are bad
+      warning do
+        if smart_fhir_context
+          assert_valid_json(smart_fhir_context,
+                            'The **SMART App Launch fhirContext** input is not valid JSON, so it will not be included in
+                            the access token response.')
+        end
+      end
+
+      warning do
+        if ehr_bundle
+          assert_valid_json(ehr_bundle,
+                            'The **EHR-available resources** input is not valid JSON, so no tester-specified instances
+                              will be available to access from Inferno.')
+          assert(FHIR.from_contents(ehr_bundle).is_a?(FHIR::Bundle),
+                 'The **EHR-available resources** input does not contain a FHIR Bundle, so no tester-specified instances
+                 will be available to access from Inferno.')
+        end
+      end
+
+      launch_prompt = if smart_app_launch == 'ehr'
+                        %(Launch the DTR SMART App from Inferno by right clicking
+                          [this link](#{launch_uri}?iss=#{fhir_base_url}&launch=#{launch_uri})
+                          and selecting or "Open in new window" or "Open in new tab".)
+                      else
+                        %(Launch the SMART App from your EHR.)
+                      end
+      inferno_prompt_cont = %(As the DTR app steps through the launch steps, Inferno will wait and respond to the app's
+                              requests for SMART configuration, authorization and access token.)
+      wait(
+        identifier: client_id,
+        message: %(
+          ### SMART App Launch
+
+          #{launch_prompt}
+
+          #{inferno_prompt_cont if smart_app_launch == 'ehr'}
+
+          Then, Inferno will expect the SMART App to invoke the DTR Questionnaire Package operation by sending a POST
+          request to
+
+          `#{questionnaire_package_url}`
+
+          A questionnaire package generated by Inferno will be returned.
+
+          ### Pre-population
+
+          Inferno will then wait for the client to complete Questionnaire pre-population. The client should make FHIR
+          GET requests using service base path:
+
+          `#{fhir_base_url}`
+
+          ### Request Identification
+
+          In order to identify requests for this session, Inferno will look for
+          an `Authorization` header with value:
+
+          ```
+          Bearer eyJhbGcmOiJub25lIn0.#{example_client_jwt_payload_part}.
+          ```
+
+          ### Continuing the Tests
+
+          When the DTR application has finished loading the Questionnaire,
+          including any clinical data requests to support pre-population,
+          [Click here](#{resume_pass_url}?client_id=#{client_id}) to continue.
+        )
+      )
+    end
+  end
+end

data/lib/davinci_dtr_test_kit/client_groups/resp_assist_device/dtr_smart_app_questionnaire_workflow_group.rb

@@ -7,10 +7,11 @@ module DaVinciDTRTestKit
     id :dtr_smart_app_questionnaire_workflow
     title 'Respiratory Assist Device Questionnaire Workflow'
     description %(
-      This workflow validates that a DTR SMART App can perform a full DTR Questionnaire workflow using a canned
-      Questionnaire for a respiratory assist device order:
+      This workflow validates that a DTR SMART App can perform a full DTR
+      Questionnaire workflow using a canned Questionnaire
+      for a respiratory assist device order:
 
-      1. Fetch the questionnaire package
+      1. Fetch the questionnaire package ([RespiratoryAssistDevices](https://github.com/inferno-framework/davinci-dtr-test-kit/blob/main/lib/davinci_dtr_test_kit/fixtures/questionnaire_package.json))
       2. Render the questionnaire
       3. Pre-populate the questionnaire response
     )

data/lib/davinci_dtr_test_kit/client_groups/shared/dtr_questionnaire_response_pre_population_test.rb

@@ -21,6 +21,7 @@ module DaVinciDTRTestKit
     )
 
     run do
+      assert_valid_json(request.request_body)
       questionnaire_response = FHIR.from_contents(request.request_body)
       skip_if !questionnaire_response.present?, 'QuestionnaireResponse not received'
 

data/lib/davinci_dtr_test_kit/docs/dtr_payer_server_suite_description_v201.md

@@ -81,9 +81,9 @@ If you would like to try out the tests but don't have a DTR payer server impleme
 you can run these tests against the DTR SMART Client test suite included in this test kit
 using the following steps:
 1. Start an Inferno session of the Da Vinci DTR SMART App Test Suite.
-1. Select test 2.1.1 *Static Questionnaire Workflow* from the menu on the left.
+1. Select test 1.1.1 *Retrieving the Static Questionnaire* from the menu on the left.
 1. Click the "Run All Tests" button in the upper right.
-1. In the "access_token" input, put `cnVuIHRvZ2V0aGVy`.
+1. In the "SMART App Launch" select `Standalone Launch` and in the "client_id" input, put `sample`.
 1. Click the "submit" button in the dialog that appears. The client tests will now be waiting for requests.
 1. Start an Inferno session of the DTR Payer Server test suite.
 1. Select test 1 *Static Questionnaire Package Retrieval* from the menu on the left.