davinci_crd_test_kit 0.12.2 → 0.14.0

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

@@ -0,0 +1,74 @@
+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'
+
+module DaVinciCRDTestKit
+  module V201
+    class ClientHooksGroup < Inferno::TestGroup
+      title 'Hooks'
+      description <<~DESCRIPTION
+        This Group contains tests which verify that valid hook requests can be made for each of the following
+        [six hooks contained in the implementation guide](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html):
+        * [appointment-book](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book)
+        * [encounter-start](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start)
+        * [encounter-discharge](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge)
+        * [order-select](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select)
+        * [order-dispatch](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch)
+        * [order-sign](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign)
+
+        Each hook group contains a test which waits for incoming hook requests from the CRD client, and tests which
+        verify the incoming hook requests conform to the specific hook requirements specified the
+        CRD IG and the [CDS hooks spec](https://cds-hooks.hl7.org/2.0/).
+
+        Each hook group tests the following:
+        * If the CRD client can invoke the specific hook service request
+        * If the incoming hook request is properly authorized with a JWT Bearer token according to the [CDS Hooks authorization requirements](https://cds-hooks.hl7.org/2.0/#trusting-cds-clients)
+        * If the incoming hook request contains valid required fields listed in the [CDS Hooks HTTP request requirements](https://cds-hooks.hl7.org/2.0/#http-request_1)
+        * If the incoming hook request contains valid optional fields listed in the [CDS Hooks HTTP request requirements](https://cds-hooks.hl7.org/2.0/#http-request_1)
+        * If the hook request's `context` field is valid according to the specific `context` requirements defined for
+        each hook type
+        * If the incoming hook request contains the optional `prefetch` field with valid resources
+        * If the hook response generated by Inferno is conformant.
+        * If the client can properly display the cards returned as a result of the hook request
+
+        Note: In order to successfully return a conformant `Coverage Information` system action, a Coverage resource must either be
+        provided in the service request's `prefetch` field, or must be fetchable from the client's FHIR server for
+        the patient provided in the service request.
+      DESCRIPTION
+      id :crd_v201_client_hooks
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@149'
+
+      input :cds_jwt_iss,
+            title: 'CRD JWT Issuer',
+            description: %(
+            Value of the `iss` claim that must be sent on the Bearer token in the `Authorization`
+            header of all requests. Run or re-run the **Client Registration** group to set or
+            change this value.
+          ),
+            locked: true
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      group from: :crd_v201_client_appointment_book,
+            optional: true
+
+      group from: :crd_v201_client_encounter_start,
+            optional: true
+
+      group from: :crd_v201_client_encounter_discharge,
+            optional: true
+
+      group from: :crd_v201_client_order_select,
+            optional: true
+
+      group from: :crd_v201_client_order_dispatch,
+            optional: true
+
+      group from: :crd_v201_client_order_sign,
+            optional: true
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+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_optional_fields_test'
+require_relative 'verify_request/hook_request_required_fields_test'
+require_relative 'verify_request/hook_request_valid_context_test'
+require_relative 'verify_request/hook_request_valid_prefetch_test'
+require_relative 'verify_request/hook_request_fetched_data_test'
+require_relative 'verify_request/hook_request_prefetch_equals_queried_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+
+module DaVinciCRDTestKit
+  module V201
+    class ClientOrderDispatchGroup < Inferno::TestGroup
+      title 'order-dispatch'
+      id :crd_v201_client_order_dispatch
+      description <<~DESCRIPTION
+        The order-dispatch hook fires when a practitioner is selecting a candidate performer for a pre-existing order
+        that was not tied to a specific performer. These tests are based on the following criteria:
+          * [CRD IG requirements for this hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch),
+          which includes the profiles that are expected to be used for the resources resolved to by `context`
+          FHIR ID fields
+          * Specific [order-dispatch `context` requirements](https://cds-hooks.hl7.org/hooks/order-dispatch/2023SepSTU1Ballot/order-dispatch/)
+          defined in the CDS Hooks specification
+
+        This version of the CRD implementation guide refers to version 1.0 of the hook.
+      DESCRIPTION
+
+      run_as_group
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      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 },
+          override_access_token: { name: :order_dispatch_override_access_token,
+                                   title: 'order-dispatch Prefetch Validation Override Bearer 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_json: { name: :order_dispatch_crd_jwks_json },
+          crd_jwks_keys_json: { name: :order_dispatch_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'order-dispatch',
+          hook_path: ORDER_DISPATCH_PATH
+        }
+      )
+
+      group do
+        title 'Make Hook Requests'
+        test from: :crd_v201_order_dispatch_request
+      end
+
+      group do
+        title 'Verify Authorization'
+        test from: :crd_v201_decode_auth_token
+        test from: :crd_v201_retrieve_jwks
+        test from: :crd_v201_token_header
+        test from: :crd_v201_token_payload
+      end
+
+      group do
+        title 'Verify Requests'
+        test from: :crd_v201_hook_request_required_fields
+        test from: :crd_v201_hook_request_optional_fields
+        test from: :crd_v201_hook_request_valid_context do
+          verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@150',
+                                'hl7.fhir.us.davinci-crd_2.0.1@284', 'hl7.fhir.us.davinci-crd_2.0.1@285',
+                                'hl7.fhir.us.davinci-crd_2.0.1@286', 'hl7.fhir.us.davinci-crd_2.0.1@287',
+                                'hl7.fhir.us.davinci-crd_2.0.1@288', 'hl7.fhir.us.davinci-crd_2.0.1@289',
+                                'hl7.fhir.us.davinci-crd_2.0.1@290', 'hl7.fhir.us.davinci-crd_2.0.1@291',
+                                'hl7.fhir.us.davinci-crd_2.0.1@292', 'hl7.fhir.us.davinci-crd_2.0.1@293',
+                                'hl7.fhir.us.davinci-crd_2.0.1@294', 'hl7.fhir.us.davinci-crd_2.0.1@295',
+                                'cds-hooks-library_1.0.1@57', 'cds-hooks-library_1.0.1@58',
+                                'cds-hooks-library_1.0.1@59', 'cds-hooks-library_1.0.1@61',
+                                'cds-hooks-library_1.0.1@62', 'cds-hooks-library_1.0.1@63',
+                                'cds-hooks-library_1.0.1@65', 'cds-hooks-library_1.0.1@66',
+                                'cds-hooks-library_1.0.1@67', 'cds-hooks-library_1.0.1@69',
+                                'cds-hooks-library_1.0.1@70', 'cds-hooks-library_1.0.1@71',
+                                'cds-hooks-library_1.0.1@72'
+        end
+        test from: :crd_v201_hook_request_valid_prefetch
+        test from: :crd_v201_hook_request_fetched_data
+        test from: :crd_v201_hook_request_prefetch_equals_queried
+      end
+
+      group do
+        title 'Verify Response Handling'
+
+        test from: :crd_v201_inferno_response_validation
+        test from: :crd_v201_card_display_attest_test
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+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_optional_fields_test'
+require_relative 'verify_request/hook_request_required_fields_test'
+require_relative 'verify_request/hook_request_valid_context_test'
+require_relative 'verify_request/hook_request_valid_prefetch_test'
+require_relative 'verify_request/hook_request_fetched_data_test'
+require_relative 'verify_request/hook_request_prefetch_equals_queried_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+
+module DaVinciCRDTestKit
+  module V201
+    class ClientOrderSelectGroup < Inferno::TestGroup
+      title 'order-select'
+      id :crd_v201_client_order_select
+      description <<~DESCRIPTION
+        The order-select hook fires when a clinician selects one or more orders to place for a patient,
+        (including orders for medications, procedures, labs and other orders). If supported by the CDS client, this
+        hook may also be invoked each time the clinician selects a detail regarding the order. These tests are based on
+        the following criteria:
+          * [CRD IG requirements for this hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-selecte),
+          which includes the profiles that are expected to be used for the resources resolved to by `context`
+          FHIR ID fields
+          * Specific [order-select `context` requirements](https://cds-hooks.hl7.org/hooks/order-select/2023SepSTU1Ballot/order-select/)
+          defined in the CDS Hooks specification
+
+        This version of the CRD implementation guide refers to version 1.0 of the hook.
+      DESCRIPTION
+
+      run_as_group
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      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 },
+          override_access_token: { name: :order_select_override_access_token,
+                                   title: 'order-select Prefetch Validation Override Bearer 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_json: { name: :order_select_crd_jwks_json },
+          crd_jwks_keys_json: { name: :order_select_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'order-select',
+          hook_path: ORDER_SELECT_PATH
+        }
+      )
+
+      group do
+        title 'Make Hook Requests'
+        test from: :crd_v201_order_select_request
+      end
+
+      group do
+        title 'Verify Authorization'
+        test from: :crd_v201_decode_auth_token
+        test from: :crd_v201_retrieve_jwks
+        test from: :crd_v201_token_header
+        test from: :crd_v201_token_payload
+      end
+
+      group do
+        title 'Verify Requests'
+        test from: :crd_v201_hook_request_required_fields
+        test from: :crd_v201_hook_request_optional_fields
+        test from: :crd_v201_hook_request_valid_context do
+          verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@71', 'hl7.fhir.us.davinci-crd_2.0.1@150',
+                                'hl7.fhir.us.davinci-crd_2.0.1@212', 'hl7.fhir.us.davinci-crd_2.0.1@213',
+                                'hl7.fhir.us.davinci-crd_2.0.1@214', 'hl7.fhir.us.davinci-crd_2.0.1@215',
+                                'hl7.fhir.us.davinci-crd_2.0.1@284', 'hl7.fhir.us.davinci-crd_2.0.1@285',
+                                'hl7.fhir.us.davinci-crd_2.0.1@286', 'hl7.fhir.us.davinci-crd_2.0.1@287',
+                                'hl7.fhir.us.davinci-crd_2.0.1@288', 'hl7.fhir.us.davinci-crd_2.0.1@289',
+                                'hl7.fhir.us.davinci-crd_2.0.1@290', 'hl7.fhir.us.davinci-crd_2.0.1@291',
+                                'hl7.fhir.us.davinci-crd_2.0.1@292', 'hl7.fhir.us.davinci-crd_2.0.1@293',
+                                'hl7.fhir.us.davinci-crd_2.0.1@294', 'hl7.fhir.us.davinci-crd_2.0.1@295',
+                                'cds-hooks-library_1.0.1@74', 'cds-hooks-library_1.0.1@75',
+                                'cds-hooks-library_1.0.1@76', 'cds-hooks-library_1.0.1@78',
+                                'cds-hooks-library_1.0.1@79', 'cds-hooks-library_1.0.1@80',
+                                'cds-hooks-library_1.0.1@82', 'cds-hooks-library_1.0.1@83',
+                                'cds-hooks-library_1.0.1@84', 'cds-hooks-library_1.0.1@86',
+                                'cds-hooks-library_1.0.1@87', 'cds-hooks-library_1.0.1@88',
+                                'cds-hooks-library_1.0.1@90', 'cds-hooks-library_1.0.1@91',
+                                'cds-hooks-library_1.0.1@92'
+        end
+        test from: :crd_v201_hook_request_valid_prefetch
+        test from: :crd_v201_hook_request_fetched_data
+        test from: :crd_v201_hook_request_prefetch_equals_queried
+      end
+
+      group do
+        title 'Verify Response Handling'
+
+        test from: :crd_v201_inferno_response_validation
+        test from: :crd_v201_card_display_attest_test
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.0.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_optional_fields_test'
+require_relative 'verify_request/hook_request_required_fields_test'
+require_relative 'verify_request/hook_request_valid_context_test'
+require_relative 'verify_request/hook_request_valid_prefetch_test'
+require_relative 'verify_request/hook_request_fetched_data_test'
+require_relative 'verify_request/hook_request_prefetch_equals_queried_test'
+require_relative 'verify_response/inferno_response_validation'
+require_relative 'verify_response/client_display_cards_attest'
+
+module DaVinciCRDTestKit
+  module V201
+    class ClientOrderSignGroup < Inferno::TestGroup
+      title 'order-sign'
+      id :crd_v201_client_order_sign
+      description <<~DESCRIPTION
+        The order-sign 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). These tests are based on the following criteria:
+          * [CRD IG requirements for this hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign),
+          which includes the profiles that are expected to be used for the resources resolved to by `context`
+          FHIR ID fields
+          * Specific [order-sign `context` requirements](https://cds-hooks.org/hooks/order-sign/)
+          defined in the CDS Hooks specification
+
+        This version of the CRD implementation guide refers to version 1.1 of the hook which, at the time of publication,
+        was not available as a snapshot. Therefore the preceding link refers to the CDS hooks current build.
+      DESCRIPTION
+
+      run_as_group
+
+      input_order :cds_jwt_iss, :cds_jwk_set
+
+      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 },
+          override_access_token: { name: :order_sign_override_access_token,
+                                   title: 'order-sign Prefetch Validation Override Bearer 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_json: { name: :order_sign_crd_jwks_json },
+          crd_jwks_keys_json: { name: :order_sign_crd_jwks_keys_json }
+        },
+        options: {
+          hook_name: 'order-sign',
+          hook_path: ORDER_SIGN_PATH
+        }
+      )
+
+      group do
+        title 'Make Hook Requests'
+        test from: :crd_v201_order_sign_request
+      end
+
+      group do
+        title 'Verify Authorization'
+        test from: :crd_v201_decode_auth_token
+        test from: :crd_v201_retrieve_jwks
+        test from: :crd_v201_token_header
+        test from: :crd_v201_token_payload
+      end
+
+      group do
+        title 'Verify Requests'
+        test from: :crd_v201_hook_request_required_fields
+        test from: :crd_v201_hook_request_optional_fields
+        test from: :crd_v201_hook_request_valid_context do
+          verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@71', 'hl7.fhir.us.davinci-crd_2.0.1@150',
+                                'hl7.fhir.us.davinci-crd_2.0.1@220', 'hl7.fhir.us.davinci-crd_2.0.1@221',
+                                'hl7.fhir.us.davinci-crd_2.0.1@222', 'hl7.fhir.us.davinci-crd_2.0.1@223',
+                                'hl7.fhir.us.davinci-crd_2.0.1@284', 'hl7.fhir.us.davinci-crd_2.0.1@285',
+                                'hl7.fhir.us.davinci-crd_2.0.1@286', 'hl7.fhir.us.davinci-crd_2.0.1@287',
+                                'hl7.fhir.us.davinci-crd_2.0.1@288', 'hl7.fhir.us.davinci-crd_2.0.1@289',
+                                'hl7.fhir.us.davinci-crd_2.0.1@290', 'hl7.fhir.us.davinci-crd_2.0.1@291',
+                                'hl7.fhir.us.davinci-crd_2.0.1@292', 'hl7.fhir.us.davinci-crd_2.0.1@293',
+                                'hl7.fhir.us.davinci-crd_2.0.1@294', 'hl7.fhir.us.davinci-crd_2.0.1@295',
+                                'cds-hooks-library_1.0.1@1', 'cds-hooks-library_1.0.1@2',
+                                'cds-hooks-library_1.0.1@3', 'cds-hooks-library_1.0.1@5',
+                                'cds-hooks-library_1.0.1@6', 'cds-hooks-library_1.0.1@7',
+                                'cds-hooks-library_1.0.1@9', 'cds-hooks-library_1.0.1@10',
+                                'cds-hooks-library_1.0.1@11', 'cds-hooks-library_1.0.1@13',
+                                'cds-hooks-library_1.0.1@14', 'cds-hooks-library_1.0.1@15'
+        end
+        test from: :crd_v201_hook_request_valid_prefetch
+        test from: :crd_v201_hook_request_fetched_data
+        test from: :crd_v201_hook_request_prefetch_equals_queried
+      end
+
+      group do
+        title 'Verify Response Handling'
+
+        test from: :crd_v201_inferno_response_validation
+        test from: :crd_v201_card_display_attest_test
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/{client_registration_group.rb → client/v2.0.1/client_registration_group.rb}

@@ -1,11 +1,13 @@
-require_relative 'client_tests/client_registration_verification_test'
+require_relative 'registration/client_registration_verification_test'
+require_relative 'registration/client_service_registration_attestation_test'
 
 module DaVinciCRDTestKit
-  class PASClientRegistrationGroup < Inferno::TestGroup
-    id :crd_client_registration
-    title 'Client Registration'
-    description %(
-        Register the CRD client under test with Inferno's simulated CRD Server by
+  module V201
+    class PASClientRegistrationGroup < Inferno::TestGroup
+      id :crd_v201_client_registration
+      title 'Client Registration'
+      description %(
+        Register the CRD client under test with Inferno's simulated CRD server by
         providing required information for Inferno to use in identifying and verify
         hook requests.
 
@@ -19,8 +21,10 @@ module DaVinciCRDTestKit
         of the client under test with the Inferno service. If the client needs to make a
         change to its registered values during execution, this test will need to be re-run.
       )
-    run_as_group
+      run_as_group
 
-    test from: :crd_client_registration_verification
+      test from: :crd_v201_client_registration_verification
+      test from: :crd_v201_client_service_registration_attestation
+    end
   end
 end

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

@@ -0,0 +1,13 @@
+require_relative '../client_base_urls'
+
+module DaVinciCRDTestKit
+  module V201
+    module ClientURLs
+      include ClientBaseURLs
+
+      def suite_id
+        DaVinciCRDTestKit::V201::CRDClientSuite.id
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.0.1/crd_client_suite.rb

@@ -0,0 +1,134 @@
+require_relative 'client_fhir_api_group'
+require_relative 'client_hooks_group'
+require_relative 'client_card_must_support_group'
+require_relative 'client_registration_group'
+require_relative '../endpoints/cds_services_discovery_handler'
+require_relative '../../cross_suite/tags'
+require_relative 'client_urls'
+require_relative '../crd_client_options'
+require_relative '../endpoints/hook_request_endpoint'
+require_relative '../../ext/inferno_core/runnable'
+
+module DaVinciCRDTestKit
+  module V201
+    class CRDClientSuite < Inferno::TestSuite
+      id :crd_client
+      title 'Da Vinci CRD Client v2.0.1 Test Suite'
+      description <<~DESCRIPTION
+        The Da Vinci CRD Client Test Suite tests the conformance of client systems
+        to [version 2.0.1 of the Da Vinci Coverage Requirements Discovery (CRD)
+        Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2).
+
+        For details on the design and use of these tests, see the wiki including
+        - [Suite Details](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details)
+          for a high-level description of the test
+          organization, including its components and limitations.
+        - [Testing Instructions](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Instructions)
+          for a step-by-step guide to execution of these
+          tests against a CRD client, including [instructions for a demonstration execution](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Instructions#demonstration-execution)
+          against the [public reference implementation](https://crd-request-generator.davinci.hl7.org/).
+      DESCRIPTION
+
+      suite_summary <<~SUMMARY
+        The Da Vinci CRD Client Test Suite tests the conformance of client systems
+        to [version 2.0.1 of the Da Vinci Coverage Requirements Discovery (CRD)
+        Implementation Guide](https://hl7.org/fhir/us/davinci-crd/STU2).
+      SUMMARY
+
+      links [
+        {
+          label: 'Report Issue',
+          url: 'https://github.com/inferno-framework/davinci-crd-test-kit/issues'
+        },
+        {
+          label: 'Open Source',
+          url: 'https://github.com/inferno-framework/davinci-crd-test-kit'
+        },
+        {
+          label: 'Download',
+          url: 'https://github.com/inferno-framework/davinci-crd-test-kit/releases'
+        }
+      ]
+
+      requirement_sets(
+        {
+          identifier: 'hl7.fhir.us.davinci-crd_2.0.1',
+          title: 'Da Vinci Coverage Requirements Discovery (CRD) v2.0.1',
+          actor: 'Client'
+        },
+        {
+          identifier: 'cds-hooks_2.0',
+          title: 'CDS Hooks',
+          actor: 'Client'
+        },
+        {
+          identifier: 'cds-hooks-library_1.0.1',
+          title: 'CDS Hooks Library',
+          actor: 'Client',
+          requirements: 'referenced'
+        }
+      )
+
+      fhir_resource_validator do
+        igs('hl7.fhir.us.davinci-crd#2.0.1')
+
+        validation_context do
+          snomedCT '731000124108' # explicit snomedCT expansion parameter
+        end
+
+        exclude_message do |message|
+          message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
+        end
+      end
+
+      suite_option :smart_app_launch_version,
+                   title: 'SMART App Launch Version',
+                   list_options: [
+                     {
+                       label: 'SMART App Launch 1.0.0',
+                       value: CRDClientOptions::SMART_1
+                     },
+                     {
+                       label: 'SMART App Launch 2.0.0',
+                       value: CRDClientOptions::SMART_2
+                     }
+                   ]
+
+      def self.extract_token_from_query_params(request)
+        request.query_parameters['token']
+      end
+
+      route :get, '/cds-services', CDSServicesDiscoveryHandler
+      allow_cors APPOINTMENT_BOOK_PATH, ENCOUNTER_START_PATH, ENCOUNTER_DISCHARGE_PATH, ORDER_DISPATCH_PATH,
+                 ORDER_SELECT_PATH, ORDER_SIGN_PATH, '/cds-services'
+      suite_endpoint :post, APPOINTMENT_BOOK_PATH, HookRequestEndpoint
+      suite_endpoint :post, ENCOUNTER_START_PATH, HookRequestEndpoint
+      suite_endpoint :post, ENCOUNTER_DISCHARGE_PATH, HookRequestEndpoint
+      suite_endpoint :post, ORDER_DISPATCH_PATH, HookRequestEndpoint
+      suite_endpoint :post, ORDER_SELECT_PATH, HookRequestEndpoint
+      suite_endpoint :post, ORDER_SIGN_PATH, HookRequestEndpoint
+
+      resume_test_route :get, RESUME_PASS_PATH do |request|
+        CRDClientSuite.extract_token_from_query_params(request)
+      end
+      resume_test_route :get, RESUME_FAIL_PATH, result: 'fail' do |request|
+        CRDClientSuite.extract_token_from_query_params(request)
+      end
+
+      group do
+        id :crd_v201_client_hook_invocation
+        title 'Hook Invocation'
+        description %(
+          This group checks that the system can register as a CDS client with
+          Inferno's simulated CRD server and make hook invocations.
+        )
+
+        group from: :crd_v201_client_registration
+        group from: :crd_v201_client_hooks
+        group from: :crd_v201_client_card_must_support
+      end
+
+      group from: :crd_v201_client_fhir_api
+    end
+  end
+end