us_core_test_kit 0.2.4 → 0.3.1

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

@@ -0,0 +1,387 @@
+---
+:name: us_core_condition_problems_health_concerns
+:class_name: USCorev501ConditionProblemsHealthConcernsSequence
+:version: v5.0.1
+:reformatted_version: v501
+:resource: Condition
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns
+:profile_name: US Core Condition Problems and Health Concerns Profile
+:profile_version: 5.0.1
+:title: Condition Problems and Health Concerns
+:short_description: Verify support for the server capabilities required by the US
+  Core Condition Problems and Health Concerns 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
+  - abatement-date
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - asserted-date
+  :names_not_must_support_or_mandatory:
+  - asserted-date
+  :must_support_or_mandatory: false
+- :expectation: SHOULD
+  :names:
+  - patient
+  - code
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - category
+  - encounter
+  :names_not_must_support_or_mandatory:
+  - encounter
+  :must_support_or_mandatory: false
+- :expectation: SHOULD
+  :names:
+  - patient
+  - category
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - recorded-date
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - onset-date
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - clinical-status
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - Condition.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :abatement-date:
+    :paths:
+    - abatementDateTime
+    - abatementPeriod
+    :full_paths:
+    - Condition.abatementDateTime
+    - Condition.abatementPeriod
+    :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
+  :asserted-date:
+    :paths:
+    - extension
+    :full_paths:
+    - Condition.extension
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: SHALL
+      :ge: SHALL
+      :lt: SHALL
+      :le: SHALL
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: Extension
+    :contains_multiple: true
+    :multiple_or: MAY
+  :code:
+    :paths:
+    - code
+    :full_paths:
+    - Condition.code
+    :comparators: {}
+    :values:
+    - '160245001'
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: MAY
+  :category:
+    :paths:
+    - category
+    :full_paths:
+    - Condition.category
+    :comparators: {}
+    :values:
+    - sdoh
+    - problem-list-item
+    - health-concern
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY
+  :encounter:
+    :paths:
+    - encounter
+    :full_paths:
+    - Condition.encounter
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :recorded-date:
+    :paths:
+    - recordedDate
+    :full_paths:
+    - Condition.recordedDate
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: SHALL
+      :ge: SHALL
+      :lt: SHALL
+      :le: SHALL
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: dateTime
+    :contains_multiple: false
+    :multiple_or: MAY
+  :onset-date:
+    :paths:
+    - onsetDateTime
+    - onsetPeriod
+    :full_paths:
+    - Condition.onsetDateTime
+    - Condition.onsetPeriod
+    :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
+  :clinical-status:
+    :paths:
+    - clinicalStatus
+    :full_paths:
+    - Condition.clinicalStatus
+    :comparators: {}
+    :values:
+    - active
+    - recurrence
+    - relapse
+    - inactive
+    - remission
+    - resolved
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts:
+- clinicalStatus
+- verificationStatus
+- category
+:must_supports:
+  :extensions:
+  - :id: Condition.extension:assertedDate
+    :url: http://hl7.org/fhir/StructureDefinition/condition-assertedDate
+  :slices:
+  - :name: Condition.category:us-core
+    :path: category
+    :discriminator:
+      :type: requiredBinding
+      :path: ''
+      :values:
+      - problem-list-item
+      - health-concern
+  - :name: Condition.category:sdoh
+    :path: category
+    :discriminator:
+      :type: patternCodeableConcept
+      :path: ''
+      :code: sdoh
+      :system: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
+  :elements:
+  - :path: clinicalStatus
+  - :path: verificationStatus
+  - :path: category
+  - :path: code
+  - :path: subject
+    :types:
+    - Reference
+  - :path: onsetDateTime
+    :original_path: onset[x]
+  - :path: abatementDateTime
+    :original_path: abatement[x]
+  - :path: recordedDate
+  :choices:
+  - :paths:
+    - onsetDateTime
+    :extension_ids:
+    - Condition.extension:assertedDate
+:mandatory_elements:
+- Condition.category
+- Condition.code
+- Condition.subject
+:bindings:
+- :type: code
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: language
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/condition-clinical
+  :path: clinicalStatus
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/condition-ver-status
+  :path: verificationStatus
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/condition-category
+  :path: category
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-problem-or-health-concern
+  :path: category
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/condition-category
+  :path: category
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/condition-severity
+  :path: severity
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
+  :path: code
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/body-site
+  :path: bodySite
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/condition-stage
+  :path: stage.summary
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/condition-stage-type
+  :path: stage.type
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/manifestation-or-symptom
+  :path: evidence.code
+:references:
+- :path: Condition.subject
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: Condition.encounter
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Encounter
+- :path: Condition.recorder
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+- :path: Condition.asserter
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+- :path: Condition.stage.assessment
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/ClinicalImpression
+  - http://hl7.org/fhir/StructureDefinition/DiagnosticReport
+  - http://hl7.org/fhir/StructureDefinition/Observation
+- :path: Condition.evidence.detail
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+:tests:
+- :id: us_core_v501_condition_problems_health_concerns_patient_search_test
+  :file_name: condition_problems_health_concerns_patient_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_abatement_date_search_test
+  :file_name: condition_problems_health_concerns_patient_abatement_date_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_asserted_date_search_test
+  :file_name: condition_problems_health_concerns_patient_asserted_date_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_code_search_test
+  :file_name: condition_problems_health_concerns_patient_code_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_category_encounter_search_test
+  :file_name: condition_problems_health_concerns_patient_category_encounter_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_category_search_test
+  :file_name: condition_problems_health_concerns_patient_category_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_recorded_date_search_test
+  :file_name: condition_problems_health_concerns_patient_recorded_date_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_onset_date_search_test
+  :file_name: condition_problems_health_concerns_patient_onset_date_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_patient_clinical_status_search_test
+  :file_name: condition_problems_health_concerns_patient_clinical_status_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_read_test
+  :file_name: condition_problems_health_concerns_read_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_provenance_revinclude_search_test
+  :file_name: condition_problems_health_concerns_provenance_revinclude_search_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_validation_test
+  :file_name: condition_problems_health_concerns_validation_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_must_support_test
+  :file_name: condition_problems_health_concerns_must_support_test.rb
+- :id: us_core_v501_condition_problems_health_concerns_reference_resolution_test
+  :file_name: condition_problems_health_concerns_reference_resolution_test.rb
+:id: us_core_v501_condition_problems_health_concerns
+:file_name: condition_problems_health_concerns_group.rb
+:delayed_references: []

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

@@ -0,0 +1,102 @@
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_abatement_date_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_asserted_date_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_code_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_category_encounter_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_category_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_recorded_date_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_onset_date_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_patient_clinical_status_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_read_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_provenance_revinclude_search_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_validation_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_must_support_test'
+require_relative 'condition_problems_health_concerns/condition_problems_health_concerns_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV501
+    class ConditionProblemsHealthConcernsGroup < Inferno::TestGroup
+      title 'Condition Problems and Health Concerns Tests'
+      short_description 'Verify support for the server capabilities required by the US Core Condition Problems and Health Concerns Profile.'
+      description %(
+  # Background
+
+The US Core Condition Problems and Health Concerns sequence verifies that the system under test is
+able to provide correct responses for Condition queries. These queries
+must contain resources conforming to the US Core Condition Problems and Health Concerns Profile 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
+
+### 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
+Condition resources with category `problem-list-item | health-concern` 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 Condition 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 Condition Problems and Health Concerns Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns). 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_condition_problems_health_concerns
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'condition_problems_health_concerns', 'metadata.yml')))
+      end
+  
+      test from: :us_core_v501_condition_problems_health_concerns_patient_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_abatement_date_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_asserted_date_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_code_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_category_encounter_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_category_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_recorded_date_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_onset_date_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_patient_clinical_status_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_read_test
+      test from: :us_core_v501_condition_problems_health_concerns_provenance_revinclude_search_test
+      test from: :us_core_v501_condition_problems_health_concerns_validation_test
+      test from: :us_core_v501_condition_problems_health_concerns_must_support_test
+      test from: :us_core_v501_condition_problems_health_concerns_reference_resolution_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/device/device_must_support_test.rb

@@ -0,0 +1,46 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV501
+    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_v501_device_must_support_test
+
+      def resource_type
+        'Device'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      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/v5.0.1/device/device_patient_search_test.rb

@@ -0,0 +1,67 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    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 v5.0.1.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core//CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v501_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'],
+        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[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/device/device_patient_type_search_test.rb

@@ -0,0 +1,54 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    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_v501_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'],
+        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[:device_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end