davinci_crd_test_kit 0.12.2 → 0.14.0

data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/appointment_book_receive_request_test.rb

@@ -0,0 +1,129 @@
+require_relative '../client_urls'
+
+module DaVinciCRDTestKit
+  module V201
+    class AppointmentBookReceiveRequestTest < Inferno::Test
+      include ClientURLs
+
+      id :crd_v201_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.
+
+        For more details on how Inferno's simulated CDS Service behave during hook invocation see the
+        [simulated CRD server(https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details#crd-server-simulation)
+        documentation.
+      )
+      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',
+                            'cds-hooks_2.0@15'
+
+      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_response_approach,
+            title: 'Response generation approach for appointment-book',
+            description: %(
+              Determines how Inferno will generate response for appointment-book
+              hook invocations.
+            ),
+            type: 'radio',
+            default: 'mocked',
+            options: {
+              list_options: [
+                {
+                  label: 'Create simple mocks based on selected response types',
+                  value: 'mocked'
+                },
+                {
+                  label: 'Generate responses based on a tester-provided template',
+                  value: 'custom'
+                }
+              ]
+            }
+      input :appointment_book_selected_response_types,
+            title: 'Response types to return from appointment-book hook requests',
+            description: %(
+              Select the CRD response types that the simulated Inferno CRD server will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses)
+              when responding to hook invocations. If no types are selected, Inferno will mock and return
+              a [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#coverage-information-response-type)
+              response for this primary hook.
+            ),
+            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'
+                }
+              ]
+            },
+            enable_when: { input_name: 'appointment_book_response_approach', value: 'mocked' }
+      input :appointment_book_custom_response_template,
+            title: 'Custom response template for appointment-book hook requests',
+            description: %(
+              Provide a [custom response template](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses)
+              in JSON form for Inferno to use when responding to hook invocations.
+            ),
+            type: 'textarea',
+            optional: true,
+            enable_when: { input_name: 'appointment_book_response_approach', value: 'custom' }
+      output :continuation_url
+
+      run do
+        identifier = cds_jwt_iss
+        continuation_url = "#{resume_pass_url}?token=#{identifier}"
+        output(continuation_url:)
+
+        wait(
+          identifier:,
+          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](#{continuation_url}) when you have finished
+            submitting requests.
+          )
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/encounter_discharge_receive_request_test.rb

@@ -0,0 +1,126 @@
+require_relative '../client_urls'
+
+module DaVinciCRDTestKit
+  module V201
+    class EncounterDischargeReceiveRequestTest < Inferno::Test
+      include ClientURLs
+
+      id :crd_v201_encounter_discharge_request
+      title 'Request received for encounter-discharge hook'
+      description %(
+        This test waits for multiple incoming [encounter-discharge](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge)
+        hook requests and responds to the client with the response types selected as an input.
+
+        For more details on how Inferno's simulated CDS Service behave during hook invocation see the
+        [simulated CRD server](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details#crd-server-simulation)
+        documentation.
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@197', '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',
+                            'cds-hooks_2.0@15'
+
+      config options: { accepts_multiple_requests: true }
+
+      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 :encounter_discharge_response_approach,
+            title: 'Response generation approach for encounter-discharge',
+            description: %(
+              Determines how Inferno will generate response for encounter-discharge
+              hook invocations.
+            ),
+            type: 'radio',
+            default: 'mocked',
+            options: {
+              list_options: [
+                {
+                  label: 'Create simple mocks based on selected response types',
+                  value: 'mocked'
+                },
+                {
+                  label: 'Generate responses based on a tester-provided template',
+                  value: 'custom'
+                }
+              ]
+            }
+      input :encounter_discharge_selected_response_types,
+            title: 'Response types to return from encounter-discharge hook requests',
+            description: %(
+              Select the CRD response types that the simulated Inferno CRD server will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses)
+              when responding to hook invocations. If no types are selected, Inferno will mock and return
+              an [Instructions](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#instructions-response-type)
+              response for this secondary hook.
+            ),
+            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'
+                }
+              ]
+            },
+            enable_when: { input_name: 'encounter_discharge_response_approach', value: 'mocked' }
+      input :encounter_discharge_custom_response_template,
+            title: 'Custom response template for encounter-discharge hook requests',
+            description: %(
+              Provide a [custom response template](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses)
+              in JSON form for Inferno to use when responding to hook invocations.
+            ),
+            type: 'textarea',
+            optional: true,
+            enable_when: { input_name: 'encounter_discharge_response_approach', value: 'custom' }
+      output :continuation_url
+
+      run do
+        identifier = cds_jwt_iss
+        continuation_url = "#{resume_pass_url}?token=#{identifier}"
+        output(continuation_url:)
+
+        wait(
+          identifier:,
+          message: %(
+            **Encounter Discharge CDS Service Test**:
+
+            Invoke the encounter-discharge hook and send requests to:
+
+            `#{encounter_discharge_url}`
+
+            Inferno will process the requests and return CDS cards if successful.
+
+            [Click here](#{continuation_url}) when you have finished submitting
+            requests.
+          )
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/encounter_start_receive_request_test.rb

@@ -0,0 +1,126 @@
+require_relative '../client_urls'
+
+module DaVinciCRDTestKit
+  module V201
+    class EncounterStartReceiveRequestTest < Inferno::Test
+      include ClientURLs
+
+      id :crd_v201_encounter_start_request
+      title 'Request received for encounter-start hook'
+      description %(
+        This test waits for multiple incoming [encounter-start](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start)
+        hook requests and responds to the client with the response types selected as an input.
+
+        For more details on how Inferno's simulated CDS Service behave during hook invocation see the
+        [simulated CRD server](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details#crd-server-simulation)
+        documentation.
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@186', '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',
+                            'cds-hooks_2.0@15'
+
+      config options: { accepts_multiple_requests: true }
+
+      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 :encounter_start_response_approach,
+            title: 'Response generation approach for encounter-start',
+            description: %(
+              Determines how Inferno will generate response for encounter-start
+              hook invocations.
+            ),
+            type: 'radio',
+            default: 'mocked',
+            options: {
+              list_options: [
+                {
+                  label: 'Create simple mocks based on selected response types',
+                  value: 'mocked'
+                },
+                {
+                  label: 'Generate responses based on a tester-provided template',
+                  value: 'custom'
+                }
+              ]
+            }
+      input :encounter_start_selected_response_types,
+            title: 'Response types to return from encounter-start 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 `Instructions` 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'
+                }
+              ]
+            },
+            enable_when: { input_name: 'encounter_start_response_approach', value: 'mocked' }
+      input :encounter_start_custom_response_template,
+            title: 'Custom response template for encounter-start hook requests',
+            description: %(
+              Select the CRD response types that the simulated Inferno CRD server will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses)
+              when responding to hook invocations. If no types are selected, Inferno will mock and return
+              an [Instructions](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#instructions-response-type)
+              response for this secondary hook.
+            ),
+            type: 'textarea',
+            optional: true,
+            enable_when: { input_name: 'encounter_start_response_approach', value: 'custom' }
+      output :continuation_url
+
+      run do
+        identifier = cds_jwt_iss
+        continuation_url = "#{resume_pass_url}?token=#{identifier}"
+        output(continuation_url:)
+
+        wait(
+          identifier:,
+          message: %(
+            **Encounter Start CDS Service Test**:
+
+            Invoke the encounter-start hook and send requests to:
+
+            `#{encounter_start_url}`
+
+            Inferno will process the requests and return CDS cards if successful.
+
+            [Click here](#{continuation_url}) when you have finished submitting
+            requests.
+          )
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/order_dispatch_receive_request_test.rb

@@ -0,0 +1,138 @@
+require_relative '../client_urls'
+
+module DaVinciCRDTestKit
+  module V201
+    class OrderDispatchReceiveRequestTest < Inferno::Test
+      include ClientURLs
+
+      id :crd_v201_order_dispatch_request
+      title 'Request received for order-dispatch hook'
+      description %(
+        This test waits for multiple incoming [order-dispatch](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch)
+        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.
+
+        For more details on how Inferno's simulated CDS Service behave during hook invocation see the
+        [simulated CRD server](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details#crd-server-simulation)
+        documentation.
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@205',
+                            'hl7.fhir.us.davinci-crd_2.0.1@207', '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',
+                            'cds-hooks_2.0@15'
+
+      config options: { accepts_multiple_requests: true }
+
+      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_dispatch_response_approach,
+            title: 'Response generation approach for order-dispatch',
+            description: %(
+              Determines how Inferno will generate response for order-dispatch
+              hook invocations.
+            ),
+            type: 'radio',
+            default: 'mocked',
+            options: {
+              list_options: [
+                {
+                  label: 'Create simple mocks based on selected response types',
+                  value: 'mocked'
+                },
+                {
+                  label: 'Generate responses based on a tester-provided template',
+                  value: 'custom'
+                }
+              ]
+            }
+      input :order_dispatch_selected_response_types,
+            title: 'Response types to return from order-dispatch hook requests',
+            description: %(
+              Select the CRD response types that the simulated Inferno CRD server will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses)
+              when responding to hook invocations. If no types are selected, Inferno will mock and return
+              a [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#coverage-information-response-type)
+              response for this primary hook.
+            ),
+            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'
+                },
+                {
+                  label: 'Propose Alternate Request',
+                  value: 'propose_alternate_request'
+                },
+                {
+                  label: 'Additional Orders as Companions/Prerequisites',
+                  value: 'companions_prerequisites'
+                }
+              ]
+            },
+            enable_when: { input_name: 'order_dispatch_response_approach', value: 'mocked' }
+      input :order_dispatch_custom_response_template,
+            title: 'Custom response template for order-dispatch hook requests',
+            description: %(
+              Provide a [custom response template](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses)
+              in JSON form for Inferno to use when responding to hook invocations.
+            ),
+            type: 'textarea',
+            optional: true,
+            enable_when: { input_name: 'order_dispatch_response_approach', value: 'custom' }
+      output :continuation_url
+
+      run do
+        identifier = cds_jwt_iss
+        continuation_url = "#{resume_pass_url}?token=#{identifier}"
+        output(continuation_url:)
+
+        wait(
+          identifier:,
+          message: %(
+            **Order Dispatch CDS Service Test**:
+
+            Invoke the order-dispatch hook and send requests to:
+
+            `#{order_dispatch_url}`
+
+            Inferno will process the requests and return CDS cards if successful.
+
+            [Click here](#{continuation_url}) when you have finished submitting
+            requests.
+          )
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/order_select_receive_request_test.rb

@@ -0,0 +1,134 @@
+require_relative '../client_urls'
+
+module DaVinciCRDTestKit
+  module V201
+    class OrderSelectReceiveRequestTest < Inferno::Test
+      include ClientURLs
+
+      id :crd_v201_order_select_request
+      title 'Request received for order-select hook'
+      description %(
+        This test waits for multiple incoming [order-select](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select)
+        hook requests and responds to the client with the response types selected as an input.
+
+        For more details on how Inferno's simulated CDS Service behave during hook invocation see the
+        [simulated CRD server](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details#crd-server-simulation)
+        documentation.
+      )
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.0.1@209', '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',
+                            'cds-hooks_2.0@15'
+
+      config options: { accepts_multiple_requests: true }
+
+      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_select_response_approach,
+            title: 'Response generation approach for order-select',
+            description: %(
+              Determines how Inferno will generate response for order-select
+              hook invocations.
+            ),
+            type: 'radio',
+            default: 'mocked',
+            options: {
+              list_options: [
+                {
+                  label: 'Create simple mocks based on selected response types',
+                  value: 'mocked'
+                },
+                {
+                  label: 'Generate responses based on a tester-provided template',
+                  value: 'custom'
+                }
+              ]
+            }
+      input :order_select_selected_response_types,
+            title: 'Response types to return from order-select 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 `Instructions` 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'
+                },
+                {
+                  label: 'Propose Alternate Request',
+                  value: 'propose_alternate_request'
+                },
+                {
+                  label: 'Additional Orders as Companions/Prerequisites',
+                  value: 'companions_prerequisites'
+                }
+              ]
+            },
+            enable_when: { input_name: 'order_select_response_approach', value: 'mocked' }
+      input :order_select_custom_response_template,
+            title: 'Custom response template for order-select hook requests',
+            description: %(
+              Select the CRD response types that the simulated Inferno CRD server will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses)
+              when responding to hook invocations. If no types are selected, Inferno will mock and return
+              an [Instructions](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#instructions-response-type)
+              response for this secondary hook.
+            ),
+            type: 'textarea',
+            optional: true,
+            enable_when: { input_name: 'order_select_response_approach', value: 'custom' }
+      output :continuation_url
+
+      run do
+        identifier = cds_jwt_iss
+        continuation_url = "#{resume_pass_url}?token=#{identifier}"
+        output(continuation_url:)
+
+        wait(
+          identifier:,
+          message: %(
+            **Order Select CDS Service Test**:
+
+            Invoke the order-select hook and send requests to:
+
+            `#{order_select_url}`
+
+            Inferno will process the requests and return CDS cards if successful.
+
+            [Click here](#{continuation_url}) when you have finished submitting
+            requests.
+          )
+        )
+      end
+    end
+  end
+end