us_core_test_kit 0.4.7 → 0.5.0

data/lib/us_core_test_kit/generated/v6.0.0/coverage/coverage_reference_resolution_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../reference_resolution_test'
+require_relative '../resource_list'
+
+module USCoreTestKit
+  module USCoreV600
+    class CoverageReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+      include ResourceList
+
+      title 'MustSupport references within Coverage resources are valid'
+      description %(
+        This test will attempt to read external references provided within elements
+        marked as 'MustSupport', if any are available.
+
+        It verifies that at least one external reference for each MustSupport Reference element
+        can be accessed by the test client, and conforms to corresponding US Core profile.
+
+        Elements which may provide external references include:
+
+        * Coverage.beneficiary
+        * Coverage.payor
+      )
+
+      id :us_core_v600_coverage_reference_resolution_test
+
+      def resource_type
+        'Coverage'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:coverage_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/coverage/coverage_validation_test.rb

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

data/lib/us_core_test_kit/generated/v6.0.0/coverage/metadata.yml

@@ -0,0 +1,160 @@
+---
+:name: us_core_coverage
+:class_name: USCorev600CoverageSequence
+:version: v6.0.0
+:reformatted_version: v600
+:resource: Coverage
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage
+:profile_name: US Core Coverage Profile
+:profile_version: 6.0.0
+:title: Coverage
+:short_description: Verify support for the server capabilities required by the US
+  Core Coverage Profile.
+:interactions:
+- :code: create
+  :expectation: MAY
+- :code: search-type
+  :expectation: SHALL
+- :code: read
+  :expectation: SHALL
+- :code: vread
+  :expectation: SHOULD
+- :code: update
+  :expectation: MAY
+- :code: patch
+  :expectation: MAY
+- :code: delete
+  :expectation: MAY
+- :code: history-instance
+  :expectation: SHOULD
+- :code: history-type
+  :expectation: MAY
+:operations: []
+:searches:
+- :names:
+  - patient
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :patient:
+    :paths:
+    - beneficiary
+    :full_paths:
+    - Coverage.beneficiary
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices:
+  - :name: Coverage.identifier:memberid
+    :path: identifier
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: type
+      :code: MB
+      :system: http://terminology.hl7.org/CodeSystem/v2-0203
+  - :name: Coverage.class:group
+    :path: class
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: type
+      :code: group
+      :system: http://terminology.hl7.org/CodeSystem/coverage-class
+  - :name: Coverage.class:plan
+    :path: class
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: type
+      :code: plan
+      :system: http://terminology.hl7.org/CodeSystem/coverage-class
+  :elements:
+  - :path: identifier
+  - :path: identifier.type.coding.code
+    :fixed_value: MB
+  - :path: status
+  - :path: type
+  - :path: subscriberId
+  - :path: beneficiary
+    :types:
+    - Reference
+  - :path: relationship
+  - :path: period
+  - :path: payor
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - :path: class
+  - :path: class.value
+  - :path: class.name
+:mandatory_elements:
+- Coverage.identifier.type
+- Coverage.status
+- Coverage.beneficiary
+- Coverage.relationship
+- Coverage.payor
+- Coverage.class.type
+- Coverage.class.value
+- Coverage.costToBeneficiary.value[x]
+- Coverage.costToBeneficiary.exception.type
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/identifier-use
+  :path: identifier.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/fm-status
+  :path: status
+:references:
+- :path: Coverage.identifier.assigner
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Coverage.policyHolder
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Coverage.subscriber
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+- :path: Coverage.beneficiary
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: Coverage.payor
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson
+- :path: Coverage.contract
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Contract
+:tests:
+- :id: us_core_v600_coverage_patient_search_test
+  :file_name: coverage_patient_search_test.rb
+- :id: us_core_v600_coverage_read_test
+  :file_name: coverage_read_test.rb
+- :id: us_core_v600_coverage_provenance_revinclude_search_test
+  :file_name: coverage_provenance_revinclude_search_test.rb
+- :id: us_core_v600_coverage_validation_test
+  :file_name: coverage_validation_test.rb
+- :id: us_core_v600_coverage_must_support_test
+  :file_name: coverage_must_support_test.rb
+- :id: us_core_v600_coverage_reference_resolution_test
+  :file_name: coverage_reference_resolution_test.rb
+:id: us_core_v600_coverage
+:file_name: coverage_group.rb
+:delayed_references:
+- :path: payor
+  :resources:
+  - Organization
+  - RelatedPerson

data/lib/us_core_test_kit/generated/v6.0.0/coverage_group.rb

@@ -0,0 +1,86 @@
+require_relative 'coverage/coverage_patient_search_test'
+require_relative 'coverage/coverage_read_test'
+require_relative 'coverage/coverage_provenance_revinclude_search_test'
+require_relative 'coverage/coverage_validation_test'
+require_relative 'coverage/coverage_must_support_test'
+require_relative 'coverage/coverage_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV600
+    class CoverageGroup < Inferno::TestGroup
+      title 'Coverage Tests'
+      short_description 'Verify support for the server capabilities required by the US Core Coverage Profile.'
+      description %(
+  # Background
+
+The US Core Coverage sequence verifies that the system under test is
+able to provide correct responses for Coverage queries. These queries
+must contain resources conforming to the US Core Coverage Profile as
+specified in the US Core v6.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
+
+### 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
+Coverage 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 Coverage 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 Coverage Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage). 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_v600_coverage
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'coverage', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :us_core_v600_coverage_patient_search_test
+      test from: :us_core_v600_coverage_read_test
+      test from: :us_core_v600_coverage_provenance_revinclude_search_test
+      test from: :us_core_v600_coverage_validation_test
+      test from: :us_core_v600_coverage_must_support_test
+      test from: :us_core_v600_coverage_reference_resolution_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/device/device_must_support_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV600
+    class DeviceMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Device 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 Device resources
+        found previously for the following must support elements:
+
+        * Device.distinctIdentifier
+        * Device.expirationDate
+        * Device.lotNumber
+        * Device.manufactureDate
+        * Device.patient
+        * Device.serialNumber
+        * Device.type
+        * Device.udiCarrier
+        * Device.udiCarrier.carrierHRF
+        * Device.udiCarrier.deviceIdentifier
+      )
+
+      id :us_core_v600_device_must_support_test
+
+      def resource_type
+        'Device'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/device/device_patient_search_test.rb

@@ -0,0 +1,68 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class DevicePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Device search by patient'
+      description %(
+A server SHALL support searching by
+patient on the Device 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 v6.0.0.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v600_device_patient_search_test
+      input :patient_ids,
+        title: 'Patient IDs',
+        description: 'Comma separated list of patient IDs that in sum contain all MUST SUPPORT elements'
+  
+      input :implantable_device_codes,
+        title: 'Implantable Device Type Code',
+        description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. '\
+                    'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+        optional: true
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          first_search: true,
+        resource_type: 'Device',
+        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'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/device/device_patient_status_search_test.rb

@@ -0,0 +1,54 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class DevicePatientStatusSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Device search by patient + status'
+      description %(
+A server SHOULD support searching by
+patient + status on the Device 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_v600_device_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'
+  
+      input :implantable_device_codes,
+        title: 'Implantable Device Type Code',
+        description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. '\
+                    'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+        optional: true
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Device',
+        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'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/device/device_patient_type_search_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class DevicePatientTypeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Device search by patient + type'
+      description %(
+A server SHOULD support searching by
+patient + type on the Device 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_v600_device_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'
+  
+      input :implantable_device_codes,
+        title: 'Implantable Device Type Code',
+        description: 'Enter the code for an Implantable Device type, or multiple codes separated by commas. '\
+                    'If blank, Inferno will validate all Device resources against the Implantable Device profile',
+        optional: true
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Device',
+        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[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/device/device_provenance_revinclude_search_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class DeviceProvenanceRevincludeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns Provenance resources from Device 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_v600_device_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: 'Device',
+        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'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_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/v6.0.0/device/device_read_test.rb

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

data/lib/us_core_test_kit/generated/v6.0.0/device/device_reference_resolution_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../reference_resolution_test'
+require_relative '../resource_list'
+
+module USCoreTestKit
+  module USCoreV600
+    class DeviceReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+      include ResourceList
+
+      title 'MustSupport references within Device resources are valid'
+      description %(
+        This test will attempt to read external references provided within elements
+        marked as 'MustSupport', if any are available.
+
+        It verifies that at least one external reference for each MustSupport Reference element
+        can be accessed by the test client, and conforms to corresponding US Core profile.
+
+        Elements which may provide external references include:
+
+        * Device.patient
+      )
+
+      id :us_core_v600_device_reference_resolution_test
+
+      def resource_type
+        'Device'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:device_resources] ||= {}
+      end
+
+      run do
+        perform_reference_resolution_test(scratch_resources[:all])
+      end
+    end
+  end
+end