carin_for_blue_button_test_kit 0.9.1 → 0.10.0

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/organization/metadata.yml

@@ -4,6 +4,7 @@
 :version: v1.1.0
 :reformatted_version: v110
 :resource: Organization
+:conformance_expectation: SHALL
 :profile_url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization
 :profile_name: C4BB Organization
 :profile_version: 1.1.0
@@ -109,11 +110,11 @@
   - http://hl7.org/fhir/StructureDefinition/Endpoint
 :tests:
 - :id: c4bb_v110_organization_read_test
-  :file_name: organization_read_test.rb
+  :file_name: read_test.rb
 - :id: c4bb_v110_organization_validation_test
-  :file_name: organization_validation_test.rb
+  :file_name: validation_test.rb
 - :id: c4bb_v110_organization_must_support_test
-  :file_name: organization_must_support_test.rb
+  :file_name: must_support_test.rb
 :id: c4bb_v110_organization
 :file_name: organization_group.rb
 :delayed_references: []

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/organization/{organization_must_support_test.rb → must_support_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../must_support_test'
-require_relative './organization_read_test'
+require_relative './read_test'
 require_relative '../../../generator/group_metadata'
 
 module CarinForBlueButtonTestKit
@@ -15,7 +15,7 @@ module CarinForBlueButtonTestKit
         Statement. This test will look through the Organization resources
         found previously for the following must support elements:
 
-        * Organization.active
+                * Organization.active
         * Organization.address
         * Organization.address.city
         * Organization.address.country

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/organization/{organization_read_test.rb → read_test.rb}

@@ -10,14 +10,13 @@ module CarinForBlueButtonTestKit
       description 'A server SHALL support the Organization read interaction.'
 
       id :c4bb_v110_organization_read_test
-
-      input :organization_ids,
-        title: "organization IDs",
+      
+      input :additional_organization_ids,
+        title: "Additional organization IDs",
         type: 'text',
-        description: "organization Resource ID"
-
-      input_order :url, :smart_credentials, :organization_ids
-
+        description: "organization Resource ID. This is optional, but must be provided if executing only the Organization test group.",
+        optional: true
+      
       def resource_type
         'Organization'
       end
@@ -26,13 +25,13 @@ module CarinForBlueButtonTestKit
         scratch[:organization_resources] ||= {}
       end
 
-      def organization_id_list
-        return [nil] unless respond_to? :organization_ids
-        organization_ids.split(',').map(&:strip)
+      def resource_ids
+        return [] unless respond_to? :additional_organization_ids
+        additional_organization_ids.split(',').map(&:strip)
       end
 
       run do
-        perform_read_test(organization_id_list)
+        perform_read_test(scratch.dig(:references, 'Organization'))
       end
     end
   end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/organization/{organization_validation_test.rb → validation_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../validation_test'
-require_relative './organization_read_test'
+require_relative './read_test'
 
 module CarinForBlueButtonTestKit
   module CARIN4BBV110
@@ -9,8 +9,7 @@ module CarinForBlueButtonTestKit
 
       id :c4bb_v110_organization_validation_test
       title 'Organization resources returned during previous tests conform to the C4BB Organization'
-      description %(
-This test verifies resources returned from the first search conform to
+      description %(This test verifies resources returned from the first search conform to
 the [C4BB Organization](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization).
 Systems must demonstrate at least one valid example in order to pass this test.
 
@@ -23,7 +22,7 @@ fail if their code/system are not found in the valueset.
       )
 
       output :dar_code_found, :dar_extension_found
-      
+
       def resource_type
         'Organization'
       end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/organization_group.rb

@@ -1,14 +1,14 @@
-require_relative 'organization/organization_read_test'
-    require_relative 'organization/organization_validation_test'
-    require_relative 'organization/organization_must_support_test'
-    
-    module CarinForBlueButtonTestKit
-      module CARIN4BBV110
-        class OrganizationGroup < Inferno::TestGroup
-          title 'Organization Tests'
-          short_description 'Verify support for the server capabilities required by the C4BB Organization.'
-          description %(
-      # Background
+require_relative 'organization/read_test'
+require_relative 'organization/validation_test'
+require_relative 'organization/must_support_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV110
+    class OrganizationGroup < Inferno::TestGroup
+      title 'Organization Tests'
+      short_description 'Verify support for the server capabilities required by the C4BB Organization.'
+      description %(
+# Background
 
 The CARIN for Blue Button Organization sequence verifies that the system under test is
 able to provide correct responses for Organization queries. These queries
@@ -40,19 +40,18 @@ At least one instance of each external reference in elements marked as
 The test will attempt to read each reference found and will fail if no
 read succeeds.
 
-          )
-    
-          id :c4bb_v110_organization
-          run_as_group
-    
-          def self.metadata
-            @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'organization', 'metadata.yml'), aliases: true))
-          end
-      
-          test from: :c4bb_v110_organization_read_test
-          test from: :c4bb_v110_organization_validation_test
-          test from: :c4bb_v110_organization_must_support_test
-        end
+      )
+
+      id :c4bb_v110_organization
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'organization', 'metadata.yml'), aliases: true))
       end
+  
+      test from: :c4bb_v110_organization_read_test
+      test from: :c4bb_v110_organization_validation_test
+      test from: :c4bb_v110_organization_must_support_test
     end
-    
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/patient/metadata.yml

@@ -4,6 +4,7 @@
 :version: v1.1.0
 :reformatted_version: v110
 :resource: Patient
+:conformance_expectation: SHALL
 :profile_url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient
 :profile_name: C4BB Patient
 :profile_version: 1.1.0
@@ -197,11 +198,11 @@
   - http://hl7.org/fhir/StructureDefinition/RelatedPerson
 :tests:
 - :id: c4bb_v110_patient_read_test
-  :file_name: patient_read_test.rb
+  :file_name: read_test.rb
 - :id: c4bb_v110_patient_validation_test
-  :file_name: patient_validation_test.rb
+  :file_name: validation_test.rb
 - :id: c4bb_v110_patient_must_support_test
-  :file_name: patient_must_support_test.rb
+  :file_name: must_support_test.rb
 :id: c4bb_v110_patient
 :file_name: patient_group.rb
 :delayed_references: []

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/patient/{patient_must_support_test.rb → must_support_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../must_support_test'
-require_relative './patient_read_test'
+require_relative './read_test'
 require_relative '../../../generator/group_metadata'
 
 module CarinForBlueButtonTestKit
@@ -15,7 +15,7 @@ module CarinForBlueButtonTestKit
         Statement. This test will look through the Patient resources
         found previously for the following must support elements:
 
-        * Patient.address
+                * Patient.address
         * Patient.address.city
         * Patient.address.country
         * Patient.address.district

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/patient/read_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../../read_test'
+require 'json'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV110
+    class PatientReadTest < Inferno::Test
+      include CarinForBlueButtonTestKit::ReadTest
+
+      title 'Server returns correct Patient resource from Patient read interaction'
+      description 'A server SHALL support the Patient read interaction.'
+
+      id :c4bb_v110_patient_read_test
+      
+      input :additional_patient_ids,
+        title: "Additional patient IDs",
+        type: 'text',
+        description: "Comma separated list of patient IDs that in sum
+                          contain all MUST SUPPORT elements. This is optional, but must be provided if executing only the Patient test group.",
+        optional: true
+      
+      def resource_type
+        'Patient'
+      end
+
+      def scratch_resources
+        scratch[:patient_resources] ||= {}
+      end
+
+      def resource_ids
+        return [] unless respond_to? :additional_patient_ids
+        additional_patient_ids.split(',').map(&:strip)
+      end
+
+      run do
+        perform_read_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/patient/{patient_validation_test.rb → validation_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../validation_test'
-require_relative './patient_read_test'
+require_relative './read_test'
 
 module CarinForBlueButtonTestKit
   module CARIN4BBV110
@@ -9,8 +9,7 @@ module CarinForBlueButtonTestKit
 
       id :c4bb_v110_patient_validation_test
       title 'Patient resources returned during previous tests conform to the C4BB Patient'
-      description %(
-This test verifies resources returned from the first search conform to
+      description %(This test verifies resources returned from the first search conform to
 the [C4BB Patient](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient).
 Systems must demonstrate at least one valid example in order to pass this test.
 
@@ -23,7 +22,7 @@ fail if their code/system are not found in the valueset.
       )
 
       output :dar_code_found, :dar_extension_found
-      
+
       def resource_type
         'Patient'
       end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/patient_group.rb

@@ -1,14 +1,14 @@
-require_relative 'patient/patient_read_test'
-    require_relative 'patient/patient_validation_test'
-    require_relative 'patient/patient_must_support_test'
-    
-    module CarinForBlueButtonTestKit
-      module CARIN4BBV110
-        class PatientGroup < Inferno::TestGroup
-          title 'Patient Tests'
-          short_description 'Verify support for the server capabilities required by the C4BB Patient.'
-          description %(
-      # Background
+require_relative 'patient/read_test'
+require_relative 'patient/validation_test'
+require_relative 'patient/must_support_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV110
+    class PatientGroup < Inferno::TestGroup
+      title 'Patient Tests'
+      short_description 'Verify support for the server capabilities required by the C4BB Patient.'
+      description %(
+# Background
 
 The CARIN for Blue Button Patient sequence verifies that the system under test is
 able to provide correct responses for Patient queries. These queries
@@ -40,19 +40,18 @@ At least one instance of each external reference in elements marked as
 The test will attempt to read each reference found and will fail if no
 read succeeds.
 
-          )
-    
-          id :c4bb_v110_patient
-          run_as_group
-    
-          def self.metadata
-            @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'patient', 'metadata.yml'), aliases: true))
-          end
-      
-          test from: :c4bb_v110_patient_read_test
-          test from: :c4bb_v110_patient_validation_test
-          test from: :c4bb_v110_patient_must_support_test
-        end
+      )
+
+      id :c4bb_v110_patient
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'patient', 'metadata.yml'), aliases: true))
       end
+  
+      test from: :c4bb_v110_patient_read_test
+      test from: :c4bb_v110_patient_validation_test
+      test from: :c4bb_v110_patient_must_support_test
     end
-    
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/practitioner/metadata.yml

@@ -4,6 +4,7 @@
 :version: v1.1.0
 :reformatted_version: v110
 :resource: Practitioner
+:conformance_expectation: SHALL
 :profile_url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner
 :profile_name: C4BB Practitioner
 :profile_version: 1.1.0
@@ -85,11 +86,11 @@
   - http://hl7.org/fhir/StructureDefinition/Organization
 :tests:
 - :id: c4bb_v110_practitioner_read_test
-  :file_name: practitioner_read_test.rb
+  :file_name: read_test.rb
 - :id: c4bb_v110_practitioner_validation_test
-  :file_name: practitioner_validation_test.rb
+  :file_name: validation_test.rb
 - :id: c4bb_v110_practitioner_must_support_test
-  :file_name: practitioner_must_support_test.rb
+  :file_name: must_support_test.rb
 :id: c4bb_v110_practitioner
 :file_name: practitioner_group.rb
 :delayed_references: []

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/practitioner/{practitioner_must_support_test.rb → must_support_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../must_support_test'
-require_relative './practitioner_read_test'
+require_relative './read_test'
 require_relative '../../../generator/group_metadata'
 
 module CarinForBlueButtonTestKit
@@ -15,7 +15,7 @@ module CarinForBlueButtonTestKit
         Statement. This test will look through the Practitioner resources
         found previously for the following must support elements:
 
-        * Practitioner.identifier
+                * Practitioner.identifier
         * Practitioner.identifier:NPI
         * Practitioner.identifier:tax
         * Practitioner.meta

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/practitioner/{practitioner_read_test.rb → read_test.rb}

@@ -10,14 +10,13 @@ module CarinForBlueButtonTestKit
       description 'A server SHALL support the Practitioner read interaction.'
 
       id :c4bb_v110_practitioner_read_test
-
-      input :practitioner_ids,
-        title: "practitioner IDs",
+      
+      input :additional_practitioner_ids,
+        title: "Additional practitioner IDs",
         type: 'text',
-        description: "practitioner Resource ID"
-
-      input_order :url, :smart_credentials, :practitioner_ids
-
+        description: "practitioner Resource ID. This is optional, but must be provided if executing only the Practitioner test group.",
+        optional: true
+      
       def resource_type
         'Practitioner'
       end
@@ -26,13 +25,13 @@ module CarinForBlueButtonTestKit
         scratch[:practitioner_resources] ||= {}
       end
 
-      def practitioner_id_list
-        return [nil] unless respond_to? :practitioner_ids
-        practitioner_ids.split(',').map(&:strip)
+      def resource_ids
+        return [] unless respond_to? :additional_practitioner_ids
+        additional_practitioner_ids.split(',').map(&:strip)
       end
 
       run do
-        perform_read_test(practitioner_id_list)
+        perform_read_test(scratch.dig(:references, 'Practitioner'))
       end
     end
   end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/practitioner/{practitioner_validation_test.rb → validation_test.rb}

@@ -1,5 +1,5 @@
 require_relative '../../../validation_test'
-require_relative './practitioner_read_test'
+require_relative './read_test'
 
 module CarinForBlueButtonTestKit
   module CARIN4BBV110
@@ -9,8 +9,7 @@ module CarinForBlueButtonTestKit
 
       id :c4bb_v110_practitioner_validation_test
       title 'Practitioner resources returned during previous tests conform to the C4BB Practitioner'
-      description %(
-This test verifies resources returned from the first search conform to
+      description %(This test verifies resources returned from the first search conform to
 the [C4BB Practitioner](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner).
 Systems must demonstrate at least one valid example in order to pass this test.
 
@@ -23,7 +22,7 @@ fail if their code/system are not found in the valueset.
       )
 
       output :dar_code_found, :dar_extension_found
-      
+
       def resource_type
         'Practitioner'
       end

data/lib/carin_for_blue_button_test_kit/generated/v1.1.0/practitioner_group.rb

@@ -1,14 +1,14 @@
-require_relative 'practitioner/practitioner_read_test'
-    require_relative 'practitioner/practitioner_validation_test'
-    require_relative 'practitioner/practitioner_must_support_test'
-    
-    module CarinForBlueButtonTestKit
-      module CARIN4BBV110
-        class PractitionerGroup < Inferno::TestGroup
-          title 'Practitioner Tests'
-          short_description 'Verify support for the server capabilities required by the C4BB Practitioner.'
-          description %(
-      # Background
+require_relative 'practitioner/read_test'
+require_relative 'practitioner/validation_test'
+require_relative 'practitioner/must_support_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV110
+    class PractitionerGroup < Inferno::TestGroup
+      title 'Practitioner Tests'
+      short_description 'Verify support for the server capabilities required by the C4BB Practitioner.'
+      description %(
+# Background
 
 The CARIN for Blue Button Practitioner sequence verifies that the system under test is
 able to provide correct responses for Practitioner queries. These queries
@@ -40,19 +40,18 @@ At least one instance of each external reference in elements marked as
 The test will attempt to read each reference found and will fail if no
 read succeeds.
 
-          )
-    
-          id :c4bb_v110_practitioner
-          run_as_group
-    
-          def self.metadata
-            @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'practitioner', 'metadata.yml'), aliases: true))
-          end
-      
-          test from: :c4bb_v110_practitioner_read_test
-          test from: :c4bb_v110_practitioner_validation_test
-          test from: :c4bb_v110_practitioner_must_support_test
-        end
+      )
+
+      id :c4bb_v110_practitioner
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'practitioner', 'metadata.yml'), aliases: true))
       end
+  
+      test from: :c4bb_v110_practitioner_read_test
+      test from: :c4bb_v110_practitioner_validation_test
+      test from: :c4bb_v110_practitioner_must_support_test
     end
-    
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0/c4bb_test_suite.rb

@@ -3,23 +3,24 @@ require 'smart_app_launch_test_kit'
 require_relative '../../version'
 
 require_relative '../../capability_statement/capability_statement_group'
+require_relative '../../custom_groups/v2.0.0/c4bb_smart_launch_group'
 
 require_relative 'patient_group'
+require_relative 'eob_group'
 require_relative 'coverage_group'
-require_relative 'explanation_of_benefit_group'
-require_relative 'explanation_of_benefit_inpatient_institutional_group'
-require_relative 'explanation_of_benefit_outpatient_institutional_group'
-require_relative 'explanation_of_benefit_oral_group'
-require_relative 'explanation_of_benefit_pharmacy_group'
-require_relative 'explanation_of_benefit_professional_non_clinician_group'
 require_relative 'organization_group'
 require_relative 'practitioner_group'
 require_relative 'related_person_group'
 
 module CarinForBlueButtonTestKit
   module CARIN4BBV200
-    class C4BBTestKit < Inferno::TestSuite
+    class C4BBTestSuite < Inferno::TestSuite
       title 'CARIN IG for Blue Button® v2.0.0'
+      description %(
+        The CARIN for Blue Button test suite validates system conformance to the HL7® FHIR® [CARIN for Blue Button® Implementation Guide](http://hl7.org/fhir/us/carin-bb/STU2).
+
+        
+      )
       version VERSION
       links [
         {
@@ -47,64 +48,37 @@ module CarinForBlueButtonTestKit
       input :url,
         title: 'FHIR Endpoint',
         description: 'URL of the FHIR endpoint'
-      input :smart_credentials,
-        title: 'OAuth Credentials',
-        type: :oauth_credentials,
-        optional: true
-
-      # SMART Test Suite requirement
-      group from: :smart_discovery,
-        run_as_group: true
-      group from: :smart_standalone_launch,
-        run_as_group: true,
-        config: {
-          outputs: {
-            patient_id: { name: :patient_ids },
-            smart_credentials: { name: :smart_credentials }
-          }
-        },
-        description: %(
-          # Background
-
-          The [Standalone
-          Launch Sequence](https://www.hl7.org/fhir/smart-app-launch/1.0.0/index.html#standalone-launch-sequence)
-          allows an app, like Inferno, to be launched independent of an
-          existing EHR session. It is one of the two launch methods described in
-          the SMART App Launch Framework alongside EHR Launch. The app will
-          request authorization for the provided scope from the authorization
-          endpoint, ultimately receiving an authorization token which can be used
-          to gain access to resources on the FHIR server.
-
-          # Test Methodology
-
-          Inferno will redirect the user to the authorization endpoint so that
-          they can provide any required credentials and authorize the application.
-          Upon successful authorization, Inferno will exchange the authorization
-          code provided for an access token.
-
-          For more information on the #{title}:
-
-          * [Standalone Launch Sequence](https://www.hl7.org/fhir/smart-app-launch/1.0.0/index.html#standalone-launch-sequence)
-        )
 
       fhir_client do
         url :url
         oauth_credentials :smart_credentials
       end
 
-      group from: :capability_statement_group
-  
-      group from: :c4bb_v200_patient
-      group from: :c4bb_v200_coverage
-      group from: :c4bb_v200_explanation_of_benefit
-      group from: :c4bb_v200_explanation_of_benefit_inpatient_institutional
-      group from: :c4bb_v200_explanation_of_benefit_outpatient_institutional
-      group from: :c4bb_v200_explanation_of_benefit_oral
-      group from: :c4bb_v200_explanation_of_benefit_pharmacy
-      group from: :c4bb_v200_explanation_of_benefit_professional_non_clinician
-      group from: :c4bb_v200_organization
-      group from: :c4bb_v200_practitioner
-      group from: :c4bb_v200_related_person
+      group from: :c4bb_v200_smart_launch
+
+      group do
+        title 'C4BB FHIR API Tests'
+        description %(
+          The CARIN for Blue Button FHIR API Tests evaluate the ability of a system (C4BB FHIR Server)
+          to support required and optional FHIR operations and search parameters to return
+          conformant C4BB resources.
+        )
+
+        input :smart_credentials,
+            title: 'OAuth Credentials',
+            type: :oauth_credentials,
+            optional: true
+        input_order :url, :smart_credentials
+
+        group from: :capability_statement_group
+    
+        group from: :c4bb_v200_patient
+        group from: :c4bb_v200_eob
+        group from: :c4bb_v200_coverage
+        group from: :c4bb_v200_organization
+        group from: :c4bb_v200_practitioner
+        group from: :c4bb_v200_related_person
+      end
     end
   end
 end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0/coverage/{coverage_id_search_test.rb → id_search_test.rb}

@@ -7,8 +7,7 @@ module CarinForBlueButtonTestKit
       include CarinForBlueButtonTestKit::CarinSearchTest
 
       title 'Server returns valid results for Coverage search by _id'
-      description %(
-A server SHALL support searching by
+      description %(A server SHALL support searching by
 _id on the Coverage resource. This test
 will pass if resources are returned and match the search criteria. If
 none are returned, the test is skipped.
@@ -25,21 +24,26 @@ requirement of CARIN IG for Blue Button® v2.0.0.
       )
 
       id :c4bb_v200_coverage__id_search_test
-
+      
       input :c4bb_v200_coverage__id_search_test_param,
-        title: 'Coverage search parameter for _id
-',
+        title: 'Coverage search parameter for _id',
         type: 'text',
-        description: 'Coverage search parameter: _id
-'
-
+        description: 'This input is optional. If running all tests, the search will look for
+                          its parameter values from the results returned in the EOB tests. If no
+                          Coverage resource was returned in previous EOB tests and this
+                          input is not provided, the search is skipped.
+
+                          When running just the Coverage Test group, this input is
+                          required to perform the search, otherwise the search is skipped.',
+        optional: true
+      
       def self.properties
         @properties ||= SearchTestProperties.new(
           first_search: true,
-        resource_type: 'Coverage',
-        search_param_names: ['_id'],
-        saves_delayed_references: true,
-        test_post_search: true
+          resource_type: 'Coverage',
+          search_param_names: ['_id'],
+          saves_delayed_references: true,
+          test_post_search: true
         )
       end