davinci_pdex_test_kit 0.11.0 → 0.12.1

data/lib/davinci_pdex_test_kit/pdex_payer_client/urls.rb

@@ -4,12 +4,10 @@ module DaVinciPDexTestKit
   module PDexPayerClient
 
     module URLs
-      BASE_PATH = "#{Inferno::Application['base_url']}/custom/pdex_payer_client"
-      TOKEN_PATH = '/mock_auth/token'
       PATIENT_PATH = '/fhir/Patient'
+      PATIENT_INSTANCE_PATH = '/fhir/Patient/:patient'
       RESOURCE_PATH = '/fhir/:endpoint'
       INSTANCE_PATH = '/fhir/:endpoint/:id'
-      SUBMIT_PATH = '/fhir/:endpoint'   # FIXME duplicate
       BINARY_PATH = '/fhir/Binary/:id'
       METADATA_PATH = '/fhir/metadata'
       EVERYTHING_PATH = '/fhir/Patient/:patient/$everything'
@@ -19,7 +17,9 @@ module DaVinciPDexTestKit
       BASE_FHIR_PATH = '/fhir'
       RESUME_PASS_PATH = '/resume_pass'
       RESUME_CLINICAL_DATA_PATH = '/resume_clinical_data'
-      RESUME_FAIL_PATH = '/resume_fail'    
+      RESUME_FAIL_PATH = '/resume_fail'
+      AUTHORIZATION_PATH = '/auth/authorization'
+      TOKEN_PATH = '/auth/token'
 
       constants.each do |path_constant|
         # For each constant X_PATH, define x_path()
@@ -29,20 +29,28 @@ module DaVinciPDexTestKit
 
         # For each constant X_PATH, define x_url(), which includes base
         define_method(path_constant.to_s.downcase.gsub(/_path$/, '_url')) do
-          File.join(BASE_PATH, URLs.const_get(path_constant))
+          base_url + URLs.const_get(path_constant)
         end
       end
 
+      def suite_id
+        PDexPayerClientSuite.id
+      end
+
       # overwrite base_url which is irregular
       def base_url
-        BASE_PATH
+        @base_url ||= "#{Inferno::Application['base_url']}/custom/#{suite_id}"
       end
 
-      # overwrite base_fhir_url which is irregular
-      def base_fhir_url
-        File.join(BASE_PATH, BASE_FHIR_PATH)
+      # overwrite fhir_base_url which is irregular
+      def fhir_base_url
+        base_url + BASE_FHIR_PATH
       end
 
+      # alias for smart and udap tests
+      def client_fhir_base_url
+        fhir_base_url
+      end
     end
 
     # Add all constants and dynamically defined methods to PDexPayerClient namespace

data/lib/davinci_pdex_test_kit/pdex_payer_client_suite.rb

@@ -1,4 +1,4 @@
-require 'inferno/dsl/oauth_credentials'
+require_relative 'pdex_payer_client/pdex_client_options'
 require_relative 'pdex_payer_client/urls'
 require_relative 'pdex_payer_client/tags'
 require_relative 'pdex_payer_client/collection'
@@ -6,6 +6,11 @@ require_relative 'pdex_payer_client/mock_server'
 # require_relative 'must_support_test'
 # require_relative 'pdex_payer_client/client_validation_test'
 
+require_relative 'pdex_payer_client/client_registration_group'
+require_relative 'pdex_payer_client/client_auth_smart_alca_group'
+require_relative 'pdex_payer_client/client_auth_smart_alcs_group'
+require_relative 'pdex_payer_client/client_auth_smart_alp_group'
+require_relative 'pdex_payer_client/client_auth_udap_group'
 require_relative 'pdex_payer_client/client_workflow_interaction_test'
 require_relative 'pdex_payer_client/client_member_match_tests/client_member_match_validation_test'
 
@@ -41,7 +46,7 @@ module DaVinciPDexTestKit
     id :pdex_payer_client
     title 'Da Vinci PDex Payer Client Test Suite'
     description File.read(File.join(__dir__, 'docs', 'payer_client_suite_description_v200.md'))
-    
+
     links [
       {
         label: 'Report Issue',
@@ -71,6 +76,27 @@ module DaVinciPDexTestKit
       end
     end
 
+    suite_option  :client_type,
+                  title: 'Client Security Type',
+                  list_options: [
+                    {
+                      label: 'SMART App Launch Public Client',
+                      value: PDexClientOptions::SMART_APP_LAUNCH_PUBLIC
+                    },
+                    {
+                      label: 'SMART App Launch Confidential Symmetric Client',
+                      value: PDexClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_SYMMETRIC
+                    },
+                    {
+                      label: 'SMART App Launch Confidential Asymmetric Client',
+                      value: PDexClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
+                    },
+                    {
+                      label: 'UDAP Authorization Code Client',
+                      value: PDexClientOptions::UDAP_AUTHORIZATION_CODE
+                    }
+                  ]
+    
     resume_test_route :get, RESUME_PASS_PATH do |request|
       PDexPayerClientSuite.extract_token_from_query_params(request)
     end
@@ -78,32 +104,51 @@ module DaVinciPDexTestKit
     resume_test_route :get, RESUME_CLINICAL_DATA_PATH do |request|
       PDexPayerClientSuite.extract_token_from_query_params(request)
     end
-  
+
     resume_test_route :get, RESUME_FAIL_PATH, result: 'fail' do |request|
       PDexPayerClientSuite.extract_token_from_query_params(request)
     end
 
+    group from: :pdex_client_registration
+
     group do
       run_as_group
-      title "Workflow Tests"
+      title 'Verify PDex Data Access'
       id :payer_to_payer_workflow
 
       group do
-        title "Interaction Tests"
-        id :client_workflow_interaction
+        title 'Interaction Tests'
+        id :pdex_client_workflow_interaction
 
         test from: :pdex_client_workflow_interaction
       end
 
+      group from: :pdex_client_auth_smart_alca,
+          required_suite_options: {
+            client_type: PDexClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
+          }
+      group from: :pdex_client_auth_smart_alcs,
+            required_suite_options: {
+              client_type: PDexClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_SYMMETRIC
+            }
+      group from: :pdex_client_auth_smart_alp,
+            required_suite_options: {
+              client_type: PDexClientOptions::SMART_APP_LAUNCH_PUBLIC
+            }
+      group from: :pdex_client_auth_udap,
+            required_suite_options: {
+              client_type: PDexClientOptions::UDAP_AUTHORIZATION_CODE
+            }
+
       group do
-        title "$member-match validation"
+        title '$member-match validation'
         id :member_match_validation
 
         test from: :pdex_initial_member_match_validation
       end
 
       group do
-        title "Clinical data request validation"
+        title 'Clinical data request validation'
         id :clinical_data_validation
 
         test from: :pdex_clinical_data_request_check
@@ -130,8 +175,11 @@ module DaVinciPDexTestKit
         test from: :pdex_procedure_clinical_data_request
       end
     end
+
+  
+    # TODO: must support validation
+
     
-    # TODO must support validation
 
     private
 
@@ -140,4 +188,3 @@ module DaVinciPDexTestKit
     end
   end
 end
-  

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_must_support_test.rb

@@ -0,0 +1,50 @@
+require 'us_core_test_kit/must_support_test'
+require 'us_core_test_kit/generator/group_metadata'
+
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DeviceMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Device 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 Device resources
+        found previously for the following must support elements:
+
+        * Device.distinctIdentifier
+        * Device.expirationDate
+        * Device.lotNumber
+        * Device.patient
+        * Device.serialNumber
+        * Device.status
+        * Device.type
+        * Device.udiCarrier
+        * Device.udiCarrier.carrierAIDC
+        * Device.udiCarrier.carrierHRF
+        * Device.udiCarrier.deviceIdentifier
+        * Device.url
+      )
+
+      id :pdex_device_must_support
+
+      def resource_type
+        'Device'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_patient_search_test.rb

@@ -0,0 +1,68 @@
+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 DevicePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Device search by patient'
+      description %(
+        A server SHALL support searching by
+        patient on the Device 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_device_patient_search
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      input :implantable_device_codes,
+            title: 'Implantable Device Type Code',
+            description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. ' \
+                         'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+            optional: true
+
+      def self.properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          first_search: true,
+          resource_type: 'Device',
+          search_param_names: ['patient'],
+          test_reference_variants: true,
+          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[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_patient_type_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 DevicePatientTypeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Device search by patient + type'
+      description %(
+        A server SHOULD support searching by
+        patient + type on the Device resource. This test
+        will pass if resources are returned and match the search criteria. If
+        none are returned, the test is skipped.
+
+        [PDex Server CapabilityStatement](https://hl7.org/fhir/us/davinci-pdex/STU2/CapabilityStatement-pdex-server.html)
+      )
+
+      id :pdex_device_patient_type_search
+      optional
+
+      input :patient_ids,
+            title: 'Patient IDs',
+            description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+      input :implantable_device_codes,
+            title: 'Implantable Device Type Code',
+            description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. ' \
+                         'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+            optional: true
+
+      def self.properties
+        @properties ||= USCoreTestKit::SearchTestProperties.new(
+          resource_type: 'Device',
+          search_param_names: ['patient', 'type'],
+          token_search_params: ['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[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/{explanation_of_benefit/explanation_of_benefit_provenance_revinclude_search_test.rb → device/device_provenance_revinclude_search_test.rb}

@@ -2,12 +2,12 @@ require 'us_core_test_kit/search_test'
 require 'us_core_test_kit/search_test_properties'
 require 'us_core_test_kit/generator/group_metadata'
 
-module USCoreTestKit
-  module USCoreV311
-    class ExplanationOfBenefitProvenanceRevincludeSearchTest < Inferno::Test
+module DaVinciPDexTestKit
+  module PDexPayerServer
+    class DeviceProvenanceRevincludeSearchTest < Inferno::Test
       include USCoreTestKit::SearchTest
 
-      title 'Server returns Provenance resources from ExplanationOfBenefit search by patient + revInclude:Provenance:target'
+      title 'Server returns Provenance resources from Device search by patient + revInclude:Provenance:target'
       description %(
         A server SHALL be capable of supporting _revIncludes:Provenance:target.
 
@@ -15,7 +15,7 @@ module USCoreTestKit
         will pass if a Provenance resource is found in the response.
       %)
 
-      id :pdex_eob_provenance_revinclude_search
+      id :pdex_device_provenance_revinclude_search
 
       input :patient_ids,
             title: 'Patient IDs',
@@ -23,7 +23,7 @@ module USCoreTestKit
 
       def properties
         @properties ||= USCoreTestKit::SearchTestProperties.new(
-          resource_type: 'ExplanationOfBenefit',
+          resource_type: 'Device',
           search_param_names: ['patient']
         )
       end
@@ -40,7 +40,7 @@ module USCoreTestKit
       end
 
       def scratch_resources
-        scratch[:explanation_of_benefit_resources] ||= {}
+        scratch[:device_resources] ||= {}
       end
 
       def scratch_provenance_resources

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_read_test.rb

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

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_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 DeviceReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+
+      title 'MustSupport references within Device 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:
+
+        * Device.patient
+      )
+
+      id :pdex_device_ref_resolution
+
+      def resource_type
+        'Device'
+      end
+
+      def self.metadata
+        @metadata ||= USCoreTestKit::Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'),
+                                                                                 aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/davinci_pdex_test_kit/pdex_payer_server/device/device_validation_test.rb

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

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

@@ -0,0 +1,154 @@
+---
+:name: pdex_device
+:class_name: PdexDeviceSequence
+:version: v2.0.0
+:reformatted_version: v200
+:resource: Device
+:profile_url: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-device
+:profile_name: PDex Device
+:profile_version: 2.0.0
+:title: PDex Device
+:short_description: Verify support for the server capabilities required by the PDex
+  Device.
+:is_delayed: false
+:interactions:
+- :code: search-type
+  :expectation: SHALL
+- :code: read
+  :expectation: SHALL
+- :code: vread
+  :expectation: SHOULD
+- :code: history-instance
+  :expectation: SHOULD
+- :code: history-type
+  :expectation: MAY
+:operations: []
+:searches:
+- :names:
+  - patient
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - type
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - status
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :patient:
+    :paths:
+    - patient
+    :full_paths:
+    - Device.patient
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :type:
+    :paths:
+    - type
+    :full_paths:
+    - Device.type
+    :comparators: {}
+    :values: []
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: MAY
+  :status:
+    :paths:
+    - status
+    :full_paths:
+    - Device.status
+    :comparators: {}
+    :values: []
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: udiCarrier
+  - :path: udiCarrier.deviceIdentifier
+  - :path: udiCarrier.carrierAIDC
+  - :path: udiCarrier.carrierHRF
+  - :path: status
+  - :path: distinctIdentifier
+  - :path: expirationDate
+  - :path: lotNumber
+  - :path: serialNumber
+  - :path: type
+  - :path: patient
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+  - :path: url
+:mandatory_elements:
+- Device.udiCarrier.deviceIdentifier
+- Device.deviceName.name
+- Device.deviceName.type
+- Device.type
+- Device.specialization.systemType
+- Device.version.value
+- Device.property.type
+- Device.patient
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/udi-entry-type
+  :path: udiCarrier.entryType
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/device-status
+  :path: status
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/device-nametype
+  :path: deviceName.type
+:references:
+- :path: Device.definition
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/DeviceDefinition
+- :path: Device.patient
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: Device.owner
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Device.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: Device.parent
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Device
+:tests:
+- :id: pdex_device_patient_search
+  :file_name: device_patient_search_test.rb
+- :id: pdex_device_patient_type_search
+  :file_name: device_patient_type_search_test.rb
+- :id: pdex_device_read
+  :file_name: device_read_test.rb
+- :id: pdex_device_provenance_revinclude_search
+  :file_name: device_provenance_revinclude_search_test.rb
+- :id: pdex_device_validation
+  :file_name: device_validation_test.rb
+- :id: pdex_device_must_support
+  :file_name: device_must_support_test.rb
+- :id: pdex_device_ref_resolution
+  :file_name: device_reference_resolution_test.rb
+:id: pdex_device
+:file_name: device_group.rb
+:delayed_references: []