carin_for_blue_button_test_kit 0.9.1 → 0.11.0

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/organization/id_search_test.rb

@@ -0,0 +1,62 @@
+require_relative '../../../carin_search_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class OrganizationIdSearchTest < Inferno::Test
+      include CarinForBlueButtonTestKit::CarinSearchTest
+
+      title 'Server returns valid results for Organization search by _id'
+      description %(A server SHALL support searching by
+_id on the Organization resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+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 CARIN IG for Blue Button® v2.0.0-dev-nonfinancial.
+
+
+      )
+
+      id :c4bb_v200devnonfinancial_organization__id_search_test
+      
+      input :c4bb_v200devnonfinancial_organization__id_search_test_param,
+        title: 'Organization search parameter for _id',
+        type: 'text',
+        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
+                          Organization resource was returned in previous EOB tests and this
+                          input is not provided, the search is skipped.
+
+                          When running just the Organization 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: 'Organization',
+          search_param_names: ['_id'],
+          test_post_search: true
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:organization_resources] ||= {}
+      end
+
+      run do
+        run_search_test(c4bb_v200devnonfinancial_organization__id_search_test_param)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/organization/lastupdated_search_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../carin_search_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class OrganizationLastupdatedSearchTest < Inferno::Test
+      include CarinForBlueButtonTestKit::CarinSearchTest
+
+      title 'Server returns valid results for Organization search by _lastUpdated'
+      description %(A server SHOULD support searching by
+_lastUpdated on the Organization resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+
+      )
+
+      id :c4bb_v200devnonfinancial_organization__lastUpdated_search_test
+      optional
+      
+      
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Organization',
+          search_param_names: ['_lastUpdated']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:organization_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/organization/metadata.yml

@@ -0,0 +1,168 @@
+---
+:name: C4BB_Organization
+:class_name: C4bbOrganizationSequence
+:version: v2.0.0-dev-nonfinancial
+:reformatted_version: v200devnonfinancial
+:resource: Organization
+:conformance_expectation: SHOULD
+:profile_url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization
+:profile_name: C4BB Organization
+:profile_version: 2.0.0
+:title: Organization
+:short_description: Verify support for the server capabilities required by the C4BB
+  Organization.
+:interactions:
+- :code: search-type
+  :expectation: MAY
+- :code: read
+  :expectation: SHALL
+- :code: vread
+  :expectation: SHOULD
+:operations: []
+:searches:
+- :names:
+  - _id
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - _lastUpdated
+  :expectation: SHOULD
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :_id:
+    :paths:
+    - id
+    :full_paths:
+    - Organization.id
+    :comparators: {}
+    :values: []
+    :type: http://hl7.org/fhirpath/System.String
+    :target_paths:
+    - :path: id
+      :target: []
+    :contains_multiple: false
+  :_lastUpdated:
+    :paths:
+    - meta.lastUpdated
+    :full_paths:
+    - Organization.meta.lastUpdated
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: MAY
+      :ge: MAY
+      :lt: MAY
+      :le: MAY
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: instant
+    :target_paths:
+    - :path: meta.lastUpdated
+      :target: []
+    :contains_multiple: false
+:include_params: []
+:revincludes: []
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices:
+  - :name: Organization.identifier:NPI
+    :path: identifier
+    :discriminator:
+      :type: patternIdentifier
+      :path: ''
+      :system: http://hl7.org/fhir/sid/us-npi
+  - :name: Organization.identifier:tax
+    :path: identifier
+    :discriminator:
+      :type: patternIdentifier
+      :path: ''
+      :system: urn:oid:2.16.840.1.113883.4.4
+  - :name: Organization.identifier:payerid
+    :path: identifier
+    :discriminator:
+      :type: patternIdentifier
+      :path: ''
+      :system:
+  - :name: Organization.identifier:naiccode
+    :path: identifier
+    :discriminator:
+      :type: patternIdentifier
+      :path: ''
+      :system: urn:oid:2.16.840.1.113883.6.300
+  :elements:
+  - :path: meta
+  - :path: meta.lastUpdated
+  - :path: identifier
+  - :path: active
+  - :path: name
+  - :path: telecom
+  - :path: address
+  - :path: address.line
+  - :path: address.city
+  - :path: address.state
+  - :path: address.postalCode
+  - :path: address.country
+:mandatory_elements:
+- Organization.meta
+- Organization.meta.profile
+- Organization.active
+- Organization.name
+:bindings:
+- :type: Coding
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/security-labels
+  :path: meta.security
+- :type: Coding
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/common-tags
+  :path: meta.tag
+- :type: code
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: language
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/organization-type
+  :path: type
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/address-use
+  :path: address.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/address-type
+  :path: address.type
+- :type: string
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
+  :path: address.state
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/contactentity-type
+  :path: contact.purpose
+:references:
+- :path: Organization.partOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Organization.endpoint
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Endpoint
+:tests:
+- :id: c4bb_v200devnonfinancial_organization__id_search_test
+  :file_name: id_search_test.rb
+- :id: c4bb_v200devnonfinancial_organization__lastUpdated_search_test
+  :file_name: lastupdated_search_test.rb
+- :id: c4bb_v200devnonfinancial_organization_read_test
+  :file_name: read_test.rb
+- :id: c4bb_v200devnonfinancial_organization_validation_test
+  :file_name: validation_test.rb
+- :id: c4bb_v200devnonfinancial_organization_must_support_test
+  :file_name: must_support_test.rb
+:id: c4bb_v200devnonfinancial_organization
+:file_name: organization_group.rb
+:delayed_references: []

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/organization/must_support_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../../must_support_test'
+require_relative './read_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class OrganizationMustSupportTest < Inferno::Test
+      include CarinForBlueButtonTestKit::MustSupportTest
+      include CarinForBlueButtonTestKit::CARIN4BBV200DEVNONFINANCIAL
+
+      title 'All must support elements are provided in the Organization resources returned'
+      description %(
+        CARIN for Blue Button Responders SHALL be capable of populating all data elements as
+        part of the query results as specified by the CARIN for Blue Button Capability
+        Statement. This test will look through the Organization resources
+        found previously for the following must support elements:
+
+                * Organization.active
+        * Organization.address
+        * Organization.address.city
+        * Organization.address.country
+        * Organization.address.line
+        * Organization.address.postalCode
+        * Organization.address.state
+        * Organization.identifier
+        * Organization.identifier:NPI
+        * Organization.identifier:naiccode
+        * Organization.identifier:payerid
+        * Organization.identifier:tax
+        * Organization.meta
+        * Organization.meta.lastUpdated
+        * Organization.name
+        * Organization.telecom
+      )
+
+      id :c4bb_v200devnonfinancial_organization_must_support_test
+
+      def resource_type
+        'Organization'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:organization_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/organization/read_test.rb

@@ -0,0 +1,32 @@
+require_relative '../../../read_test'
+require 'json'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class OrganizationReadTest < Inferno::Test
+      include CarinForBlueButtonTestKit::ReadTest
+
+      title 'Server returns correct Organization resource from Organization read interaction'
+      description 'A server SHALL support the Organization read interaction.'
+
+      id :c4bb_v200devnonfinancial_organization_read_test
+      
+      def resource_type
+        'Organization'
+      end
+
+      def scratch_resources
+        scratch[:organization_resources] ||= {}
+      end
+
+      def resource_ids
+        return [] unless respond_to? :additional_organization_ids
+        additional_organization_ids.split(',').map(&:strip)
+      end
+
+      run do
+        perform_read_test(scratch.dig(:references, 'Organization'))
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/organization/validation_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../validation_test'
+require_relative './read_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class OrganizationValidationTest < Inferno::Test
+      include CarinForBlueButtonTestKit::ValidationTest
+      include CarinForBlueButtonTestKit::CARIN4BBV200DEVNONFINANCIAL
+
+      id :c4bb_v200devnonfinancial_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
+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.
+
+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
+        'Organization'
+      end
+
+      def scratch_resources
+        scratch[:organization_resources] ||= {}
+      end
+
+      run do
+        perform_validation_test(scratch_resources[:all] || [],
+                                'http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization',
+                                '2.0.0',
+                                skip_if_empty: true)
+      end
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/organization_group.rb

@@ -0,0 +1,86 @@
+require_relative 'organization/id_search_test'
+require_relative 'organization/lastupdated_search_test'
+require_relative 'organization/read_test'
+require_relative 'organization/validation_test'
+require_relative 'organization/must_support_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    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
+must contain resources conforming to the C4BB Organization as
+specified in the CARIN for Blue Button v2.0.0-dev-nonfinancial 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:
+
+* _id
+
+### 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
+Organization resources and save them for subsequent tests.
+Each resource 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 Organization resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [C4BB Organization](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization). Each element is checked against
+terminology 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 :c4bb_v200devnonfinancial_organization
+      run_as_group
+      optional
+      
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'organization', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :c4bb_v200devnonfinancial_organization__id_search_test
+      test from: :c4bb_v200devnonfinancial_organization__lastUpdated_search_test
+      test from: :c4bb_v200devnonfinancial_organization_read_test
+      test from: :c4bb_v200devnonfinancial_organization_validation_test
+      test from: :c4bb_v200devnonfinancial_organization_must_support_test
+    end
+  end
+end

data/lib/carin_for_blue_button_test_kit/generated/{v1.1.0/explanation_of_benefit/explanation_of_benefit_id_search_test.rb → v2.0.0-dev-nonfinancial/patient/id_search_test.rb}

@@ -2,14 +2,13 @@ require_relative '../../../carin_search_test'
 require_relative '../../../generator/group_metadata'
 
 module CarinForBlueButtonTestKit
-  module CARIN4BBV110
-    class ExplanationOfBenefitIdSearchTest < Inferno::Test
+  module CARIN4BBV200DEVNONFINANCIAL
+    class PatientIdSearchTest < Inferno::Test
       include CarinForBlueButtonTestKit::CarinSearchTest
 
-      title 'Server returns valid results for ExplanationOfBenefit search by _id'
-      description %(
-A server SHALL support searching by
-_id on the ExplanationOfBenefit resource. This test
+      title 'Server returns valid results for Patient search by _id'
+      description %(A server SHALL support searching by
+_id on the Patient resource. This test
 will pass if resources are returned and match the search criteria. If
 none are returned, the test is skipped.
 
@@ -19,27 +18,25 @@ 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 CARIN IG for Blue Button® v1.1.0.
+requirement of CARIN IG for Blue Button® v2.0.0-dev-nonfinancial.
 
 
       )
 
-      id :c4bb_v110_explanation_of_benefit__id_search_test
-
-      input :c4bb_v110_explanation_of_benefit__id_search_test_param,
-        title: 'ExplanationOfBenefit search parameter for _id
-',
+      id :c4bb_v200devnonfinancial_patient__id_search_test
+      
+      input :patient_ids,
+        title: 'Patient IDs',
         type: 'text',
-        description: 'ExplanationOfBenefit search parameter: _id
-'
-
+        description: 'Comma separated list of patient IDs that in sum
+                          contain all MUST SUPPORT elements'
+      
       def self.properties
         @properties ||= SearchTestProperties.new(
           first_search: true,
-        resource_type: 'ExplanationOfBenefit',
-        search_param_names: ['_id'],
-        saves_delayed_references: true,
-        test_post_search: true
+          resource_type: 'Patient',
+          search_param_names: ['_id'],
+          test_post_search: true
         )
       end
 
@@ -48,11 +45,11 @@ requirement of CARIN IG for Blue Button® v1.1.0.
       end
 
       def scratch_resources
-        scratch[:explanation_of_benefit_resources] ||= {}
+        scratch[:patient_resources] ||= {}
       end
 
       run do
-        run_search_test(c4bb_v110_explanation_of_benefit__id_search_test_param)
+        run_search_test
       end
     end
   end

data/lib/carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/patient/lastupdated_search_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../carin_search_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class PatientLastupdatedSearchTest < Inferno::Test
+      include CarinForBlueButtonTestKit::CarinSearchTest
+
+      title 'Server returns valid results for Patient search by _lastUpdated'
+      description %(A server SHOULD support searching by
+_lastUpdated on the Patient resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+
+      )
+
+      id :c4bb_v200devnonfinancial_patient__lastUpdated_search_test
+      optional
+      
+      
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Patient',
+          search_param_names: ['_lastUpdated']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:patient_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end