us_core_test_kit 0.4.7 → 0.5.0

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

@@ -0,0 +1,315 @@
+---
+:name: us_core_documentreference
+:class_name: USCorev600DocumentreferenceSequence
+:version: v6.0.0
+:reformatted_version: v600
+:resource: DocumentReference
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference
+:profile_name: US Core DocumentReference Profile
+:profile_version: 6.0.0
+:title: DocumentReference
+:short_description: Verify support for the server capabilities required by the US
+  Core DocumentReference Profile.
+: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:
+- :code: docref
+  :expectation: SHALL
+:searches:
+- :names:
+  - patient
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - _id
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHALL
+  :names:
+  - patient
+  - type
+  :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
+  - type
+  - period
+  :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: SHALL
+  :names:
+  - patient
+  - category
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :_id:
+    :paths:
+    - id
+    :full_paths:
+    - DocumentReference.id
+    :comparators: {}
+    :values: []
+    :type: http://hl7.org/fhirpath/System.String
+    :contains_multiple: false
+    :multiple_or: MAY
+  :patient:
+    :paths:
+    - subject
+    :full_paths:
+    - DocumentReference.subject
+    :comparators: {}
+    :values: []
+    :type: Reference
+    :contains_multiple: false
+    :multiple_or: MAY
+  :type:
+    :paths:
+    - type
+    :full_paths:
+    - DocumentReference.type
+    :comparators: {}
+    :values:
+    - UNK
+    :type: CodeableConcept
+    :contains_multiple: false
+    :multiple_or: MAY
+  :status:
+    :paths:
+    - status
+    :full_paths:
+    - DocumentReference.status
+    :comparators: {}
+    :values:
+    - current
+    - superseded
+    - entered-in-error
+    :type: code
+    :contains_multiple: false
+    :multiple_or: SHALL
+  :period:
+    :paths:
+    - context.period
+    :full_paths:
+    - DocumentReference.context.period
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: SHALL
+      :ge: SHALL
+      :lt: SHALL
+      :le: SHALL
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: Period
+    :contains_multiple: false
+    :multiple_or: MAY
+  :category:
+    :paths:
+    - category
+    :full_paths:
+    - DocumentReference.category
+    :comparators: {}
+    :values:
+    - clinical-note
+    :type: CodeableConcept
+    :contains_multiple: true
+    :multiple_or: MAY
+  :date:
+    :paths:
+    - date
+    :full_paths:
+    - DocumentReference.date
+    :comparators:
+      :eq: MAY
+      :ne: MAY
+      :gt: SHALL
+      :ge: SHALL
+      :lt: SHALL
+      :le: SHALL
+      :sa: MAY
+      :eb: MAY
+      :ap: MAY
+    :values: []
+    :type: instant
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts:
+- type
+- category
+:must_supports:
+  :extensions: []
+  :slices:
+  - :name: DocumentReference.category:uscore
+    :path: category
+    :discriminator:
+      :type: requiredBinding
+      :path: ''
+      :values:
+      - clinical-note
+    :uscdi_only: true
+  :elements:
+  - :path: identifier
+  - :path: status
+  - :path: type
+  - :path: category
+  - :path: subject
+    :types:
+    - Reference
+  - :path: date
+  - :path: author
+    :types:
+    - Reference
+    :target_profiles:
+    - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
+  - :path: content
+  - :path: content.attachment
+  - :path: content.attachment.contentType
+  - :path: content.attachment.data
+  - :path: content.attachment.url
+  - :path: content.format
+  - :path: context
+  - :path: context.encounter
+    :types:
+    - Reference
+  - :path: context.period
+  :choices:
+  - :paths:
+    - content.attachment.data
+    - content.attachment.url
+:mandatory_elements:
+- DocumentReference.status
+- DocumentReference.type
+- DocumentReference.category
+- DocumentReference.subject
+- DocumentReference.relatesTo.code
+- DocumentReference.relatesTo.target
+- DocumentReference.content
+- DocumentReference.content.attachment
+:bindings:
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/document-reference-status
+  :path: status
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/composition-status
+  :path: docStatus
+- :type: CodeableConcept
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
+  :path: type
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/document-relationship-type
+  :path: relatesTo.code
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/mimetypes
+  :path: content.attachment.contentType
+:references:
+- :path: DocumentReference.subject
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+- :path: DocumentReference.author
+  :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-patient
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson
+  - http://hl7.org/fhir/StructureDefinition/Device
+- :path: DocumentReference.authenticator
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: DocumentReference.custodian
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: DocumentReference.relatesTo.target
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/DocumentReference
+- :path: DocumentReference.context.encounter
+  :profiles:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
+- :path: DocumentReference.context.sourcePatientInfo
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+- :path: DocumentReference.context.related
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Resource
+:tests:
+- :id: us_core_v600_document_reference_patient_search_test
+  :file_name: document_reference_patient_search_test.rb
+- :id: us_core_v600_document_reference__id_search_test
+  :file_name: document_reference_id_search_test.rb
+- :id: us_core_v600_document_reference_patient_type_search_test
+  :file_name: document_reference_patient_type_search_test.rb
+- :id: us_core_v600_document_reference_patient_status_search_test
+  :file_name: document_reference_patient_status_search_test.rb
+- :id: us_core_v600_document_reference_patient_type_period_search_test
+  :file_name: document_reference_patient_type_period_search_test.rb
+- :id: us_core_v600_document_reference_patient_category_date_search_test
+  :file_name: document_reference_patient_category_date_search_test.rb
+- :id: us_core_v600_document_reference_patient_category_search_test
+  :file_name: document_reference_patient_category_search_test.rb
+- :id: us_core_v600_document_reference_read_test
+  :file_name: document_reference_read_test.rb
+- :id: us_core_v600_document_reference_provenance_revinclude_search_test
+  :file_name: document_reference_provenance_revinclude_search_test.rb
+- :id: us_core_v600_document_reference_validation_test
+  :file_name: document_reference_validation_test.rb
+- :id: us_core_v600_document_reference_must_support_test
+  :file_name: document_reference_must_support_test.rb
+- :id: us_core_v600_document_reference_reference_resolution_test
+  :file_name: document_reference_reference_resolution_test.rb
+- :id: us_core_v400_document_reference_custodian_test
+  :file_name: "../../custom_groups/v4.0.0/document_reference_custodian_test.rb"
+:id: us_core_v600_document_reference
+:file_name: document_reference_group.rb
+:delayed_references:
+- :path: author
+  :resources:
+  - Practitioner
+  - Organization
+  - PractitionerRole
+  - RelatedPerson

data/lib/us_core_test_kit/generated/v6.0.0/document_reference_group.rb

@@ -0,0 +1,104 @@
+require_relative 'document_reference/document_reference_patient_search_test'
+require_relative 'document_reference/document_reference_id_search_test'
+require_relative 'document_reference/document_reference_patient_type_search_test'
+require_relative 'document_reference/document_reference_patient_status_search_test'
+require_relative 'document_reference/document_reference_patient_type_period_search_test'
+require_relative 'document_reference/document_reference_patient_category_date_search_test'
+require_relative 'document_reference/document_reference_patient_category_search_test'
+require_relative 'document_reference/document_reference_read_test'
+require_relative 'document_reference/document_reference_provenance_revinclude_search_test'
+require_relative 'document_reference/document_reference_validation_test'
+require_relative 'document_reference/document_reference_must_support_test'
+require_relative 'document_reference/document_reference_reference_resolution_test'
+require_relative '../../custom_groups/v4.0.0/document_reference_custodian_test'
+
+module USCoreTestKit
+  module USCoreV600
+    class DocumentReferenceGroup < Inferno::TestGroup
+      title 'DocumentReference Tests'
+      short_description 'Verify support for the server capabilities required by the US Core DocumentReference Profile.'
+      description %(
+  # Background
+
+The US Core DocumentReference sequence verifies that the system under test is
+able to provide correct responses for DocumentReference queries. These queries
+must contain resources conforming to the US Core DocumentReference Profile as
+specified in the US Core v6.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
+* _id
+* patient + type
+* 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
+DocumentReference 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 DocumentReference 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 DocumentReference Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference). 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_v600_document_reference
+      run_as_group
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'document_reference', 'metadata.yml'), aliases: true))
+      end
+  
+      test from: :us_core_v600_document_reference_patient_search_test
+      test from: :us_core_v600_document_reference__id_search_test
+      test from: :us_core_v600_document_reference_patient_type_search_test
+      test from: :us_core_v600_document_reference_patient_status_search_test
+      test from: :us_core_v600_document_reference_patient_type_period_search_test
+      test from: :us_core_v600_document_reference_patient_category_date_search_test
+      test from: :us_core_v600_document_reference_patient_category_search_test
+      test from: :us_core_v600_document_reference_read_test
+      test from: :us_core_v600_document_reference_provenance_revinclude_search_test
+      test from: :us_core_v600_document_reference_validation_test
+      test from: :us_core_v600_document_reference_must_support_test
+      test from: :us_core_v600_document_reference_reference_resolution_test
+      test from: :us_core_v400_document_reference_custodian_test
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/encounter/encounter_class_patient_search_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class EncounterClassPatientSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by class + patient'
+      description %(
+A server SHOULD support searching by
+class + patient on the Encounter 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_encounter_class_patient_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: 'Encounter',
+        search_param_names: ['class', 'patient'],
+        possible_status_search: true,
+        token_search_params: ['class']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/encounter/encounter_date_patient_search_test.rb

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

data/lib/us_core_test_kit/generated/v6.0.0/encounter/encounter_id_search_test.rb

@@ -0,0 +1,42 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class EncounterIdSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by _id'
+      description %(
+A server SHALL support searching by
+_id on the Encounter 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_encounter__id_search_test
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Encounter',
+        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[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/encounter/encounter_identifier_search_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV600
+    class EncounterIdentifierSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Encounter search by identifier'
+      description %(
+A server SHOULD support searching by
+identifier on the Encounter 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_encounter_identifier_search_test
+      optional
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Encounter',
+        search_param_names: ['identifier'],
+        possible_status_search: true,
+        token_search_params: ['identifier']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v6.0.0/encounter/encounter_must_support_test.rb

@@ -0,0 +1,53 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV600
+    class EncounterMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Encounter 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 Encounter resources
+        found previously for the following must support elements:
+
+        * Encounter.class
+        * Encounter.hospitalization
+        * Encounter.hospitalization.dischargeDisposition
+        * Encounter.identifier
+        * Encounter.identifier.system
+        * Encounter.identifier.value
+        * Encounter.location
+        * Encounter.location.location or Encounter.serviceProvider
+        * Encounter.participant
+        * Encounter.participant.individual
+        * Encounter.participant.period
+        * Encounter.participant.type
+        * Encounter.period
+        * Encounter.reasonCode or Encounter.reasonReference
+        * Encounter.status
+        * Encounter.subject
+        * Encounter.type
+      )
+
+      id :us_core_v600_encounter_must_support_test
+
+      def resource_type
+        'Encounter'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml'), aliases: true))
+      end
+
+      def scratch_resources
+        scratch[:encounter_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end