ipa_test_kit 0.2.0

data/lib/ipa_test_kit/generated/heartrate/metadata.yml

@@ -0,0 +1,325 @@
+---
+:name: heartrate
+:class_name: HeartrateSequence
+:version: v0.1.0
+:reformatted_version: v010
+:resource: Observation
+:profile_url: http://hl7.org/fhir/StructureDefinition/heartrate
+:profile_name: Observation Heart Rate Profile
+:title: Observation Heart Rate
+:short_description: Verify support for the server capabilities required by the Observation
+  Heart Rate 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:
+- :expectation: SHALL
+  :names:
+  - patient
+  - code
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHALL
+  :names:
+  - patient
+  - category
+  - date
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - patient
+  - category
+  - status
+  :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: SHALL
+  :names:
+  - patient
+  - category
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :patient:
+    :path: subject
+    :full_path: Observation.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :category:
+    :path: category
+    :full_path: Observation.category
+    :comparators: {}
+    :values:
+    - vital-signs
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY
+  :date:
+    :path: effective
+    :full_path: Observation.effective
+    :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:
+    :path: status
+    :full_path: Observation.status
+    :comparators: {}
+    :values:
+    - registered
+    - preliminary
+    - final
+    - amended
+    - corrected
+    - cancelled
+    - entered-in-error
+    - unknown
+    :type: code
+    :contains_multiple: false
+    :multiple_or: SHALL
+  :code:
+    :path: code
+    :full_path: Observation.code
+    :comparators: {}
+    :values:
+    - 8867-4
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: SHOULD
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts:
+:must_supports:
+  :extensions: []
+  :slices:
+  - :name: Observation.value[x]:valueQuantity
+    :path: value[x]
+    :discriminator:
+      :type: type
+      :code: Quantity
+  - :name: Observation.category:VSCat
+    :path: category
+    :discriminator:
+      :type: value
+      :values:
+      - :path: coding.code
+        :value: vital-signs
+      - :path: coding.system
+        :value: http://terminology.hl7.org/CodeSystem/observation-category
+  :elements:
+  - :path: status
+  - :path: category
+  - :path: category.coding
+  - :path: category.coding.system
+    :fixed_value: http://terminology.hl7.org/CodeSystem/observation-category
+  - :path: category.coding.code
+    :fixed_value: vital-signs
+  - :path: code
+  - :path: subject
+  - :path: effective[x]
+  - :path: value[x]
+  - :path: value[x].value
+  - :path: value[x].unit
+  - :path: value[x].system
+    :fixed_value: http://unitsofmeasure.org
+  - :path: value[x].code
+    :fixed_value: "/min"
+:mandatory_elements:
+- Observation.status
+- Observation.category
+- Observation.category
+- Observation.category.coding
+- Observation.category.coding.system
+- Observation.category.coding.code
+- Observation.code
+- Observation.code.coding
+- Observation.code.coding.system
+- Observation.code.coding.code
+- Observation.subject
+- Observation.effective[x]
+- Observation.value[x].value
+- Observation.value[x].unit
+- Observation.value[x].system
+- Observation.value[x].code
+- Observation.component.code
+:bindings:
+- :type: code
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: language
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/observation-status
+  :path: status
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/observation-category
+  :path: category
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/observation-category
+  :path: category
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/observation-vitalsignresult
+  :path: code
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/quantity-comparator
+  :path: value.comparator
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/data-absent-reason
+  :path: dataAbsentReason
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/observation-interpretation
+  :path: interpretation
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/body-site
+  :path: bodySite
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/observation-methods
+  :path: method
+- :type: CodeableConcept
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/referencerange-meaning
+  :path: referenceRange.type
+- :type: CodeableConcept
+  :strength: example
+  :system: http://hl7.org/fhir/ValueSet/referencerange-appliesto
+  :path: referenceRange.appliesTo
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/observation-vitalsignresult
+  :path: component.code
+- :type: Quantity
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/ucum-vitals-common
+  :path: component.value
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/data-absent-reason
+  :path: component.dataAbsentReason
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/observation-interpretation
+  :path: component.interpretation
+:references:
+- :path: Observation.basedOn
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/CarePlan
+  - http://hl7.org/fhir/StructureDefinition/DeviceRequest
+  - http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
+  - http://hl7.org/fhir/StructureDefinition/MedicationRequest
+  - http://hl7.org/fhir/StructureDefinition/NutritionOrder
+  - http://hl7.org/fhir/StructureDefinition/ServiceRequest
+- :path: Observation.partOf
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/MedicationAdministration
+  - http://hl7.org/fhir/StructureDefinition/MedicationDispense
+  - http://hl7.org/fhir/StructureDefinition/MedicationStatement
+  - http://hl7.org/fhir/StructureDefinition/Procedure
+  - http://hl7.org/fhir/StructureDefinition/Immunization
+  - http://hl7.org/fhir/StructureDefinition/ImagingStudy
+- :path: Observation.subject
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+- :path: Observation.focus
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+- :path: Observation.encounter
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Encounter
+- :path: Observation.performer
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Organization
+  - http://hl7.org/fhir/StructureDefinition/CareTeam
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+- :path: Observation.specimen
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Specimen
+- :path: Observation.device
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/StructureDefinition/DeviceMetric
+- :path: Observation.hasMember
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse
+  - http://hl7.org/fhir/StructureDefinition/MolecularSequence
+  - http://hl7.org/fhir/StructureDefinition/vitalsigns
+- :path: Observation.derivedFrom
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/DocumentReference
+  - http://hl7.org/fhir/StructureDefinition/ImagingStudy
+  - http://hl7.org/fhir/StructureDefinition/Media
+  - http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse
+  - http://hl7.org/fhir/StructureDefinition/MolecularSequence
+  - http://hl7.org/fhir/StructureDefinition/vitalsigns
+:tests:
+- :id: ipa_010_heartrate_patient_code_search_test
+  :file_name: heartrate_patient_code_search_test.rb
+- :id: ipa_010_heartrate_patient_category_date_search_test
+  :file_name: heartrate_patient_category_date_search_test.rb
+- :id: ipa_010_heartrate_patient_category_status_search_test
+  :file_name: heartrate_patient_category_status_search_test.rb
+- :id: ipa_010_heartrate_patient_code_date_search_test
+  :file_name: heartrate_patient_code_date_search_test.rb
+- :id: ipa_010_heartrate_patient_category_search_test
+  :file_name: heartrate_patient_category_search_test.rb
+- :id: ipa_010_heartrate_read_test
+  :file_name: heartrate_read_test.rb
+- :id: ipa_010_heartrate_provenance_revinclude_search_test
+  :file_name: heartrate_provenance_revinclude_search_test.rb
+- :id: ipa_010_heartrate_validation_test
+  :file_name: heartrate_validation_test.rb
+- :id: ipa_010_heartrate_must_support_test
+  :file_name: heartrate_must_support_test.rb
+- :id: ipa_010_heartrate_reference_resolution_test
+  :file_name: heartrate_reference_resolution_test.rb
+:id: ipa_010_heartrate
+:file_name: heartrate_group.rb
+:delayed_references: []

data/lib/ipa_test_kit/generated/heartrate_group.rb

@@ -0,0 +1,93 @@
+require_relative 'heartrate/heartrate_patient_code_search_test'
+require_relative 'heartrate/heartrate_patient_category_date_search_test'
+require_relative 'heartrate/heartrate_patient_category_status_search_test'
+require_relative 'heartrate/heartrate_patient_code_date_search_test'
+require_relative 'heartrate/heartrate_patient_category_search_test'
+require_relative 'heartrate/heartrate_read_test'
+require_relative 'heartrate/heartrate_provenance_revinclude_search_test'
+require_relative 'heartrate/heartrate_validation_test'
+require_relative 'heartrate/heartrate_must_support_test'
+require_relative 'heartrate/heartrate_reference_resolution_test'
+
+module IpaTestKit
+  class HeartrateGroup < Inferno::TestGroup
+    title 'Observation Heart Rate Tests'
+    short_description 'Verify support for the server capabilities required by the Observation Heart Rate Profile.'
+    description %(
+# Background
+
+The IPA Observation Heart Rate sequence verifies that the system under test is
+able to provide correct responses for Observation queries. These queries
+must contain resources conforming to the Observation Heart Rate Profile as
+specified in the IPA v0.1.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 + code
+* patient + category + date
+* patient + category
+
+### 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
+Observation 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 Observation resources found in the first test for these
+elements.
+
+## Profile Validation
+Each resource returned from the first search is expected to conform to
+the [Observation Heart Rate Profile](http://hl7.org/fhir/StructureDefinition/heartrate). 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
+Each reference within the resources found from the previous tests must
+resolve. The test will attempt to read each reference found and will
+fail if any attempted read fails.
+
+    )
+
+    id :ipa_010_heartrate
+    run_as_group
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'heartrate', 'metadata.yml')))
+    end
+
+    test from: :ipa_010_heartrate_patient_code_search_test
+    test from: :ipa_010_heartrate_patient_category_date_search_test
+    test from: :ipa_010_heartrate_patient_category_status_search_test
+    test from: :ipa_010_heartrate_patient_code_date_search_test
+    test from: :ipa_010_heartrate_patient_category_search_test
+    test from: :ipa_010_heartrate_read_test
+    test from: :ipa_010_heartrate_provenance_revinclude_search_test
+    test from: :ipa_010_heartrate_validation_test
+    test from: :ipa_010_heartrate_must_support_test
+    test from: :ipa_010_heartrate_reference_resolution_test
+  end
+end

data/lib/ipa_test_kit/generated/immunization/immunization_must_support_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../must_support_test'
+
+module IpaTestKit
+  class ImmunizationMustSupportTest < Inferno::Test
+    include IpaTestKit::MustSupportTest
+
+    title 'All must support elements are provided in the Immunization resources returned'
+    description %(
+      IPA Responders SHALL be capable of populating all data elements as
+      part of the query results as specified by the IPA Server Capability
+      Statement. This test will look through the Immunization resources
+      found previously for the following must support elements:
+
+      * Immunization.occurrence[x]
+      * Immunization.patient
+      * Immunization.primarySource
+      * Immunization.status
+      * Immunization.statusReason
+      * Immunization.vaccineCode
+    )
+
+    id :ipa_010_immunization_must_support_test
+
+    def resource_type
+      'Immunization'
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:immunization_resources] ||= {}
+    end
+
+    run do
+      perform_must_support_test(all_scratch_resources)
+    end
+  end
+end

data/lib/ipa_test_kit/generated/immunization/immunization_patient_date_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class ImmunizationPatientDateSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Immunization search by patient + date'
+    description %(
+A server SHOULD support searching by
+patient + date on the Immunization resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_immunization_patient_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: 'Immunization',
+        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')))
+    end
+
+    def scratch_resources
+      scratch[:immunization_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/immunization/immunization_patient_search_test.rb

@@ -0,0 +1,60 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class ImmunizationPatientSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Immunization search by patient'
+    description %(
+A server SHALL support searching by
+patient on the Immunization 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. IPA
+requires that both forms are supported by IPA 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 IPA v0.1.0.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_immunization_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: 'Immunization',
+        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')))
+    end
+
+    def scratch_resources
+      scratch[:immunization_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/immunization/immunization_patient_status_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class ImmunizationPatientStatusSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns valid results for Immunization search by patient + status'
+    description %(
+A server SHOULD support searching by
+patient + status on the Immunization resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+[IPA Server CapabilityStatement](https://build.fhir.org/ig/HL7/fhir-ipa/CapabilityStatement-ipa-server.html)
+
+    )
+
+    id :ipa_010_immunization_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: 'Immunization',
+        search_param_names: ['patient', 'status']
+      )
+    end
+
+    def self.metadata
+      @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+    end
+
+    def scratch_resources
+      scratch[:immunization_resources] ||= {}
+    end
+
+    run do
+      run_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/immunization/immunization_provenance_revinclude_search_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../search_test'
+require_relative '../../generator/group_metadata'
+
+module IpaTestKit
+  class ImmunizationProvenanceRevincludeSearchTest < Inferno::Test
+    include IpaTestKit::SearchTest
+
+    title 'Server returns Provenance resources from Immunization 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 :ipa_010_immunization_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: 'Immunization',
+        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[:immunization_resources] ||= {}
+    end
+
+    def scratch_provenance_resources
+      scratch[:provenance_resources] ||= {}
+    end
+
+    run do
+      run_provenance_revinclude_search_test
+    end
+  end
+end

data/lib/ipa_test_kit/generated/immunization/immunization_read_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../read_test'
+
+module IpaTestKit
+  class ImmunizationReadTest < Inferno::Test
+    include IpaTestKit::ReadTest
+
+    title 'Server returns correct Immunization resource from Immunization read interaction'
+    description 'A server SHALL support the Immunization read interaction.'
+
+    id :ipa_010_immunization_read_test
+
+    def resource_type
+      'Immunization'
+    end
+
+    def scratch_resources
+      scratch[:immunization_resources] ||= {}
+    end
+
+    run do
+      perform_read_test(all_scratch_resources)
+    end
+  end
+end