us_core_test_kit 0.1.0

data/lib/us_core_test_kit/generated/encounter/encounter_provenance_revinclude_search_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class EncounterProvenanceRevincludeSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns Provenance resources from Encounter search by patient + revInclude:Provenance:target'
+    description %(
+      A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+      This test will perform a search by patient + revInclude:Provenance:target and
+      will pass if a Provenance resource is found in the response.
+    %)
+
+    id :us_core_311_encounter_provenance_revinclude_search_test
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Encounter',
+        search_param_names: ['patient'],
+        possible_status_search: true
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def self.provenance_metadata
+      @provenance_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', 'provenance', 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:encounter_resources] ||= {}
+    end
+
+    def scratch_provenance_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      run_provenance_revinclude_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/encounter/encounter_read_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../read_test'
+
+module USCoreTestKit
+  class EncounterReadTest < Inferno::Test
+    include USCoreTestKit::ReadTest
+
+    title 'Server returns correct Encounter resource from Encounter read interaction'
+    description 'A server SHALL support the Encounter read interaction.'
+
+    id :us_core_311_encounter_read_test
+
+    def resource_type
+      'Encounter'
+    end
+
+    def scratch_resources
+      scratch[:encounter_resources] ||= {}
+    end
+
+    run do
+      perform_read_test(scratch.dig(:references, 'Encounter'))
+    end
+  end
+end

data/lib/us_core_test_kit/generated/encounter/encounter_reference_resolution_test.rb

@@ -0,0 +1,28 @@
+require_relative '../../reference_resolution_test'
+
+module USCoreTestKit
+  class EncounterReferenceResolutionTest < Inferno::Test
+    include USCoreTestKit::ReferenceResolutionTest
+
+    title 'Every reference within Encounter resources can be read'
+    description %(
+      This test will attempt to read the first 50 references found in the
+      resources from the first search. The test will fail if Inferno fails to
+      read any of those references.
+    )
+
+    id :us_core_311_encounter_reference_resolution_test
+
+    def resource_type
+      'Encounter'
+    end
+
+    def scratch_resources
+      scratch[:encounter_resources] ||= {}
+    end
+
+    run do
+      perform_reference_resolution_test(scratch_resources[:all])
+    end
+  end
+end

data/lib/us_core_test_kit/generated/encounter/encounter_validation_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../validation_test'
+
+module USCoreTestKit
+  class EncounterValidationTest < Inferno::Test
+    include USCoreTestKit::ValidationTest
+
+    id :us_core_311_encounter_validation_test
+    title 'Encounter resources returned during previous tests conform to the US Core Encounter Profile'
+    description %(
+This test verifies resources returned from the first search conform to
+the [US Core Encounter Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter).
+
+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
+      'Encounter'
+    end
+
+    def scratch_resources
+      scratch[:encounter_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [], 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter')
+    end
+  end
+end

data/lib/us_core_test_kit/generated/encounter_group.rb

@@ -0,0 +1,97 @@
+require_relative 'encounter/encounter_read_test'
+require_relative 'encounter/encounter_patient_search_test'
+require_relative 'encounter/encounter_id_search_test'
+require_relative 'encounter/encounter_identifier_search_test'
+require_relative 'encounter/encounter_class_patient_search_test'
+require_relative 'encounter/encounter_patient_status_search_test'
+require_relative 'encounter/encounter_patient_type_search_test'
+require_relative 'encounter/encounter_date_patient_search_test'
+require_relative 'encounter/encounter_provenance_revinclude_search_test'
+require_relative 'encounter/encounter_validation_test'
+require_relative 'encounter/encounter_must_support_test'
+require_relative 'encounter/encounter_reference_resolution_test'
+
+module USCoreTestKit
+  class EncounterGroup < Inferno::TestGroup
+    title 'Encounter Tests'
+    short_description 'Verify support for the server capabilities required by the US Core Encounter Profile.'
+    description %(
+# Background
+
+The US Core Encounter sequence verifies that the system under test is
+able to provide correct responses for Encounter queries. These queries
+must contain resources conforming to the US Core Encounter Profile as
+specified in the US Core v3.1.1 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:
+
+* patient
+* _id
+* date + patient
+
+### 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
+Encounter resources and save them for subsequent tests. Each of
+these resources 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 Encounter resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [US Core Encounter Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter). Each element is checked against
+teminology binding and cardinality requirements.
+
+Elements with a required binding are validated against their bound
+ValueSet. If the code/system in the element is not part of the ValueSet,
+then the test will fail.
+
+## Reference Validation
+Each reference within the resources found from the previous tests must
+resolve. The test will attempt to read each reference found and will
+fail if any attempted read fails.
+
+    )
+
+    id :us_core_311_encounter
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'encounter', 'metadata.yml')))
+    end
+
+    test from: :us_core_311_encounter_read_test
+    test from: :us_core_311_encounter_patient_search_test
+    test from: :us_core_311_encounter__id_search_test
+    test from: :us_core_311_encounter_identifier_search_test
+    test from: :us_core_311_encounter_class_patient_search_test
+    test from: :us_core_311_encounter_patient_status_search_test
+    test from: :us_core_311_encounter_patient_type_search_test
+    test from: :us_core_311_encounter_date_patient_search_test
+    test from: :us_core_311_encounter_provenance_revinclude_search_test
+    test from: :us_core_311_encounter_validation_test
+    test from: :us_core_311_encounter_must_support_test
+    test from: :us_core_311_encounter_reference_resolution_test
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_must_support_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../must_support_test'
+
+module USCoreTestKit
+  class GoalMustSupportTest < Inferno::Test
+    include USCoreTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the Goal resources returned'
+    description %(
+      US Core Responders SHALL be capable of populating all data elements as
+      part of the query results as specified by the US Core Server Capability
+      Statement. This test will look through the Goal resources
+      found previously for the following must support elements:
+
+      * Goal.description
+      * Goal.lifecycleStatus
+      * Goal.subject
+      * Goal.target
+      * Goal.target.due[x]:dueDate
+    )
+
+    id :us_core_311_goal_must_support_test
+
+    def resource_type
+      'Goal'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_patient_lifecycle_status_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class GoalPatientLifecycleStatusSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Goal search by patient + lifecycle-status'
+    description %(
+A server SHOULD support searching by
+patient + lifecycle-status on the Goal resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_goal_patient_lifecycle_status_search_test
+    optional
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Goal',
+        search_param_names: ['patient', 'lifecycle-status']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_patient_search_test.rb

@@ -0,0 +1,60 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class GoalPatientSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Goal search by patient'
+    description %(
+A server SHALL support searching by
+patient on the Goal 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 US Core 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 US Core v3.1.1.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_goal_patient_search_test
+    input :patient_ids,
+      title: 'Patient IDs',
+      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: 'Goal',
+        search_param_names: ['patient'],
+        possible_status_search: true,
+        test_reference_variants: true,
+        test_post_search: true
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_patient_target_date_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class GoalPatientTargetDateSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns valid results for Goal search by patient + target-date'
+    description %(
+A server SHOULD support searching by
+patient + target-date on the Goal resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html)
+
+    )
+
+    id :us_core_311_goal_patient_target_date_search_test
+    optional
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def self.properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Goal',
+        search_param_names: ['patient', 'target-date'],
+        possible_status_search: true,
+        params_with_comparators: ['target-date']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_provenance_revinclude_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module USCoreTestKit
+  class GoalProvenanceRevincludeSearchTest < Inferno::Test
+    include USCoreTestKit::SearchTest
+
+    title 'Server returns Provenance resources from Goal search by patient + revInclude:Provenance:target'
+    description %(
+      A server SHALL be capable of supporting _revIncludes:Provenance:target.
+
+      This test will perform a search by patient + revInclude:Provenance:target and
+      will pass if a Provenance resource is found in the response.
+    %)
+
+    id :us_core_311_goal_provenance_revinclude_search_test
+
+    input :patient_ids,
+      title: 'Patient IDs',
+      description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+
+    def properties
+      @properties ||= SearchTestProperties.new(
+        resource_type: 'Goal',
+        search_param_names: ['patient']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def self.provenance_metadata
+      @provenance_metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, '..', 'provenance', 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    def scratch_provenance_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      run_provenance_revinclude_search_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_read_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../read_test'
+
+module USCoreTestKit
+  class GoalReadTest < Inferno::Test
+    include USCoreTestKit::ReadTest
+
+    title 'Server returns correct Goal resource from Goal read interaction'
+    description 'A server SHALL support the Goal read interaction.'
+
+    id :us_core_311_goal_read_test
+
+    def resource_type
+      'Goal'
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    run do
+      perform_read_test(all_scratch_resources)
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_reference_resolution_test.rb

@@ -0,0 +1,28 @@
+require_relative '../../reference_resolution_test'
+
+module USCoreTestKit
+  class GoalReferenceResolutionTest < Inferno::Test
+    include USCoreTestKit::ReferenceResolutionTest
+
+    title 'Every reference within Goal resources can be read'
+    description %(
+      This test will attempt to read the first 50 references found in the
+      resources from the first search. The test will fail if Inferno fails to
+      read any of those references.
+    )
+
+    id :us_core_311_goal_reference_resolution_test
+
+    def resource_type
+      'Goal'
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    run do
+      perform_reference_resolution_test(scratch_resources[:all])
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal/goal_validation_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../validation_test'
+
+module USCoreTestKit
+  class GoalValidationTest < Inferno::Test
+    include USCoreTestKit::ValidationTest
+
+    id :us_core_311_goal_validation_test
+    title 'Goal resources returned during previous tests conform to the US Core Goal Profile'
+    description %(
+This test verifies resources returned from the first search conform to
+the [US Core Goal Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal).
+
+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
+      'Goal'
+    end
+
+    def scratch_resources
+      scratch[:goal_resources] ||= {}
+    end
+
+    run do
+      perform_validation_test(scratch_resources[:all] || [], 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal')
+    end
+  end
+end

data/lib/us_core_test_kit/generated/goal_group.rb

@@ -0,0 +1,87 @@
+require_relative 'goal/goal_patient_search_test'
+require_relative 'goal/goal_patient_lifecycle_status_search_test'
+require_relative 'goal/goal_patient_target_date_search_test'
+require_relative 'goal/goal_read_test'
+require_relative 'goal/goal_provenance_revinclude_search_test'
+require_relative 'goal/goal_validation_test'
+require_relative 'goal/goal_must_support_test'
+require_relative 'goal/goal_reference_resolution_test'
+
+module USCoreTestKit
+  class GoalGroup < Inferno::TestGroup
+    title 'Goal Tests'
+    short_description 'Verify support for the server capabilities required by the US Core Goal Profile.'
+    description %(
+# Background
+
+The US Core Goal sequence verifies that the system under test is
+able to provide correct responses for Goal queries. These queries
+must contain resources conforming to the US Core Goal Profile as
+specified in the US Core v3.1.1 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:
+
+* patient
+
+### 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
+Goal resources and save them for subsequent tests. Each of
+these resources 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 Goal resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [US Core Goal Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal). Each element is checked against
+teminology binding and cardinality requirements.
+
+Elements with a required binding are validated against their bound
+ValueSet. If the code/system in the element is not part of the ValueSet,
+then the test will fail.
+
+## Reference Validation
+Each reference within the resources found from the previous tests must
+resolve. The test will attempt to read each reference found and will
+fail if any attempted read fails.
+
+    )
+
+    id :us_core_311_goal
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'goal', 'metadata.yml')))
+    end
+
+    test from: :us_core_311_goal_patient_search_test
+    test from: :us_core_311_goal_patient_lifecycle_status_search_test
+    test from: :us_core_311_goal_patient_target_date_search_test
+    test from: :us_core_311_goal_read_test
+    test from: :us_core_311_goal_provenance_revinclude_search_test
+    test from: :us_core_311_goal_validation_test
+    test from: :us_core_311_goal_must_support_test
+    test from: :us_core_311_goal_reference_resolution_test
+  end
+end