davinci_crd_test_kit 0.13.0 → 0.14.1

data/lib/davinci_crd_test_kit/client/v2.2.1/client_hooks_group.rb

@@ -0,0 +1,84 @@
+require_relative 'client_appointment_book_group'
+require_relative 'client_encounter_discharge_group'
+require_relative 'client_encounter_start_group'
+require_relative 'client_order_dispatch_group'
+require_relative 'client_order_select_group'
+require_relative 'client_order_sign_group'
+require_relative 'client_urls'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientHooksGroup < Inferno::TestGroup
+      title 'Hooks'
+      description <<~DESCRIPTION
+        This group contains sub-groups which each verify the ability of the client to make and react to responses from
+        one of the [six hooks described in the CRD IG](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html):
+        * [appointment-book](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#appointment-book)
+        * [encounter-start](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#encounter-start)
+        * [encounter-discharge](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#encounter-discharge)
+        * [order-select](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-select)
+        * [order-dispatch](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-dispatch)
+        * [order-sign](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-sign)
+
+        Each hook-specific group follows the same pattern:
+        1. Allow the client to make hook invocations for the tested hook, waiting until the tester indicates
+           that all desired requests have been made, then
+        2. Check the requests and their associated responses for conformance to CRD and CDS Hooks requirements.
+           Additionally, ask the tester to confirm that the responses were displayed appropriately by the client.
+
+        The CRD IG does not require support for any specific hook, so all the hook-specific sub-groups are
+        optional. A conformant CRD client will have implemented at least one hook and will run and pass
+        the hook-specific groups corresponding to each hook that it implements.
+
+        Inferno simulates two CRD discovery endpoints, each with service endpoints for all six CRD hooks
+        but with different service ids:
+        - Discovery endpoint for services requesting the complete [standard prefetch data set](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#standard-prefetch):
+          `#{ClientURLs.discovery_url}`
+          * `appointment-book` service id: `appointment-book-service`
+          * `encounter-start` service id: `encounter-start-service`
+          * `encounter-discharge` service id: `encounter-discharge-service`
+          * `order-select` service id: `order-select-service`
+          * `order-dispatch` service id: `order-dispatch-service`
+          * `order-sign` service id: `order-sign-service`
+        - Discovery endpoint for services requesting the a subset of the [standard prefetch data set](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#standard-prefetch):
+          `#{ClientURLs.prefetch_subset_discovery_url}`
+          * `appointment-book` service id: `appointment-book-subset`
+          * `encounter-start` service id: `encounter-start-subset`
+          * `encounter-discharge` service id: `encounter-discharge-subset`
+          * `order-select` service id: `order-select-subset`
+          * `order-dispatch` service id: `order-dispatch-subset`
+          * `order-sign` service id: `order-sign-subset`
+      DESCRIPTION
+      id :crd_v221_client_hooks
+
+      input :cds_jwt_iss,
+            title: 'CRD JWT Issuer',
+            description: %(
+              Value of the `iss` claim that must be present in the JWT used to authorize the client's hook
+              request sent as the Bearer token in the `Authorization` header.
+              Run or re-run the "Registration" group to set or change this value.
+            ),
+            locked: true
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      group from: :crd_v221_client_appointment_book,
+            optional: true
+
+      group from: :crd_v221_client_encounter_start,
+            optional: true
+
+      group from: :crd_v221_client_encounter_discharge,
+            optional: true
+
+      group from: :crd_v221_client_order_select,
+            optional: true
+
+      group from: :crd_v221_client_order_dispatch,
+            optional: true
+
+      group from: :crd_v221_client_order_sign,
+            optional: true
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_long_running_hook_group.rb

@@ -0,0 +1,32 @@
+require_relative 'long_running/client_long_running_receive_request_test'
+require_relative 'long_running/client_skip_long_running_attestation_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientLongRunningHookGroup < Inferno::TestGroup
+      title 'Long-running Hook Request'
+      id :crd_v221_client_long_running_hook
+      description <<~DESCRIPTION
+        When a hook invocation runs long, the CRD IG requires systems to provide
+        users with a way to bypass the hook and continue their workflow.
+
+        Hook requests made during these tests will not be checked for conformance
+        or included in the cross-hook analyses around must support and other coverage requirements.
+      DESCRIPTION
+
+      run_as_group
+
+      input_order :long_running_pause_time
+
+      config(
+        options: {
+          hook_name: ANY_HOOK_TAG,
+          crd_test_group: LONG_RUNNING_GROUP_TAG
+        }
+      )
+
+      test from: :crd_v221_client_long_running_receive_request
+      test from: :crd_v221_client_skip_long_running_attestation_test
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_dispatch_group.rb

@@ -0,0 +1,107 @@
+require_relative 'invocation/order_dispatch_receive_request_test'
+require_relative 'auth/decode_auth_token_test'
+require_relative 'auth/retrieve_jwks_test'
+require_relative 'auth/token_header_test'
+require_relative 'auth/token_payload_test'
+require_relative 'verify_request/hook_request_conformance_test'
+require_relative 'verify_request/hook_request_requested_version_test'
+require_relative 'verify_request/hook_request_prefetch_profiles_test'
+require_relative 'verify_request/hook_request_prefetch_complete_test'
+require_relative 'verify_request/hook_request_granted_scopes_test'
+require_relative 'verify_request/hook_request_secured_transport_test'
+require_relative 'verify_request/hook_request_coverage_verification_test'
+require_relative 'verify_request/hook_request_data_fetch_verification_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+require_relative 'verify_response/hook_response_support_coverage_information_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientOrderDispatchGroup < Inferno::TestGroup
+      title 'order-dispatch'
+      id :crd_v221_client_order_dispatch
+      description <<~DESCRIPTION
+        The [order-dispatch](https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html) hook fires when a
+        practitioner is selecting a candidate performer for a pre-existing order
+        that was not tied to a specific performer. The CRD IG places [additional constraints on the use
+        of the order-dispatch hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-dispatch),
+        including the profiles that resources in each request must conform to.
+
+        Inferno's simulated `order-dispatch` hook endpoints are available at:
+        - Complete Prefetch: `#{ClientURLs.base_url}#{ORDER_DISPATCH_PATH}`
+        - Subset Prefetch: `#{ClientURLs.base_url}#{ORDER_DISPATCH_PREFETCH_SUBSET_PATH}`
+      DESCRIPTION
+      run_as_group
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A', 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-B'
+
+      input_order :order_dispatch_response_approach,
+                  :order_dispatch_selected_response_types,
+                  :order_dispatch_custom_response_template
+
+      config(
+        inputs: {
+          auth_token_headers_json: { name: :order_dispatch_auth_token_headers_json },
+          auth_tokens: { name: :order_dispatch_auth_tokens },
+          auth_tokens_jwk_json: { name: :order_dispatch_auth_tokens_jwk_json },
+          client_access_token: { name: :order_dispatch_client_access_token },
+          client_fhir_server: { name: :order_dispatch_client_fhir_server },
+          crd_jwks_keys_json: { name: :order_dispatch_crd_jwks_keys_json },
+          custom_response_template: { name: :order_dispatch_custom_response_template },
+          selected_response_types: { name: :order_dispatch_selected_response_types }
+        },
+        outputs: {
+          auth_token_headers_json: { name: :order_dispatch_auth_token_headers_json },
+          auth_token_payloads_json: { name: :order_dispatch_auth_token_payloads_json },
+          auth_tokens: { name: :order_dispatch_auth_tokens },
+          auth_tokens_jwk_json: { name: :order_dispatch_auth_tokens_jwk_json },
+          client_access_token: { name: :order_dispatch_client_access_token },
+          client_fhir_server: { name: :order_dispatch_client_fhir_server },
+          crd_jwks_keys_json: { name: :order_dispatch_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'order-dispatch'
+        }
+      )
+
+      group do
+        title 'Interaction'
+        test from: :crd_v221_order_dispatch_request
+      end
+
+      group do
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
+      end
+
+      group do
+        title 'Requests'
+        test from: :crd_v221_hook_request_conformance do
+          verifies_requirements(*HookRequestConformanceTest.verifies_requirements,
+                                'hl7.fhir.us.davinci-crd_2.2.1@hook-31')
+        end
+        test from: :crd_v221_hook_request_requested_version
+        test from: :crd_v221_hook_request_prefetch_profiles
+        test from: :crd_v221_hook_request_prefetch_complete
+        test from: :crd_v221_hook_request_coverage_verification
+        test from: :crd_v221_hook_data_fetch_verification
+        test from: :crd_v221_hook_request_granted_scopes
+        test from: :crd_v221_hook_request_secured_transport
+      end
+
+      group do
+        title 'Response Handling'
+
+        test from: :crd_v221_inferno_response_validation
+        test from: :crd_v221_card_display_attest_test
+        test from: :crd_v221_client_hook_response_support_coverage_information do
+          title 'Client supports the Coverage Information response type on the order-dispatch hook'
+          verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-33'
+        end
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_select_group.rb

@@ -0,0 +1,108 @@
+require_relative 'invocation/order_select_receive_request_test'
+require_relative 'auth/decode_auth_token_test'
+require_relative 'auth/retrieve_jwks_test'
+require_relative 'auth/token_header_test'
+require_relative 'auth/token_payload_test'
+require_relative 'verify_request/hook_request_conformance_test'
+require_relative 'verify_request/hook_request_requested_version_test'
+require_relative 'verify_request/hook_request_prefetch_profiles_test'
+require_relative 'verify_request/hook_request_prefetch_complete_test'
+require_relative 'verify_request/hook_request_granted_scopes_test'
+require_relative 'verify_request/hook_request_secured_transport_test'
+require_relative 'verify_request/hook_request_coverage_verification_test'
+require_relative 'verify_request/hook_request_data_fetch_verification_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientOrderSelectGroup < Inferno::TestGroup
+      title 'order-select'
+      id :crd_v221_client_order_select
+      description <<~DESCRIPTION
+        The [order-select](https://cds-hooks.hl7.org/hooks/STU1/order-select.html) hook fires
+        when a clinician selects one or more orders to place for a patient (including orders for medications,
+        procedures, labs and other orders). The CRD IG places [additional constraints on the use
+        of the order-select hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-select),
+        including the profiles that resources in each request must conform to.
+
+        Inferno's simulated `order-select` hook endpoints are available at:
+        - Complete Prefetch: `#{ClientURLs.base_url}#{ORDER_SELECT_PATH}`
+        - Subset Prefetch: `#{ClientURLs.base_url}#{ORDER_SELECT_PREFETCH_SUBSET_PATH}`
+      DESCRIPTION
+      run_as_group
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A', 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-B'
+
+      input_order :order_select_response_approach,
+                  :order_select_selected_response_types,
+                  :order_select_custom_response_template
+
+      config(
+        inputs: {
+          auth_token_headers_json: { name: :order_select_auth_token_headers_json },
+          auth_tokens: { name: :order_select_auth_tokens },
+          auth_tokens_jwk_json: { name: :order_select_auth_tokens_jwk_json },
+          client_access_token: { name: :order_select_client_access_token },
+          client_fhir_server: { name: :order_select_client_fhir_server },
+          crd_jwks_keys_json: { name: :order_select_crd_jwks_keys_json },
+          custom_response_template: { name: :order_select_custom_response_template },
+          selected_response_types: { name: :order_select_selected_response_types }
+        },
+        outputs: {
+          auth_token_headers_json: { name: :order_select_auth_token_headers_json },
+          auth_token_payloads_json: { name: :order_select_auth_token_payloads_json },
+          auth_tokens: { name: :order_select_auth_tokens },
+          auth_tokens_jwk_json: { name: :order_select_auth_tokens_jwk_json },
+          client_access_token: { name: :order_select_client_access_token },
+          client_fhir_server: { name: :order_select_client_fhir_server },
+          crd_jwks_keys_json: { name: :order_select_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'order-select'
+        }
+      )
+
+      group do
+        title 'Interaction'
+        test from: :crd_v221_order_select_request
+      end
+
+      group do
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
+      end
+
+      group do
+        title 'Requests'
+        test from: :crd_v221_hook_request_conformance do
+          verifies_requirements(*HookRequestConformanceTest.verifies_requirements,
+                                'hl7.fhir.us.davinci-crd_2.2.1@hook-35',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-3',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-6',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-9',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-10',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-11',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-12')
+        end
+        test from: :crd_v221_hook_request_requested_version
+        test from: :crd_v221_hook_request_prefetch_profiles
+        test from: :crd_v221_hook_request_prefetch_complete
+        test from: :crd_v221_hook_request_coverage_verification
+        test from: :crd_v221_hook_data_fetch_verification
+        test from: :crd_v221_hook_request_granted_scopes
+        test from: :crd_v221_hook_request_secured_transport
+      end
+
+      group do
+        title 'Response Handling'
+
+        test from: :crd_v221_inferno_response_validation
+        test from: :crd_v221_card_display_attest_test
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_sign_group.rb

@@ -0,0 +1,113 @@
+require_relative 'invocation/order_sign_receive_request_test'
+require_relative 'auth/decode_auth_token_test'
+require_relative 'auth/retrieve_jwks_test'
+require_relative 'auth/token_header_test'
+require_relative 'auth/token_payload_test'
+require_relative 'verify_request/hook_request_conformance_test'
+require_relative 'verify_request/hook_request_requested_version_test'
+require_relative 'verify_request/hook_request_prefetch_profiles_test'
+require_relative 'verify_request/hook_request_prefetch_complete_test'
+require_relative 'verify_request/hook_request_granted_scopes_test'
+require_relative 'verify_request/hook_request_secured_transport_test'
+require_relative 'verify_request/hook_request_coverage_verification_test'
+require_relative 'verify_request/hook_request_data_fetch_verification_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+require_relative 'verify_response/hook_response_support_coverage_information_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientOrderSignGroup < Inferno::TestGroup
+      title 'order-sign'
+      id :crd_v221_client_order_sign
+      description <<~DESCRIPTION
+        The [order-sign](https://cds-hooks.hl7.org/hooks/STU1/order-sign.html) hook fires
+        when a clinician is ready to sign one or more orders for a patient (including orders
+        for medications, procedures, labs and other orders). The CRD IG places [additional constraints on the use
+        of the order-sign hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#order-sign),
+        including the profiles that resources in each request must conform to.
+
+        Inferno's simulated `order-sign` hook endpoints are available at:
+        - Complete Prefetch: `#{ClientURLs.base_url}#{ORDER_SIGN_PATH}`
+        - Subset Prefetch: `#{ClientURLs.base_url}#{ORDER_SIGN_PREFETCH_SUBSET_PATH}`
+      DESCRIPTION
+      run_as_group
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-A', 'hl7.fhir.us.davinci-crd_2.2.1@hook-2-B'
+
+      input_order :order_sign_response_approach,
+                  :order_sign_selected_response_types,
+                  :order_sign_custom_response_template
+
+      config(
+        inputs: {
+          auth_token_headers_json: { name: :order_sign_auth_token_headers_json },
+          auth_tokens: { name: :order_sign_auth_tokens },
+          auth_tokens_jwk_json: { name: :order_sign_auth_tokens_jwk_json },
+          client_access_token: { name: :order_sign_client_access_token },
+          client_fhir_server: { name: :order_sign_client_fhir_server },
+          crd_jwks_keys_json: { name: :order_sign_crd_jwks_keys_json },
+          custom_response_template: { name: :order_sign_custom_response_template },
+          selected_response_types: { name: :order_sign_selected_response_types }
+        },
+        outputs: {
+          auth_token_headers_json: { name: :order_sign_auth_token_headers_json },
+          auth_token_payloads_json: { name: :order_sign_auth_token_payloads_json },
+          auth_tokens: { name: :order_sign_auth_tokens },
+          auth_tokens_jwk_json: { name: :order_sign_auth_tokens_jwk_json },
+          client_access_token: { name: :order_sign_client_access_token },
+          client_fhir_server: { name: :order_sign_client_fhir_server },
+          crd_jwks_keys_json: { name: :order_sign_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'order-sign'
+        }
+      )
+
+      group do
+        title 'Interaction'
+        test from: :crd_v221_order_sign_request
+      end
+
+      group do
+        title 'Authorization'
+        test from: :crd_v221_decode_auth_token
+        test from: :crd_v221_retrieve_jwks
+        test from: :crd_v221_token_header
+        test from: :crd_v221_token_payload
+      end
+
+      group do
+        title 'Requests'
+        test from: :crd_v221_hook_request_conformance do
+          verifies_requirements(*HookRequestConformanceTest.verifies_requirements,
+                                'hl7.fhir.us.davinci-crd_2.2.1@hook-37',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-3',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-6',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-9',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-10',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-11',
+                                'hl7.fhir.us.davinci-crd_2.2.1@prof-12')
+        end
+        test from: :crd_v221_hook_request_requested_version
+        test from: :crd_v221_hook_request_prefetch_profiles
+        test from: :crd_v221_hook_request_prefetch_complete
+        test from: :crd_v221_hook_request_coverage_verification
+        test from: :crd_v221_hook_data_fetch_verification
+        test from: :crd_v221_hook_request_granted_scopes
+        test from: :crd_v221_hook_request_secured_transport
+      end
+
+      group do
+        title 'Response Handling'
+
+        test from: :crd_v221_inferno_response_validation
+        test from: :crd_v221_card_display_attest_test
+        test from: :crd_v221_client_hook_response_support_coverage_information do
+          title 'Client supports the Coverage Information response type on the order-sign hook'
+          verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-39'
+        end
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_registration_group.rb

@@ -0,0 +1,33 @@
+require_relative 'registration/client_registration_verification_test'
+require_relative 'registration/client_service_registration_attestation_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class CRDClientRegistrationGroup < Inferno::TestGroup
+      id :crd_v221_client_registration
+      title 'Registration'
+      description %(
+        Before hook invocations can be made, the client tested in this session
+        must be registered with and trusted by Inferno's simulated CRD server
+        and vice-versa. Tests in this group confirm the registration of the partner
+        system on both ends.
+
+        Inferno simulates two CRD discovery endpoints for the client to connect to:
+        - Discovery endpoint for services requesting the complete [standard prefetch data set](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#standard-prefetch):
+          `#{ClientURLs.discovery_url}`
+        - Discovery endpoint for services requesting the a subset of the [standard prefetch data set](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#standard-prefetch):
+          `#{ClientURLs.prefetch_subset_discovery_url}`
+
+        This group must be run before any other tests in the "Hook Invocation" group because inputs
+        provided to this group will be used by Inferno for the remainder of the tests
+        to identify client requests and verify behavior. The inputs will appear as locked and
+        unchangeable on these subsequent tests. If changes to these values are needed,
+        re-run this group and provide the corrected input values.
+      )
+      run_as_group
+
+      test from: :crd_v221_client_registration_verification
+      test from: :crd_v221_client_service_registration_attestation
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/client_urls.rb

@@ -0,0 +1,27 @@
+require_relative '../client_base_urls'
+
+module DaVinciCRDTestKit
+  module V221
+    module ClientURLs
+      include ClientBaseURLs
+
+      SUITE_ID = 'crd_client_v221'.freeze
+
+      def self.base_url
+        "#{Inferno::Application['base_url']}/custom/#{SUITE_ID}"
+      end
+
+      def self.discovery_url
+        "#{base_url}#{DaVinciCRDTestKit::DISCOVERY_PATH}"
+      end
+
+      def self.prefetch_subset_discovery_url
+        "#{base_url}#{DaVinciCRDTestKit::PREFETCH_DISCOVERY_PATH}"
+      end
+
+      def suite_id
+        SUITE_ID
+      end
+    end
+  end
+end