davinci_crd_test_kit 0.13.0 → 0.14.0

data/lib/davinci_crd_test_kit/client_hooks_group.rb

@@ -1,74 +0,0 @@
-require_relative 'client_tests/client_appointment_book_group'
-require_relative 'client_tests/client_encounter_discharge_group'
-require_relative 'client_tests/client_encounter_start_group'
-require_relative 'client_tests/client_order_dispatch_group'
-require_relative 'client_tests/client_order_select_group'
-require_relative 'client_tests/client_order_sign_group'
-
-require_relative 'jwt_helper'
-require_relative 'urls'
-
-module DaVinciCRDTestKit
-  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 the required fields listed in the [CDS Hooks HTTP request requirements](https://cds-hooks.hl7.org/2.0/#http-request_1)
-      * OPTIONAL: If the incoming hook request contains the 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
-      * OPTIONAL: If the incoming hook contains the optional `prefetch` field with valid resources
-      * If the client can properly display the cards returned as a result of the hook request
-
-      Note: In order to successfully return a `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_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_client_appointment_book,
-          optional: true
-
-    group from: :crd_client_encounter_start,
-          optional: true
-
-    group from: :crd_client_encounter_discharge,
-          optional: true
-
-    group from: :crd_client_order_select,
-          optional: true
-
-    group from: :crd_client_order_dispatch,
-          optional: true
-
-    group from: :crd_client_order_sign,
-          optional: true
-  end
-end

data/lib/davinci_crd_test_kit/client_tests/appointment_book_receive_request_test.rb

@@ -1,93 +0,0 @@
-require_relative '../urls'
-
-module DaVinciCRDTestKit
-  class AppointmentBookReceiveRequestTest < Inferno::Test
-    include URLs
-
-    id :crd_appointment_book_request
-    title 'Request received for appointment-book hook'
-    description %(
-        This test waits for multiple incoming [appointment-book](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book)
-        hook requests and responds to the client with the response types selected as an input. This hook is a 'primary'
-        hook, meaning that CRD Servers SHALL, at minimum, return a [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-ext-coverage-information.html)
-        system action for these hooks, even if the response indicates that further information is needed or that the
-        level of detail provided is insufficient to determine coverage.
-      )
-    config options: { accepts_multiple_requests: true }
-    verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@171',
-                          'hl7.fhir.us.davinci-crd_2.0.1@183', 'hl7.fhir.us.davinci-crd_2.0.1@243',
-                          'hl7.fhir.us.davinci-crd_2.0.1@244', 'hl7.fhir.us.davinci-crd_2.0.1@245'
-
-    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 :appointment_book_selected_response_types,
-          title: 'Response types to return from appointment-book hook requests',
-          description: %(
-            Select the cards/action response types that the Inferno hook request endpoints will return. The default
-            response type that will be returned for this hook is the `Coverage Information` card type.
-          ),
-          type: 'checkbox',
-          default: ['coverage_information', 'external_reference', 'instructions'],
-          optional: true,
-          options: {
-            list_options: [
-              {
-                label: 'External Reference',
-                value: 'external_reference'
-              },
-              {
-                label: 'Instructions',
-                value: 'instructions'
-              },
-              {
-                label: 'Coverage Information',
-                value: 'coverage_information'
-              },
-              {
-                label: 'Request Form Completion',
-                value: 'request_form_completion'
-              },
-              {
-                label: 'Create/Update Coverage Information',
-                value: 'create_update_coverage_info'
-              },
-              {
-                label: 'Launch SMART Application',
-                value: 'launch_smart_app'
-              }
-            ]
-          }
-    input :appointment_book_custom_response,
-          title: 'Custom response for appointment-book hook requests',
-          description: %(
-            A JSON string may be provided here to replace the normal response
-            from the hook request endpoint
-          ),
-          type: 'textarea',
-          optional: true
-
-    run do
-      wait(
-        identifier: "appointment-book #{cds_jwt_iss}",
-        message: %(
-          **Appointment Book CDS Service Test**:
-
-          Invoke the appointment-book hook and send requests to:
-
-          `#{appointment_book_url}`
-
-          Inferno will process the requests and return CDS cards if successful.
-
-          [Click here](#{resume_pass_url}?token=appointment-book%20#{cds_jwt_iss}) when you have finished
-          submitting requests.
-        )
-      )
-    end
-  end
-end

data/lib/davinci_crd_test_kit/client_tests/client_appointment_book_group.rb

@@ -1,75 +0,0 @@
-require_relative 'appointment_book_receive_request_test'
-require_relative 'client_display_cards_attest'
-require_relative 'decode_auth_token_test'
-require_relative 'hook_request_optional_fields_test'
-require_relative 'hook_request_required_fields_test'
-require_relative 'hook_request_valid_context_test'
-require_relative 'hook_request_valid_prefetch_test'
-require_relative 'retrieve_jwks_test'
-require_relative 'submitted_response_validation'
-require_relative 'token_header_test'
-require_relative 'token_payload_test'
-
-module DaVinciCRDTestKit
-  class ClientAppointmentBookGroup < Inferno::TestGroup
-    title 'appointment-book'
-    id :crd_client_appointment_book
-    description <<~DESCRIPTION
-      The appointment-book hook is invoked when the user is scheduling one or more future encounters/visits for the
-      patient. These tests are based on the following criteria:
-        * [CRD IG requirements for this hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book),
-        which include the profiles that are expected to be used for the resources resolved to by `context` FHIR ID
-        fields
-        * Specific [appointment-book `context` requirements](https://cds-hooks.hl7.org/hooks/appointment-book/2023SepSTU1Ballot/appointment-book/)
-        defined in the CDS Hooks specification
-
-      This version of the CRD implementation guide refers to version 1.0 of the hook.
-    DESCRIPTION
-    verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@172'
-
-    run_as_group
-
-    input_order :cds_jwt_iss, :cds_jwk_set
-
-    config(
-      inputs: {
-        auth_token_headers_json: { name: :appointment_book_auth_token_headers_json },
-        auth_tokens: { name: :appointment_book_auth_tokens },
-        auth_tokens_jwk_json: { name: :appointment_book_auth_tokens_jwk_json },
-        client_access_token: { name: :appointment_book_client_access_token },
-        client_fhir_server: { name: :appointment_book_client_fhir_server },
-        crd_jwks_keys_json: { name: :appointment_book_crd_jwks_keys_json },
-        custom_response: { name: :appointment_book_custom_response },
-        selected_response_types: { name: :appointment_book_selected_response_types }
-      },
-      outputs: {
-        auth_token_headers_json: { name: :appointment_book_auth_token_headers_json },
-        auth_token_payloads_json: { name: :appointment_book_auth_token_payloads_json },
-        auth_tokens: { name: :appointment_book_auth_tokens },
-        auth_tokens_jwk_json: { name: :appointment_book_auth_tokens_jwk_json },
-        client_access_token: { name: :appointment_book_client_access_token },
-        client_fhir_server: { name: :appointment_book_client_fhir_server },
-        crd_jwks_json: { name: :appointment_book_crd_jwks_json },
-        crd_jwks_keys_json: { name: :appointment_book_crd_jwks_keys_json }
-      },
-      options: {
-        hook_name: 'appointment-book',
-        hook_path: APPOINTMENT_BOOK_PATH
-      }
-    )
-
-    test from: :crd_submitted_response_validation
-    test from: :crd_appointment_book_request
-    test from: :crd_decode_auth_token
-    test from: :crd_retrieve_jwks
-    test from: :crd_token_header
-    test from: :crd_token_payload
-    test from: :crd_hook_request_required_fields
-    test from: :crd_hook_request_optional_fields
-    test from: :crd_hook_request_valid_context do
-      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@71', 'hl7.fhir.us.davinci-crd_2.0.1@286'
-    end
-    test from: :crd_hook_request_valid_prefetch
-    test from: :crd_card_display_attest_test
-  end
-end

data/lib/davinci_crd_test_kit/client_tests/client_display_cards_attest.rb

@@ -1,48 +0,0 @@
-require_relative '../urls'
-
-module DaVinciCRDTestKit
-  class ClientCardDisplayAttest < Inferno::Test
-    include URLs
-
-    id :crd_card_display_attest_test
-    title 'Check that Cards returned are displayed to the user'
-
-    input :selected_response_types,
-          type: 'checkbox'
-
-    def format_selected_response_types
-      selected_response_types
-        .map do |response_type|
-        response_type_string =
-          response_type.split('_')
-            .map(&:capitalize)
-            .join(' ')
-            .prepend('- ')
-            .sub('Smart', 'SMART')
-            .sub('Create Update', 'Create/Update')
-            .sub('Companions Prerequisites', 'Companions/Prerequisites')
-        response_type_string
-      end
-        .join("\n")
-    end
-
-    run do
-      identifier = SecureRandom.hex(32)
-      wait(
-        identifier:,
-        message: <<~MESSAGE
-          **Approval Workflow Test**:
-
-          I attest that the following CDS response types were returned and that the client system displays
-          each of the CDS Service Cards to the user:
-
-          #{format_selected_response_types}
-
-          [Click here](#{resume_pass_url}?token=#{identifier}) if the above statement is **true**.
-
-          [Click here](#{resume_fail_url}?token=#{identifier}) if the above statement is **false**.
-        MESSAGE
-      )
-    end
-  end
-end

data/lib/davinci_crd_test_kit/client_tests/client_encounter_discharge_group.rb

@@ -1,73 +0,0 @@
-require_relative 'encounter_discharge_receive_request_test'
-require_relative 'client_display_cards_attest'
-require_relative 'decode_auth_token_test'
-require_relative 'hook_request_optional_fields_test'
-require_relative 'hook_request_required_fields_test'
-require_relative 'hook_request_valid_context_test'
-require_relative 'hook_request_valid_prefetch_test'
-require_relative 'retrieve_jwks_test'
-require_relative 'submitted_response_validation'
-require_relative 'token_header_test'
-require_relative 'token_payload_test'
-
-module DaVinciCRDTestKit
-  class ClientEncounterDischargeGroup < Inferno::TestGroup
-    title 'encounter-discharge'
-    id :crd_client_encounter_discharge
-    description <<~DESCRIPTION
-      The encounter-discharge hook is invoked when the user is performing the discharge process for an encounter where
-      the notion of 'discharge' is relevant - typically an inpatient encounter. These tests are based on the
-      following criteria:
-        * [CRD IG requirements for this hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge),
-        which includes the profiles that are expected to be used for the resources resolved to by `context`
-        FHIR ID fields
-        * Specific [encounter-discharge `context` requirements](https://cds-hooks.hl7.org/hooks/encounter-discharge/2023SepSTU1Ballot/encounter-discharge/)
-        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: :encounter_discharge_auth_token_headers_json },
-        auth_tokens: { name: :encounter_discharge_auth_tokens },
-        auth_tokens_jwk_json: { name: :encounter_discharge_auth_tokens_jwk_json },
-        client_access_token: { name: :encounter_discharge_client_access_token },
-        client_fhir_server: { name: :encounter_discharge_client_fhir_server },
-        crd_jwks_keys_json: { name: :encounter_discharge_crd_jwks_keys_json },
-        custom_response: { name: :encounter_discharge_custom_response },
-        selected_response_types: { name: :encounter_discharge_selected_response_types }
-      },
-      outputs: {
-        auth_token_headers_json: { name: :encounter_discharge_auth_token_headers_json },
-        auth_token_payloads_json: { name: :encounter_discharge_auth_token_payloads_json },
-        auth_tokens: { name: :encounter_discharge_auth_tokens },
-        auth_tokens_jwk_json: { name: :encounter_discharge_auth_tokens_jwk_json },
-        client_access_token: { name: :encounter_discharge_client_access_token },
-        client_fhir_server: { name: :encounter_discharge_client_fhir_server },
-        crd_jwks_json: { name: :encounter_discharge_crd_jwks_json },
-        crd_jwks_keys_json: { name: :encounter_discharge_crd_jwks_keys_json }
-      },
-      options: {
-        hook_name: 'encounter-discharge',
-        hook_path: ENCOUNTER_DISCHARGE_PATH
-      }
-    )
-
-    test from: :crd_submitted_response_validation
-    test from: :crd_encounter_discharge_request
-    test from: :crd_decode_auth_token
-    test from: :crd_retrieve_jwks
-    test from: :crd_token_header
-    test from: :crd_token_payload
-    test from: :crd_hook_request_required_fields
-    test from: :crd_hook_request_optional_fields
-    test from: :crd_hook_request_valid_context
-    test from: :crd_hook_request_valid_prefetch
-    test from: :crd_card_display_attest_test
-  end
-end

data/lib/davinci_crd_test_kit/client_tests/client_encounter_start_group.rb

@@ -1,73 +0,0 @@
-require_relative 'encounter_start_receive_request_test'
-require_relative 'client_display_cards_attest'
-require_relative 'decode_auth_token_test'
-require_relative 'hook_request_optional_fields_test'
-require_relative 'hook_request_required_fields_test'
-require_relative 'hook_request_valid_context_test'
-require_relative 'hook_request_valid_prefetch_test'
-require_relative 'retrieve_jwks_test'
-require_relative 'submitted_response_validation'
-require_relative 'token_header_test'
-require_relative 'token_payload_test'
-
-module DaVinciCRDTestKit
-  class ClientEncounterStartGroup < Inferno::TestGroup
-    title 'encounter-start'
-    id :crd_client_encounter_start
-    description <<~DESCRIPTION
-      The encounter-start hook is invoked when the user is initiating a new encounter. These tests are based on the
-      following criteria:
-        * [CRD IG requirements for this hook](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start),
-        which include the profiles that are expected to be used for the resources resolved to by `context` FHIR ID
-        fields
-        * Specific [encounter-start `context` requirements](https://cds-hooks.hl7.org/hooks/encounter-start/2023SepSTU1Ballot/encounter-start/)
-        defined in the CDS Hooks specification
-
-      This version of the CRD implementation guide refers to version 1.0 of the hook.
-    DESCRIPTION
-    verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@187'
-
-    run_as_group
-
-    input_order :cds_jwt_iss, :cds_jwk_set
-
-    config(
-      inputs: {
-        auth_token_headers_json: { name: :encounter_start_auth_token_headers_json },
-        auth_tokens: { name: :encounter_start_auth_tokens },
-        auth_tokens_jwk_json: { name: :encounter_start_auth_tokens_jwk_json },
-        client_access_token: { name: :encounter_start_client_access_token },
-        client_fhir_server: { name: :encounter_start_client_fhir_server },
-        crd_jwks_keys_json: { name: :encounter_start_crd_jwks_keys_json },
-        custom_response: { name: :encounter_start_custom_response },
-        selected_response_types: { name: :encounter_start_selected_response_types }
-      },
-      outputs: {
-        auth_token_headers_json: { name: :encounter_start_auth_token_headers_json },
-        auth_token_payloads_json: { name: :encounter_start_auth_token_payloads_json },
-        auth_tokens: { name: :encounter_start_auth_tokens },
-        auth_tokens_jwk_json: { name: :encounter_start_auth_tokens_jwk_json },
-        client_access_token: { name: :encounter_start_client_access_token },
-        client_fhir_server: { name: :encounter_start_client_fhir_server },
-        crd_jwks_json: { name: :encounter_start_crd_jwks_json },
-        crd_jwks_keys_json: { name: :encounter_start_crd_jwks_keys_json }
-      },
-      options: {
-        hook_name: 'encounter-start',
-        hook_path: ENCOUNTER_START_PATH
-      }
-    )
-
-    test from: :crd_submitted_response_validation
-    test from: :crd_encounter_start_request
-    test from: :crd_decode_auth_token
-    test from: :crd_retrieve_jwks
-    test from: :crd_token_header
-    test from: :crd_token_payload
-    test from: :crd_hook_request_required_fields
-    test from: :crd_hook_request_optional_fields
-    test from: :crd_hook_request_valid_context
-    test from: :crd_hook_request_valid_prefetch
-    test from: :crd_card_display_attest_test
-  end
-end

data/lib/davinci_crd_test_kit/client_tests/client_fhir_api_create_test.rb

@@ -1,42 +0,0 @@
-module DaVinciCRDTestKit
-  class ClientFHIRApiCreateTest < Inferno::Test
-    id :crd_client_fhir_api_create_test
-    title 'Create Interaction'
-    description %(
-        Verify that the CRD client supports the create interaction for the given resource. The capabilities required
-        by each resource can be found here: https://hl7.org/fhir/us/davinci-crd/CapabilityStatement-crd-client.html#resourcesSummary1
-      )
-    verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@74'
-
-    input :create_resources,
-          type: 'textarea',
-          description: 'Provide a list of resources to create. e.g., [json_resource_1, json_resource_2]',
-          optional: true
-
-    def resource_type
-      config.options[:resource_type]
-    end
-
-    run do
-      skip_if create_resources.blank?, 'Provide a list of resources to create to run this test.'
-      assert_valid_json(create_resources)
-      create_resources_list = JSON.parse(create_resources)
-      skip_if(!create_resources_list.is_a?(Array), 'Resources to create not inputted in list format, skipping test.')
-
-      valid_create_resources =
-        create_resources_list
-          .compact_blank
-          .map { |resource| FHIR.from_contents(resource.to_json) }
-          .select { |resource| resource.resourceType == resource_type }
-          .select { |resource| resource_is_valid?(resource:) }
-
-      skip_if(valid_create_resources.blank?,
-              %(No valid #{resource_type} resources were provided to send in Create requests, skipping test.))
-
-      valid_create_resources.each do |create_resource|
-        fhir_create(create_resource)
-        assert_response_status(201)
-      end
-    end
-  end
-end

data/lib/davinci_crd_test_kit/client_tests/client_fhir_api_read_test.rb

@@ -1,40 +0,0 @@
-module DaVinciCRDTestKit
-  class ClientFHIRApiReadTest < Inferno::Test
-    id :crd_client_fhir_api_read_test
-    title 'Read Interaction'
-    description %(
-        Verify that the CRD client supports the read interaction for the given resource. The capabilities required by
-        each resource can be found here: https://hl7.org/fhir/us/davinci-crd/CapabilityStatement-crd-client.html#resourcesSummary1
-      )
-
-    input :resource_ids,
-          optional: true
-
-    def resource_type
-      config.options[:resource_type]
-    end
-
-    def no_resources_skip_message
-      "No #{resource_type} resource ids were provided, skipping test. "
-    end
-
-    def bad_resource_id_message(expected_id)
-      "Expected resource to have id: `#{expected_id}`, but found `#{resource.id}`"
-    end
-
-    run do
-      skip_if resource_ids.blank?, no_resources_skip_message
-
-      resource_id_list = resource_ids.split(',').map(&:strip)
-      assert resource_id_list.present?, "No #{resource_type} id provided."
-
-      resource_id_list.each do |resource_id_to_read|
-        fhir_read resource_type, resource_id_to_read, tags: [resource_type, 'read']
-
-        assert_response_status(200)
-        assert_resource_type(resource_type)
-        assert resource.id.present? && resource.id == resource_id_to_read, bad_resource_id_message(resource_id_to_read)
-      end
-    end
-  end
-end