us_core_test_kit 0.11.4 → 0.11.6

data/lib/us_core_test_kit/metadata.rb

@@ -12,8 +12,9 @@ module USCoreTestKit
       [v4.0.0](http://hl7.org/fhir/us/core/STU4/),
       [v5.0.1](http://hl7.org/fhir/us/core/STU5.0.1/),
       [v6.1.0](https://hl7.org/fhir/us/core/STU6.1/),
+      [v7.0.0](https://hl7.org/fhir/us/core/STU7/),
       and
-      [v7.0.0](https://hl7.org/fhir/us/core/STU7/).
+      [v8.0.0](https://hl7.org/fhir/us/core/STU8/).
       <!-- break -->
 
       This test kit is [open source](https://github.com/inferno-framework/us-core-test-kit#license)
@@ -44,7 +45,7 @@ module USCoreTestKit
       - Missing Data Guidance
 
       ### Client suites
-      
+
       The US Core Client suites are less mature and currently verify the following requirements:
 
       - Support for making requests for data on all US Core Profiles
@@ -68,7 +69,7 @@ module USCoreTestKit
       [issues section](https://github.com/inferno-framework/us-core-test-kit/issues)
       of the repository.
     DESCRIPTION
-    suite_ids [:us_core_v311, :us_core_v400, :us_core_v501, :us_core_v610, :us_core_v700, :us_core_client_v311,
+    suite_ids [:us_core_v311, :us_core_v400, :us_core_v501, :us_core_v610, :us_core_v700, :us_core_v800, :us_core_client_v311,
                :us_core_client_v400, :us_core_client_v501, :us_core_client_v610, :us_core_client_v700]
     tags ['SMART App Launch', 'US Core']
     last_updated LAST_UPDATED

data/lib/us_core_test_kit/must_support_test.rb

@@ -2,8 +2,8 @@ require_relative 'fhir_resource_navigation'
 
 module USCoreTestKit
   module MustSupportTest
+    include Inferno::DSL::FHIRResourceNavigation
     extend Forwardable
-    include FHIRResourceNavigation
 
     def_delegators 'self.class', :metadata
 

data/lib/us_core_test_kit/practitioner_address_test.rb

@@ -30,7 +30,8 @@ module USCoreTestKit
       @missing_elements = MUST_SUPPORT_ELEMENTS
       practitioners = []
 
-      references.each do |reference|
+      references.each do |reference_info|
+        reference = reference_info[:reference]
         resolved_resource = resolve_reference(reference)
 
         if resolved_resource.nil? ||
@@ -58,7 +59,7 @@ module USCoreTestKit
           search_and_check_response(search_params, resource_type)
 
           practitioner_roles = fetch_all_bundled_resources(resource_type:)
-                               .select { |resource| resource.resourceType == resource_type }
+            .select { |resource| resource.resourceType == resource_type }
 
           next false if practitioner_roles.empty?
           next true if config.options[:skip_practitioner_role_validation]
@@ -70,10 +71,10 @@ module USCoreTestKit
         end
       end
 
-      missing_must_support_message = "Could not find US Core PractitionerRole Profile resources and " \
+      missing_must_support_message = 'Could not find US Core PractitionerRole Profile resources and ' \
                                      "these MustSupport elements #{missing_elements_string.join(', ')} " \
-                                     "in US Core Practitioner Profile resources. " \
-                                     "Please use patients with more information."
+                                     'in US Core Practitioner Profile resources. ' \
+                                     'Please use patients with more information.'
 
       assert (support_practitioner_role || @missing_elements.blank?), missing_must_support_message
     end

data/lib/us_core_test_kit/primitive_type.rb

@@ -1,5 +1,5 @@
 module USCoreTestKit
-  class PrimitiveType < FHIR::Element
-    attr_accessor :value
-  end
+  # This functionality has been moved to Inferno Core, but this reference is
+  # retained to avoid a breaking change.
+  PrimitiveType = Inferno::DSL::PrimitiveType
 end

data/lib/us_core_test_kit/provenance_validator.rb

@@ -1,6 +1,6 @@
 module USCoreTestKit
   class ProvenanceValidator
-    include FHIRResourceNavigation
+    include Inferno::DSL::FHIRResourceNavigation
 
     def self.validate(...)
       new(...).validate

data/lib/us_core_test_kit/read_test.rb

@@ -4,22 +4,63 @@ module USCoreTestKit
       scratch_resources[:all] ||= []
     end
 
-    def perform_read_test(resources, reply_handler = nil)
+    def perform_read_test(resources, reply_handler = nil, delayed_reference: false)
       skip_if resources.blank?, no_resources_skip_message
 
-      resources_to_read = readable_resources(resources)
+      resources_to_read = if delayed_reference
+                            readable_references(resources)
+                          else
+                            readable_resources(resources)
+                          end
 
       assert resources_to_read.present?, "No #{resource_type} id found."
 
       if config.options[:read_all_resources]
+        if delayed_reference
+          all_referencing_resources = referencing_resources(resources_to_read)
+          info %(
+            The #{resource_type} references used for this test were pulled from the following resources:
+            #{all_referencing_resources}
+          )
+
+          resources_to_read.map! { |resource| resource[:reference] }
+        end
+
         resources_to_read.each do |resource|
           read_and_validate(resource)
         end
       else
-        read_and_validate(resources_to_read.first)
+        first_resource = resources_to_read.first
+        if delayed_reference.present?
+          info %(
+            The #{resource_type} reference used for this test was pulled from resource
+            #{first_resource[:referencing_resource]}
+          )
+          first_resource = first_resource[:reference]
+        end
+        read_and_validate(first_resource)
       end
     end
 
+    def referencing_resources(readable_resources)
+      readable_resources
+        .map { |resource| resource[:referencing_resource] }
+        .join(', ')
+    end
+
+    def readable_references(resources)
+      resources
+        .filter_map do |resource|
+          next unless resource[:reference].present? && resource[:reference].is_a?(FHIR::Reference)
+
+          reference_id = resource[:reference].reference&.split('/')&.last
+          next unless reference_id&.present?
+
+          resource
+        end
+        .uniq { |resource| resource[:reference].reference.split('/').last }
+    end
+
     def readable_resources(resources)
       resources
         .select { |resource| resource.is_a?(resource_class) || resource.is_a?(FHIR::Reference) }
@@ -37,9 +78,9 @@ module USCoreTestKit
       assert_resource_type(resource_type)
       assert resource.id.present? && resource.id == id, bad_resource_id_message(id)
 
-      if resource_to_read.is_a? FHIR::Reference
-        all_scratch_resources << resource
-      end
+      return unless resource_to_read.is_a? FHIR::Reference
+
+      all_scratch_resources << resource
     end
 
     def resource_id(resource)
@@ -48,7 +89,7 @@ module USCoreTestKit
 
     def no_resources_skip_message
       "No #{resource_type} resources appear to be available. " \
-      'Please use patients with more information.'
+        'Please use patients with more information.'
     end
 
     def bad_resource_id_message(expected_id)

data/lib/us_core_test_kit/reference_resolution_test.rb

@@ -2,8 +2,8 @@ require_relative 'fhir_resource_navigation'
 
 module USCoreTestKit
   module ReferenceResolutionTest
+    include Inferno::DSL::FHIRResourceNavigation
     extend Forwardable
-    include FHIRResourceNavigation
 
     def_delegators 'self.class', :metadata
 

data/lib/us_core_test_kit/requirements/generated/us_core_client_v311_requirements_coverage.csv

@@ -0,0 +1 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Client v3.1.1 Short ID(s),US Core Client v3.1.1 Full ID(s)

data/lib/us_core_test_kit/requirements/generated/us_core_client_v400_requirements_coverage.csv

@@ -0,0 +1 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Client v4.0.0 Short ID(s),US Core Client v4.0.0 Full ID(s)

data/lib/us_core_test_kit/requirements/generated/us_core_client_v501_requirements_coverage.csv

@@ -0,0 +1 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Client v5.0.1 Short ID(s),US Core Client v5.0.1 Full ID(s)

data/lib/us_core_test_kit/requirements/generated/us_core_client_v610_requirements_coverage.csv

@@ -0,0 +1,120 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Client v6.1.0 Short ID(s),US Core Client v6.1.0 Full ID(s)
+hl7.fhir.us.core_6.1.0,22,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#required-bindings-for-coded-elements,[When populating a coded element with a [required binding](http://hl7.org/fhir/R4/terminologies.html#required) to a ValueSet definition] US Core Requestors **SHALL** be capable of processing the code [from the required binding ValueSet],SHALL,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,28,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#extensible-binding-for-coded-elements,US Core Requestors SHALL be capable of processing the code in ['DataElement.code.code' or text in 'DataElement.code.text' for a DataElement.code that has an extensible binding],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,32,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#modifier-elements,Clients SHALL be able to process [elements that are] [Mandatory](https://hl7.org/fhir/us/core/must-support.html) or [Must Support elements](https://hl7.org/fhir/us/core/must-support.html),SHALL,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,35,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#modifier-elements,receivers SHOULD accept instances that ... contain unexpected data elements  [[definition](http://hl7.org/fhir/R4/conformance-rules.html#isModifier)],SHOULD,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,36,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#modifier-elements,receivers SHOULD [NOT] accept instances that ... contain unexpected data elements … when those elements are modifier elements [[definition](http://hl7.org/fhir/R4/conformance-rules.html#isModifier)],SHOULD NOT,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,37,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#modifier-elements,"Unless a client determines they can process [a resource with a modifier] safely, rejection is typically the only safe action if unexpected modifier elements are present.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,38,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#modifier-elements,Implementers SHOULD review the “Key Elements Tab” on the US Core profile pages.,SHOULD,"Client,Server",false,,,"",""
+hl7.fhir.us.core_6.1.0,53,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `token` type searchparameter [(how to search by token)](http://hl7.org/fhir/R4/search.html#token) The client **SHALL** provide at least a code value,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,54,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `token` type searchparameter [(how to search by token)](http://hl7.org/fhir/R4/search.html#token) The client … **MAY** provide both the system and code values.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,56,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `reference` type searchparameter [(how to search by reference)](http://hl7.org/fhir/R4/search.html#reference) The client **SHALL** provide at least an id value,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,57,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `reference` type searchparameter [(how to search by reference)](http://hl7.org/fhir/R4/search.html#reference) The client … **MAY** provide both the Type and id values.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,59,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `date` type searchparameter [(how to search by date)](http://hl7.org/fhir/R4/search.html#date) The client **SHALL** provide values precise to the day for elements of datatype `date`,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,60,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `date` type searchparameter [(how to search by date)](http://hl7.org/fhir/R4/search.html#date) The client **SHALL** provide values precise … to the second + time offset for elements of datatype `dateTime`.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,76,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+US Core Requestors **SHALL** be capable of processing resource instances containing the data elements without generating an error or causing the application to fail.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,77,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+US Core Requestors **SHOULD** be capable of displaying the data elements for human use or storing it for other purposes.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,79,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+When querying US Core Responders, US Core Requestors **SHALL** interpret missing data elements within resource instances as data not present in the US Core Responder’s system.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,82,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+US Core Requestors **SHALL** be able to process resource instances containing data elements asserting missing information.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,82.A,https://hl7.org/fhir/us/core/STU6.1/must-support.html#uscdi-requirements,"[T]he following US Core Profiles do not represent USCDI data classes, and their Mandatory and Must Support elements are not USCDI [v3] Requirements [for US Core Requestors and Responders seeking ONC certification in the ONC IT Health Certification program under US Core 6.1]: US Core Location Profile",MAY,"Server,Client",true,,,"",""
+hl7.fhir.us.core_6.1.0,82.B,https://hl7.org/fhir/us/core/STU6.1/must-support.html#uscdi-requirements,"[T]he following US Core Profiles do not represent USCDI data classes, and their Mandatory and Must Support elements are not USCDI [v3] Requirements [for US Core Requestors and Responders seeking ONC certification in the ONC IT Health Certification program under US Core 6.1]: US Core Organization Profile",MAY,"Server,Client",true,,,"",""
+hl7.fhir.us.core_6.1.0,82.C,https://hl7.org/fhir/us/core/STU6.1/must-support.html#uscdi-requirements,"[T]he following US Core Profiles do not represent USCDI data classes, and their Mandatory and Must Support elements are not USCDI [v3] Requirements [for US Core Requestors and Responders seeking ONC certification in the ONC IT Health Certification program under US Core 6.1]: US Core Practioner Profile",MAY,"Server,Client",true,,,"",""
+hl7.fhir.us.core_6.1.0,82.D,https://hl7.org/fhir/us/core/STU6.1/must-support.html#uscdi-requirements,"[T]he following US Core Profiles do not represent USCDI data classes, and their Mandatory and Must Support elements are not USCDI [v3] Requirements [for US Core Requestors and Responders seeking ONC certification in the ONC IT Health Certification program under US Core 6.1]: US Core PractionerRole Profile",MAY,"Server,Client",true,,,"",""
+hl7.fhir.us.core_6.1.0,83,https://hl7.org/fhir/us/core/STU6.1/must-support.html#additional-uscdi-requirements,Implementors [US Core Requestors] seeking ONC certification [in the ONC IT Health Certification program] **SHALL** interpret Additional USCDI Requirements as Must Support elements as documented above,SHALL,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,85,https://hl7.org/fhir/us/core/STU6.1/must-support.html#additional-uscdi-requirements,Implementors [US Core Requestors] [not] seeking ONC certification [in the ONC IT Health Certification program] **SHALL** interpret Additional USCDI Requirements as … optional.,SHALL,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,92,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---primitive-element,[W]hen claiming conformance [to a profile with a must support primitive element] … US Core requestors SHALL be capable of processing the value [of the primitive element],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,98,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---complex-elements,[When claiming conformance to a must support complex element with no must support sub-elements US Core Requestors SHALL be capable of processing a value in the complex element],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,100,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---complex-elements,When claiming conformance [to a must support complex element with one or more must support sub-elements] … US Core Requestors SHALL be capable of processing a values in [each must support sub-element],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,102,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---complex-elements,"Systems [US Core Requestors] can support the other elements [of a complex element, not labeled as a Must Support], but this is not a requirement of US Core",MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,104,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---complex-elements,"The U.S. Core Data for Interoperability (USCDI) may require additional elements, [which is a requirement for certification in the ONC IT Health Certification program, but not a requirement of US Core conformance for US Core Requestors]",MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,106,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---resource-references,"In certain profiles, only specific resource references are labeled as Must Support.
+
+...
+
+- US Core Requestors **SHALL** be capable of processing [such an element] with a valid reference to [all listed Must Support profile(s).]",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,108,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---resource-references,"Systems [US Core Requestors] can support other [resource] references [other than those labeled as Must Support], but this is not a requirement of US Core",MAY,Client,,,,"",""
+hl7.fhir.us.core_6.1.0,110,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---resource-references,"In specific profiles, only a single resource reference is present on an element labeled Must Support.
+
+…
+
+- US Core Requestors **SHALL** be capable of processing [such an element] with a valid reference to [the Must Support Profile.]",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,112,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---choice-of-data-types,"Some elements allow different data types (e.g., Observation.effective[x]) for their content. Only specific data type choice elements are labeled Must Support in these situations.
+
+… When claiming conformance to [such a] profile:
+
+- US Core Requestors **SHALL** be capable of processing [the Must Support data type choice]",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,113,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---choice-of-data-types,"Some elements allow different data types (e.g., Observation.effective[x]) for their content. Only specific data type choice elements are labeled Must Support in these situations.
+
+…
+
+[US Core Requestors] **MAY** support ... processing other [data type] choice elements (such as Observation.effectivePeriod), but this is not a requirement of US Core.",MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,116,https://hl7.org/fhir/us/core/STU6.1/must-support.html#must-support---choice-of-profile-elements,"There are several instances in this Guide where there is a choice of supporting one or another profile element to meet the Must Support requirement. In such cases, … the client application **SHALL** support all elements.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,194,https://hl7.org/fhir/us/core/STU6.1/general-guidance.html#language-support,[When clients request a resource in a specific language] clients MAY request language/locale using the http [Accept-Language](https://www.ietf.org/rfc/rfc2616.txt) header.,MAY,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,226,https://hl7.org/fhir/us/core/STU6.1/clinical-notes.html#support-requirements,Systems [clients] may support other [DiagnosticReport] categories as well.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,232,https://hl7.org/fhir/us/core/STU6.1/clinical-notes.html#support-requirements,a client can determine the note and report types supported by a server by invoking the standard FHIR Value Set Expansion ([$expand](http://hl7.org/fhir/R4/valueset-operation-expand.html)) operation defined in the FHIR R4 specification.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,251,https://hl7.org/fhir/us/core/STU6.1/medication-list.html#options-for-representing-medication,"The client application MUST support all methods [for referencing a medication resource: returned bundle, as an external resource, or as a [contained](http://hl7.org/fhir/R4/references.html#contained) resource]",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,262,https://hl7.org/fhir/us/core/STU6.1/medication-list.html#fetching-all-medications-active-medications-and-all-medications-for-an-encounter,"Requirements to access “all medications” [all historical, active, and future prescribed medications and medications entered in error and whose status is unknown.] and “all active medications” [all medications with an active status. Active medications do not include past, future, unknown status, and entered-in-error medications.] for a patient:
+A MedicationRequest resource query:
+The category and encounter elements MAY be used together to get the intersection of medications for a given encounter (i.e., the context) that were administered during as an inpatient (i.e., the category).",MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,264,https://hl7.org/fhir/us/core/STU6.1/medication-list.html#de-duplication-of-data,"To provide a list of a patient’s medications, it may be necessary to “de-duplicate” them. The de-duplication activity ... SHOULD be provided by the client.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,275,https://hl7.org/fhir/us/core/STU6.1/screening-and-assessments.html#category-codes,"API consumers can query by category (for example, `sdoh`) when accessing patient information.",MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,286,https://hl7.org/fhir/us/core/STU6.1/changes-between-versions.html#no-guarantee-that-resource-ids-are-preserved,"Therefore, client applications must plan on deduplication methods that rely on something other than a common identifier across FHIR versions.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,292,https://hl7.org/fhir/us/core/STU6.1/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r5,The FHIR RESTful resource types supported in a DSTU2 implementation SHOULD be supported in a R4 implementation,SHOULD,Client,true,,,"",""
+hl7.fhir.us.core_6.1.0,293,https://hl7.org/fhir/us/core/STU6.1/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r7,"The FHIR RESTful resource types supported in a DSTU2 implementation SHOULD be supported in a R4 implementation [with the] exception [of]
+MedicationStatement may be deprecated, and the data SHOULD be mapped to MedicationRequest.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,294,https://hl7.org/fhir/us/core/STU6.1/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r8,"The FHIR RESTful resource types supported in a DSTU2 implementation SHOULD be supported in a R4 implementation [with the] exception [of]
+Care teams as represented by CarePlan in DSTU2 SHOULD be replaced by and the data mapped to CareTeam in R4",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,299,https://hl7.org/fhir/us/core/STU6.1/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r13,"When updating between versions, clients SHOULD consider the impact of any changes to data visualization on the usability for the end user and the maintenance of data integrity.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,301,https://hl7.org/fhir/us/core/STU6.1/changes-between-versions.html#authorization-across-versions,Separate authorization is required [between different versions of FHIR],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,314,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html#mandatory-and-must-support-data-elements,[C]lient application[s conforming to the Us Core CareTeam profile] SHALL support [US Core Practitioner Profile],SHALL,Client,false,,,2.43.01,us_core_client_v610-us_core_client_read_search_group_v610-us_core_client_v610_practitioner-us_core_v610_practitioner_client_read_test
+hl7.fhir.us.core_6.1.0,315,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html#mandatory-and-must-support-data-elements,[C]lient application[s conforming to the Us Core CareTeam profile] SHALL support [US Core PractitionerRole Profile],SHALL,Client,false,,,2.44.01,us_core_client_v610-us_core_client_read_search_group_v610-us_core_client_v610_practitioner_role-us_core_v610_practitioner_role_client_read_test
+hl7.fhir.us.core_6.1.0,316,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html#mandatory-and-must-support-data-elements,[C]lient application[s conforming to the Us Core CareTeam profile] SHALL support [US Core RelatedPerson Profile],SHALL,Client,false,,,2.46.01,us_core_client_v610-us_core_client_read_search_group_v610-us_core_client_v610_related_person-us_core_v610_related_person_client_read_test
+hl7.fhir.us.core_6.1.0,327,"https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-encounter-diagnosis.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html#mandatory-and-must-support-data-elements",The client application[s supporting US Core Condition profiles] SHALL support [[assertedDate Extension](http://hl7.org/fhir/R4/extension-condition-asserteddate.html),SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,328,"https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-encounter-diagnosis.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html#mandatory-and-must-support-data-elements",The client application[s supporting US Core Condition profiles] SHALL support Condition.onsetDateTime,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,329,"https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-encounter-diagnosis.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html#mandatory-and-must-support-data-elements",The client application[s supporting US Core Condition profiles] SHALL support Condition.recordedDate,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,369,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html#mandatory-and-must-support-data-elements,The client application SHALL support [DocumentReference.attachment.url],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,370,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html#mandatory-and-must-support-data-elements,The client application SHALL support [DocumentReference.attachment.data],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,376,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [ Encounter.reasonCode],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,377,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [Encounter.reasonReference],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,380,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [Encounter.location.location],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,381,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [Encounter.serviceProvider],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,388,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-goal.html#mandatory-and-must-support-data-elements,The client application SHALL support ... Goal.startDate,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,389,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-goal.html#mandatory-and-must-support-data-elements,The client application SHALL support ... Goal.target.dueDate,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,403,"https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationdispense.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements",The client application SHALL support [using a code in .medicationCodeableConcept to represent medications when supporting the US Core MedicationDispense profile],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,404,"https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationdispense.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements",The client application SHALL support [referencing a Medication resource in .medicationReferencet to represent medications when supporting the US Core MedicationDispense profile],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,409,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements,The client application SHALL support [medicationRequest.reportedBoolean],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,410,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements,The client application SHALL support [MedicationRequest.reportedReference],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,526,https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-specimen.html#mandatory-and-must-support-data-elements,clients may request Specimen resources be included with the Observation or DiagnosticReport resource query,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,527,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html#should_igs,[Clients] SHOULD Support the Following Implementation Guide [SMART Application Launch Framework Implementation Guide](http://hl7.org/fhir/smart-app-launch/history.html),SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,528,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the transaction interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,529,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the batch interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,530,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the search-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,531,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the history-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,544,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the transaction interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,545,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the batch interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,546,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the search-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,547,https://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the history-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,551,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems SHALL establish a risk analysis and management regime that conforms with HIPAA security regulatory requirements,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,553,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,US Federal systems SHOULD conform with the risk management and mitigation requirements defined in NIST 800 series documents.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,555,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,US Federal systems … SHOULD include security category assignment following NIST 800-60 vol. 2 Appendix D.14.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,557,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,The coordination of risk management and the related security and privacy controls … SHOULD be defined in the Business Associate Agreement when available.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,559,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems SHALL reference a single time source to establish a common time base for security auditing and clinical data records among computing systems.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,561,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,The selected time service SHOULD be documented in the Business Associate Agreement when available.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,563,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems SHALL keep audit logs of the various transactions.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,565,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems SHALL use TLS version 1.2 or higher for all transmissions not taking place over a secure network connection.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,567,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,US Federal systems SHOULD conform with FIPS PUB 140-2.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,569,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems SHALL conform to [FHIR Communications Security](http://hl7.org/fhir/R4/security.html#http) requirements.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,571,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,"For Authentication and Authorization, Systems SHALL support any [SMART App Launch version](http://hl7.org/fhir/smart-app-launch/history.html) for client <-> server interactions.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,573,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,"Systems SHALL implement consent requirements per their state, local, and institutional policies.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,575,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,The Business Associate Agreements SHOULD document systems’ mutual consent requirements.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,577,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems SHOULD provide Provenance statements using the [US Core Provenance Profile](https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-provenance.html) resource and associated requirements.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,579,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems MAY implement the [FHIR Digital Signatures](http://hl7.org/fhir/R4/security.html#digital%20signatures),MAY,Client,false,,,"",""
+hl7.fhir.us.core_6.1.0,581,https://hl7.org/fhir/us/core/STU6.1/security.html#patient-privacy-and-security,Systems MAY protect the confidentiality of data at rest via encryption and associated access controls.,MAY,Client,false,,,"",""

data/lib/us_core_test_kit/requirements/generated/us_core_client_v700_requirements_coverage.csv

@@ -0,0 +1,129 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Client v7.0.0 Short ID(s),US Core Client v7.0.0 Full ID(s)
+hl7.fhir.us.core_7.0.0,22,https://hl7.org/fhir/us/core/STU7/general-requirements.html#required-bindings-for-coded-elements,[When populating a coded element with a [required binding](http://hl7.org/fhir/R4/terminologies.html#required) to a ValueSet definition] US Core Requestors **SHALL** be capable of processing the code [from the required binding ValueSet],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,28,https://hl7.org/fhir/us/core/STU7/general-requirements.html#extensible-binding-for-coded-elements,US Core Requestors SHALL be capable of processing the code in ['DataElement.code.code' or text in 'DataElement.code.text' for a DataElement.code that has an extensible binding],SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,32,https://hl7.org/fhir/us/core/STU7/general-requirements.html#modifier-elements,Clients SHALL be able to process [elements that are] [Mandatory](https://hl7.org/fhir/us/core/must-support.html) or [Must Support elements](https://hl7.org/fhir/us/core/must-support.html),SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,35,https://hl7.org/fhir/us/core/STU7/general-requirements.html#modifier-elements,receivers SHOULD accept instances that ... contain unexpected data elements  [[definition](http://hl7.org/fhir/R4/conformance-rules.html#isModifier)],SHOULD,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,36,https://hl7.org/fhir/us/core/STU7/general-requirements.html#modifier-elements,receivers SHOULD [NOT] accept instances that ... contain unexpected data elements … when those elements are modifier elements [[definition](http://hl7.org/fhir/R4/conformance-rules.html#isModifier)],SHOULD NOT,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,37,https://hl7.org/fhir/us/core/STU7/general-requirements.html#modifier-elements,"Unless a client determines they can process [a resource with a modifier] safely, rejection is typically the only safe action if unexpected modifier elements are present.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,53,https://hl7.org/fhir/us/core/STU7/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `token` type searchparameter [(how to search by token)](http://hl7.org/fhir/R4/search.html#token) The client **SHALL** provide at least a code value,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,54,https://hl7.org/fhir/us/core/STU7/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `token` type searchparameter [(how to search by token)](http://hl7.org/fhir/R4/search.html#token) The client … **MAY** provide both the system and code values.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,56,https://hl7.org/fhir/us/core/STU7/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `reference` type searchparameter [(how to search by reference)](http://hl7.org/fhir/R4/search.html#reference) The client **SHALL** provide at least an id value,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,57,https://hl7.org/fhir/us/core/STU7/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `reference` type searchparameter [(how to search by reference)](http://hl7.org/fhir/R4/search.html#reference) The client … **MAY** provide both the Type and id values.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,59,https://hl7.org/fhir/us/core/STU7/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `date` type searchparameter [(how to search by date)](http://hl7.org/fhir/R4/search.html#date) The client **SHALL** provide values precise to the day for elements of datatype `date`,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,60,https://hl7.org/fhir/us/core/STU7/general-requirements.html#fhir-restful-search-api-requirements,When searching using the `date` type searchparameter [(how to search by date)](http://hl7.org/fhir/R4/search.html#date) The client **SHALL** provide values precise … to the second + time offset for elements of datatype `dateTime`.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,76,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+US Core Requestors **SHALL** be capable of processing resource instances containing the data elements without generating an error or causing the application to fail.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,77,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+US Core Requestors **SHOULD** be capable of displaying the data elements for human use or storing it for other purposes.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,79,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+When querying US Core Responders, US Core Requestors **SHALL** interpret missing data elements within resource instances as data not present in the US Core Responder’s system.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,82,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support-elements,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
+
+US Core Requestors **SHALL** be able to process resource instances containing data elements asserting missing information.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,83,https://hl7.org/fhir/us/core/STU7/must-support.html#additional-uscdi-requirements,Implementors [US Core Requestors] seeking ONC certification [in the ONC IT Health Certification program] **SHALL** interpret Additional USCDI Requirements as Must Support elements as documented above;,SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,85,https://hl7.org/fhir/us/core/STU7/must-support.html#additional-uscdi-requirements,Implementors [US Core Requestors] [not] seeking ONC certification [in the ONC IT Health Certification program] **SHALL** interpret Additional USCDI Requirements as … optional.,SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,92,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---primitive-element,[W]hen claiming conformance [to a profile with a must support primitive element] … US Core requestors SHALL be capable of processing the value [of the primitive element],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,98,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---complex-elements,When claiming conformance [to a must support complex element with no must support sub-elements] … US Core Requestors SHALL be capable of processing a value in [the complex element],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,100,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---complex-elements,When claiming conformance [to a must support complex element with one or more must support sub-elements] … US Core Requestors SHALL be capable of processing a values in [each must support sub-element],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,102,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---complex-elements,"Systems [US Core Requestors] can support the other elements [of a complex element, not labeled as a Must Support], but this is not a requirement of US Core",MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,104,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---complex-elements,"The U.S. Core Data for Interoperability (USCDI) may require additional elements, [which is a requirement for certification in the ONC IT Health Certification program, but not a requirement of US Core conformance for US Core Requestors]",MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,106,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---resource-references,"In certain profiles, only specific resource references are labeled as Must Support.
+
+...
+
+- US Core Requestors **SHALL** be capable of processing [such an element] with a valid reference to [all listed Must Support profile(s).]",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,108,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---resource-references,"Systems [US Core Requestors] can support other [resource] references [other than those labeled as Must Support], but this is not a requirement of US Core",MAY,Client,,,,"",""
+hl7.fhir.us.core_7.0.0,110,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---resource-references,"In specific profiles, only a single resource reference is present on an element labeled Must Support.
+
+…
+
+- US Core Requestors **SHALL** be capable of processing [such an element] with a valid reference to [the Must Support Profile.]",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,112,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---choice-of-data-types,"Some elements allow different data types (e.g., Observation.effective[x]) for their content. Only specific data type choice elements are labeled Must Support in these situations.
+
+… When claiming conformance to [such a] profile:
+
+- US Core Requestors **SHALL** be capable of processing [the Must Support data type choice]",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,113,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---choice-of-data-types,"Some elements allow different data types (e.g., Observation.effective[x]) for their content. Only specific data type choice elements are labeled Must Support in these situations.
+
+…
+
+[US Core Requestors] **MAY** support ... processing other [data type] choice elements (such as Observation.effectivePeriod), but this is not a requirement of US Core.",MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,116,https://hl7.org/fhir/us/core/STU7/must-support.html#must-support---choice-of-profile-elements,"There are several instances in this Guide where there is a choice of supporting one or another profile element to meet the Must Support requirement. In such cases, … the client application **SHALL** support all elements.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,127,https://hl7.org/fhir/us/core/STU7/scopes.html#smart-scopes,US Core clients should follow the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege) and access only the necessary resources.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,172,https://hl7.org/fhir/us/core/STU7/scopes.html#additional-us-core-requirements,US Core requires ... additional metadata [to be available through the server's [Well-Known Uniform Resource Identifier (URI)](https://hl7.org/fhir/smart-app-launch/STU2/conformance.html#using-well-known)]: ... [in] `scopes_supported` [the] array of scopes a client may request. The app SHOULD inspect the returned scopes and accommodate the differences from the scopes it asked for and registered.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,194,https://hl7.org/fhir/us/core/STU7/general-guidance.html#language-support,[When clients request a resource in a specific language] clients MAY request language/locale using the http [Accept-Language](https://www.ietf.org/rfc/rfc2616.txt) header.,MAY,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,226,https://hl7.org/fhir/us/core/STU7/clinical-notes.html#support-requirements,Systems [clients] may support other [DiagnosticReport] categories as well.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,232,https://hl7.org/fhir/us/core/STU7/clinical-notes.html#support-requirements,a client can determine the note and report types supported by a server by invoking the standard FHIR Value Set Expansion ([$expand](http://hl7.org/fhir/R4/valueset-operation-expand.html)) operation defined in the FHIR R4 specification.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,251,https://hl7.org/fhir/us/core/STU7/medication-list.html#options-for-representing-medication,"The client application MUST support all methods [for referencing a medication resource: returned bundle, as an external resource, or as a [contained](http://hl7.org/fhir/R4/references.html#contained) resource]",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,262,https://hl7.org/fhir/us/core/STU7/medication-list.html#fetching-all-medications-active-medications-and-all-medications-for-an-encounter,"Requirements to access “all medications” [all historical, active, and future prescribed medications and medications entered in error and whose status is unknown.] and “all active medications” [all medications with an active status. Active medications do not include past, future, unknown status, and entered-in-error medications.] for a patient:
+A MedicationRequest resource query:
+The category and encounter elements MAY be used together to get the intersection of medications for a given encounter (i.e., the context) that were administered during as an inpatient (i.e., the category).",MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,264,https://hl7.org/fhir/us/core/STU7/medication-list.html#de-duplication-of-data,"To provide a list of a patient’s medications, it may be necessary to “de-duplicate” them. The de-duplication activity ... SHOULD be provided by the client.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,275,https://hl7.org/fhir/us/core/STU7/screening-and-assessments.html#category-codes,"API consumers can query by category (for example, `sdoh`) when accessing patient information.",MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,286,https://hl7.org/fhir/us/core/STU7/changes-between-versions.html#no-guarantee-that-resource-ids-are-preserved,"Therefore, client applications must plan on deduplication methods that rely on something other than a common identifier across FHIR versions.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,292,https://hl7.org/fhir/us/core/STU7/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r5,The FHIR RESTful resource types supported in a DSTU2 implementation SHOULD be supported in a R4 implementation,SHOULD,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,293,https://hl7.org/fhir/us/core/STU7/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r7,"The FHIR RESTful resource types supported in a DSTU2 implementation SHOULD be supported in a R4 implementation [with the] exception [of]
+MedicationStatement may be deprecated, and the data SHOULD be mapped to MedicationRequest.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,294,https://hl7.org/fhir/us/core/STU7/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r8,"The FHIR RESTful resource types supported in a DSTU2 implementation SHOULD be supported in a R4 implementation [with the] exception [of]
+Care teams as represented by CarePlan in DSTU2 SHOULD be replaced by and the data mapped to CareTeam in R4",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,299,https://hl7.org/fhir/us/core/STU7/changes-between-versions.html#expectation-that-fhir-dstu2-data-is-preserved-in-fhir-r13,"When updating between versions, clients SHOULD consider the impact of any changes to data visualization on the usability for the end user and the maintenance of data integrity.",SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,301,https://hl7.org/fhir/us/core/STU7/changes-between-versions.html#authorization-across-versions,Separate authorization is required [between different versions of FHIR],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,314,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-careteam.html#mandatory-and-must-support-data-elements,[C]lient application[s conforming to the US Core CareTeam profile] SHALL support [US Core Practitioner Profile],SHALL,Client,false,,,2.47.01,us_core_client_v700-us_core_client_read_search_group_v700-us_core_client_v700_practitioner-us_core_v700_practitioner_client_read_test
+hl7.fhir.us.core_7.0.0,315,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-careteam.html#mandatory-and-must-support-data-elements,[C]lient application[s conforming to the US Core CareTeam profile] SHALL support [US Core PractitionerRole Profile],SHALL,Client,false,,,2.48.01,us_core_client_v700-us_core_client_read_search_group_v700-us_core_client_v700_practitioner_role-us_core_v700_practitioner_role_client_read_test
+hl7.fhir.us.core_7.0.0,316,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-careteam.html#mandatory-and-must-support-data-elements,[C]lient application[s conforming to the US Core CareTeam profile] SHALL support [US Core RelatedPerson Profile],SHALL,Client,false,,,2.50.01,us_core_client_v700-us_core_client_read_search_group_v700-us_core_client_v700_related_person-us_core_v700_related_person_client_read_test
+hl7.fhir.us.core_7.0.0,327,"https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-condition-encounter-diagnosis.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-condition-problems-health-concerns.html#mandatory-and-must-support-data-elements",The client application[s supporting US Core Condition profiles] SHALL support [[assertedDate Extension](http://hl7.org/fhir/R4/extension-condition-asserteddate.html),SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,328,"https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-condition-encounter-diagnosis.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-condition-problems-health-concerns.html#mandatory-and-must-support-data-elements",The client application[s supporting US Core Condition profiles] SHALL support Condition.onsetDateTime,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,329,"https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-condition-encounter-diagnosis.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-condition-problems-health-concerns.html#mandatory-and-must-support-data-elements",The client application[s supporting US Core Condition profiles] SHALL support Condition.recordedDate,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,369,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-documentreference.html#mandatory-and-must-support-data-elements,The client application SHALL support [DocumentReference.attachment.url],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,370,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-documentreference.html#mandatory-and-must-support-data-elements,The client application SHALL support [DocumentReference.attachment.data],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,376,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [ Encounter.reasonCode],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,377,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [Encounter.reasonReference],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,380,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [Encounter.location.location],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,381,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-encounter.html#mandatory-and-must-support-data-elements,The client application SHALL support [Encounter.serviceProvider],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,388,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-goal.html#mandatory-and-must-support-data-elements,The client application SHALL support ... Goal.startDate,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,389,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-goal.html#mandatory-and-must-support-data-elements,The client application SHALL support ... Goal.target.dueDate,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,403,"https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationdispense.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements",The client application SHALL support [using a code in .medicationCodeableConcept to represent medications when supporting the US Core MedicationDispense profile],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,404,"https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationdispense.html#mandatory-and-must-support-data-elements, https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements",The client application SHALL support [referencing a Medication resource in .medicationReferencet to represent medications when supporting the US Core MedicationDispense profile],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,409,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements,The client application SHALL support [medicationRequest.reporedtBoolean],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,410,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements,The client application SHALL support [MedicationRequest.reportedReference],SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,412,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements,"[For organizations participating in the ONC Health IT Certification program,] the certifying client application SHALL support [MedicationRequest.reasonCode.]",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,413,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements,"[For organizations participating in the ONC Health IT Certification program,] the certifying client application SHALL support [MedicationRequest.reasonReference.]",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,415,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-medicationrequest.html#mandatory-and-must-support-data-elements,"[For organizations participating in the ONC Health IT Certification program,] clients SHALL support all target resources in MedicationRequest.reasonReference.",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,476,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-practitioner.html#mandatory-and-must-support-data-elements,The client application SHALL support both [the PractionerRole profile and the Practioner.address element],SHALL,Client,,,,"",""
+hl7.fhir.us.core_7.0.0,483,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-procedure.html#mandatory-and-must-support-data-elements,[For organizations participating in the ONC Health IT Certification program] … Clients SHALL support ... US Core Procedure Profile for communicating the reason or justification for a referral as Additional USCDI Requirements,SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,485,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-procedure.html#mandatory-and-must-support-data-elements,"[For organizations participating in the ONC Health IT Certification program,] The certifying client application SHALL support both [Procedure.reasonCode and Procedure.reasonReference]",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,487,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-procedure.html#mandatory-and-must-support-data-elements,"[For organizations participating in the ONC Health IT Certification program,] when using Procedure.reasonReference … Clients SHALL support all target resources in Procedure.reasonReference",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,517,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-servicerequest.html#mandatory-and-must-support-data-elements,[For organizations participating in the ONC Health IT Certification program] … Clients SHALL support ... US Core ServiceRequest Profile for communicating the reason or justification for a referral as Additional USCDI Requirements,SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,519,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-servicerequest.html#mandatory-and-must-support-data-elements,"[For organizations participating in the ONC Health IT Certification program,] The certifying client application SHALL support both [ServiceRequest.reasonCode and ServiceRequest.reasonReference]",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,521,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-servicerequest.html#mandatory-and-must-support-data-elements,"[For organizations participating in the ONC Health IT Certification program,] when using ServiceRequest.reasonReference … Clients SHALL support all target resources in ServiceRequest.reasonReference",SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,525,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-specimen.html#mandatory-and-must-support-data-elements,The client application SHALL support both [ Specimen.identifier and Specimen.accessionIdentifier],SHALL,Client,true,,,"",""
+hl7.fhir.us.core_7.0.0,526,https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-specimen.html#mandatory-and-must-support-data-elements,Clients may request Specimen resources be included with the Observation or DiagnosticReport resource query.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,527,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html#should_igs,[Clients] SHOULD Support the Following Implementation Guide [SMART Application Launch Framework Implementation Guide](http://hl7.org/fhir/smart-app-launch/history.html),SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,528,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the transaction interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,529,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the batch interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,530,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the search-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,531,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html#behavior,[Clients] MAY support the history-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,544,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the transaction interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,545,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the batch interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,546,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the search-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,547,https://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-server.html#behavior,[Server] MAY support the history-system interaction,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,551,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems SHALL establish a risk analysis and management regime that conforms with HIPAA security regulatory requirements,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,553,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,US Federal systems SHOULD conform with the risk management and mitigation requirements defined in NIST 800 series documents.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,555,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,US Federal systems … SHOULD include security category assignment following NIST 800-60 vol. 2 Appendix D.14.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,557,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,The coordination of risk management and the related security and privacy controls … SHOULD be defined in the Business Associate Agreement when available.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,559,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems SHALL reference a single time source to establish a common time base for security auditing and clinical data records among computing systems.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,561,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,The selected time service SHOULD be documented in the Business Associate Agreement when available.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,563,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems SHALL keep audit logs of the various transactions.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,565,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems SHALL use TLS version 1.2 or higher for all transmissions not taking place over a secure network connection.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,567,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,US Federal systems SHOULD conform with FIPS PUB 140-2.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,569,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems SHALL conform to [FHIR Communications Security](http://hl7.org/fhir/R4/security.html#http) requirements.,SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,571,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,"For Authentication and Authorization, Systems SHALL support any [SMART App Launch version](http://hl7.org/fhir/smart-app-launch/history.html) for client <-> server interactions.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,573,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,"Systems SHALL implement consent requirements per their state, local, and institutional policies.",SHALL,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,575,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,The Business Associate Agreements SHOULD document systems’ mutual consent requirements.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,577,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems SHOULD provide Provenance statements using the [US Core Provenance Profile](https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-provenance.html) resource and associated requirements.,SHOULD,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,579,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems MAY implement the [FHIR Digital Signatures](http://hl7.org/fhir/R4/security.html#digital%20signatures),MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,581,https://hl7.org/fhir/us/core/STU7/security.html#patient-privacy-and-security,Systems MAY protect the confidentiality of data at rest via encryption and associated access controls.,MAY,Client,false,,,"",""
+hl7.fhir.us.core_7.0.0,582,https://www.hl7.org/fhir/us/core/STU7/general-requirements.html#current-binding-for-coded-elements,"The [additional] current binding [[FHIR R5 link](https://hl7.org/fhir/R5/terminologies.html#binding)] requires newly recorded, non-legacy data to be drawn from the [bound] value set.",SHALL,Client,true,,,"",""

data/lib/us_core_test_kit/requirements/generated/us_core_v311_requirements_coverage.csv

@@ -0,0 +1 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Server v3.1.1 Short ID(s),US Core Server v3.1.1 Full ID(s)

data/lib/us_core_test_kit/requirements/generated/us_core_v400_requirements_coverage.csv

@@ -0,0 +1 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Server v4.0.0 Short ID(s),US Core Server v4.0.0 Full ID(s)

data/lib/us_core_test_kit/requirements/generated/us_core_v501_requirements_coverage.csv

@@ -0,0 +1 @@
+Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,US Core Server v5.0.1 Short ID(s),US Core Server v5.0.1 Full ID(s)