us_core_test_kit 0.2.3 → 0.3.0

data/lib/us_core_test_kit/generated/v5.0.1/diagnostic_report_note_group.rb

@@ -0,0 +1,99 @@
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_category_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_category_date_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_status_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_code_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_code_date_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_read_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_provenance_revinclude_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_validation_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_must_support_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV501
+    class DiagnosticReportNoteGroup < Inferno::TestGroup
+      title 'DiagnosticReport for Report and Note Exchange Tests'
+      short_description 'Verify support for the server capabilities required by the US Core DiagnosticReport Profile for Report and Note Exchange.'
+      description %(
+  # Background
+
+The US Core DiagnosticReport for Report and Note Exchange sequence verifies that the system under test is
+able to provide correct responses for DiagnosticReport queries. These queries
+must contain resources conforming to the US Core DiagnosticReport Profile for Report and Note Exchange as
+specified in the US Core v5.0.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 + category
+* patient
+* patient + category + date
+* patient + code
+
+### 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
+DiagnosticReport 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 DiagnosticReport 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 DiagnosticReport Profile for Report and Note Exchange](http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note). 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_v501_diagnostic_report_note
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'diagnostic_report_note', 'metadata.yml')))
+      end
+  
+      test from: :us_core_v501_diagnostic_report_note_patient_category_search_test
+      test from: :us_core_v501_diagnostic_report_note_patient_search_test
+      test from: :us_core_v501_diagnostic_report_note_patient_category_date_search_test
+      test from: :us_core_v501_diagnostic_report_note_patient_status_search_test
+      test from: :us_core_v501_diagnostic_report_note_patient_code_search_test
+      test from: :us_core_v501_diagnostic_report_note_patient_code_date_search_test
+      test from: :us_core_v501_diagnostic_report_note_read_test
+      test from: :us_core_v501_diagnostic_report_note_provenance_revinclude_search_test
+      test from: :us_core_v501_diagnostic_report_note_validation_test
+      test from: :us_core_v501_diagnostic_report_note_must_support_test
+      test from: :us_core_v501_diagnostic_report_note_reference_resolution_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_id_search_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_must_support_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV501
+    class DocumentReferenceMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the DocumentReference 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 DocumentReference resources
+        found previously for the following must support elements:
+
+        * DocumentReference.author
+        * DocumentReference.category
+        * DocumentReference.category:us-core
+        * DocumentReference.content
+        * DocumentReference.content.attachment
+        * DocumentReference.content.attachment.contentType
+        * DocumentReference.content.attachment.data or DocumentReference.content.attachment.url
+        * DocumentReference.content.format
+        * DocumentReference.context
+        * DocumentReference.context.encounter
+        * DocumentReference.context.period
+        * DocumentReference.date
+        * DocumentReference.identifier
+        * DocumentReference.status
+        * DocumentReference.subject
+        * DocumentReference.type
+      )
+
+      id :us_core_v501_document_reference_must_support_test
+
+      def resource_type
+        'DocumentReference'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:document_reference_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_patient_category_date_search_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_patient_category_search_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_patient_search_test.rb

@@ -0,0 +1,63 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class DocumentReferencePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for DocumentReference search by patient'
+      description %(
+A server SHALL support searching by
+patient on the DocumentReference 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 v5.0.1.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v501_document_reference_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: 'DocumentReference',
+        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')))
+      end
+
+      def scratch_resources
+        scratch[:document_reference_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_patient_status_search_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_patient_type_period_search_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_patient_type_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class DocumentReferencePatientTypeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for DocumentReference search by patient + type'
+      description %(
+A server SHALL support searching by
+patient + type on the DocumentReference 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//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v501_document_reference_patient_type_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: 'DocumentReference',
+        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')))
+      end
+
+      def scratch_resources
+        scratch[:document_reference_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_provenance_revinclude_search_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class DocumentReferenceProvenanceRevincludeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns Provenance resources from DocumentReference 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_v501_document_reference_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: 'DocumentReference',
+        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[:document_reference_resources] ||= {}
+      end
+
+      def scratch_provenance_resources
+        scratch[:provenance_resources] ||= {}
+      end
+
+      run do
+        run_provenance_revinclude_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_read_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_reference_resolution_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../../reference_resolution_test'
+require_relative '../resource_list'
+
+module USCoreTestKit
+  module USCoreV501
+    class DocumentReferenceReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+      include ResourceList
+
+      title 'MustSupport references within DocumentReference resources can be read'
+      description %(
+        This test will attempt to read external references provided within elements
+        marked as 'MustSupport', if any are available.  Elements which may provide
+        external references include:
+
+        * DocumentReference.author
+        * DocumentReference.context.encounter
+        * DocumentReference.subject
+      )
+
+      id :us_core_v501_document_reference_reference_resolution_test
+
+      def resource_type
+        'DocumentReference'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:document_reference_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/document_reference/document_reference_validation_test.rb

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