carin_for_blue_button_test_kit 0.9.1 → 0.10.0

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

@@ -0,0 +1,144 @@
+---
+:name: C4BB_Practitioner
+:class_name: C4bbPractitionerSequence
+:version: v2.0.0-dev-nonfinancial
+:reformatted_version: v200devnonfinancial
+:resource: Practitioner
+:conformance_expectation: SHOULD
+:profile_url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner
+:profile_name: C4BB Practitioner
+:profile_version: 2.0.0
+:title: Practitioner
+:short_description: Verify support for the server capabilities required by the C4BB
+  Practitioner.
+: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:
+    - Practitioner.id
+    :comparators: {}
+    :values: []
+    :type: http://hl7.org/fhirpath/System.String
+    :target_paths:
+    - :path: id
+      :target: []
+    :contains_multiple: false
+  :_lastUpdated:
+    :paths:
+    - meta.lastUpdated
+    :full_paths:
+    - Practitioner.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: Practitioner.identifier:NPI
+    :path: identifier
+    :discriminator:
+      :type: patternIdentifier
+      :path: ''
+      :system: http://hl7.org/fhir/sid/us-npi
+  - :name: Practitioner.identifier:tax
+    :path: identifier
+    :discriminator:
+      :type: patternIdentifier
+      :path: ''
+      :system: urn:oid:2.16.840.1.113883.4.4
+  :elements:
+  - :path: meta
+  - :path: meta.lastUpdated
+  - :path: identifier
+  - :path: name
+  - :path: name.family
+:mandatory_elements:
+- Practitioner.meta
+- Practitioner.meta.profile
+- Practitioner.identifier
+- Practitioner.name
+- Practitioner.name.family
+- Practitioner.qualification.code
+: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: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/name-use
+  :path: name.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/administrative-gender
+  :path: gender
+- :type: CodeableConcept
+  :strength: example
+  :system: http://terminology.hl7.org/ValueSet/v2-2.7-0360
+  :path: qualification.code
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: communication
+:references:
+- :path: Practitioner.qualification.issuer
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+:tests:
+- :id: c4bb_v200devnonfinancial_practitioner__id_search_test
+  :file_name: id_search_test.rb
+- :id: c4bb_v200devnonfinancial_practitioner__lastUpdated_search_test
+  :file_name: lastupdated_search_test.rb
+- :id: c4bb_v200devnonfinancial_practitioner_read_test
+  :file_name: read_test.rb
+- :id: c4bb_v200devnonfinancial_practitioner_validation_test
+  :file_name: validation_test.rb
+- :id: c4bb_v200devnonfinancial_practitioner_must_support_test
+  :file_name: must_support_test.rb
+:id: c4bb_v200devnonfinancial_practitioner
+:file_name: practitioner_group.rb
+:delayed_references: []

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

@@ -0,0 +1,46 @@
+require_relative '../../../must_support_test'
+require_relative './read_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class PractitionerMustSupportTest < Inferno::Test
+      include CarinForBlueButtonTestKit::MustSupportTest
+      include CarinForBlueButtonTestKit::CARIN4BBV200DEVNONFINANCIAL
+
+      title 'All must support elements are provided in the Practitioner 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 Practitioner resources
+        found previously for the following must support elements:
+
+                * Practitioner.identifier
+        * Practitioner.identifier:NPI
+        * Practitioner.identifier:tax
+        * Practitioner.meta
+        * Practitioner.meta.lastUpdated
+        * Practitioner.name
+        * Practitioner.name.family
+      )
+
+      id :c4bb_v200devnonfinancial_practitioner_must_support_test
+
+      def resource_type
+        'Practitioner'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:practitioner_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/practitioner/read_test.rb

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

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

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

@@ -0,0 +1,86 @@
+require_relative 'practitioner/id_search_test'
+require_relative 'practitioner/lastupdated_search_test'
+require_relative 'practitioner/read_test'
+require_relative 'practitioner/validation_test'
+require_relative 'practitioner/must_support_test'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    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
+must contain resources conforming to the C4BB Practitioner 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
+Practitioner 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 Practitioner 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 Practitioner](http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Practitioner). 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_practitioner
+      run_as_group
+      optional
+      
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'practitioner', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :c4bb_v200devnonfinancial_practitioner__id_search_test
+      test from: :c4bb_v200devnonfinancial_practitioner__lastUpdated_search_test
+      test from: :c4bb_v200devnonfinancial_practitioner_read_test
+      test from: :c4bb_v200devnonfinancial_practitioner_validation_test
+      test from: :c4bb_v200devnonfinancial_practitioner_must_support_test
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require_relative '../../../carin_search_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class RelatedPersonIdSearchTest < Inferno::Test
+      include CarinForBlueButtonTestKit::CarinSearchTest
+
+      title 'Server returns valid results for RelatedPerson search by _id'
+      description %(A server SHALL support searching by
+_id on the RelatedPerson 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_related_person__id_search_test
+      
+      input :c4bb_v200devnonfinancial_related_person__id_search_test_param,
+        title: 'RelatedPerson 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
+                          RelatedPerson resource was returned in previous EOB tests and this
+                          input is not provided, the search is skipped.
+
+                          When running just the RelatedPerson 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: 'RelatedPerson',
+          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[:relatedperson_resources] ||= {}
+      end
+
+      run do
+        run_search_test(c4bb_v200devnonfinancial_related_person__id_search_test_param)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require_relative '../../../carin_search_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class RelatedPersonLastupdatedSearchTest < Inferno::Test
+      include CarinForBlueButtonTestKit::CarinSearchTest
+
+      title 'Server returns valid results for RelatedPerson search by _lastUpdated'
+      description %(A server SHOULD support searching by
+_lastUpdated on the RelatedPerson 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_related_person__lastUpdated_search_test
+      optional
+      
+      
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'RelatedPerson',
+          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[:relatedperson_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/related_person/metadata.yml

@@ -0,0 +1,133 @@
+---
+:name: C4BB_RelatedPerson
+:class_name: C4bbRelatedpersonSequence
+:version: v2.0.0-dev-nonfinancial
+:reformatted_version: v200devnonfinancial
+:resource: RelatedPerson
+:conformance_expectation: SHOULD
+:profile_url: http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson
+:profile_name: C4BB RelatedPerson
+:profile_version: 2.0.0
+:title: RelatedPerson
+:short_description: Verify support for the server capabilities required by the C4BB
+  RelatedPerson.
+: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:
+    - RelatedPerson.id
+    :comparators: {}
+    :values: []
+    :type: http://hl7.org/fhirpath/System.String
+    :target_paths:
+    - :path: id
+      :target: []
+    :contains_multiple: false
+  :_lastUpdated:
+    :paths:
+    - meta.lastUpdated
+    :full_paths:
+    - RelatedPerson.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: []
+  :elements:
+  - :path: meta
+  - :path: meta.lastUpdated
+  - :path: active
+  - :path: patient
+    :types:
+    - Reference
+  - :path: relationship
+  - :path: name
+  - :path: telecom
+  - :path: address
+:mandatory_elements:
+- RelatedPerson.meta
+- RelatedPerson.meta.lastUpdated
+- RelatedPerson.meta.profile
+- RelatedPerson.active
+- RelatedPerson.patient
+- RelatedPerson.communication.language
+: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: preferred
+  :system: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
+  :path: relationship
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/administrative-gender
+  :path: gender
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: communication.language
+:references:
+- :path: RelatedPerson.patient
+  :profiles:
+  - http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient
+:tests:
+- :id: c4bb_v200devnonfinancial_related_person__id_search_test
+  :file_name: id_search_test.rb
+- :id: c4bb_v200devnonfinancial_related_person__lastUpdated_search_test
+  :file_name: lastupdated_search_test.rb
+- :id: c4bb_v200devnonfinancial_related_person_read_test
+  :file_name: read_test.rb
+- :id: c4bb_v200devnonfinancial_related_person_validation_test
+  :file_name: validation_test.rb
+- :id: c4bb_v200devnonfinancial_related_person_must_support_test
+  :file_name: must_support_test.rb
+:id: c4bb_v200devnonfinancial_related_person
+:file_name: related_person_group.rb
+:delayed_references: []

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

@@ -0,0 +1,47 @@
+require_relative '../../../must_support_test'
+require_relative './read_test'
+require_relative '../../../generator/group_metadata'
+
+module CarinForBlueButtonTestKit
+  module CARIN4BBV200DEVNONFINANCIAL
+    class RelatedPersonMustSupportTest < Inferno::Test
+      include CarinForBlueButtonTestKit::MustSupportTest
+      include CarinForBlueButtonTestKit::CARIN4BBV200DEVNONFINANCIAL
+
+      title 'All must support elements are provided in the RelatedPerson 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 RelatedPerson resources
+        found previously for the following must support elements:
+
+                * RelatedPerson.active
+        * RelatedPerson.address
+        * RelatedPerson.meta
+        * RelatedPerson.meta.lastUpdated
+        * RelatedPerson.name
+        * RelatedPerson.patient
+        * RelatedPerson.relationship
+        * RelatedPerson.telecom
+      )
+
+      id :c4bb_v200devnonfinancial_related_person_must_support_test
+
+      def resource_type
+        'RelatedPerson'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:relatedperson_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/related_person/read_test.rb

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