us_core_test_kit 0.2.5 → 0.3.0

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

@@ -0,0 +1,364 @@
+---
+:name: us_core_patient
+:class_name: USCorev501PatientSequence
+:version: v5.0.1
+:reformatted_version: v501
+:resource: Patient
+:profile_url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
+:profile_name: US Core Patient Profile
+:profile_version: 5.0.1
+:title: Patient
+:short_description: Verify support for the server capabilities required by the US
+  Core Patient 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:
+  - _id
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - identifier
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :names:
+  - name
+  :expectation: SHALL
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - birthdate
+  - family
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHALL
+  :names:
+  - birthdate
+  - name
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHOULD
+  :names:
+  - family
+  - gender
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+- :expectation: SHALL
+  :names:
+  - gender
+  - name
+  :names_not_must_support_or_mandatory: []
+  :must_support_or_mandatory: true
+:search_definitions:
+  :_id:
+    :paths:
+    - id
+    :full_paths:
+    - Patient.id
+    :comparators: {}
+    :values: []
+    :type: http://hl7.org/fhirpath/System.String
+    :contains_multiple: false
+    :multiple_or: MAY
+  :identifier:
+    :paths:
+    - identifier
+    :full_paths:
+    - Patient.identifier
+    :comparators: {}
+    :values: []
+    :type: Identifier
+    :contains_multiple: true
+    :multiple_or: MAY
+  :name:
+    :paths:
+    - name
+    :full_paths:
+    - Patient.name
+    :comparators: {}
+    :values: []
+    :type: HumanName
+    :contains_multiple: true
+    :multiple_or: MAY
+  :birthdate:
+    :paths:
+    - birthDate
+    :full_paths:
+    - Patient.birthDate
+    :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
+  :family:
+    :paths:
+    - name.family
+    :full_paths:
+    - Patient.name.family
+    :comparators: {}
+    :values: []
+    :type: string
+    :contains_multiple: false
+    :multiple_or: MAY
+  :gender:
+    :paths:
+    - gender
+    :full_paths:
+    - Patient.gender
+    :comparators: {}
+    :values:
+    - male
+    - female
+    - other
+    - unknown
+    :type: code
+    :contains_multiple: false
+    :multiple_or: MAY
+:include_params: []
+:revincludes:
+- Provenance:target
+:required_concepts: []
+:must_supports:
+  :extensions:
+  - :id: Patient.extension:race
+    :url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
+    :uscdi_only: true
+  - :id: Patient.extension:ethnicity
+    :url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
+    :uscdi_only: true
+  - :id: Patient.extension:birthsex
+    :url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
+    :uscdi_only: true
+  - :id: Patient.extension:genderIdentity
+    :url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
+    :uscdi_only: true
+  :slices: []
+  :elements:
+  - :path: identifier
+  - :path: identifier.system
+  - :path: identifier.value
+  - :path: name
+  - :path: name.family
+  - :path: name.given
+  - :path: telecom.system
+    :uscdi_only: true
+  - :path: telecom.value
+    :uscdi_only: true
+  - :path: telecom.use
+    :uscdi_only: true
+  - :path: gender
+  - :path: birthDate
+  - :path: address
+  - :path: address.line
+  - :path: address.city
+  - :path: address.state
+  - :path: address.postalCode
+  - :path: address.period
+  - :path: communication.language
+    :uscdi_only: true
+  - :path: name.suffix
+    :uscdi_only: true
+  - :path: name.use
+    :fixed_value: old
+    :uscdi_only: true
+  - :path: name.period.end
+    :uscdi_only: true
+  - :path: telecom
+    :uscdi_only: true
+  - :path: communication
+    :uscdi_only: true
+  - :path: address.use
+    :fixed_value: old
+    :uscdi_only: true
+  :choices:
+  - :paths:
+    - name.period.end
+    - name.use
+    :uscdi_only: true
+:mandatory_elements:
+- Patient.identifier
+- Patient.identifier.system
+- Patient.identifier.value
+- Patient.name
+- Patient.telecom.system
+- Patient.telecom.value
+- Patient.gender
+- Patient.communication.language
+- Patient.link.other
+- Patient.link.type
+:bindings:
+- :type: code
+  :strength: preferred
+  :system: http://hl7.org/fhir/ValueSet/languages
+  :path: language
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/identifier-use
+  :path: identifier.use
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/identifier-type
+  :path: identifier.type
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/name-use
+  :path: name.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/contact-point-system
+  :path: telecom.system
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/contact-point-use
+  :path: telecom.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/administrative-gender
+  :path: gender
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/address-use
+  :path: address.use
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/address-type
+  :path: address.type
+- :type: string
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
+  :path: address.state
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/marital-status
+  :path: maritalStatus
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/ValueSet/patient-contactrelationship
+  :path: contact.relationship
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/administrative-gender
+  :path: contact.gender
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://hl7.org/fhir/us/core/ValueSet/simple-language
+  :path: communication.language
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/ValueSet/link-type
+  :path: link.type
+- :type: Coding
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/omb-race-category
+  :path: value
+  :extensions:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
+  - ombCategory
+- :type: Coding
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/detailed-race
+  :path: value
+  :extensions:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
+  - detailed
+- :type: Coding
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
+  :path: value
+  :extensions:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
+  - ombCategory
+- :type: Coding
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
+  :path: value
+  :extensions:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
+  - detailed
+- :type: code
+  :strength: required
+  :system: http://hl7.org/fhir/us/core/ValueSet/birthsex
+  :path: value
+  :extensions:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
+- :type: CodeableConcept
+  :strength: extensible
+  :system: http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32
+  :path: value
+  :extensions:
+  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
+:references:
+- :path: Patient.identifier.assigner
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Patient.contact.organization
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Patient.generalPractitioner
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+  - http://hl7.org/fhir/StructureDefinition/Practitioner
+  - http://hl7.org/fhir/StructureDefinition/PractitionerRole
+- :path: Patient.managingOrganization
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Organization
+- :path: Patient.link.other
+  :profiles:
+  - http://hl7.org/fhir/StructureDefinition/Patient
+  - http://hl7.org/fhir/StructureDefinition/RelatedPerson
+:tests:
+- :id: us_core_v501_patient__id_search_test
+  :file_name: patient_id_search_test.rb
+- :id: us_core_v501_patient_identifier_search_test
+  :file_name: patient_identifier_search_test.rb
+- :id: us_core_v501_patient_name_search_test
+  :file_name: patient_name_search_test.rb
+- :id: us_core_v501_patient_birthdate_family_search_test
+  :file_name: patient_birthdate_family_search_test.rb
+- :id: us_core_v501_patient_birthdate_name_search_test
+  :file_name: patient_birthdate_name_search_test.rb
+- :id: us_core_v501_patient_family_gender_search_test
+  :file_name: patient_family_gender_search_test.rb
+- :id: us_core_v501_patient_gender_name_search_test
+  :file_name: patient_gender_name_search_test.rb
+- :id: us_core_v501_patient_read_test
+  :file_name: patient_read_test.rb
+- :id: us_core_v501_patient_provenance_revinclude_search_test
+  :file_name: patient_provenance_revinclude_search_test.rb
+- :id: us_core_v501_patient_validation_test
+  :file_name: patient_validation_test.rb
+- :id: us_core_v501_patient_must_support_test
+  :file_name: patient_must_support_test.rb
+:id: us_core_v501_patient
+:file_name: patient_group.rb
+:delayed_references: []

data/lib/us_core_test_kit/generated/v5.0.1/patient/patient_birthdate_family_search_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class PatientBirthdateFamilySearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Patient search by birthdate + family'
+      description %(
+A server SHOULD support searching by
+birthdate + family on the Patient 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_patient_birthdate_family_search_test
+      optional
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Patient',
+        search_param_names: ['birthdate', 'family']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:patient_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/patient/patient_birthdate_name_search_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class PatientBirthdateNameSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Patient search by birthdate + name'
+      description %(
+A server SHALL support searching by
+birthdate + name on the Patient 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_patient_birthdate_name_search_test
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Patient',
+        search_param_names: ['birthdate', 'name']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:patient_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/patient/patient_family_gender_search_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class PatientFamilyGenderSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Patient search by family + gender'
+      description %(
+A server SHOULD support searching by
+family + gender on the Patient 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_patient_family_gender_search_test
+      optional
+  
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Patient',
+        search_param_names: ['family', 'gender']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:patient_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/patient/patient_gender_name_search_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class PatientGenderNameSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Patient search by gender + name'
+      description %(
+A server SHALL support searching by
+gender + name on the Patient 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_patient_gender_name_search_test
+      def self.properties
+        @properties ||= SearchTestProperties.new(
+          resource_type: 'Patient',
+        search_param_names: ['gender', 'name']
+        )
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:patient_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/patient/patient_id_search_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../../search_test'
+require_relative '../../../generator/group_metadata'
+
+module USCoreTestKit
+  module USCoreV501
+    class PatientIdSearchTest < Inferno::Test
+      include USCoreTestKit::SearchTest
+
+      title 'Server returns valid results for Patient search by _id'
+      description %(
+A server SHALL support searching by
+_id on the Patient resource. This test
+will pass if resources are returned and match the search criteria. If
+none are returned, the test is skipped.
+
+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_patient__id_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: 'Patient',
+        search_param_names: ['_id'],
+        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[:patient_resources] ||= {}
+      end
+
+      run do
+        run_search_test
+      end
+    end
+  end
+end

data/lib/us_core_test_kit/generated/v5.0.1/patient/patient_identifier_search_test.rb

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

data/lib/us_core_test_kit/generated/v5.0.1/patient/patient_must_support_test.rb

@@ -0,0 +1,66 @@
+require_relative '../../../must_support_test'
+
+module USCoreTestKit
+  module USCoreV501
+    class PatientMustSupportTest < Inferno::Test
+      include USCoreTestKit::MustSupportTest
+
+      title 'All must support elements are provided in the Patient 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 Patient resources
+        found previously for the following must support elements:
+
+        * Patient.address
+        * Patient.address.city
+        * Patient.address.line
+        * Patient.address.period
+        * Patient.address.postalCode
+        * Patient.address.state
+        * Patient.birthDate
+        * Patient.gender
+        * Patient.identifier
+        * Patient.identifier.system
+        * Patient.identifier.value
+        * Patient.name
+        * Patient.name.family
+        * Patient.name.given
+
+        For ONC USCDI requirements, each Patient must support the following additional elements:
+
+        * Patient.address.use
+        * Patient.communication
+        * Patient.communication.language
+        * Patient.extension:birthsex
+        * Patient.extension:ethnicity
+        * Patient.extension:genderIdentity
+        * Patient.extension:race
+        * Patient.name.period.end or Patient.name.use
+        * Patient.name.suffix
+        * Patient.telecom
+        * Patient.telecom.system
+        * Patient.telecom.use
+        * Patient.telecom.value
+      )
+
+      id :us_core_v501_patient_must_support_test
+
+      def resource_type
+        'Patient'
+      end
+
+      def self.metadata
+        @metadata ||= Generator::GroupMetadata.new(YAML.load_file(File.join(__dir__, 'metadata.yml')))
+      end
+
+      def scratch_resources
+        scratch[:patient_resources] ||= {}
+      end
+
+      run do
+        perform_must_support_test(all_scratch_resources)
+      end
+    end
+  end
+end