us_core_test_kit 0.7.2 → 0.8.1

data/lib/us_core_test_kit/generated/v7.0.0/document_reference_group.rb

@@ -0,0 +1,104 @@
+require_relative 'document_reference/document_reference_patient_search_test'
+require_relative 'document_reference/document_reference_id_search_test'
+require_relative 'document_reference/document_reference_patient_type_search_test'
+require_relative 'document_reference/document_reference_patient_category_date_search_test'
+require_relative 'document_reference/document_reference_patient_type_period_search_test'
+require_relative 'document_reference/document_reference_patient_status_search_test'
+require_relative 'document_reference/document_reference_patient_category_search_test'
+require_relative 'document_reference/document_reference_read_test'
+require_relative 'document_reference/document_reference_provenance_revinclude_search_test'
+require_relative 'document_reference/document_reference_validation_test'
+require_relative 'document_reference/document_reference_must_support_test'
+require_relative 'document_reference/document_reference_reference_resolution_test'
+require_relative '../../custom_groups/v4.0.0/document_reference_custodian_test'
+
+module USCoreTestKit
+  module USCoreV700
+    class DocumentReferenceGroup < Inferno::TestGroup
+      title 'DocumentReference Tests'
+      short_description 'Verify support for the server capabilities required by the US Core DocumentReference Profile.'
+      description %(
+  # Background
+
+The US Core DocumentReference sequence verifies that the system under test is
+able to provide correct responses for DocumentReference queries. These queries
+must contain resources conforming to the US Core DocumentReference Profile as
+specified in the US Core v7.0.0 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
+* patient + type
+* patient + category + date
+* patient + category
+
+### 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
+DocumentReference 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 DocumentReference 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 DocumentReference Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference). 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
+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 :us_core_v700_document_reference
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'document_reference', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :us_core_v700_document_reference_patient_search_test
+      test from: :us_core_v700_document_reference__id_search_test
+      test from: :us_core_v700_document_reference_patient_type_search_test
+      test from: :us_core_v700_document_reference_patient_category_date_search_test
+      test from: :us_core_v700_document_reference_patient_type_period_search_test
+      test from: :us_core_v700_document_reference_patient_status_search_test
+      test from: :us_core_v700_document_reference_patient_category_search_test
+      test from: :us_core_v700_document_reference_read_test
+      test from: :us_core_v700_document_reference_provenance_revinclude_search_test
+      test from: :us_core_v700_document_reference_validation_test
+      test from: :us_core_v700_document_reference_must_support_test
+      test from: :us_core_v700_document_reference_reference_resolution_test
+      test from: :us_core_v400_document_reference_custodian_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_class_patient_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterClassPatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by class + patient'
+      description %(
+A server SHOULD support searching by
+class + patient on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_class_patient_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: 'Encounter',
+        search_param_names: ['class', 'patient'],
+        possible_status_search: true,
+        token_search_params: ['class']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_date_patient_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterDatePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by date + patient'
+      description %(
+A server SHALL support searching by
+date + patient on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_date_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(
+          resource_type: 'Encounter',
+        search_param_names: ['date', 'patient'],
+        possible_status_search: true,
+        params_with_comparators: ['date']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_id_search_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterIdSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by _id'
+      description %(
+A server SHALL support searching by
+_id on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter__id_search_test
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Encounter',
+        search_param_names: ['_id'],
+        possible_status_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[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_identifier_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterIdentifierSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by identifier'
+      description %(
+A server SHOULD support searching by
+identifier on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_identifier_search_test
+      optional
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Encounter',
+        search_param_names: ['identifier'],
+        possible_status_search: true,
+        token_search_params: ['identifier']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_must_support_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Encounter 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 Encounter resources
+        found previously for the following must support elements:
+
+        * Encounter.class
+        * Encounter.hospitalization
+        * Encounter.hospitalization.dischargeDisposition
+        * Encounter.identifier
+        * Encounter.identifier.system
+        * Encounter.identifier.value
+        * Encounter.location
+        * Encounter.location.location or Encounter.serviceProvider
+        * Encounter.meta
+        * Encounter.meta.lastUpdated
+        * Encounter.participant
+        * Encounter.participant.individual
+        * Encounter.participant.period
+        * Encounter.participant.type
+        * Encounter.period
+        * Encounter.reasonCode or Encounter.reasonReference
+        * Encounter.status
+        * Encounter.subject
+        * Encounter.type
+      )
+
+      id :us_core_v700_encounter_must_support_test
+
+      def resource_type
+        'Encounter'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_patient_discharge_disposition_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterPatientDischargeDispositionSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by patient + discharge-disposition'
+      description %(
+A server SHOULD support searching by
+patient + discharge-disposition on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_patient_discharge_disposition_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: 'Encounter',
+        search_param_names: ['patient', 'discharge-disposition'],
+        possible_status_search: true,
+        token_search_params: ['discharge-disposition']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_patient_lastupdated_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterPatientLastupdatedSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by patient + _lastUpdated'
+      description %(
+A server SHOULD support searching by
+patient + _lastUpdated on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_patient__lastUpdated_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: 'Encounter',
+        search_param_names: ['patient', '_lastUpdated'],
+        possible_status_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[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_patient_location_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterPatientLocationSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by patient + location'
+      description %(
+A server SHOULD support searching by
+patient + location on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_patient_location_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: 'Encounter',
+        search_param_names: ['patient', 'location'],
+        possible_status_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[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_patient_search_test.rb

@@ -0,0 +1,63 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterPatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by patient'
+      description %(
+A server SHALL support searching by
+patient on the Encounter 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 v7.0.0.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_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: 'Encounter',
+        search_param_names: ['patient'],
+        saves_delayed_references: true,
+        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'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_patient_status_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterPatientStatusSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by patient + status'
+      description %(
+A server SHOULD support searching by
+patient + status on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_patient_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: 'Encounter',
+        search_param_names: ['patient', 'status']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/encounter/encounter_patient_type_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class EncounterPatientTypeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by patient + type'
+      description %(
+A server SHOULD support searching by
+patient + type on the Encounter 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_encounter_patient_type_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: 'Encounter',
+        search_param_names: ['patient', 'type'],
+        possible_status_search: true,
+        token_search_params: ['type']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end