us_core_test_kit 0.7.2 → 0.8.0

data/lib/us_core_test_kit/generated/v7.0.0/diagnostic_report_note/metadata.yml

@@ -0,0 +1,316 @@
+---
+:name: us_core_diagnosticreport_note
+:class_name: USCorev700DiagnosticreportNoteSequence
+:version: v7.0.0
+:reformatted_version: v700
+:resource: DiagnosticReport
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note
+:profile_name: US Core DiagnosticReport Profile for Report and Note Exchange
+:profile_version: 7.0.0
+:title: DiagnosticReport for Report and Note Exchange
+:short_description: Verify support for the server capabilities required by the US
+  Core DiagnosticReport Profile for Report and Note Exchange.
+:is_delayed: false
+:interactions:
+- :code: create
+  :expectation: SHALL
+- :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
+  - category
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - patient
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :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
+  - 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: SHOULD
+  :names:
+  - patient
+  - category
+  - _lastUpdated
+  :names_not_must_support_or_mandatory:
+  - _lastUpdated
+  :must_support_or_mandatory: false
+:search_definitions:
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - DiagnosticReport.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :code:
+    :paths:
+    - code
+    :full_paths:
+    - DiagnosticReport.code
+    :comparators: {}
+    :values: []
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: SHOULD
+  :category:
+    :paths:
+    - category
+    :full_paths:
+    - DiagnosticReport.category
+    :comparators: {}
+    :values:
+    - LP29684-5
+    - LP29708-2
+    - LP7839-6
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY
+  :date:
+    :paths:
+    - effective
+    :full_paths:
+    - DiagnosticReport.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:
+    :paths:
+    - status
+    :full_paths:
+    - DiagnosticReport.status
+    :comparators: {}
+    :values:
+    - registered
+    - partial
+    - preliminary
+    - final
+    - amended
+    - corrected
+    - appended
+    - cancelled
+    - entered-in-error
+    - unknown
+    :type: code
+    :contains_multiple: false
+    :multiple_or: SHALL
+  :_lastUpdated:
+    :paths:
+    - meta.lastUpdated
+    :full_paths:
+    - DiagnosticReport.meta.lastUpdated
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: MAY
+      :ge: MAY
+      :lt: MAY
+      :le: MAY
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: date
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts:
+- category
+:must_supports:
+  :extensions: []
+  :slices:
+  - :slice_id: DiagnosticReport.category:us-core
+    :slice_name: us-core
+    :path: category
+    :discriminator:
+      :type: requiredBinding
+      :path: ''
+      :values:
+      - :system: http://loinc.org
+        :code: LP29684-5
+      - :system: http://loinc.org
+        :code: LP29708-2
+      - :system: http://loinc.org
+        :code: LP7839-6
+  :elements:
+  - :path: status
+  - :path: category
+  - :path: code
+  - :path: subject
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+  - :path: encounter
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
+  - :path: effectiveDateTime
+    :original_path: effective[x]
+  - :path: issued
+  - :path: performer
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - :path: result
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result
+  - :path: media
+  - :path: media.link
+    :types:
+    - Reference
+  - :path: presentedForm
+:mandatory_elements:
+- DiagnosticReport.status
+- DiagnosticReport.category
+- DiagnosticReport.code
+- DiagnosticReport.subject
+- DiagnosticReport.media.link
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/diagnostic-report-status
+  :path: status
+:references:
+- :path: DiagnosticReport.basedOn
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/CarePlan
+  - 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: DiagnosticReport.subject
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+  - http://hl7.org/fhir/StructureDefinition/Group
+  - http://hl7.org/fhir/StructureDefinition/Device
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-location
+- :path: DiagnosticReport.encounter
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
+- :path: DiagnosticReport.performer
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam
+- :path: DiagnosticReport.resultsInterpreter
+  :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
+- :path: DiagnosticReport.specimen
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Specimen
+- :path: DiagnosticReport.result
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result
+  - http://hl7.org/fhir/StructureDefinition/Observation
+- :path: DiagnosticReport.imagingStudy
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/ImagingStudy
+- :path: DiagnosticReport.media.link
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Media
+:tests:
+- :id: us_core_v700_diagnostic_report_note_patient_category_search_test
+  :file_name: diagnostic_report_note_patient_category_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_patient_search_test
+  :file_name: diagnostic_report_note_patient_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_patient_code_search_test
+  :file_name: diagnostic_report_note_patient_code_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_patient_category_date_search_test
+  :file_name: diagnostic_report_note_patient_category_date_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_patient_code_date_search_test
+  :file_name: diagnostic_report_note_patient_code_date_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_patient_status_search_test
+  :file_name: diagnostic_report_note_patient_status_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_patient_category__lastUpdated_search_test
+  :file_name: diagnostic_report_note_patient_category_lastupdated_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_read_test
+  :file_name: diagnostic_report_note_read_test.rb
+- :id: us_core_v700_diagnostic_report_note_provenance_revinclude_search_test
+  :file_name: diagnostic_report_note_provenance_revinclude_search_test.rb
+- :id: us_core_v700_diagnostic_report_note_validation_test
+  :file_name: diagnostic_report_note_validation_test.rb
+- :id: us_core_v700_diagnostic_report_note_must_support_test
+  :file_name: diagnostic_report_note_must_support_test.rb
+- :id: us_core_v700_diagnostic_report_note_reference_resolution_test
+  :file_name: diagnostic_report_note_reference_resolution_test.rb
+:id: us_core_v700_diagnostic_report_note
+:file_name: diagnostic_report_note_group.rb
+:delayed_references:
+- :path: subject
+  :resources:
+  - Location
+- :path: performer
+  :resources:
+  - Practitioner
+  - Organization
+  - PractitionerRole

data/lib/us_core_test_kit/generated/v7.0.0/diagnostic_report_note_group.rb

@@ -0,0 +1,101 @@
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_category_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_code_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_category_date_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_code_date_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_status_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_patient_category_lastupdated_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_read_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_provenance_revinclude_search_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_validation_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_must_support_test'
+require_relative 'diagnostic_report_note/diagnostic_report_note_reference_resolution_test'
+
+module USCoreTestKit
+  module USCoreV700
+    class DiagnosticReportNoteGroup < Inferno::TestGroup
+      title 'DiagnosticReport for Report and Note Exchange Tests'
+      short_description 'Verify support for the server capabilities required by the US Core DiagnosticReport Profile for Report and Note Exchange.'
+      description %(
+  # Background
+
+The US Core DiagnosticReport for Report and Note Exchange sequence verifies that the system under test is
+able to provide correct responses for DiagnosticReport queries. These queries
+must contain resources conforming to the US Core DiagnosticReport Profile for Report and Note Exchange as
+specified in the US Core v7.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 + category
+* patient
+* patient + code
+* patient + category + date
+
+### 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
+DiagnosticReport 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 DiagnosticReport 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 DiagnosticReport Profile for Report and Note Exchange](http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note). 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_v700_diagnostic_report_note
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'diagnostic_report_note', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :us_core_v700_diagnostic_report_note_patient_category_search_test
+      test from: :us_core_v700_diagnostic_report_note_patient_search_test
+      test from: :us_core_v700_diagnostic_report_note_patient_code_search_test
+      test from: :us_core_v700_diagnostic_report_note_patient_category_date_search_test
+      test from: :us_core_v700_diagnostic_report_note_patient_code_date_search_test
+      test from: :us_core_v700_diagnostic_report_note_patient_status_search_test
+      test from: :us_core_v700_diagnostic_report_note_patient_category__lastUpdated_search_test
+      test from: :us_core_v700_diagnostic_report_note_read_test
+      test from: :us_core_v700_diagnostic_report_note_provenance_revinclude_search_test
+      test from: :us_core_v700_diagnostic_report_note_validation_test
+      test from: :us_core_v700_diagnostic_report_note_must_support_test
+      test from: :us_core_v700_diagnostic_report_note_reference_resolution_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/document_reference/document_reference_id_search_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class DocumentReferenceIdSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for DocumentReference search by _id'
+      description %(
+A server SHALL support searching by
+_id on the DocumentReference 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_document_reference__id_search_test
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'DocumentReference',
+        search_param_names: ['_id'],
+        possible_status_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[:document_reference_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/document_reference/document_reference_must_support_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV700
+    class DocumentReferenceMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the DocumentReference 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 DocumentReference resources
+        found previously for the following must support elements:
+
+        * DocumentReference.author
+        * DocumentReference.category
+        * DocumentReference.content
+        * DocumentReference.content.attachment
+        * DocumentReference.content.attachment.contentType
+        * DocumentReference.content.attachment.data or DocumentReference.content.attachment.url
+        * DocumentReference.content.format
+        * DocumentReference.context
+        * DocumentReference.context.encounter
+        * DocumentReference.context.period
+        * DocumentReference.date
+        * DocumentReference.identifier
+        * DocumentReference.status
+        * DocumentReference.subject
+        * DocumentReference.type
+
+        For ONC USCDI requirements, each DocumentReference must support the following additional elements:
+
+        * DocumentReference.category:uscore
+      )
+
+      id :us_core_v700_document_reference_must_support_test
+
+      def resource_type
+        'DocumentReference'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:document_reference_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/document_reference/document_reference_patient_category_date_search_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class DocumentReferencePatientCategoryDateSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for DocumentReference search by patient + category + date'
+      description %(
+A server SHALL support searching by
+patient + category + date on the DocumentReference 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_document_reference_patient_category_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: 'DocumentReference',
+        search_param_names: ['patient', 'category', 'date'],
+        possible_status_search: true,
+        token_search_params: ['category'],
+        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[:document_reference_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/document_reference/document_reference_patient_category_search_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class DocumentReferencePatientCategorySearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for DocumentReference search by patient + category'
+      description %(
+A server SHALL support searching by
+patient + category on the DocumentReference 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/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_document_reference_patient_category_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: 'DocumentReference',
+        search_param_names: ['patient', 'category'],
+        possible_status_search: true,
+        token_search_params: ['category']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:document_reference_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v7.0.0/document_reference/document_reference_patient_search_test.rb

@@ -0,0 +1,63 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV700
+    class DocumentReferencePatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for DocumentReference search by patient'
+      description %(
+A server SHALL support searching by
+patient on the DocumentReference 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 v7.0.0.
+
+[US Core Server CapabilityStatement](http://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html)
+
+      )
+
+      id :us_core_v700_document_reference_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: 'DocumentReference',
+        search_param_names: ['patient'],
+        saves_delayed_references: true,
+        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[:document_reference_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end