us_core_test_kit 0.4.7 → 0.5.0

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

@@ -0,0 +1,232 @@
+---
+:name: us_core_procedure
+:class_name: USCorev600ProcedureSequence
+:version: v6.0.0
+:reformatted_version: v600
+:resource: Procedure
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure
+:profile_name: US Core Procedure Profile
+:profile_version: 6.0.0
+:title: Procedure
+:short_description: Verify support for the server capabilities required by the US
+  Core Procedure 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
+- :expectation: SHOULD
+  :names:
+  - patient
+  - code
+  - date
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - status
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHALL
+  :names:
+  - patient
+  - date
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - Procedure.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :code:
+    :paths:
+    - code
+    :full_paths:
+    - Procedure.code
+    :comparators: {}
+    :values: []
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: SHOULD
+  :date:
+    :paths:
+    - performed
+    :full_paths:
+    - Procedure.performed
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: SHALL
+      :ge: SHALL
+      :lt: SHALL
+      :le: SHALL
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: date
+    :contains_multiple: false
+    :multiple_or: MAY
+  :status:
+    :paths:
+    - status
+    :full_paths:
+    - Procedure.status
+    :comparators: {}
+    :values:
+    - preparation
+    - in-progress
+    - not-done
+    - on-hold
+    - stopped
+    - completed
+    - entered-in-error
+    - unknown
+    :type: code
+    :contains_multiple: false
+    :multiple_or: SHALL
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts: []
+:must_supports:
+  :extensions: []
+  :slices: []
+  :elements:
+  - :path: basedOn
+    :uscdi_only: true
+    :types:
+    - Reference
+  - :path: status
+  - :path: code
+  - :path: subject
+    :types:
+    - Reference
+  - :path: performedDateTime
+    :original_path: performed[x]
+:mandatory_elements:
+- Procedure.status
+- Procedure.code
+- Procedure.subject
+- Procedure.performer.actor
+- Procedure.focalDevice.manipulated
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/event-status
+  :path: status
+:references:
+- :path: Procedure.basedOn
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest
+- :path: Procedure.partOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Procedure
+  - http://hl7.org/fhir/StructureDefinition/Observation
+  - http://hl7.org/fhir/StructureDefinition/MedicationAdministration
+- :path: Procedure.subject
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: Procedure.encounter
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Encounter
+- :path: Procedure.recorder
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+- :path: Procedure.asserter
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+- :path: Procedure.performer.actor
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Organization
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+  - http://hl7.org/fhir/StructureDefinition/Device
+- :path: Procedure.performer.onBehalfOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Procedure.location
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Location
+- :path: Procedure.reasonReference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Condition
+  - http://hl7.org/fhir/StructureDefinition/Observation
+  - http://hl7.org/fhir/StructureDefinition/Procedure
+  - http://hl7.org/fhir/StructureDefinition/DiagnosticReport
+  - http://hl7.org/fhir/StructureDefinition/DocumentReference
+- :path: Procedure.report
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/DiagnosticReport
+  - http://hl7.org/fhir/StructureDefinition/DocumentReference
+  - http://hl7.org/fhir/StructureDefinition/Composition
+- :path: Procedure.complicationDetail
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Condition
+- :path: Procedure.focalDevice.manipulated
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Device
+- :path: Procedure.usedReference
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/Medication
+  - http://hl7.org/fhir/StructureDefinition/Substance
+:tests:
+- :id: us_core_v600_procedure_patient_search_test
+  :file_name: procedure_patient_search_test.rb
+- :id: us_core_v600_procedure_patient_code_date_search_test
+  :file_name: procedure_patient_code_date_search_test.rb
+- :id: us_core_v600_procedure_patient_status_search_test
+  :file_name: procedure_patient_status_search_test.rb
+- :id: us_core_v600_procedure_patient_date_search_test
+  :file_name: procedure_patient_date_search_test.rb
+- :id: us_core_v600_procedure_read_test
+  :file_name: procedure_read_test.rb
+- :id: us_core_v600_procedure_provenance_revinclude_search_test
+  :file_name: procedure_provenance_revinclude_search_test.rb
+- :id: us_core_v600_procedure_validation_test
+  :file_name: procedure_validation_test.rb
+- :id: us_core_v600_procedure_must_support_test
+  :file_name: procedure_must_support_test.rb
+- :id: us_core_v600_procedure_reference_resolution_test
+  :file_name: procedure_reference_resolution_test.rb
+:id: us_core_v600_procedure
+:file_name: procedure_group.rb
+:delayed_references: []

data/lib/us_core_test_kit/generated/v6.0.0/procedure/procedure_must_support_test.rb

@@ -0,0 +1,44 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV600
+    class ProcedureMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Procedure 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 Procedure resources
+        found previously for the following must support elements:
+
+        * Procedure.code
+        * Procedure.performedDateTime
+        * Procedure.status
+        * Procedure.subject
+
+        For ONC USCDI requirements, each Procedure must support the following additional elements:
+
+        * Procedure.basedOn
+      )
+
+      id :us_core_v600_procedure_must_support_test
+
+      def resource_type
+        'Procedure'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:procedure_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/procedure/procedure_patient_code_date_search_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class ProcedurePatientCodeDateSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Procedure search by patient + code + date'
+      description %(
+A server SHOULD support searching by
+patient + code + date on the Procedure 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_procedure_patient_code_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: 'Procedure',
+        search_param_names: ['patient', 'code', 'date'],
+        possible_status_search: true,
+        token_search_params: ['code'],
+        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[:procedure_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/procedure/procedure_patient_date_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class ProcedurePatientDateSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Procedure search by patient + date'
+      description %(
+A server SHALL support searching by
+patient + date on the Procedure 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_procedure_patient_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: 'Procedure',
+        search_param_names: ['patient', 'date'],
+        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[:procedure_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/procedure/procedure_patient_search_test.rb

@@ -0,0 +1,62 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class ProcedurePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Procedure search by patient'
+      description %(
+A server SHALL support searching by
+patient on the Procedure 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_procedure_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: 'Procedure',
+        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[:procedure_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/procedure/procedure_patient_status_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class ProcedurePatientStatusSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Procedure search by patient + status'
+      description %(
+A server SHOULD support searching by
+patient + status on the Procedure 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_procedure_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: 'Procedure',
+        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[:procedure_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/procedure/procedure_provenance_revinclude_search_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class ProcedureProvenanceRevincludeSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns Provenance resources from Procedure 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_procedure_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: 'Procedure',
+        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[:procedure_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/procedure/procedure_read_test.rb

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

data/lib/us_core_test_kit/generated/v6.0.0/procedure/procedure_reference_resolution_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../reference_resolution_test'
+require_relative '../resource_list'
+
+module USCoreTestKit
+  module USCoreV600
+    class ProcedureReferenceResolutionTest < Inferno::Test
+      include USCoreTestKit::ReferenceResolutionTest
+      include ResourceList
+
+      title 'MustSupport references within Procedure 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:
+
+        * Procedure.basedOn
+        * Procedure.subject
+      )
+
+      id :us_core_v600_procedure_reference_resolution_test
+
+      def resource_type
+        'Procedure'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:procedure_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/procedure/procedure_validation_test.rb

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