us_core_test_kit 0.2.5 → 0.3.0

data/lib/us_core_test_kit/generated/v5.0.1/provenance/metadata.yml

@@ -0,0 +1,201 @@
+---
+:name: us_core_provenance
+:class_name: USCorev501ProvenanceSequence
+:version: v5.0.1
+:reformatted_version: v501
+:resource: Provenance
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
+:profile_name: US Core Provenance Profile
+:profile_version: 5.0.1
+:title: Provenance
+:short_description: Verify support for the server capabilities required by the US
+  Core Provenance Profile.
+:interactions:
+- :code: create
+  :expectation: MAY
+- :code: search-type
+  :expectation: MAY
+- :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: []
+:search_definitions: {}
+:include_params: []
+:revincludes: []
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices:
+  - :name: Provenance.agent:ProvenanceAuthor
+    :path: agent
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: type
+      :code: author
+      :system: http://terminology.hl7.org/CodeSystem/provenance-participant-type
+  - :name: Provenance.agent:ProvenanceTransmitter
+    :path: agent
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: type
+      :code: transmitter
+      :system: http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
+  :elements:
+  - :path: target
+    :types:
+    - Reference
+  - :path: target.reference
+  - :path: recorded
+  - :path: agent
+  - :path: agent.type
+  - :path: agent.who
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - :path: agent.onBehalfOf
+    :types:
+    - Reference
+  - :path: agent.type.coding.code
+    :fixed_value: author
+  - :path: agent.type.coding.code
+    :fixed_value: transmitter
+:mandatory_elements:
+- Provenance.target
+- Provenance.recorded
+- Provenance.agent
+- Provenance.agent.who
+- Provenance.agent.type
+- Provenance.entity.role
+- Provenance.entity.what
+:bindings:
+- :type: code
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: language
+- :type: uri
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/resource-types
+  :path: target.type
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
+  :path: reason
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/provenance-activity-type
+  :path: activity
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
+  :path: agent.type
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/security-role-type
+  :path: agent.role
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/provenance-agent-type
+  :path: agent.type
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/security-role-type
+  :path: agent.role
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/provenance-agent-type
+  :path: agent.type
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/security-role-type
+  :path: agent.role
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/provenance-entity-role
+  :path: entity.role
+:references:
+- :path: Provenance.target
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+- :path: Provenance.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: Provenance.agent.who
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson
+  - http://hl7.org/fhir/StructureDefinition/Device
+- :path: Provenance.agent.onBehalfOf
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+- :path: Provenance.agent.who
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Provenance.agent.onBehalfOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Provenance.agent.who
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Provenance.agent.onBehalfOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Provenance.entity.what
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+:tests:
+- :id: us_core_v501_provenance_read_test
+  :file_name: provenance_read_test.rb
+- :id: us_core_v501_provenance_validation_test
+  :file_name: provenance_validation_test.rb
+- :id: us_core_v501_provenance_must_support_test
+  :file_name: provenance_must_support_test.rb
+- :id: us_core_v501_provenance_reference_resolution_test
+  :file_name: provenance_reference_resolution_test.rb
+:id: us_core_v501_provenance
+:file_name: provenance_group.rb
+:delayed_references:
+- :path: agent.who
+  :resources:
+  - Organization
+  - Practitioner
+  - PractitionerRole
+  - RelatedPerson
+- :path: agent.onBehalfOf
+  :resources:
+  - Organization

data/lib/us_core_test_kit/generated/v5.0.1/provenance/provenance_must_support_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV501
+    class ProvenanceMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Provenance 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 Provenance resources
+        found previously for the following must support elements:
+
+        * Provenance.agent
+        * Provenance.agent.onBehalfOf
+        * Provenance.agent.type
+        * Provenance.agent.type.coding.code
+        * Provenance.agent.who
+        * Provenance.agent:ProvenanceAuthor
+        * Provenance.agent:ProvenanceTransmitter
+        * Provenance.recorded
+        * Provenance.target
+        * Provenance.target.reference
+      )
+
+      id :us_core_v501_provenance_must_support_test
+
+      def resource_type
+        'Provenance'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:provenance_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/provenance/provenance_read_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/provenance/provenance_reference_resolution_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../../reference_resolution_test'
+require_relative '../resource_list'
+
+module USCoreTestKit
+  module USCoreV501
+    class ProvenanceReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+      include ResourceList
+
+      title 'MustSupport references within Provenance 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:
+
+        * Provenance.agent.onBehalfOf
+        * Provenance.agent.who
+        * Provenance.target
+      )
+
+      id :us_core_v501_provenance_reference_resolution_test
+
+      def resource_type
+        'Provenance'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:provenance_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/provenance/provenance_validation_test.rb

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

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

@@ -0,0 +1,59 @@
+require_relative 'provenance/provenance_read_test'
+require_relative 'provenance/provenance_validation_test'
+require_relative 'provenance/provenance_must_support_test'
+require_relative 'provenance/provenance_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV501
+    class ProvenanceGroup < Inferno::TestGroup
+      title 'Provenance Tests'
+      short_description 'Verify support for the server capabilities required by the US Core Provenance Profile.'
+      description %(
+  # Background
+
+The US Core Provenance sequence verifies that the system under test is
+able to provide correct responses for Provenance queries. These queries
+must contain resources conforming to the US Core Provenance Profile as
+specified in the US Core v5.0.1 Implementation Guide.
+
+# Testing Methodology
+
+
+## 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 Provenance 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 Provenance Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance). 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_provenance
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'provenance', 'metadata.yml')))
+      end
+  
+      test from: :us_core_v501_provenance_read_test
+      test from: :us_core_v501_provenance_validation_test
+      test from: :us_core_v501_provenance_must_support_test
+      test from: :us_core_v501_provenance_reference_resolution_test
+    end
+  end
+end