davinci_pdex_test_kit 0.10.6 → 0.12.0

data/lib/davinci_pdex_test_kit/pdex_payer_server/provenance/metadata.yml

@@ -0,0 +1,173 @@
+---
+:name: pdex_provenance
+:class_name: PdexProvenanceSequence
+:version: v2.0.0
+:reformatted_version: v200
+:resource: Provenance
+:profile_url: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance
+:profile_name: PDex Provenance
+:profile_version: 2.0.0
+:title: PDex Provenance
+:short_description: Verify support for the server capabilities required by the PDex
+  Provenance.
+:is_delayed: true
+:interactions:
+- :code: search-type
+  :expectation: MAY
+- :code: read
+  :expectation: SHALL
+- :code: vread
+  :expectation: SHOULD
+- :code: patch
+  :expectation: MAY
+- :code: history-instance
+  :expectation: SHOULD
+- :code: history-type
+  :expectation: MAY
+:operations: []
+:searches: []
+:search_definitions: {}
+:include_params: []
+:revincludes: []
+:required_concepts:
+- agent.type
+- entity.extension.valueCodeableConcept
+:must_supports:
+  :extensions:
+  - :id: Provenance.entity.extension:sourceFormat
+    :path: entity.extension
+    :url: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
+  :slices:
+  - :slice_id: Provenance.agent:ProvenanceAuthor
+    :slice_name: ProvenanceAuthor
+    :path: agent
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: type
+      :code: author
+      :system: http://terminology.hl7.org/CodeSystem/provenance-participant-type
+  - :slice_id: Provenance.agent:ProvenanceTransmitter
+    :slice_name: ProvenanceTransmitter
+    :path: agent
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: type
+      :code: transmitter
+      :system: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
+  :elements:
+  - :path: target
+    :types:
+    - Reference
+  - :path: recorded
+  - :path: agent
+  - :path: agent.type
+  - :path: agent.who
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+  - :path: agent.onBehalfOf
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - :path: agent:ProvenanceAuthor.type
+  - :path: agent:ProvenanceAuthor.who
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+  - :path: agent:ProvenanceTransmitter.type
+  - :path: agent:ProvenanceTransmitter.who
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+:mandatory_elements:
+- Provenance.target
+- Provenance.recorded
+- Provenance.agent
+- Provenance.agent.who
+- Provenance.agent.type
+- Provenance.entity.extension.url
+- Provenance.entity.role
+- Provenance.entity.what
+:bindings:
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
+  :path: agent.type
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenanceAgentType
+  :path: agent:ProvenanceAuthor.type
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
+  :path: entity.extension:sourceFormat.value
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/provenance-entity-role
+  :path: entity.role
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/davinci-pdex/ValueSet/ProvenancePayerSourceFormat
+  :path: value
+  :extensions:
+  - http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/ProvenanceSourceFrom
+:references:
+- :path: Provenance.target
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+- :path: Provenance.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: Provenance.agent.who
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+- :path: Provenance.agent.onBehalfOf
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+- :path: Provenance.agent:ProvenanceAuthor.who
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+- :path: Provenance.agent:ProvenanceAuthor.onBehalfOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Provenance.agent:ProvenanceTransmitter.who
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+- :path: Provenance.agent:ProvenanceTransmitter.onBehalfOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Provenance.entity.what
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+:tests:
+- :id: pdex_provenance_read
+  :file_name: provenance_read_test.rb
+- :id: pdex_provenance_validation
+  :file_name: provenance_validation_test.rb
+- :id: pdex_provenance_must_support
+  :file_name: provenance_must_support_test.rb
+- :id: pdex_provenance_ref_resolution
+  :file_name: provenance_reference_resolution_test.rb
+:id: pdex_provenance
+:file_name: provenance_group.rb
+:delayed_references: []

data/lib/davinci_pdex_test_kit/pdex_payer_server/provenance/provenance_must_support_test.rb

@@ -0,0 +1,51 @@
+require 'us_core_test_kit/must_support_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class ProvenanceMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Provenance 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 Provenance resources
+        found previously for the following must support elements:
+
+        * Provenance.agent
+        * Provenance.agent.onBehalfOf
+        * Provenance.agent.type
+        * Provenance.agent.who
+        * Provenance.agent:ProvenanceAuthor
+        * Provenance.agent:ProvenanceAuthor.type
+        * Provenance.agent:ProvenanceAuthor.who
+        * Provenance.agent:ProvenanceTransmitter
+        * Provenance.agent:ProvenanceTransmitter.type
+        * Provenance.agent:ProvenanceTransmitter.who
+        * Provenance.entity.extension:sourceFormat
+        * Provenance.recorded
+        * Provenance.target
+      )
+
+      id :pdex_provenance_must_support
+
+      def resource_type
+        'Provenance'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/provenance/provenance_read_test.rb

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

data/lib/davinci_pdex_test_kit/pdex_payer_server/provenance/provenance_reference_resolution_test.rb

@@ -0,0 +1,46 @@
+require 'us_core_test_kit/reference_resolution_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class ProvenanceReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+
+      title 'MustSupport references within Provenance 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:
+
+        * Provenance.agent.onBehalfOf
+        * Provenance.agent.who
+        * Provenance.agent:ProvenanceAuthor.who
+        * Provenance.agent:ProvenanceTransmitter.who
+        * Provenance.target
+      )
+
+      id :pdex_provenance_ref_resolution
+
+      def resource_type
+        'Provenance'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/provenance/provenance_validation_test.rb

@@ -0,0 +1,39 @@
+require 'us_core_test_kit/validation_test'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class ProvenanceValidationTest < Inferno::Test
+      include USCoreTestKit::ValidationTest
+
+      id :pdex_provenance_validation
+      title 'Provenance resources returned during previous tests conform to the PDex Provenance'
+      description %(
+        This test verifies resources returned from the first search conform to
+        the [PDex Provenance](http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance).
+        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
+        'Provenance'
+      end
+
+      def scratch_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance',
+                                '2.0.0',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/provenance_group.rb

@@ -0,0 +1,59 @@
+require_relative 'provenance/provenance_read_test'
+require_relative 'provenance/provenance_validation_test'
+require_relative 'provenance/provenance_must_support_test'
+require_relative 'provenance/provenance_reference_resolution_test'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class ProvenanceGroup < Inferno::TestGroup
+      title 'PDex Provenance Tests'
+      short_description 'Verify support for the server capabilities required by the PDex Provenance.'
+      description %(
+        # Background
+
+        The PDex Provenance sequence verifies that the system under test is
+        able to provide correct responses for Provenance queries. These queries
+        must contain resources conforming to the PDex Provenance as
+        specified in the PDex v2.0.0 Implementation Guide.
+
+        # Testing Methodology
+
+
+        ## 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 Provenance 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 Provenance](http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance). Each element is checked against
+        teminology binding and cardinality requirements.
+
+        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_provenance
+      run_as_group
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'provenance', 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      test from: :pdex_provenance_read
+      test from: :pdex_provenance_validation
+      test from: :pdex_provenance_must_support
+      test from: :pdex_provenance_ref_resolution
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/workflow_clinical_data_group.rb

@@ -1,9 +1,7 @@
-# frozen_string_literal: true
-
 module DaVinciPDexTestKit
   module PDexPayerServer
     class WorkflowClinicalDataGroup < Inferno::TestGroup
-      id :pdex_workflow_clinical_data_group
+      id :pdex_workflow_clinical_data
       title 'Server can respond to search requests for clinical data on the matched patient'
       short_title 'Clinical data query'
       description %{
@@ -20,35 +18,47 @@ module DaVinciPDexTestKit
         for this test. If neither is available tests are skipped.
       }
 
+      verifies_requirements 'hl7.fhir.us.davinci-pdex_2.0.0@42'
+
       input :patient_id,
-        title: 'Patient ID',
-        description: 'Manual Patient ID for testing Clinical Query and $everything without $member-match.',
-        optional: true
+            title: 'Patient ID',
+            description: 'Manual Patient ID for testing Clinical Query and $everything without $member-match.',
+            optional: true
+
+      input :smart_auth_info,
+            title: 'OAuth Credentials',
+            type: :auth_info,
+            optional: true
+
+      fhir_client do
+        url :url
+        auth_info :smart_auth_info
+      end
 
       test do
-        id :workflow_clinical_encounter_query_test
+        id :pdex_workflow_clinical_encounter_query_test
         title 'Server can provide clinical Encounter data from matched member identifier'
-        description %{
+        description %(
           Server receives request `GET [baseURL]/Encounter?subject=Patient/[id]` and returns 200.
-        }
+        )
 
         makes_request :pdex_clinical_query
 
         run do
           skip_if !patient_id,
-            'No Patient FHIR ID was derived from $member-match response or supplied by user input'
+                  'No Patient FHIR ID was derived from $member-match response or supplied by user input'
 
-          fhir_search(FHIR::Encounter, params: {patient: "Patient/#{patient_id}"}, name: :pdex_clinical_query)
+          fhir_search(FHIR::Encounter, params: { patient: "Patient/#{patient_id}" }, name: :pdex_clinical_query)
           assert_response_status(200)
         end
       end
 
       test do
-        id :workflow_clinical_encounter_test
+        id :pdex_workflow_clinical_encounter_test
         title 'Server returned Search bundle with valid Encounter data'
-        description %{
+        description %(
             Server returned search Bundle of Encounters with least 1 resource entry.
-        }
+        )
 
         uses_request :pdex_clinical_query
 
@@ -56,11 +66,10 @@ module DaVinciPDexTestKit
           assert_valid_resource
           assert_resource_type('Bundle')
           assert resource.entry.length > 0, 'Response Bundle must have at least one entry'
-          assert resource.entry.map{|entry| entry.resource}.all? { |res| res.resourceType == 'Encounter' },
+          assert resource.entry.map { |entry| entry.resource }.all? { |res| res.resourceType == 'Encounter' },
                  'Response Bundle must only have Encounter resources'
         end
       end
     end
   end
 end
-

data/lib/davinci_pdex_test_kit/pdex_payer_server/workflow_everything_group.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative 'patient_operation_in_capability_statement_validation'
 
 module DaVinciPDexTestKit
@@ -7,7 +5,7 @@ module DaVinciPDexTestKit
     class WorkflowEverythingGroup < Inferno::TestGroup
       title 'Server can respond to $everything requests on matched patient'
       short_title '$everything'
-      id :pdex_workflow_everything_group
+      id :pdex_workflow_everything
       optional
       description %{
         # Background
@@ -21,13 +19,24 @@ module DaVinciPDexTestKit
         This test sequence takes a patient id input and executes the `$everything` FHIR operation on it.
       }
 
+      verifies_requirements 'hl7.fhir.us.davinci-pdex_2.0.0@42'
 
       input :patient_id,
-        title: 'Patient ID',
-        description: 'Manual Patient ID for testing Clinical Query and $everything $export without $member-match.',
-        optional: true
+            title: 'Patient ID',
+            description: 'Manual Patient ID for testing Clinical Query and $everything $export without $member-match.',
+            optional: true
+
+      input :smart_auth_info,
+            title: 'OAuth Credentials',
+            type: :auth_info,
+            optional: true
+
+      fhir_client do
+        url :url
+        auth_info :smart_auth_info
+      end
 
-      test from: :patient_operation_in_capability_statement_validation,
+      test from: :pdex_patient_operation_in_cap_stmt_validation,
            title: 'Server declares support for Patient everything operation in CapabilityStatement',
            config: {
              options: { operation_name: 'everything', operation_url: 'http://hl7.org/fhir/OperationDefinition/Patient-everything' }
@@ -36,11 +45,13 @@ module DaVinciPDexTestKit
       test do
         title 'Server can handle GET /Patient/[ID]/$everything'
 
+        verifies_requirements 'hl7.fhir.us.davinci-pdex_2.0.0@46'
+
         makes_request :pdex_patient_everything
 
         run do
           skip_if !patient_id,
-            "No Patient FHIR ID was derived from $member-match response or supplied by user input"
+                  'No Patient FHIR ID was derived from $member-match response or supplied by user input'
 
           fhir_operation("/Patient/#{patient_id}/$everything", operation_method: :get, name: :pdex_patient_everything)
 
@@ -57,7 +68,7 @@ module DaVinciPDexTestKit
 
         run do
           skip_if !patient_id
-            'No Patient ID was derived from $member-match nor supplied from user input'
+          'No Patient ID was derived from $member-match nor supplied from user input'
           skip_if response[:status] != 200, 'Skipped because previous test did not pass'
 
           assert_valid_resource
@@ -71,7 +82,7 @@ module DaVinciPDexTestKit
         end
       end
 
-      # TODO: convert to attestation    
+      # TODO: convert to attestation
       # test do
       #   title %{
       #     The resources returned SHALL include all the data covered by the meaningful use common data elements as

data/lib/davinci_pdex_test_kit/pdex_payer_server/workflow_export_group.rb

@@ -1,14 +1,11 @@
-# frozen_string_literal: true
-
 require 'bulk_data_test_kit/v2.0.0/bulk_data_patient_export_test_group'
-# require 'bulk_data_test_kit/v1.0.1/patient/bulk_data_patient_export_group'
 require_relative 'export_patient_group'
 require_relative 'export_validation_group'
 
 module DaVinciTestKit
   module PDexPayerServer
     class WorkflowExportGroup < Inferno::TestGroup
-      id :pdex_workflow_export_group
+      id :pdex_workflow_export
       title 'Server can respond to FHIR Bulk $export requests on the matched patient'
       short_title 'Bulk $export'
       optional
@@ -27,41 +24,48 @@ module DaVinciTestKit
         to be returned by Patient-level export. The tests require a Bulk Data Autthorization Bearer Token.
       }
 
-      config({
-        inputs: {
-          url: { name: :bulk_server_url },
-          # bulk_server_url: { name: :url },
-          bulk_export_url: { default: 'Patient/$export' },
-          bearer_token: { description: 'The authorization bearer token for $export access that is scoped to the same patient found by $member-match or entered as patient id. This is not necessarily the same OAuth token that allows access to the server\'s $member-match. If omitted $export tests will be skipped.' }
+      config(
+        {
+          inputs: {
+            url: { name: :bulk_server_url },
+            bulk_export_url: { default: 'Patient/$export' },
+            smart_auth_info: {
+              name: :bulk_auth_info,
+              title: 'Bulk Data Authorization',
+              description: "The authorization information for $export access that is scoped to the same patient found by $member-match or entered as patient id. This is not necessarily the same authorization information that allows access to the server's $member-match.",
+              options: {
+                mode: 'access'
+              },
+              optional: true
+            }
+          }
         }
-      })
+      )
 
       input :url # inherit properties from test suite
 
-      input :bearer_token # inherit properties from parent
-
       input :patient_id,
-        title: 'Patient ID',
-        description: 'Manual Patient ID for testing Clinical Query, $everything, and $export without $member-match.',
-        optional: true
+            title: 'Patient ID',
+            description: 'Manual Patient ID for testing Clinical Query, $everything, and $export without $member-match.',
+            optional: true
 
       # Required by Bulk Data tests
       fhir_client :bulk_server do
         url :url
-        bearer_token :bearer_token
+        # auth_info :bulk_auth_info # FIXME to respect config, workaround below:
+        headers { 'Authorization' => "Bearer #{bulk_auth_info.access_token}" }
       end
 
       http_client :bulk_server do
         url :url
-        headers {'Authorization' => "Bearer #{bearer_token}"}
+        headers { 'Authorization' => "Bearer #{bulk_auth_info.access_token}" }
       end
 
-      group from: :pdex_patient_export_group
+      group from: :pdex_patient_export
 
       group from: :pdex_export_validation,
             title: 'Patient Export Validation Tests',
             optional: true
-
     end
   end
 end