davinci_pdex_test_kit 0.11.0 → 0.12.0

data/lib/davinci_pdex_test_kit/pdex_payer_server/explanation_of_benefit_group.rb

@@ -1,103 +1,101 @@
-require 'us_core_test_kit/generator/group_metadata'
-require_relative 'explanation_of_benefit/explanation_of_benefit_patient_use_search_test'
+require_relative 'explanation_of_benefit/explanation_of_benefit_patient_search_test'
 require_relative 'explanation_of_benefit/explanation_of_benefit_id_search_test'
-require_relative 'explanation_of_benefit/explanation_of_benefit_patient_last_updated_search_test'
-require_relative 'explanation_of_benefit/explanation_of_benefit_patient_service_date_search_test'
+require_relative 'explanation_of_benefit/explanation_of_benefit_patient_lastupdated_search_test'
 require_relative 'explanation_of_benefit/explanation_of_benefit_patient_type_search_test'
 require_relative 'explanation_of_benefit/explanation_of_benefit_identifier_search_test'
+require_relative 'explanation_of_benefit/explanation_of_benefit_patient_service_date_search_test'
 require_relative 'explanation_of_benefit/explanation_of_benefit_read_test'
-require_relative 'explanation_of_benefit/explanation_of_benefit_provenance_revinclude_search_test'
 require_relative 'explanation_of_benefit/explanation_of_benefit_validation_test'
 require_relative 'explanation_of_benefit/explanation_of_benefit_must_support_test'
 require_relative 'explanation_of_benefit/explanation_of_benefit_reference_resolution_test'
 
 module DaVinciPDexTestKit
   module PDexPayerServer
-
-    # PDex PriorAuthorization Profile for ExplanationOfBenefit Resource Test Group
     class ExplanationOfBenefitGroup < Inferno::TestGroup
-      id :pdex_eob
       title 'PDex Prior Authorization Tests'
-      short_description 'Verify support for the server capabilities required by the PDex Prior Authorization Profile.'
+      short_description 'Verify support for the server capabilities required by the PDex Prior Authorization.'
       description %(
-# Background
+        # Background
 
-The PDex Prior Authorization sequence verifies that the system under test is
-able to provide correct responses for ExplanationOfBenefit queries. These queries
-must contain resources conforming to the PDex Prior Authorization Profile as
-specified in the Da Vinci PDex v2.0.0 Implementation Guide.
+        The PDex Prior Authorization sequence verifies that the system under test is
+        able to provide correct responses for ExplanationOfBenefit queries. These queries
+        must contain resources conforming to the PDex Prior Authorization as
+        specified in the PDex v2.0.0 Implementation Guide.
 
-# Testing Methodology
-## Searching
-This test sequence will first perform each required search associated
-with this resource. This sequence will perform searches with the
-following parameters:
+        # Testing Methodology
+        ## Searching
+        This test sequence will first perform each required search associated
+        with this resource. This sequence will perform searches with the
+        following parameters:
 
-* patient + use
-* _id
-* patient + _lastUpdated
-* patient + service-date
-* patient + type
-* identifier
+        * patient
+        * _id
+        * patient + _lastUpdated
+        * patient + type
+        * identifier
+        * patient + service-date
 
-### Search Parameters
-The first search uses the selected patient(s) from the Patient Tests group.
-Any subsequent searches will look for its parameter values
-from the results of the first search. For example, the `provider`
-search in this sequence is performed by looking for an existing
-`ExplanationOfBenefit.provider` from any of the resources returned in the `patient`
-search. If a value cannot be found this way, the search is skipped.
+        ### Search Parameters
+        The first search uses the selected patient(s) from the prior launch
+        sequence. Any subsequent searches will look for its parameter values
+        from the results of the first search. For example, the `identifier`
+        search in the patient sequence is performed by looking for an existing
+        `Patient.identifier` from any of the resources returned in the `_id`
+        search. If a value cannot be found this way, the search is skipped.
 
-### Search Validation
-Inferno will retrieve up to the first 20 bundle pages of the reply for
-ExplanationOfBenefit resources and save them for subsequent tests. Each of
-these resources is then checked to see if it matches the searched
-parameters in accordance with [FHIR search
-guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
-for example, if a Patient search for `gender=male` returns a `female`
-patient.
+        ### Search Validation
+        Inferno will retrieve up to the first 20 bundle pages of the reply for
+        ExplanationOfBenefit resources and save them for subsequent tests. Each of
+        these resources is then checked to see if it matches the searched
+        parameters in accordance with [FHIR search
+        guidelines](https://www.hl7.org/fhir/search.html). The test will fail,
+        for example, if a Patient search for `gender=male` returns a `female`
+        patient.
 
-## Must Support
-Each profile contains elements marked as "must support". This test
-sequence expects to see each of these elements at least once. If at
-least one cannot be found, the test will fail. The test will look
-through the ExplanationOfBenefit resources found in the first test for these
-elements.
 
-## Profile Validation
-Each resource returned from the first search is expected to conform to
-the [PDex Prior Authorization Profile](http://hl7.org/fhir/us/davinci-pdex/StructureDefinition-pdex-priorauthorization.html).
-Each element is checked against teminology binding and cardinality requirements.
+        ## Must Support
+        Each profile contains elements marked as "must support". This test
+        sequence expects to see each of these elements at least once. If at
+        least one cannot be found, the test will fail. The test will look
+        through the ExplanationOfBenefit resources found in the first test for these
+        elements.
 
-Elements with a required binding are validated against their bound
-ValueSet. If the code/system in the element is not part of the ValueSet,
-then the test will fail.
+        ## Profile Validation
+        Each resource returned from the first search is expected to conform to
+        the [PDex Prior Authorization](http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-priorauthorization). Each element is checked against
+        teminology binding and cardinality requirements.
 
-## Reference Validation
-At least one instance of each external reference in elements marked as
-"must support" within the resources provided by the system must resolve.
-The test will attempt to read each reference found and will fail if no
-read succeeds.
+        Elements with a required binding are validated against their bound
+        ValueSet. If the code/system in the element is not part of the ValueSet,
+        then the test will fail.
+
+        ## Reference Validation
+        At least one instance of each external reference in elements marked as
+        "must support" within the resources provided by the system must resolve.
+        The test will attempt to read each reference found and will fail if no
+        read succeeds.
       )
 
+      id :pdex_eob
       run_as_group
 
       def self.metadata
-        # TODO: create metadata.yml to fit GroupMetadata OR circumvent metadata
-        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'explanation_of_benefit', 'metadata.yml')), aliases: true)
+        @metadata ||= USCoreTestKit::USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(
+                                                                                   File.join(__dir__, 'explanation_of_benefit',
+                                                                                             'metadata.yml'), aliases: true
+                                                                                 ))
       end
 
-      test from: :pdex_eob_patient_use_search
+      test from: :pdex_eob_patient_search
       test from: :pdex_eob_id_search
       test from: :pdex_eob_patient_last_updated_search
-      test from: :pdex_eob_patient_service_date_search
       test from: :pdex_eob_patient_type_search
       test from: :pdex_eob_identifier_search
+      test from: :pdex_eob_patient_service_date_search
       test from: :pdex_eob_read
-      test from: :pdex_eob_provenance_revinclude_search
       test from: :pdex_eob_validation
       test from: :pdex_eob_must_support
-      # test from: :pdex_eob_ref_resolution
+      test from: :pdex_eob_ref_resolution
     end
   end
 end

data/lib/davinci_pdex_test_kit/pdex_payer_server/export_patient_group.rb

@@ -1,7 +1,5 @@
 require 'tls_test_kit'
 
-# require 'bulk_data_test_kit/v1.0.1/bulk_data_export_operation_support_test'
-require 'bulk_data_test_kit/v1.0.1/bulk_data_no_auth_test'
 require 'bulk_data_test_kit/v1.0.1/bulk_data_export_kick_off_test'
 require 'bulk_data_test_kit/v1.0.1/bulk_data_status_check_test'
 require 'bulk_data_test_kit/v1.0.1/bulk_data_output_check_test'
@@ -21,10 +19,8 @@ module DaVinciPDexTestKit
 
       run_as_group
 
-      input :bearer_token,
-            title: 'Bulk Data Authorization Bearer Token',
-            description: 'The authorization bearer token for the Bulk FHIR server. If not required, leave blank.',
-            optional: true
+      verifies_requirements 'hl7.fhir.us.davinci-pdex_2.0.0@42'
+
       input :bulk_timeout,
             title: 'Export Times Out after (1-600)',
             description: <<~DESCRIPTION,
@@ -41,8 +37,9 @@ module DaVinciPDexTestKit
            id: :pdex_patient_export_in_cap_stmt,
            title: 'Bulk Data Server declares support for Patient export operation in CapabilityStatement',
            config: {
-             options: { operation_name: 'export', operation_url: 'http://hl7.org/fhir/uv/bulkdata/OperationDefinition/patient-export' }
-           }
+             options: { operation_name: 'export', operation_url: 'http://hl7.org/fhir/uv/bulkdata/OperationDefinition/patient-export', client: :bulk_server }
+           },
+           verifies_requirements: 'hl7.fhir.us.davinci-pdex_2.0.0@47'
 
       test from: :bulk_data_kick_off,
            id: :pdex_export_patient_kick_off,
@@ -54,7 +51,9 @@ module DaVinciPDexTestKit
       test from: :bulk_data_status_check,
            id: :pdex_export_patient_status_check,
            config: {
-             inputs: { polling_url: { name: :patient_polling_url } },
+             inputs: {
+               polling_url: { name: :patient_polling_url },
+             },
              outputs: {
                status_response: { name: :patient_status_response },
                requires_access_token: { name: :patient_requires_access_token }

data/lib/davinci_pdex_test_kit/pdex_payer_server/export_validation_group.rb

@@ -1,4 +1,3 @@
-# require 'bulk_data_test_kit/v1.0.1/bulk_data_multiple_patients_test'
 require 'bulk_data_test_kit/v1.0.1/bulk_data_ndjson_download_test'
 require 'bulk_data_test_kit/v1.0.1/bulk_data_valid_resources_test'
 
@@ -13,7 +12,7 @@ module DaVinciPDexTestKit
 
       id :pdex_export_validation
 
-      input :patient_status_output, :patient_requires_access_token, :bearer_token, :patient_bulk_download_url
+      input :patient_status_output, :patient_requires_access_token, :patient_bulk_download_url
       input :lines_to_validate,
             title: 'Limit validation to a maximum resource count',
             description: 'To validate all, leave blank.',

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_must_support_test.rb

@@ -0,0 +1,42 @@
+require 'us_core_test_kit/must_support_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispenseMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the MedicationDispense resources returned'
+      description %(
+        PDex Responders SHALL be capable of populating all data elements as
+        part of the query results as specified by the PDex Server Capability
+        Statement. This test will look through the MedicationDispense resources
+        found previously for the following must support elements:
+
+        * MedicationDispense.status
+        * MedicationDispense.subject
+        * MedicationDispense.substitution
+        * MedicationDispense.substitution.wasSubstituted
+      )
+
+      id :pdex_medication_dispense_must_support
+
+      def resource_type
+        'MedicationDispense'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_patient_search_test.rb

@@ -0,0 +1,64 @@
+require 'us_core_test_kit/search_test'
+require 'us_core_test_kit/search_test_properties'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispensePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for MedicationDispense search by patient'
+      description %(
+        A server SHALL support searching by
+        patient on the MedicationDispense resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        This test verifies that the server supports searching by reference using
+        the form `patient=[id]` as well as `patient=Patient/[id]`. The two
+        different forms are expected to return the same number of results. US
+        Core requires that both forms are supported by PDex responders.
+
+        Because this is the first search of the sequence, resources in the
+        response will be used for subsequent tests.
+
+        Additionally, this test will check that GET and POST search methods
+        return the same number of results. Search by POST is required by the
+        FHIR R4 specification, and these tests interpret search by GET as a
+        requirement of PDex v2.0.0.
+
+        [PDex Server CapabilityStatement](https://hl7.org/fhir/us/davinci-pdex/STU2/CapabilityStatement-pdex-server.html)
+      )
+
+      id :pdex_medication_dispense_patient_search
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      def self.properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          first_search: true,
+          resource_type: 'MedicationDispense',
+          search_param_names: ['patient'],
+          test_medication_inclusion: true,
+          test_reference_variants: true,
+          multiple_or_search_params: ['status'],
+          test_post_search: true
+        )
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_patient_status_search_test.rb

@@ -0,0 +1,54 @@
+require 'us_core_test_kit/search_test'
+require 'us_core_test_kit/search_test_properties'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispensePatientStatusSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for MedicationDispense search by patient + status'
+      description %(
+        A server SHOULD support searching by
+        patient + status on the MedicationDispense resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        If any MedicationDispense resources use external references to
+        Medications, the search will be repeated with
+        `_include=MedicationDispense:medication`.
+
+        [PDex Server CapabilityStatement](https://hl7.org/fhir/us/davinci-pdex/STU2/CapabilityStatement-pdex-server.html)
+      )
+
+      id :pdex_medication_dispense_patient_status_search
+      optional
+
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      def self.properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          resource_type: 'MedicationDispense',
+          search_param_names: ['patient', 'status'],
+          test_medication_inclusion: true,
+          multiple_or_search_params: ['status']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_patient_status_type_search_test.rb

@@ -0,0 +1,55 @@
+require 'us_core_test_kit/search_test'
+require 'us_core_test_kit/search_test_properties'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispensePatientStatusTypeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for MedicationDispense search by patient + status + type'
+      description %(
+        A server SHOULD support searching by
+        patient + status + type on the MedicationDispense resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        If any MedicationDispense resources use external references to
+        Medications, the search will be repeated with
+        `_include=MedicationDispense:medication`.
+
+        [PDex Server CapabilityStatement](https://hl7.org/fhir/us/davinci-pdex/STU2/CapabilityStatement-pdex-server.html)
+      )
+
+      id :pdex_medication_dispense_patient_status_type_search
+      optional
+
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      def self.properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          resource_type: 'MedicationDispense',
+          search_param_names: ['patient', 'status', 'type'],
+          test_medication_inclusion: true,
+          token_search_params: ['type'],
+          multiple_or_search_params: ['status', 'type']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_provenance_revinclude_search_test.rb

@@ -0,0 +1,54 @@
+require 'us_core_test_kit/search_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispenseProvenanceRevincludeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns Provenance resources from MedicationDispense search by patient + status + revInclude:Provenance:target'
+      description %(
+        A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+        This test will perform a search by patient + status + revInclude:Provenance:target and
+        will pass if a Provenance resource is found in the response.
+      %)
+
+      id :pdex_medication_dispense_provenance_revinclude_search
+
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      def properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          resource_type: 'MedicationDispense',
+          search_param_names: ['patient', 'status']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def self.provenance_metadata
+        @provenance_metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(
+                                                                               File.join(__dir__, '..', 'provenance',
+                                                                                         'metadata.yml'), aliases: true
+                                                                             ))
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      def scratch_provenance_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        run_provenance_revinclude_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_read_test.rb

@@ -0,0 +1,26 @@
+require 'us_core_test_kit/read_test'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispenseReadTest < Inferno::Test
+      include USCoreTestKit::ReadTest
+
+      title 'Server returns correct MedicationDispense resource from MedicationDispense read interaction'
+      description 'A server SHALL support the MedicationDispense read interaction.'
+
+      id :pdex_medication_dispense_read
+
+      def resource_type
+        'MedicationDispense'
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      run do
+        perform_read_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_reference_resolution_test.rb

@@ -0,0 +1,42 @@
+require 'us_core_test_kit/reference_resolution_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispenseReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+
+      title 'MustSupport references within MedicationDispense resources are valid'
+      description %(
+        This test will attempt to read external references provided within elements
+        marked as 'MustSupport', if any are available.
+
+        It verifies that at least one external reference for each MustSupport Reference element
+        can be accessed by the test client, and conforms to corresponding PDex profile.
+
+        Elements which may provide external references include:
+
+        * MedicationDispense.subject
+      )
+
+      id :pdex_medication_dispense_ref_resolution
+
+      def resource_type
+        'MedicationDispense'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/medication_dispense/medication_dispense_validation_test.rb

@@ -0,0 +1,39 @@
+require 'us_core_test_kit/validation_test'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class MedicationDispenseValidationTest < Inferno::Test
+      include USCoreTestKit::ValidationTest
+
+      id :pdex_medication_dispense_validation
+      title 'MedicationDispense resources returned during previous tests conform to the PDex MedicationDispense'
+      description %(
+        This test verifies resources returned from the first search conform to
+        the [PDex MedicationDispense](http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense).
+        Systems must demonstrate at least one valid example in order to pass this test.
+
+        It verifies the presence of mandatory elements and that elements with
+        required bindings contain appropriate values. CodeableConcept element
+        bindings will fail if none of their codings have a code/system belonging
+        to the bound ValueSet. Quantity, Coding, and code element bindings will
+        fail if their code/system are not found in the valueset.
+      )
+      output :dar_code_found, :dar_extension_found
+
+      def resource_type
+        'MedicationDispense'
+      end
+
+      def scratch_resources
+        scratch[:medication_dispense_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense',
+                                '2.0.0',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end