diff --git a/Gemfile.lock b/Gemfile.lock index e9343cc..ed98a0d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -4,7 +4,7 @@ PATH bulk_data_test_kit (0.12.2) bloomer (~> 1.0.0) colorize (~> 0.8.1) - inferno_core (>= 0.6.7) + inferno_core (>= 0.6.8) json-jwt (~> 1.15.3) mime-types (~> 3.4.0) ndjson (~> 1.0.0) @@ -197,7 +197,6 @@ GEM mime-types (3.4.1) mime-types-data (~> 3.2015) mime-types-data (3.2025.0514) - mini_portile2 (2.8.9) minitest (5.25.5) msgpack (1.8.0) multi_json (1.15.0) @@ -213,13 +212,8 @@ GEM ndjson (1.0.0) netrc (0.11.0) nio4r (2.7.4) - nokogiri (1.18.8) - mini_portile2 (~> 2.8.2) - racc (~> 1.4) nokogiri (1.18.8-arm64-darwin) racc (~> 1.4) - nokogiri (1.18.8-x86_64-darwin) - racc (~> 1.4) nokogiri (1.18.8-x86_64-linux-gnu) racc (~> 1.4) oauth2 (1.4.11) @@ -264,6 +258,9 @@ GEM mime-types (>= 1.16, < 4.0) netrc (~> 0.8) rexml (3.4.1) + roo (2.10.1) + nokogiri (~> 1) + rubyzip (>= 1.3.0, < 3.0.0) rouge (4.5.2) rspec (3.13.0) rspec-core (~> 3.13.0) @@ -291,10 +288,7 @@ GEM json-jwt (~> 1.15.3) jwt (~> 2.6) tls_test_kit (~> 0.3.0) - sqlite3 (1.7.3) - mini_portile2 (~> 2.8.0) sqlite3 (1.7.3-arm64-darwin) - sqlite3 (1.7.3-x86_64-darwin) sqlite3 (1.7.3-x86_64-linux) stringio (3.1.7) strings (0.2.1) @@ -326,10 +320,7 @@ GEM zeitwerk (2.7.2) PLATFORMS - arm64-darwin-21 - ruby - x86_64-darwin-19 - x86_64-darwin-20 + arm64-darwin-23 x86_64-linux DEPENDENCIES @@ -338,6 +329,7 @@ DEPENDENCIES debug factory_bot (~> 6.1) rack-test (~> 2.2) + roo (~> 2.10.1) rspec (~> 3.10) webmock (~> 3.11) diff --git a/bulk_data_test_kit.gemspec b/bulk_data_test_kit.gemspec index b2c2867..f39b9a4 100644 --- a/bulk_data_test_kit.gemspec +++ b/bulk_data_test_kit.gemspec @@ -13,7 +13,7 @@ Gem::Specification.new do |spec| spec.license = 'Apache-2.0' spec.add_runtime_dependency 'bloomer', '~> 1.0.0' spec.add_runtime_dependency 'colorize', '~> 0.8.1' - spec.add_runtime_dependency 'inferno_core', '>= 0.6.7' + spec.add_runtime_dependency 'inferno_core', '>= 0.6.8' spec.add_runtime_dependency 'json-jwt', '~> 1.15.3' spec.add_runtime_dependency 'mime-types', '~> 3.4.0' spec.add_runtime_dependency 'ndjson', '~> 1.0.0' @@ -24,6 +24,7 @@ Gem::Specification.new do |spec| spec.add_development_dependency 'factory_bot', '~> 6.1' spec.add_development_dependency 'rspec', '~> 3.10' spec.add_development_dependency 'webmock', '~> 3.11' + spec.add_development_dependency 'roo', '~> 2.10.1' spec.required_ruby_version = Gem::Requirement.new('>= 3.3.6') spec.metadata['homepage_uri'] = spec.homepage spec.metadata['source_code_uri'] = spec.homepage diff --git a/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_out_of_scope_requirements.csv b/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_out_of_scope_requirements.csv index cfb0846..aae56ec 100644 --- a/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_out_of_scope_requirements.csv +++ b/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_out_of_scope_requirements.csv @@ -1 +1,23 @@ Req Set,ID,Reason,Details +hl7.fhir.uv.bulkdata_2.0.0,31,Not Tested,This seems more like a requirement that the server can handle the alternative notation. +hl7.fhir.uv.bulkdata_2.0.0,48,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,54,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,61,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,74,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,84,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,91,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,95,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,102,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,104,Not Tested,Depends on MAY params requirements +hl7.fhir.uv.bulkdata_2.0.0,113,Not Tested,Depends on MAY params requirements +hl7.fhir.uv.bulkdata_2.0.0,114,Not Tested,Depends on MAY params requirements +hl7.fhir.uv.bulkdata_2.0.0,116,Not Tested,Same as 31 (but specific to `_typeFilter`)? +hl7.fhir.uv.bulkdata_2.0.0,124,Not Tested,See Question +hl7.fhir.uv.bulkdata_2.0.0,221,Not Verifiable, +hl7.fhir.uv.bulkdata_2.0.0,252,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,255,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,258,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,261,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,264,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,267,Not Tested,MAY param requirement +hl7.fhir.uv.bulkdata_2.0.0,270,Not Tested,MAY param requirement diff --git a/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_requirements.csv b/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_requirements.csv index e51d623..ee9da08 100644 --- a/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_requirements.csv +++ b/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_requirements.csv @@ -15,8 +15,8 @@ hl7.fhir.uv.bulkdata_2.0.0,13,https://hl7.org/fhir/uv/bulkdata/STU2/export.html# hl7.fhir.uv.bulkdata_2.0.0,14,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Provider - consists of… Output File Server,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,15,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that requests … access tokens,SHALL,Client,,false hl7.fhir.uv.bulkdata_2.0.0,16,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that ... receives access tokens,SHALL,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,17,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that requests ... Bulk Data files,SHALL,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,18,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that ... receives ... Bulk Data files,SHALL,Client,,false +hl7.fhir.uv.bulkdata_2.0.0,17,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,[A] Bulk Data Client [is a] system that requests ... Bulk Data files,SHALL,Client,,false +hl7.fhir.uv.bulkdata_2.0.0,18,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,[A] Bulk Data Client [is a] system that ... receives ... Bulk Data files,SHALL,Client,,false hl7.fhir.uv.bulkdata_2.0.0,19,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Authorization Server … issues access tokens in response to valid token requests from client.,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,20,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server … accepts kick-off request,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,21,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server … provides job status,SHALL,Server,,false @@ -41,7 +41,7 @@ hl7.fhir.uv.bulkdata_2.0.0,39,https://hl7.org/fhir/uv/bulkdata/STU2/export.html# hl7.fhir.uv.bulkdata_2.0.0,40,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,Binary Resources not associated with an individual patient MAY be included in a System Level export.,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,41,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"References in the resources returned MAY be relative URLs with the format /, or MAY be absolute URLs with the same structure rooted in the base URL for the server from which the export was performed.",MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,42,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---group-of-patients,"If a FHIR server supports Group-level data export, it SHOULD support reading and searching for Group resource.",SHOULD,Server,,true -hl7.fhir.uv.bulkdata_2.0.0,43,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,A client SHOULD provide [the accept] header.,SHOULD,Client,,false +hl7.fhir.uv.bulkdata_2.0.0,43,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,A client SHOULD provide [the Accept] header.,SHOULD,Client,,false hl7.fhir.uv.bulkdata_2.0.0,44,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"If [the client omits the accept header], the server MAY return an error or MAY process the request as if application/fhir+json was supplied.",MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,45,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"A client SHOULD provide [the prefer] header [with value ""respond-async""].",SHOULD,Client,,false hl7.fhir.uv.bulkdata_2.0.0,46,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"If [the client omits the prefer header], the server MAY return an error or MAY process the request as if respond-async was supplied.",MAY,Server,,false @@ -93,7 +93,11 @@ hl7.fhir.uv.bulkdata_2.0.0,91,https://hl7.org/fhir/uv/bulkdata/STU2/export.html# hl7.fhir.uv.bulkdata_2.0.0,92,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`includeAssociatedData`: a server with support for the parameter and requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request.,SHALL,Server,,true hl7.fhir.uv.bulkdata_2.0.0,93,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`includeAssociatedData`: A server that is unable to support the requested includeAssociatedData values SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true hl7.fhir.uv.bulkdata_2.0.0,94,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error.",MAY,Server,,true -hl7.fhir.uv.bulkdata_2.0.0,95,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: A client MAY include one or more of the following values.,MAY,Client,hl7.fhir.uv.bulkdata_2.0.0@97-100,false +hl7.fhir.uv.bulkdata_2.0.0,95,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,"`includeAssociatedData`: A client MAY include one or more of the following values… + +- `LatestProvenanceResources`… +- `RelevantProvenanceResources`… +- `_[custom value]`…",MAY,Client,hl7.fhir.uv.bulkdata_2.0.0@97-100,false hl7.fhir.uv.bulkdata_2.0.0,96,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: If multiple conflicting values are included, the server SHALL apply the least restrictive value (value that will return the largest dataset). ",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@97-100,true hl7.fhir.uv.bulkdata_2.0.0,97,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `LatestProvenanceResources`: Export will include the most recent Provenance resources associated with each of the non-provenance resources being returned.,SHALL,Server,,true hl7.fhir.uv.bulkdata_2.0.0,98,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `LatestProvenanceResources`: Other Provenance resources will not be returned.,SHALL NOT,Server,,true @@ -102,7 +106,7 @@ hl7.fhir.uv.bulkdata_2.0.0,100,"https://hl7.org/fhir/uv/bulkdata/STU2/export.htm hl7.fhir.uv.bulkdata_2.0.0,101,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_typeFilter`: Optionality for Server: optional,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,102,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_typeFilter`: Optionality for Client: optional,MAY,Client,,false hl7.fhir.uv.bulkdata_2.0.0,103,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_typeFilter`: When provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria.",SHALL,Server,,true -hl7.fhir.uv.bulkdata_2.0.0,104,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_typeFilter`:FHIR search response parameters such as _include and _sort SHALL NOT be used.,SHALL,Client,,true +hl7.fhir.uv.bulkdata_2.0.0,104,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_typeFilter`: FHIR search response parameters such as _include and _sort SHALL NOT be used.,SHALL NOT,Client,,true hl7.fhir.uv.bulkdata_2.0.0,105,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_typeFilter`:A server unable to support the requested _typeFilter queries SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true hl7.fhir.uv.bulkdata_2.0.0,106,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_typeFilter`:When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error. ",MAY,Server,,true hl7.fhir.uv.bulkdata_2.0.0,107,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the US Core Implementation Guide",MAY,Server,,false @@ -112,7 +116,7 @@ hl7.fhir.uv.bulkdata_2.0.0,110,"https://hl7.org/fhir/uv/bulkdata/STU2/export.htm hl7.fhir.uv.bulkdata_2.0.0,111,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` value relevant to provenance is not specified ..., the server SHALL include ... all available Provenance resources in a system level export request unless a specific resource set is specified using the _type parameter and this set does not include Provenance.",SHALL,Server,,true hl7.fhir.uv.bulkdata_2.0.0,112,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` ... parameter is not supported by a server, the server SHALL include ... all available Provenance resources in a system level export request unless a specific resource set is specified using the _type parameter and this set does not include Provenance.",SHALL,Server,,true hl7.fhir.uv.bulkdata_2.0.0,113,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"To request finer-grained filtering, a client MAY supply a `_typeFilter` parameter alongside the _type parameter.",MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,114,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,FHIR search response parameters such as `_include` and `_sort` SHALL NOT be used.,SHALL,Client,,false +hl7.fhir.uv.bulkdata_2.0.0,114,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,FHIR search response parameters such as `_include` and `_sort` SHALL NOT be used.,SHALL NOT,Client,,false hl7.fhir.uv.bulkdata_2.0.0,115,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"Since support for `_typeFilter` is OPTIONAL for a FHIR server, clients SHOULD be robust to servers that ignore `_typeFilter`.",SHOULD,Client,,false hl7.fhir.uv.bulkdata_2.0.0,116,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,A client MAY repeat the `_typeFilter` parameter multiple times in a kick-off request. ,MAY,Client,,false hl7.fhir.uv.bulkdata_2.0.0,117,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"When [the `_typeFilter` parameter is] repeated, the server SHALL treat the repeated values as if they were comma delimited values within a single `_typeFilter` parameter.",SHALL,Server,,false @@ -130,24 +134,24 @@ hl7.fhir.uv.bulkdata_2.0.0,128,https://hl7.org/fhir/uv/bulkdata/STU2/export.html hl7.fhir.uv.bulkdata_2.0.0,129,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"If excessively frequent status queries persist, the server MAY return a 429 Too Many Requests status code and terminate the session.",MAY,Server,,true hl7.fhir.uv.bulkdata_2.0.0,130,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"When requesting status, the client SHOULD use an Accept header indicating a content type of application/json.",SHOULD,Client,,true hl7.fhir.uv.bulkdata_2.0.0,131,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"In the case that errors prevent the export from completing, the server SHOULD respond with a FHIR OperationOutcome resource in JSON format.",SHOULD,Server,,true -hl7.fhir.uv.bulkdata_2.0.0,132,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,Response - In-Progress Status: HTTP Status Code of `202 Accepted`,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,132,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,[A Bulk Data server SHALL resond to a successful Status Request that is in-progress with] HTTP Status Code of `202 Accepted`,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,133,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,the server MAY return an `X-Progress` header with a text description of the status of the request that is less than 100 characters.,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,134,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,"The format of [the `X-Progress`] description ... MAY be a percentage complete value, or MAY be a more general status such as “in progress”. ",MAY,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,135,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,"The client MAY parse the description, display it to the user, or log it.",MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,136,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,Response - Error Status: HTTP status code of `4XX` or `5XX`,SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,137,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,`Content-Type` header of `application/fhir+json` when body is a FHIR `OperationOutcome` resource,SHALL,Server,,true -hl7.fhir.uv.bulkdata_2.0.0,138,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,The body of the response SHOULD be a FHIR OperationOutcome resource in JSON format.,SHOULD,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,135,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,"The client MAY parse the [status] description [sent in the `X-Progress` header], display it to the user, or log it.",MAY,Client,,false +hl7.fhir.uv.bulkdata_2.0.0,136,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,[A Bulk Data server SHALL respond to an errored Bulk Data Status Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,137,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,[A Bulk Data server SHALL respond to an errored Bulk Data Status Request with] `Content-Type` header of `application/fhir+json` when body is a FHIR `OperationOutcome` resource,SHALL,Server,,true +hl7.fhir.uv.bulkdata_2.0.0,138,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"[When a Bulk Data server responds to an errored Bulk Data Delete Request,] [t]he body of the response SHOULD be a FHIR OperationOutcome resource in JSON format.",SHOULD,Server,,false hl7.fhir.uv.bulkdata_2.0.0,139,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1," If [a response including the FHIR `OperationOutcome` resource] is not possible (for example, the infrastructure layer returning the error is not FHIR aware), the server MAY return an error message in another format and include a corresponding value for the `Content-Type` header.",MAY,Server,,true hl7.fhir.uv.bulkdata_2.0.0,140,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"In the case of a polling failure that does not indicate failure of the export job, a server SHOULD use a transient code from the IssueType valueset when populating the FHIR `OperationOutcome` resource’s `issue.code` element to indicate to the client that it should retry the request at a later time.",SHOULD,Server,,true hl7.fhir.uv.bulkdata_2.0.0,141,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"Even if some of the requested resources cannot successfully be exported, the overall export operation MAY still succeed. ",MAY,Server,,true hl7.fhir.uv.bulkdata_2.0.0,142,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"[if the overall export succeeds despite some resources not sucessfully exporting], the Response.error array of the completion response body SHALL be populated with one or more files in ndjson format containing FHIR `OperationOutcome` resources to indicate what went wrong . ",SHALL,Server,,true hl7.fhir.uv.bulkdata_2.0.0,143,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"In the case of a partial success, the server SHALL use a 200 status code instead of 4XX or 5XX. ",SHALL,Server,,true -hl7.fhir.uv.bulkdata_2.0.0,144,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,Response - Complete Status: HTTP status of `200 OK`,SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,145,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,Response - Complete Status: `Content-Type` header of `application/json`,SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,146,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,Response - Complete Status: The server SHOULD return an Expires header indicating when the files listed will no longer be available for access.,SHOULD,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,147,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: A body containing a JSON object providing metadata, and links to the generated Bulk Data files.",SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,148,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,The files [linked in the response] SHALL be accessible to the client at the URLs advertised.,SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,149,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,These URLs [advertised in the response] MAY be served by file servers other than a FHIR-specific server.,MAY,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,144,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,[A Bulk Data server SHALL respond to a successful Status Request that has completed with] HTTP status of `200 OK`,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,145,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,[A Bulk Data server SHALL respond to a successful Status Request that has completed with] `Content-Type` header of `application/json`,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,146,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"[When a Bulk Data server responds to a successful Status Request that has completed, it] SHOULD return an Expires header indicating when the files listed will no longer be available for access.",SHOULD,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,147,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"[A Bulk Data server SHALL respond to a successful Status Request that has completed with a] body containing a JSON object providing metadata, and links to the generated Bulk Data files.",SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,148,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"[When a Bulk Data server responds to a successful Status Request that has completed,] [t]he files [linked in the response] SHALL be accessible to the client at the URLs advertised.",SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,149,[A Bulk Data server SHALL respond to an errored Bulk Data Output File Request with] HTTP Status Code of `4XX` or `5XX`,"[When a Bulk Data server responds to a successful Status Request that has completed, the] URLs [advertised in the response] MAY be served by file servers other than a FHIR-specific server.",MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,150,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `transactionTime`: required",SHALL,Server,,false @@ -360,15 +364,15 @@ hl7.fhir.uv.bulkdata_2.0.0,200,https://hl7.org/fhir/uv/bulkdata/STU2/export.html hl7.fhir.uv.bulkdata_2.0.0,201,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,"If the requiresAccessToken field in the Complete Status body is set to true, the request SHALL include a valid access token.",SHALL,Client,,true hl7.fhir.uv.bulkdata_2.0.0,202,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,The exported data SHALL include only the most recent version of any exported resources unless the client explicitly requests different behavior in a fashion supported by the server,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,203,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,Inclusion of the Resource.meta information in the resources is at the discretion of the server (as it is for all FHIR interactions).,MAY,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,204,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint-2,Endpoint: GET [url from status request output field],SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,205,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers-1,"Headers: Accept (optional, defaults to application/fhir+ndjson)",MAY,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,206,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,Response - Success: HTTP status of 200 OK,SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,207,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,Response - Success: `Content-Type` header that matches the file format being delivered. ,SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,208,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"Response - Success: For files in ndjson format, [`Content-Type`] SHALL be `application/fhir+ndjson`",SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,209,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"Response - Success: Body of FHIR resources in newline delimited json - ndjson or other requested format +hl7.fhir.uv.bulkdata_2.0.0,204,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint-2,[A Bulk Data server SHALL support Output File Requests at the endpoint] `GET [url from status request output field]`,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,205,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers-1,"[To request an Output File, a client MAY use the header] Accept (... defaults to application/fhir+ndjson)",MAY,Client,,false +hl7.fhir.uv.bulkdata_2.0.0,206,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,[A Bulk Data server SHALL respond to a successful Output File Request with] HTTP status of `200 OK`,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,207,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,[A Bulk Data server SHALL respond to a successful Output File Request with] `Content-Type` header that matches the file format being delivered. ,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,208,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"[When Bulk Data server responds to a successful Output File Request,] [f]or files in ndjson format, [`Content-Type`] SHALL be `application/fhir+ndjson`",SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,209,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"[A Bulk Data server SHALL respond to a successful Output File Request with] [b]ody of FHIR resources in newline delimited json - ndjson or other requested format ",SHALL,Server,,false -hl7.fhir.uv.bulkdata_2.0.0,210,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error,Response - Error: HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,210,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error,[A Bulk Data server SHALL respond to an errored Bulk Data Output File Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,211,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: If resources in an output file contain elements of the type Attachment, the server SHOULD populate the Attachment.contentType code",SHOULD,Server,,true hl7.fhir.uv.bulkdata_2.0.0,212,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: If resources in an output file contain elements of the type Attachment, the server SHOULD populate … either the data element or the url element.",SHOULD,Server,,true hl7.fhir.uv.bulkdata_2.0.0,213,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When populated, the url element SHALL be an absolute url that can be de-referenced to the attachment’s content.",SHALL,Server,,true @@ -396,70 +400,84 @@ hl7.fhir.uv.bulkdata_2.0.0,226,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityS hl7.fhir.uv.bulkdata_2.0.0,227,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern.,SHALL,Server,http://hl7.org/fhir/R4/async.html,false hl7.fhir.uv.bulkdata_2.0.0,228,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,Servers SHALL support GET requests and MAY support POST requests that supply parameters using the FHIR Parameters Resource.,MAY,Server,https://www.hl7.org/fhir/parameters.html,false hl7.fhir.uv.bulkdata_2.0.0,229,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,http://hl7.org/fhir/R4/async.html,false -hl7.fhir.uv.bulkdata_2.0.0,230,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,_outputFormat: The server SHALL support Newline Delimited JSON,SHALL,Server,,false +hl7.fhir.uv.bulkdata_2.0.0,230,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,_outputFormat: The server SHALL support Newline Delimited JSON,DEPRECATED,Server,,false hl7.fhir.uv.bulkdata_2.0.0,231,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,232,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,233,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@47-52,false +hl7.fhir.uv.bulkdata_2.0.0,233,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,234,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: Support is required for a server,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,235,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: Support is … optional for a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,236,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@53-59,false +hl7.fhir.uv.bulkdata_2.0.0,236,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,237,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,238,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,239,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@60-72,false +hl7.fhir.uv.bulkdata_2.0.0,239,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,240,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,241,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,242,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@73-82,false +hl7.fhir.uv.bulkdata_2.0.0,242,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,243,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,244,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,245,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@90-100,false +hl7.fhir.uv.bulkdata_2.0.0,245,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,246,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,247,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,248,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@101-106,false +hl7.fhir.uv.bulkdata_2.0.0,248,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,249,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,Group Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,250,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,Group Level Export: URL: [base]/Group/[id]/$export,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,251,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,252,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,253,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@47-52,false +hl7.fhir.uv.bulkdata_2.0.0,253,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,254,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: Support is required for a server,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,255,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: Support is … optional for a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,256,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@53-59,false +hl7.fhir.uv.bulkdata_2.0.0,256,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,257,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,258,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,259,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@60-72,false +hl7.fhir.uv.bulkdata_2.0.0,259,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,260,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,261,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,262,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@73-82,false +hl7.fhir.uv.bulkdata_2.0.0,262,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,263,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,264,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,265,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@83-89,false +hl7.fhir.uv.bulkdata_2.0.0,265,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,266,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,267,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,268,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@90-100,false +hl7.fhir.uv.bulkdata_2.0.0,268,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,269,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,270,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,271,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@101-106,false +hl7.fhir.uv.bulkdata_2.0.0,271,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,272,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,Patient Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,273,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,Patient Level Export: URL: [base]/Patient/$export,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,274,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false hl7.fhir.uv.bulkdata_2.0.0,275,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,276,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@47-52,false +hl7.fhir.uv.bulkdata_2.0.0,276,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,277,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: Support is required for a server,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,278,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: Support is … optional for a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,279,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@53-59,false +hl7.fhir.uv.bulkdata_2.0.0,279,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,280,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,281,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,282,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@60-72,false +hl7.fhir.uv.bulkdata_2.0.0,282,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,283,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,284,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,285,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@73-82,false +hl7.fhir.uv.bulkdata_2.0.0,285,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,286,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,287,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,288,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@83-89,false +hl7.fhir.uv.bulkdata_2.0.0,288,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,289,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,290,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,291,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@90-100,false +hl7.fhir.uv.bulkdata_2.0.0,291,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,292,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false hl7.fhir.uv.bulkdata_2.0.0,293,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false -hl7.fhir.uv.bulkdata_2.0.0,294,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: requirements,DEPRECATED,Server/Client,hl7.fhir.uv.bulkdata_2.0.0@101-106,false +hl7.fhir.uv.bulkdata_2.0.0,294,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: requirements,DEPRECATED,Server/Client,,false hl7.fhir.uv.bulkdata_2.0.0,295,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,All exchanges described herein between a client and a server SHALL be secured using Transport Layer Security (TLS) Protocol Version 1.2 (RFC5246) or a more recent version of TLS.,SHALL,Client,,false hl7.fhir.uv.bulkdata_2.0.0,296,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Use of mutual TLS is OPTIONAL.,MAY,Client,,false +hl7.fhir.uv.bulkdata_2.0.0,297,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---all-patients,"[If the server supports Bulk Data Patient Export, the endpoint SHALL be] `[fhir base]/Patient/$export`",SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,298,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---group-of-patients,"[If the server supports Bulk Data Group Export, the endpoint SHALL be] `[fhir base]/Group/[id]/$export`",SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,299,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---system-level-export,"[If the server supports Bulk Data System Level Export, the endpoint SHALL be] `[fhir base]/$export`",SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,300,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success,[A Bulk Data server SHALL respond to a successful Bulk Data Kickoff Request with] HTTP Status Code of `202 Accepted`,SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,301,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success,[A Bulk Data server SHALL respond to a successful Bulk Data Kickoff Request with] `Content-Location` header with the absolute URL of an endpoint for subsequent status requests (polling location),SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,302,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success,[A Bulk Data server MAY respond to a successful Bulk Data Kickoff Request with] a FHIR `OperationOutcome` resource in the body in JSON format,MAY,Server,, +hl7.fhir.uv.bulkdata_2.0.0,303,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-eg-unsupported-search-parameter,[A Bulk Data server SHALL respond to an errored Bulk Data Kickoff Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,304,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-eg-unsupported-search-parameter,"[When a Bulk Data server responds to an errored Bulk Data Kickoff Request,] [t]he body SHALL be a FHIR OperationOutcome resource in JSON format",SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,305,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint,[A Bulk Data server SHALL support Delete Requests at the endpoint] `DELETE [polling content location]`,SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,306,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-1,[A Bulk Data server SHALL respond to a successful Delete Request with] HTTP Status Code of `202 Accepted`,SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,307,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-1,[A Bulk Data server MAY respond to a successful Delete Request with] a FHIR `OperationOutcome` resource in the body in JSON format,MAY,Server,, +hl7.fhir.uv.bulkdata_2.0.0,308,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status,[A Bulk Data server SHALL respond to an errored Bulk Data Delete Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,309,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status,"[When a Bulk Data server responds to an errored Bulk Data Delete Request,] [t]he body SHALL be a FHIR OperationOutcome resource in JSON format",SHALL,Server,, +hl7.fhir.uv.bulkdata_2.0.0,310,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint-1,[A Bulk Data server SHALL support Status Requests at the endpoint] `GET [polling content location]`,SHALL,Server,, diff --git a/lib/bulk_data_test_kit/requirements/generated/bulk-data-test-kit_requirements_coverage.csv b/lib/bulk_data_test_kit/requirements/generated/bulk-data-test-kit_requirements_coverage.csv index ff08d38..23ee51a 100644 --- a/lib/bulk_data_test_kit/requirements/generated/bulk-data-test-kit_requirements_coverage.csv +++ b/lib/bulk_data_test_kit/requirements/generated/bulk-data-test-kit_requirements_coverage.csv @@ -1,224 +1,228 @@ -Req Set,ID,URL,Requirement,Conformance,Actor,Sub-Requirement(s),Conditionality,Bulk Data Access v2.0.0 Short ID(s),Bulk Data Access v2.0.0 Full ID(s) -hl7.fhir.uv.bulkdata_2.0.0,1,https://hl7.org/fhir/uv/bulkdata/STU2/#conformance,"To declare conformance with this IG, a server should include the following URL in its CapabilityStatement.instantiates: http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data",SHOULD,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,2,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,All exchanges described herein between a client and a server SHALL be secured using Transport Layer Security (TLS) Protocol Version 1.2 (RFC5246) or a more recent version of TLS.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,3,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Use of mutual TLS is OPTIONAL.,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,4,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,"With each of the requests described herein, implementers SHOULD implement OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Profile. ",SHOULD,Server,SMART Backend Services Authorization Profile,false,, -hl7.fhir.uv.bulkdata_2.0.0,5,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,"When SMART Backend Services Authorization is used, Bulk Data Status Request and Bulk Data Output File Requests with requiresAccessToken=true SHALL be protected the same way the Bulk Data Kick-off Request, including an access token with scopes that cover all resources being exported.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,6,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,A server MAY additionally restrict Bulk Data Status Request and Bulk Data Output File Requests by limiting them to the client that originated the export.,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,7,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,"Implementations MAY include endpoints that use authorization schemes other than OAuth 2.0, such as mutual-TLS or signed URLs.",MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,8,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,A server SHOULD NOT delete files from a Bulk Data response that a client is actively in the process of downloading regardless of the pre-specified expiration time.,SHOULD NOT,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,9,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,The FHIR server SHALL limit the data returned to only those FHIR resources for which the client is authorized. ,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,10,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Implementers SHOULD incorporate technology that preserves and respects an individual’s wishes to share their data with desired privacy protections.,SHOULD,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,11,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Server developers SHOULD consider and mitigate the risk of intentional or inadvertent denial-of-service attacks though the details are beyond the scope of this specification.,SHOULD,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,12,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Provider - consists of… FHIR Authorization Server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,13,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Provider - consists of… FHIR Resource Server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,14,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Provider - consists of… Output File Server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,15,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that requests … access tokens,SHALL,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,16,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that ... receives access tokens,SHALL,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,17,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that requests ... Bulk Data files,SHALL,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,18,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that ... receives ... Bulk Data files,SHALL,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,19,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Authorization Server … issues access tokens in response to valid token requests from client.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,20,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server … accepts kick-off request,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,21,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server … provides job status,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,22,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server ... provides ... completion manifest.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,23,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Output File Server … returns ... attachments in response to urls in the completion manifest.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,24,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Output File Server … returns FHIR Bulk Data files ... in response to urls in the completion manifest. ,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,25,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,"Output File Server … may be built into the FHIR Server, or may be independently hosted.",SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,27,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,a server SHALL limit the data returned to only those FHIR resources for which the client is authorized.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,28,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,The Resource FHIR server SHALL support invocation of [the bulk data kick-off request] operation using the FHIR Asynchronous Request Pattern.,SHALL,Server,http://hl7.org/fhir/R4/async.html,false,, -hl7.fhir.uv.bulkdata_2.0.0,29,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,A server SHALL support GET requests,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,30,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,A server ... MAY support POST requests that supply parameters using the FHIR Parameters Resource.,MAY,Server,http://hl7.org/fhir/R4/parameters.html,false,, -hl7.fhir.uv.bulkdata_2.0.0,31,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,A client MAY repeat kick-off parameters that accept comma delimited values multiple times in a kick-off request.,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,32,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,The server SHALL treat the values provided as if they were comma delimited values within a single instance of the parameter.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,33,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For Patient-level requests ..., the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,34,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For … Group-level requests associated with groups of patients, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,35,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For Patient-level requests ..., … where applicable, Patient resources SHOULD be returned.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,36,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For … Group-level requests associated with groups of patients, … where applicable, Patient resources SHOULD be returned.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,37,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For Patient-level requests ..., … Other resources outside of the patient compartment that are helpful in interpreting the patient data (such as Organization and Practitioner) MAY also be returned.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,38,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For … Group-level requests associated with groups of patients, … Other resources outside of the patient compartment that are helpful in interpreting the patient data (such as Organization and Practitioner) MAY also be returned.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,39,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,Binary Resources whose content is associated with an individual patient SHALL be serialized as DocumentReference Resources with the content.attachment element populated as described in the Attachments section below.,MAY,Server,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,false,, -hl7.fhir.uv.bulkdata_2.0.0,40,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,Binary Resources not associated with an individual patient MAY be included in a System Level export.,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,41,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"References in the resources returned MAY be relative URLs with the format /, or MAY be absolute URLs with the same structure rooted in the base URL for the server from which the export was performed.",MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,42,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---group-of-patients,"If a FHIR server supports Group-level data export, it SHOULD support reading and searching for Group resource.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,43,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,A client SHOULD provide [the accept] header.,SHOULD,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,44,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"If [the client omits the accept header], the server MAY return an error or MAY process the request as if application/fhir+json was supplied.",MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,45,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"A client SHOULD provide [the prefer] header [with value ""respond-async""].",SHOULD,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,46,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"If [the client omits the prefer header], the server MAY return an error or MAY process the request as if respond-async was supplied.",MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,47,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_outputFormat`: Optionality for Server: required,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,48,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_outputFormat`: Optionality for Client: optional,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,49,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server SHALL support Newline Delimited JSON,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,50,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server … MAY choose to support additional output formats,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,51,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server SHALL accept the full content type of `application/fhir+ndjson`,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,52,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server SHALL accept ... the abbreviated representations `application/ndjson` and `ndjson`.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,53,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_since`: Optionality for Server: required,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,54,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_since`: Optionality for Client: optional,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,55,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: In the case of a Group level export, the server MAY return additional resources modified prior to the supplied time if the resources belong to the patient compartment of a patient added to the Group after the supplied time",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,56,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_since`: [returning resources modified prior to the supplied time] SHOULD be clearly documented by the server,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,57,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: For Patient- and Group-level requests, the server MAY return resources that are referenced by the resources being returned regardless of when the referenced resources were last updated.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,58,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: For resources where the server does not maintain a last updated time, the server MAY include these resources in a response irrespective of the `_since` value supplied by a client.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,59,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: Resources will be included in the response if their state has changed after the supplied time (e.g., if Resource.meta.lastUpdated is later than the supplied `_since` time).",SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,60,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_type`: Optionality for Server: optional,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,61,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_type`: Optionality for Client: optional,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,62,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_type`: The response SHALL be filtered to only include resources of the specified resource types(s).,SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,63,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: If this parameter is omitted, the server SHALL return all supported resources within the scope of the client authorization",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,64,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the US Core Implementation Guide.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,65,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: For … Group-level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,66,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: For Patient- ...level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,67,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_type`: other resources outside of the Patient Compartment that are referenced by the resources being returned and would be helpful in interpreting the patient data MAY also be returned (such as Organization and Practitioner).,MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,68,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: When [returning resources outside of the Patient Compartment] is supported, a server SHOULD document this support (for example, as narrative text, or by including a GraphDefinition Resource).",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,69,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_type`:A server that is unable to support `_type` SHOULD return an error and FHIR `OperationOutcome ` resource,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,70,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`:If the client explicitly asks for export of resources that the Bulk Data server doesn't support ..., the server SHOULD return details via a FHIR `OperationOutcome ` resource in an error response to the request.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,71,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: If the client ... asks for only resource types that are outside the Patient Compartment, the server SHOULD return details via a FHIR `OperationOutcome ` resource in an error response to the request.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,72,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: When a `Prefer: handling=lenient` header is included in the request [and the request would otherwise create an error], the server MAY process the request instead of returning an error.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,73,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_elements`: Optionality for Server: optional,MAY,Server,,,, -hl7.fhir.uv.bulkdata_2.0.0,74,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_elements`: Optionality for Client: optional,MAY,Client,,,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,75,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_elements`: When provided, the server SHOULD omit unlisted, non-mandatory elements from the resources returned.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,76,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: Elements SHOULD be of the form `[resource type].[element name]` or `[element name]`,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,77,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: only root elements in a resource are permitted.,SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,78,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_elements`: If the resource type is omitted, the element SHOULD be returned for all resources in the response where it is applicable.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,79,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: A server SHOULD always return mandatory elements whether they are requested or not.,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,80,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: A server SHOULD mark [resources with only some elements returned] with the tag SUBSETTED to ensure that the incomplete resource is not actually used to overwrite a complete resource.,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,81,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: A server that is unable to support _elements SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,82,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_elements`: When a `Prefer: handling=lenient` header is included in the request, the server MAY process the request instead of returning an error. ",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,83,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_patient`: Optionality for Server: optional,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,84,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_patient`: Optionality for Client: optional,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,85,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: When provided, the server SHALL NOT return resources in the patient compartments belonging to patients outside of this list.",SHALL NOT,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,86,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: If a client requests patients who are not present on the server ..., the server SHOULD return details via a FHIR OperationOutcome resource in an error response to the request.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,87,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: If a client requests patients who… in the case of a group level export, who are not members of the group..., the server SHOULD return details via a FHIR OperationOutcome resource in an error response to the request.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,88,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`patient`: A server that is unable to support `patient` SHOULD return an error and FHIR `OperationOutcome` resource so the client can re-submit a request omitting the patient parameter.,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,89,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: When a `Prefer: handling=lenient` header is included in the request, the server MAY process the request instead of returning an error. ",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,90,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_includeAssociatedData`: Optionality for Server: optional,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,91,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_includeAssociatedData`: Optionality for Client: optional,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,92,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`includeAssociatedData`: a server with support for the parameter and requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request.,SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,93,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`includeAssociatedData`: A server that is unable to support the requested includeAssociatedData values SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,94,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,95,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: A client MAY include one or more of the following values.,MAY,Client,hl7.fhir.uv.bulkdata_2.0.0@97-100,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,96,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: If multiple conflicting values are included, the server SHALL apply the least restrictive value (value that will return the largest dataset). ",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@97-100,true,, -hl7.fhir.uv.bulkdata_2.0.0,97,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `LatestProvenanceResources`: Export will include the most recent Provenance resources associated with each of the non-provenance resources being returned.,SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,98,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `LatestProvenanceResources`: Other Provenance resources will not be returned.,SHALL NOT,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,99,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `RelevantProvenanceResources`: Export will include all Provenance resources associated with each of the non-provenance resources being returned.,SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,100,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: `_[custom value]`: A server MAY define and support custom values that are prefixed with an underscore (e.g., _myCustomPreset).",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,101,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_typeFilter`: Optionality for Server: optional,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,102,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_typeFilter`: Optionality for Client: optional,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,103,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_typeFilter`: When provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,104,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_typeFilter`:FHIR search response parameters such as _include and _sort SHALL NOT be used.,SHALL,Client,,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,105,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_typeFilter`:A server unable to support the requested _typeFilter queries SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,106,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_typeFilter`:When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error. ",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,107,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the US Core Implementation Guide",MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,108,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If the client explicitly asks for export of resources that the Bulk Data server doesn’t support, the server SHOULD return details via a FHIR `OperationOutcome` resource in an error response to the request.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,109,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` value relevant to provenance is not specified ..., the server SHALL include all available Provenance resources whose Provenance.target is a resource in the Patient compartment in a patient level export request",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,110,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` ... parameter is not supported by a server, the server SHALL include all available Provenance resources whose Provenance.target is a resource in the Patient compartment in a patient level export request",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,111,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` value relevant to provenance is not specified ..., the server SHALL include ... all available Provenance resources in a system level export request unless a specific resource set is specified using the _type parameter and this set does not include Provenance.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,112,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` ... parameter is not supported by a server, the server SHALL include ... all available Provenance resources in a system level export request unless a specific resource set is specified using the _type parameter and this set does not include Provenance.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,113,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"To request finer-grained filtering, a client MAY supply a `_typeFilter` parameter alongside the _type parameter.",MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,114,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,FHIR search response parameters such as `_include` and `_sort` SHALL NOT be used.,SHALL,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,115,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"Since support for `_typeFilter` is OPTIONAL for a FHIR server, clients SHOULD be robust to servers that ignore `_typeFilter`.",SHOULD,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,116,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,A client MAY repeat the `_typeFilter` parameter multiple times in a kick-off request. ,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,117,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"When [the `_typeFilter` parameter is] repeated, the server SHALL treat the repeated values as if they were comma delimited values within a single `_typeFilter` parameter.",SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,118,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-eg-unsupported-search-parameter,"If a server wants to prevent a client from beginning a new export before an in-progress export is completed, it SHOULD respond with a 429 `Too Many Requests` status and a `Retry-After` header.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,119,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"After a Bulk Data request has been started, a client MAY send a DELETE request to the URL provided in the Content-Location header to cancel the request as described in the FHIR Asynchronous Request Pattern.",MAY,Client,https://www.hl7.org/fhir/R4/async.html,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,120,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"If the request has been completed, a server MAY use the request as a signal that ... it is safe for the sever to remove those [requested files] from storage.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,121,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"If the request has been completed, a server MAY use the request as a signal that a client is done retrieving files",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,122,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"Following the delete request, when subsequent requests are made to the polling location, the server SHALL return a `404 Not Found` error and an associated FHIR `OperationOutcome` in JSON format.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,123,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"After a Bulk Data request has been started, the client MAY poll the status URL provided in the `Content-Location` header as described in the FHIR Asynchronous Request Pattern.",MAY,Client,https://www.hl7.org/fhir/R4/async.html,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,124,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,Clients SHOULD follow an exponential backoff approach when polling for status.,SHOULD,Client,,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,125,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"A server SHOULD supply a `Retry-After` header with a with a delay time in seconds (e.g., 120 to represent two minutes) or a http-date (e.g., Fri, 31 Dec 1999 23:59:59 GMT). ",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,126,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"When provided a [`Retry-After` header is provided], clients SHOULD use this information to inform the timing of future polling requests.",SHOULD,Client,,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,127,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,The server SHOULD keep an accounting of status queries received from a given client,SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,128,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"if a client is polling too frequently, the server SHOULD respond with a 429 Too Many Requests status code in addition to a Retry-After header, and optionally a FHIR OperationOutcome resource with further explanation.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,129,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"If excessively frequent status queries persist, the server MAY return a 429 Too Many Requests status code and terminate the session.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,130,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"When requesting status, the client SHOULD use an Accept header indicating a content type of application/json.",SHOULD,Client,,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,131,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"In the case that errors prevent the export from completing, the server SHOULD respond with a FHIR OperationOutcome resource in JSON format.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,132,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,Response - In-Progress Status: HTTP Status Code of `202 Accepted`,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,133,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,the server MAY return an `X-Progress` header with a text description of the status of the request that is less than 100 characters.,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,134,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,"The format of [the `X-Progress`] description ... MAY be a percentage complete value, or MAY be a more general status such as “in progress”. ",MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,135,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,"The client MAY parse the description, display it to the user, or log it.",MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,136,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,Response - Error Status: HTTP status code of `4XX` or `5XX`,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,137,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,`Content-Type` header of `application/fhir+json` when body is a FHIR `OperationOutcome` resource,SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,138,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,The body of the response SHOULD be a FHIR OperationOutcome resource in JSON format.,SHOULD,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,139,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1," If [a response including the FHIR `OperationOutcome` resource] is not possible (for example, the infrastructure layer returning the error is not FHIR aware), the server MAY return an error message in another format and include a corresponding value for the `Content-Type` header.",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,140,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"In the case of a polling failure that does not indicate failure of the export job, a server SHOULD use a transient code from the IssueType valueset when populating the FHIR `OperationOutcome` resource’s `issue.code` element to indicate to the client that it should retry the request at a later time.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,141,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"Even if some of the requested resources cannot successfully be exported, the overall export operation MAY still succeed. ",MAY,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,142,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"[if the overall export succeeds despite some resources not sucessfully exporting], the Response.error array of the completion response body SHALL be populated with one or more files in ndjson format containing FHIR `OperationOutcome` resources to indicate what went wrong . ",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,143,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"In the case of a partial success, the server SHALL use a 200 status code instead of 4XX or 5XX. ",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,144,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,Response - Complete Status: HTTP status of `200 OK`,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,145,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,Response - Complete Status: `Content-Type` header of `application/json`,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,146,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,Response - Complete Status: The server SHOULD return an Expires header indicating when the files listed will no longer be available for access.,SHOULD,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,147,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: A body containing a JSON object providing metadata, and links to the generated Bulk Data files.",SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,148,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,The files [linked in the response] SHALL be accessible to the client at the URLs advertised.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,149,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,These URLs [advertised in the response] MAY be served by file servers other than a FHIR-specific server.,MAY,Server,,false,, +Req Set,ID,URL,Requirement,Conformance,Actor,Sub-Requirement(s),Conditionality,Bulk Data Access v1.0.1 Server Short ID(s),Bulk Data Access v1.0.1 Server Full ID(s),Bulk Data Access v2.0.0 Server Short ID(s),Bulk Data Access v2.0.0 Server Full ID(s),Bulk Data Access v2.0.0 Client Short ID(s),Bulk Data Access v2.0.0 Client Full ID(s) +hl7.fhir.uv.bulkdata_2.0.0,1,https://hl7.org/fhir/uv/bulkdata/STU2/#conformance,"To declare conformance with this IG, a server should include the following URL in its CapabilityStatement.instantiates: http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data",SHOULD,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,2,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,All exchanges described herein between a client and a server SHALL be secured using Transport Layer Security (TLS) Protocol Version 1.2 (RFC5246) or a more recent version of TLS.,SHALL,Server,,false,"","",1.2,bulk_data_v200-bulk_data_smart_backend_services_v200-backend_services_authorization,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,3,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Use of mutual TLS is OPTIONAL.,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,4,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,"With each of the requests described herein, implementers SHOULD implement OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Profile. ",SHOULD,Server,SMART Backend Services Authorization Profile,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,5,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,"When SMART Backend Services Authorization is used, Bulk Data Status Request and Bulk Data Output File Requests with requiresAccessToken=true SHALL be protected the same way the Bulk Data Kick-off Request, including an access token with scopes that cover all resources being exported.",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,6,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,A server MAY additionally restrict Bulk Data Status Request and Bulk Data Output File Requests by limiting them to the client that originated the export.,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,7,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,"Implementations MAY include endpoints that use authorization schemes other than OAuth 2.0, such as mutual-TLS or signed URLs.",MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,8,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,A server SHOULD NOT delete files from a Bulk Data response that a client is actively in the process of downloading regardless of the pre-specified expiration time.,SHOULD NOT,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,9,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,The FHIR server SHALL limit the data returned to only those FHIR resources for which the client is authorized. ,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,10,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Implementers SHOULD incorporate technology that preserves and respects an individual’s wishes to share their data with desired privacy protections.,SHOULD,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,11,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Server developers SHOULD consider and mitigate the risk of intentional or inadvertent denial-of-service attacks though the details are beyond the scope of this specification.,SHOULD,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,12,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Provider - consists of… FHIR Authorization Server,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,13,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Provider - consists of… FHIR Resource Server,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,14,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Provider - consists of… Output File Server,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,15,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that requests … access tokens,SHALL,Client,,false,NA,NA,NA,NA,3.01,bulk_data_v200_client-bulk_data_client_auth_verification-bulk_data_client_token_smart_bsca_verification +hl7.fhir.uv.bulkdata_2.0.0,16,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Bulk Data Client - system that ... receives access tokens,SHALL,Client,,false,NA,NA,NA,NA,3.01,bulk_data_v200_client-bulk_data_client_auth_verification-bulk_data_client_token_smart_bsca_verification +hl7.fhir.uv.bulkdata_2.0.0,17,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,[A] Bulk Data Client [is a] system that requests ... Bulk Data files,SHALL,Client,,false,NA,NA,NA,NA,2.02,bulk_data_v200_client-bulk_data_client_export_group-bulk_data_client_kick_off +hl7.fhir.uv.bulkdata_2.0.0,18,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,[A] Bulk Data Client [is a] system that ... receives ... Bulk Data files,SHALL,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,19,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Authorization Server … issues access tokens in response to valid token requests from client.,SHALL,Server,,false,"","",1.2,bulk_data_v200-bulk_data_smart_backend_services_v200-backend_services_authorization,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,20,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server … accepts kick-off request,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,21,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server … provides job status,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,22,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,FHIR Resource Server ... provides ... completion manifest.,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,23,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Output File Server … returns ... attachments in response to urls in the completion manifest.,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,24,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,Output File Server … returns FHIR Bulk Data files ... in response to urls in the completion manifest. ,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,25,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#roles,"Output File Server … may be built into the FHIR Server, or may be independently hosted.",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,27,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,a server SHALL limit the data returned to only those FHIR resources for which the client is authorized.,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,28,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,The Resource FHIR server SHALL support invocation of [the bulk data kick-off request] operation using the FHIR Asynchronous Request Pattern.,SHALL,Server,http://hl7.org/fhir/R4/async.html,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,29,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,A server SHALL support GET requests,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,30,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,A server ... MAY support POST requests that supply parameters using the FHIR Parameters Resource.,MAY,Server,http://hl7.org/fhir/R4/parameters.html,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,31,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,A client MAY repeat kick-off parameters that accept comma delimited values multiple times in a kick-off request.,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,32,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,The server SHALL treat the values provided as if they were comma delimited values within a single instance of the parameter.,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,33,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For Patient-level requests ..., the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,34,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For … Group-level requests associated with groups of patients, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,35,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For Patient-level requests ..., … where applicable, Patient resources SHOULD be returned.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,36,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For … Group-level requests associated with groups of patients, … where applicable, Patient resources SHOULD be returned.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,37,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For Patient-level requests ..., … Other resources outside of the patient compartment that are helpful in interpreting the patient data (such as Organization and Practitioner) MAY also be returned.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,38,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"For … Group-level requests associated with groups of patients, … Other resources outside of the patient compartment that are helpful in interpreting the patient data (such as Organization and Practitioner) MAY also be returned.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,39,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,Binary Resources whose content is associated with an individual patient SHALL be serialized as DocumentReference Resources with the content.attachment element populated as described in the Attachments section below.,MAY,Server,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,40,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,Binary Resources not associated with an individual patient MAY be included in a System Level export.,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,41,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-kick-off-request,"References in the resources returned MAY be relative URLs with the format /, or MAY be absolute URLs with the same structure rooted in the base URL for the server from which the export was performed.",MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,42,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---group-of-patients,"If a FHIR server supports Group-level data export, it SHOULD support reading and searching for Group resource.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,43,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,A client SHOULD provide [the Accept] header.,SHOULD,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,44,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"If [the client omits the accept header], the server MAY return an error or MAY process the request as if application/fhir+json was supplied.",MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,45,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"A client SHOULD provide [the prefer] header [with value ""respond-async""].",SHOULD,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,46,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers,"If [the client omits the prefer header], the server MAY return an error or MAY process the request as if respond-async was supplied.",MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,47,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_outputFormat`: Optionality for Server: required,SHALL,Server,,false,"","","2.2.4.01, 2.3.4.01, 2.4.4.01","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_parameters_group-output_format_in_group_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_parameters_group-output_format_in_patient_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_parameters_group-output_format_in_system_export_response",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,48,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_outputFormat`: Optionality for Client: optional,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,49,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server SHALL support Newline Delimited JSON,SHALL,Server,,false,"","","2.2.4.01, 2.3.4.01, 2.4.4.01","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_parameters_group-output_format_in_group_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_parameters_group-output_format_in_patient_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_parameters_group-output_format_in_system_export_response",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,50,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server … MAY choose to support additional output formats,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,51,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server SHALL accept the full content type of `application/fhir+ndjson`,SHALL,Server,,false,"","","2.2.4.01, 2.3.4.01, 2.4.4.01","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_parameters_group-output_format_in_group_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_parameters_group-output_format_in_patient_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_parameters_group-output_format_in_system_export_response",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,52,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_outputFormat `: The server SHALL accept ... the abbreviated representations `application/ndjson` and `ndjson`.,SHALL,Server,,false,"","","2.2.4.01, 2.3.4.01, 2.4.4.01","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_parameters_group-output_format_in_group_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_parameters_group-output_format_in_patient_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_parameters_group-output_format_in_system_export_response",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,53,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_since`: Optionality for Server: required,SHALL,Server,,false,"","","2.2.4.02, 2.3.4.02, 2.4.4.02","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_parameters_group-since_in_group_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_parameters_group-since_in_patient_export_response, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_parameters_group-since_in_system_export_response",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,54,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_since`: Optionality for Client: optional,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,55,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: In the case of a Group level export, the server MAY return additional resources modified prior to the supplied time if the resources belong to the patient compartment of a patient added to the Group after the supplied time",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,56,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_since`: [returning resources modified prior to the supplied time] SHOULD be clearly documented by the server,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,57,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: For Patient- and Group-level requests, the server MAY return resources that are referenced by the resources being returned regardless of when the referenced resources were last updated.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,58,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: For resources where the server does not maintain a last updated time, the server MAY include these resources in a response irrespective of the `_since` value supplied by a client.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,59,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_since`: Resources will be included in the response if their state has changed after the supplied time (e.g., if Resource.meta.lastUpdated is later than the supplied `_since` time).",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,60,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_type`: Optionality for Server: optional,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,61,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_type`: Optionality for Client: optional,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,62,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_type`: The response SHALL be filtered to only include resources of the specified resource types(s).,SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,63,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: If this parameter is omitted, the server SHALL return all supported resources within the scope of the client authorization",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,64,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the US Core Implementation Guide.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,65,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: For … Group-level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,66,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: For Patient- ...level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,67,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_type`: other resources outside of the Patient Compartment that are referenced by the resources being returned and would be helpful in interpreting the patient data MAY also be returned (such as Organization and Practitioner).,MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,68,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: When [returning resources outside of the Patient Compartment] is supported, a server SHOULD document this support (for example, as narrative text, or by including a GraphDefinition Resource).",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,69,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_type`:A server that is unable to support `_type` SHOULD return an error and FHIR `OperationOutcome ` resource,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,70,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`:If the client explicitly asks for export of resources that the Bulk Data server doesn't support ..., the server SHOULD return details via a FHIR `OperationOutcome ` resource in an error response to the request.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,71,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: If the client ... asks for only resource types that are outside the Patient Compartment, the server SHOULD return details via a FHIR `OperationOutcome ` resource in an error response to the request.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,72,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_type`: When a `Prefer: handling=lenient` header is included in the request [and the request would otherwise create an error], the server MAY process the request instead of returning an error.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,73,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_elements`: Optionality for Server: optional,MAY,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,74,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_elements`: Optionality for Client: optional,MAY,Client,,,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,75,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_elements`: When provided, the server SHOULD omit unlisted, non-mandatory elements from the resources returned.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,76,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: Elements SHOULD be of the form `[resource type].[element name]` or `[element name]`,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,77,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: only root elements in a resource are permitted.,SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,78,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_elements`: If the resource type is omitted, the element SHOULD be returned for all resources in the response where it is applicable.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,79,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: A server SHOULD always return mandatory elements whether they are requested or not.,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,80,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: A server SHOULD mark [resources with only some elements returned] with the tag SUBSETTED to ensure that the incomplete resource is not actually used to overwrite a complete resource.,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,81,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_elements`: A server that is unable to support _elements SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,82,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_elements`: When a `Prefer: handling=lenient` header is included in the request, the server MAY process the request instead of returning an error. ",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,83,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_patient`: Optionality for Server: optional,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,84,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_patient`: Optionality for Client: optional,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,85,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: When provided, the server SHALL NOT return resources in the patient compartments belonging to patients outside of this list.",SHALL NOT,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,86,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: If a client requests patients who are not present on the server ..., the server SHOULD return details via a FHIR OperationOutcome resource in an error response to the request.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,87,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: If a client requests patients who… in the case of a group level export, who are not members of the group..., the server SHOULD return details via a FHIR OperationOutcome resource in an error response to the request.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,88,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`patient`: A server that is unable to support `patient` SHOULD return an error and FHIR `OperationOutcome` resource so the client can re-submit a request omitting the patient parameter.,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,89,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`patient`: When a `Prefer: handling=lenient` header is included in the request, the server MAY process the request instead of returning an error. ",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,90,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_includeAssociatedData`: Optionality for Server: optional,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,91,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_includeAssociatedData`: Optionality for Client: optional,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,92,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`includeAssociatedData`: a server with support for the parameter and requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request.,SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,93,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`includeAssociatedData`: A server that is unable to support the requested includeAssociatedData values SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,94,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,95,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,"`includeAssociatedData`: A client MAY include one or more of the following values… + +- `LatestProvenanceResources`… +- `RelevantProvenanceResources`… +- `_[custom value]`…",MAY,Client,hl7.fhir.uv.bulkdata_2.0.0@97-100,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,96,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: If multiple conflicting values are included, the server SHALL apply the least restrictive value (value that will return the largest dataset). ",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@97-100,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,97,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `LatestProvenanceResources`: Export will include the most recent Provenance resources associated with each of the non-provenance resources being returned.,SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,98,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `LatestProvenanceResources`: Other Provenance resources will not be returned.,SHALL NOT,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,99,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`includeAssociatedData`: `RelevantProvenanceResources`: Export will include all Provenance resources associated with each of the non-provenance resources being returned.,SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,100,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`includeAssociatedData`: `_[custom value]`: A server MAY define and support custom values that are prefixed with an underscore (e.g., _myCustomPreset).",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,101,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_typeFilter`: Optionality for Server: optional,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,102,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters,`_typeFilter`: Optionality for Client: optional,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,103,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_typeFilter`: When provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria.",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,104,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_typeFilter`: FHIR search response parameters such as _include and _sort SHALL NOT be used.,SHALL NOT,Client,,true,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,105,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport",`_typeFilter`:A server unable to support the requested _typeFilter queries SHOULD return an error and FHIR OperationOutcome resource,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,106,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","`_typeFilter`:When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error. ",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,107,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the US Core Implementation Guide",MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,108,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If the client explicitly asks for export of resources that the Bulk Data server doesn’t support, the server SHOULD return details via a FHIR `OperationOutcome` resource in an error response to the request.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,109,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` value relevant to provenance is not specified ..., the server SHALL include all available Provenance resources whose Provenance.target is a resource in the Patient compartment in a patient level export request",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,110,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` ... parameter is not supported by a server, the server SHALL include all available Provenance resources whose Provenance.target is a resource in the Patient compartment in a patient level export request",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,111,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` value relevant to provenance is not specified ..., the server SHALL include ... all available Provenance resources in a system level export request unless a specific resource set is specified using the _type parameter and this set does not include Provenance.",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,112,"https://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport","If an `includeAssociatedValue` ... parameter is not supported by a server, the server SHALL include ... all available Provenance resources in a system level export request unless a specific resource set is specified using the _type parameter and this set does not include Provenance.",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,113,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"To request finer-grained filtering, a client MAY supply a `_typeFilter` parameter alongside the _type parameter.",MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,114,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,FHIR search response parameters such as `_include` and `_sort` SHALL NOT be used.,SHALL NOT,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,115,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"Since support for `_typeFilter` is OPTIONAL for a FHIR server, clients SHOULD be robust to servers that ignore `_typeFilter`.",SHOULD,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,116,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,A client MAY repeat the `_typeFilter` parameter multiple times in a kick-off request. ,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,117,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#_typefilter-experimental-query-parameter,"When [the `_typeFilter` parameter is] repeated, the server SHALL treat the repeated values as if they were comma delimited values within a single `_typeFilter` parameter.",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,118,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-eg-unsupported-search-parameter,"If a server wants to prevent a client from beginning a new export before an in-progress export is completed, it SHOULD respond with a 429 `Too Many Requests` status and a `Retry-After` header.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,119,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"After a Bulk Data request has been started, a client MAY send a DELETE request to the URL provided in the Content-Location header to cancel the request as described in the FHIR Asynchronous Request Pattern.",MAY,Client,https://www.hl7.org/fhir/R4/async.html,true,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,120,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"If the request has been completed, a server MAY use the request as a signal that ... it is safe for the sever to remove those [requested files] from storage.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,121,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"If the request has been completed, a server MAY use the request as a signal that a client is done retrieving files",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,122,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request,"Following the delete request, when subsequent requests are made to the polling location, the server SHALL return a `404 Not Found` error and an associated FHIR `OperationOutcome` in JSON format.",SHALL,Server,,true,"","","2.2.3.02, 2.3.3.02, 2.4.3.02","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_cancel_group_stu2-bulk_data_group_export_cancel_stu2, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_cancel_group_stu2-bulk_data_patient_export_cancel_stu2, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_cancel_group_stu2-bulk_data_system_export_cancel_stu2",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,123,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"After a Bulk Data request has been started, the client MAY poll the status URL provided in the `Content-Location` header as described in the FHIR Asynchronous Request Pattern.",MAY,Client,https://www.hl7.org/fhir/R4/async.html,true,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,124,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,Clients SHOULD follow an exponential backoff approach when polling for status.,SHOULD,Client,,true,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,125,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"A server SHOULD supply a `Retry-After` header with a with a delay time in seconds (e.g., 120 to represent two minutes) or a http-date (e.g., Fri, 31 Dec 1999 23:59:59 GMT). ",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,126,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"When provided a [`Retry-After` header is provided], clients SHOULD use this information to inform the timing of future polling requests.",SHOULD,Client,,true,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,127,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,The server SHOULD keep an accounting of status queries received from a given client,SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,128,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"if a client is polling too frequently, the server SHOULD respond with a 429 Too Many Requests status code in addition to a Retry-After header, and optionally a FHIR OperationOutcome resource with further explanation.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,129,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"If excessively frequent status queries persist, the server MAY return a 429 Too Many Requests status code and terminate the session.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,130,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"When requesting status, the client SHOULD use an Accept header indicating a content type of application/json.",SHOULD,Client,,true,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,131,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-status-request,"In the case that errors prevent the export from completing, the server SHOULD respond with a FHIR OperationOutcome resource in JSON format.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,132,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,[A Bulk Data server SHALL resond to a successful Status Request that is in-progress with] HTTP Status Code of `202 Accepted`,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,133,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,the server MAY return an `X-Progress` header with a text description of the status of the request that is less than 100 characters.,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,134,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,"The format of [the `X-Progress`] description ... MAY be a percentage complete value, or MAY be a more general status such as “in progress”. ",MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,135,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---in-progress-status,"The client MAY parse the [status] description [sent in the `X-Progress` header], display it to the user, or log it.",MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,136,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,[A Bulk Data server SHALL respond to an errored Bulk Data Status Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,137,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,[A Bulk Data server SHALL respond to an errored Bulk Data Status Request with] `Content-Type` header of `application/fhir+json` when body is a FHIR `OperationOutcome` resource,SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,138,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"[When a Bulk Data server responds to an errored Bulk Data Delete Request,] [t]he body of the response SHOULD be a FHIR OperationOutcome resource in JSON format.",SHOULD,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,139,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1," If [a response including the FHIR `OperationOutcome` resource] is not possible (for example, the infrastructure layer returning the error is not FHIR aware), the server MAY return an error message in another format and include a corresponding value for the `Content-Type` header.",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,140,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"In the case of a polling failure that does not indicate failure of the export job, a server SHOULD use a transient code from the IssueType valueset when populating the FHIR `OperationOutcome` resource’s `issue.code` element to indicate to the client that it should retry the request at a later time.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,141,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"Even if some of the requested resources cannot successfully be exported, the overall export operation MAY still succeed. ",MAY,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,142,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"[if the overall export succeeds despite some resources not sucessfully exporting], the Response.error array of the completion response body SHALL be populated with one or more files in ndjson format containing FHIR `OperationOutcome` resources to indicate what went wrong . ",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,143,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status-1,"In the case of a partial success, the server SHALL use a 200 status code instead of 4XX or 5XX. ",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,144,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,[A Bulk Data server SHALL respond to a successful Status Request that has completed with] HTTP status of `200 OK`,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,145,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,[A Bulk Data server SHALL respond to a successful Status Request that has completed with] `Content-Type` header of `application/json`,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,146,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"[When a Bulk Data server responds to a successful Status Request that has completed, it] SHOULD return an Expires header indicating when the files listed will no longer be available for access.",SHOULD,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,147,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"[A Bulk Data server SHALL respond to a successful Status Request that has completed with a] body containing a JSON object providing metadata, and links to the generated Bulk Data files.",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,148,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"[When a Bulk Data server responds to a successful Status Request that has completed,] [t]he files [linked in the response] SHALL be accessible to the client at the URLs advertised.",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,149,[A Bulk Data server SHALL respond to an errored Bulk Data Output File Request with] HTTP Status Code of `4XX` or `5XX`,"[When a Bulk Data server responds to a successful Status Request that has completed, the] URLs [advertised in the response] MAY be served by file servers other than a FHIR-specific server.",MAY,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,150,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`transactionTime`: required",SHALL,Server,,false,, +`transactionTime`: required",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,151,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`transactionTime`: type: FHIR instant",SHALL,Server,,false,, +`transactionTime`: type: FHIR instant",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,152,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`transactionTime`: Indicates the server's time when the query is run.",SHALL,Server,,false,, +`transactionTime`: Indicates the server's time when the query is run.",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,153,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`transactionTime`: The response SHOULD NOT include any resources modified after this instant",SHOULD,Server,,false,, +`transactionTime`: The response SHOULD NOT include any resources modified after this instant",SHOULD,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,154,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`transactionTime`: The response … SHALL include any matching resources modified up to and including this instant.",SHALL,Server,,false,, +`transactionTime`: The response … SHALL include any matching resources modified up to and including this instant.",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,155,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`request`: required",SHALL,Server,,false,, +`request`: required",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,156,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`request`: type: String",SHALL,Server,,false,, +`request`: type: String",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,157,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"""Response - Complete Status: -`request`: The full URL of the original Bulk Data kick-off request.",SHALL,Server,,false,, +`request`: The full URL of the original Bulk Data kick-off request.",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,158,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`request`: In the case of a POST request, this URL will not include the request parameters.",SHALL,Server,,true,, +`request`: In the case of a POST request, this URL will not include the request parameters.",SHALL,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,159,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`requiresAccessToken`: required",SHALL,Server,,false,, +`requiresAccessToken`: required",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,160,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`requiresAccessToken`: type: Boolean",SHALL,Server,,false,, +`requiresAccessToken`: type: Boolean",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,161,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`requiresAccessToken`: Indicates whether downloading the generated files requires the same authorization mechanism as the $export operation itself.",SHALL,Server,,false,, +`requiresAccessToken`: Indicates whether downloading the generated files requires the same authorization mechanism as the $export operation itself.",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,162,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`requiresAccessToken`: Value SHALL be true if both the file server and the FHIR API server control access using OAuth 2.0 bearer tokens. ",SHALL,Server,,true,, +`requiresAccessToken`: Value SHALL be true if both the file server and the FHIR API server control access using OAuth 2.0 bearer tokens. ",SHALL,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,163,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`requiresAccessToken`: Value MAY be false for file servers that use access-control schemes other than OAuth 2.0",MAY,Server,,false,, +`requiresAccessToken`: Value MAY be false for file servers that use access-control schemes other than OAuth 2.0",MAY,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,164,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`output`: required",SHALL,Server,,false,, +`output`: required",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,165,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`output`: type: JSON array",SHALL,Server,,false,, +`output`: type: JSON array",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,166,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -An array of file items with one entry for each generated file. ",SHALL,Server,,false,, +An array of file items with one entry for each generated file. ",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,167,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -If no resources are returned from the kick-off request, the server SHOULD return an empty array. ",SHOULD,Server,,true,, +If no resources are returned from the kick-off request, the server SHOULD return an empty array. ",SHOULD,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,168,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: @@ -227,216 +231,229 @@ Each file item SHALL contain the following fields: - `type` -- `url`",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@ 169-176,false,, +- `url`",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@ 169-176,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,169,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`type` - the FHIR resource type that is contained in the file. ",SHALL,Server,,false,, +`type` - the FHIR resource type that is contained in the file. ",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,170,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`type`: Each file SHALL contain resources of only one type",SHALL,Server,,false,, +`type`: Each file SHALL contain resources of only one type",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,171,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`type`: a server MAY create more than one file for each resource type returned",MAY,Server,,false,, +`type`: a server MAY create more than one file for each resource type returned",MAY,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,172,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`type`: The number of resources contained in a file MAY vary between servers.",MAY,Server,,false,, +`type`: The number of resources contained in a file MAY vary between servers.",MAY,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,173,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`type`: If no data are found for a resource, the server SHOULD NOT return an output item for that resource in the response. ",SHOULD,Server,,true,, +`type`: If no data are found for a resource, the server SHOULD NOT return an output item for that resource in the response. ",SHOULD,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,174,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`type`: any resource MAY have a ""contained"" array that includes referenced resources of other types. ",MAY,Server,,false,, +`type`: any resource MAY have a ""contained"" array that includes referenced resources of other types. ",MAY,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,175,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`url`: the absolute path to the file.",SHALL,Server,,false,, +`url`: the absolute path to the file.",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,176,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`url`: The format of the file SHOULD reflect that requested in the `_outputFormat` parameter of the initial kick-off request. ",SHOULD,Server,,false,, +`url`: The format of the file SHOULD reflect that requested in the `_outputFormat` parameter of the initial kick-off request. ",SHOULD,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,177,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: Each file item MAY contain the following fields: -- `count`",MAY,Server,hl7.fhir.uv.bulkdata_2.0.0@178,false,, +- `count`",MAY,Server,hl7.fhir.uv.bulkdata_2.0.0@178,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,178,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: `output`: -`count`: the number of resources in the file, represented as a JSON number. ",SHALL,Server,,false,, +`count`: the number of resources in the file, represented as a JSON number. ",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,179,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`deleted`: optional",MAY,Server,,false,, +`deleted`: optional",MAY,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,180,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`deleted`: type: JSON array",SHALL,Server,,false,, +`deleted`: type: JSON array",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,181,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: An array of deleted file items following the same structure as the `output` array.",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@168-178,false,, +`deleted`: An array of deleted file items following the same structure as the `output` array.",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@168-178,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,182,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: When a _since timestamp is supplied in the export request, this array SHOULD be populated with output files containing FHIR Transaction Bundles that indicate which FHIR resources match the kick-off request criteria, but have been deleted subsequent to the _since date. ",SHOULD,Server,,true,, +`deleted`: When a _since timestamp is supplied in the export request, this array SHOULD be populated with output files containing FHIR Transaction Bundles that indicate which FHIR resources match the kick-off request criteria, but have been deleted subsequent to the _since date. ",SHOULD,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,183,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: If no resources have been deleted, ... the server MAY omit this key or MAY return an empty array. ",MAY,Server,,true,, +`deleted`: If no resources have been deleted, ... the server MAY omit this key or MAY return an empty array. ",MAY,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,184,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: If ... the _since parameter was not supplied, ... the server MAY omit this key or MAY return an empty array. ",MAY,Server,,true,, +`deleted`: If ... the _since parameter was not supplied, ... the server MAY omit this key or MAY return an empty array. ",MAY,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,185,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: If ... the server has other reasons to avoid exposing these data, the server MAY omit this key or MAY return an empty array. ",MAY,Server,,true,, +`deleted`: If ... the server has other reasons to avoid exposing these data, the server MAY omit this key or MAY return an empty array. ",MAY,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,186,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: Resources that appear in the 'deleted' section of an export manifest SHALL NOT appear in the 'output' section of the manifest. ",SHALL,Server,,false,, +`deleted`: Resources that appear in the 'deleted' section of an export manifest SHALL NOT appear in the 'output' section of the manifest. ",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,187,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: Each line in the output file SHALL contain a FHIR Bundle with a type of transaction",SHALL,Server,,false,, +`deleted`: Each line in the output file SHALL contain a FHIR Bundle with a type of transaction",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,188,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: transaction ... SHALL contain one or more entry items that reflect a deleted resource. ",SHALL,Server,,false,, +`deleted`: transaction ... SHALL contain one or more entry items that reflect a deleted resource. ",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,189,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: In each entry, the request.url and request.method elements SHALL be populated. ",SHALL,Server,,false,, +`deleted`: In each entry, the request.url and request.method elements SHALL be populated. ",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,190,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`deleted`: The request.method element SHALL be set to DELETE. ",SHALL,Server,,false,, +`deleted`: The request.method element SHALL be set to DELETE. ",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,191,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`error`: required",SHALL,Server,,false,, +`error`: required",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,192,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`error`: type: Array",SHALL,Server,,false,, +`error`: type: Array",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,193,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`error`: Array of message file items following the same structure as the output array.",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@168-178,false,, +`error`: Array of message file items following the same structure as the output array.",SHALL,Server,hl7.fhir.uv.bulkdata_2.0.0@168-178,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,194,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`error`: Error, warning, and information messages related to the export SHOULD be included here (not in output). ",SHOULD,Server,,false,, +`error`: Error, warning, and information messages related to the export SHOULD be included here (not in output). ",SHOULD,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,195,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`error`: If there are no relevant messages, the server SHOULD return an empty array. ",SHOULD,Server,,true,, +`error`: If there are no relevant messages, the server SHOULD return an empty array. ",SHOULD,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,196,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`error`: Only the FHIR OperationOutcome resource type is currently supported, so the server SHALL generate files in the same format as Bulk Data output files that contain FHIR OperationOutcome resources.",SHALL,Server,,false,, +`error`: Only the FHIR OperationOutcome resource type is currently supported, so the server SHALL generate files in the same format as Bulk Data output files that contain FHIR OperationOutcome resources.",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,197,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: -`error`: If the request contained invalid or unsupported parameters along with a Prefer: handling=lenient header and the server processed the request, the server SHOULD include a FHIR OperationOutcome resource for each of these parameters.",SHOULD,Server,,true,, +`error`: If the request contained invalid or unsupported parameters along with a Prefer: handling=lenient header and the server processed the request, the server SHOULD include a FHIR OperationOutcome resource for each of these parameters.",SHOULD,Server,,true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,198,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`extension`: optional",SHALL,Server,,false,, +`extension`: optional",SHALL,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,199,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status: Required Fields: -`extension`: type: JSON object",SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,200,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,"Using the URLs supplied by the FHIR server in the Complete Status response body, a client MAY download the generated Bulk Data files (one or more per resource type) within the time period specified in the Expires header (if present).",MAY,Client,,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,201,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,"If the requiresAccessToken field in the Complete Status body is set to true, the request SHALL include a valid access token.",SHALL,Client,,true,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,202,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,The exported data SHALL include only the most recent version of any exported resources unless the client explicitly requests different behavior in a fashion supported by the server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,203,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,Inclusion of the Resource.meta information in the resources is at the discretion of the server (as it is for all FHIR interactions).,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,204,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint-2,Endpoint: GET [url from status request output field],SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,205,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers-1,"Headers: Accept (optional, defaults to application/fhir+ndjson)",MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,206,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,Response - Success: HTTP status of 200 OK,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,207,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,Response - Success: `Content-Type` header that matches the file format being delivered. ,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,208,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"Response - Success: For files in ndjson format, [`Content-Type`] SHALL be `application/fhir+ndjson`",SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,209,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"Response - Success: Body of FHIR resources in newline delimited json - ndjson or other requested format - -",SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,210,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error,Response - Error: HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,211,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: If resources in an output file contain elements of the type Attachment, the server SHOULD populate the Attachment.contentType code",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,212,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: If resources in an output file contain elements of the type Attachment, the server SHOULD populate … either the data element or the url element.",SHOULD,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,213,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When populated, the url element SHALL be an absolute url that can be de-referenced to the attachment’s content.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,214,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When the url element is populated with an absolute URL and the requiresAccessToken field in the Complete Status body is set to true, the url location must be accessible by a client with a valid access token, ",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,215,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When the url element is populated with an absolute URL and the requiresAccessToken field in the Complete Status body is set to true, the url location ... SHALL NOT require the use of additional authentication credentials.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,216,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When the url element is populated and the requiresAccessToken field in the Complete Status body is set to false, the url location must be accessible by a client without an access token.",SHALL,Server,,true,, -hl7.fhir.uv.bulkdata_2.0.0,217,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#server-capability-documentation,server providers SHOULD ensure that their Capability Statement accurately reflects the implemented Bulk Data Operations and that their documentation addresses the topics below. [see list from source document],SHOULD,Server,,false,, +`extension`: type: JSON object",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,200,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,"Using the URLs supplied by the FHIR server in the Complete Status response body, a client MAY download the generated Bulk Data files (one or more per resource type) within the time period specified in the Expires header (if present).",MAY,Client,,true,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,201,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,"If the requiresAccessToken field in the Complete Status body is set to true, the request SHALL include a valid access token.",SHALL,Client,,true,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,202,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,The exported data SHALL include only the most recent version of any exported resources unless the client explicitly requests different behavior in a fashion supported by the server,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,203,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-output-file-request,Inclusion of the Resource.meta information in the resources is at the discretion of the server (as it is for all FHIR interactions).,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,204,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint-2,[A Bulk Data server SHALL support Output File Requests at the endpoint] `GET [url from status request output field]`,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,205,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#headers-1,"[To request an Output File, a client MAY use the header] Accept (... defaults to application/fhir+ndjson)",MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,206,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,[A Bulk Data server SHALL respond to a successful Output File Request with] HTTP status of `200 OK`,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,207,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,[A Bulk Data server SHALL respond to a successful Output File Request with] `Content-Type` header that matches the file format being delivered. ,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,208,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"[When Bulk Data server responds to a successful Output File Request,] [f]or files in ndjson format, [`Content-Type`] SHALL be `application/fhir+ndjson`",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,209,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-2,"[A Bulk Data server SHALL respond to a successful Output File Request with] [b]ody of FHIR resources in newline delimited json - ndjson or other requested format + +",SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,210,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error,[A Bulk Data server SHALL respond to an errored Bulk Data Output File Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,211,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: If resources in an output file contain elements of the type Attachment, the server SHOULD populate the Attachment.contentType code",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,212,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: If resources in an output file contain elements of the type Attachment, the server SHOULD populate … either the data element or the url element.",SHOULD,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,213,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When populated, the url element SHALL be an absolute url that can be de-referenced to the attachment’s content.",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,214,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When the url element is populated with an absolute URL and the requiresAccessToken field in the Complete Status body is set to true, the url location must be accessible by a client with a valid access token, ",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,215,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When the url element is populated with an absolute URL and the requiresAccessToken field in the Complete Status body is set to true, the url location ... SHALL NOT require the use of additional authentication credentials.",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,216,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments,"Attachments: When the url element is populated and the requiresAccessToken field in the Complete Status body is set to false, the url location must be accessible by a client without an access token.",SHALL,Server,,true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,217,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#server-capability-documentation,server providers SHOULD ensure that their Capability Statement accurately reflects the implemented Bulk Data Operations and that their documentation addresses the topics below. [see list from source document],SHOULD,Server,,false,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,218,https://hl7.org/fhir/uv/bulkdata/STU2/authorization.html,Bulk Data Providers implementing the Bulk Data Export Operation SHOULD implement OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Profile.,SHOULD,Server,"http://www.hl7.org/fhir/smart-app-launch/backend-services.html -http://www.hl7.org/fhir/smart-app-launch",false,, -hl7.fhir.uv.bulkdata_2.0.0,220,https://hl7.org/fhir/uv/bulkdata/STU2/artifacts.html#behavior-capability-statements,Systems implementing this capability statement should meet the requirements set by the Bulk Data Access Implementation Guide.,SHOULD,Server,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html,false,, -hl7.fhir.uv.bulkdata_2.0.0,221,https://hl7.org/fhir/uv/bulkdata/STU2/artifacts.html#behavior-capability-statements,A FHIR Bulk Data Client has the option of choosing from this list to access necessary data based on use cases and other contextual requirements.,MAY,Client,,false,NA,NA +http://www.hl7.org/fhir/smart-app-launch",false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,220,https://hl7.org/fhir/uv/bulkdata/STU2/artifacts.html#behavior-capability-statements,Systems implementing this capability statement should meet the requirements set by the Bulk Data Access Implementation Guide.,SHOULD,Server,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,221,https://hl7.org/fhir/uv/bulkdata/STU2/artifacts.html#behavior-capability-statements,A FHIR Bulk Data Client has the option of choosing from this list to access necessary data based on use cases and other contextual requirements.,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested hl7.fhir.uv.bulkdata_2.0.0,223,https://hl7.org/fhir/uv/bulkdata/STU2/artifacts.html#behavior-operation-definitions,FHIR Bulk Data System Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,"http://hl7.org/fhir/R4/async.html -https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html",true,, +https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html",true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,224,https://hl7.org/fhir/uv/bulkdata/STU2/artifacts.html#behavior-operation-definitions,FHIR Bulk Data Group Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,"http://hl7.org/fhir/R4/async.html -https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html",true,, +https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html",true,,,,,NA,NA hl7.fhir.uv.bulkdata_2.0.0,225,https://hl7.org/fhir/uv/bulkdata/STU2/artifacts.html#behavior-operation-definitions,FHIR Bulk Data Patient Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,"http://hl7.org/fhir/R4/async.html -https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html",true,, -hl7.fhir.uv.bulkdata_2.0.0,226,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,The FHIR server SHALL limit the data returned to only those FHIR resources for which the client is authorized.,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,227,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern.,SHALL,Server,http://hl7.org/fhir/R4/async.html,false,, -hl7.fhir.uv.bulkdata_2.0.0,228,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,Servers SHALL support GET requests and MAY support POST requests that supply parameters using the FHIR Parameters Resource.,MAY,Server,https://www.hl7.org/fhir/parameters.html,false,, -hl7.fhir.uv.bulkdata_2.0.0,229,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,http://hl7.org/fhir/R4/async.html,false,, -hl7.fhir.uv.bulkdata_2.0.0,230,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,_outputFormat: The server SHALL support Newline Delimited JSON,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,231,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,232,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,234,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: Support is required for a server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,235,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: Support is … optional for a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,237,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,238,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,240,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,241,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,243,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,244,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,246,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,247,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,249,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,Group Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,250,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,Group Level Export: URL: [base]/Group/[id]/$export,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,251,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,252,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,254,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: Support is required for a server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,255,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: Support is … optional for a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,257,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,258,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,260,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,261,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,263,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,264,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,266,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,267,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,269,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,270,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,272,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,Patient Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,273,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,Patient Level Export: URL: [base]/Patient/$export,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,274,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,275,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,277,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: Support is required for a server,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,278,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: Support is … optional for a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,280,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,281,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,283,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,284,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,286,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,287,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,289,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,290,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,292,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false,, -hl7.fhir.uv.bulkdata_2.0.0,293,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,295,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,All exchanges described herein between a client and a server SHALL be secured using Transport Layer Security (TLS) Protocol Version 1.2 (RFC5246) or a more recent version of TLS.,SHALL,Client,,false,NA,NA -hl7.fhir.uv.bulkdata_2.0.0,296,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Use of mutual TLS is OPTIONAL.,MAY,Client,,false,NA,NA +https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html",true,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,226,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,The FHIR server SHALL limit the data returned to only those FHIR resources for which the client is authorized.,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,227,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern.,SHALL,Server,http://hl7.org/fhir/R4/async.html,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,228,https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html#bulkdataigcapabilitystatement,Servers SHALL support GET requests and MAY support POST requests that supply parameters using the FHIR Parameters Resource.,MAY,Server,https://www.hl7.org/fhir/parameters.html,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,229,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,http://hl7.org/fhir/R4/async.html,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,231,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false,"","",2.4.4.01,bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_parameters_group-output_format_in_system_export_response,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,232,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,234,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: Support is required for a server,SHALL,Server,,false,"","",2.4.4.02,bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_parameters_group-since_in_system_export_response,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,235,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_since`: Support is … optional for a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,237,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,238,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_type`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,240,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,241,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_elements`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,243,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,244,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,246,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,247,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html#bulkdataexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,249,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,Group Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,250,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,Group Level Export: URL: [base]/Group/[id]/$export,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,251,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false,"","",2.2.4.01,bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_parameters_group-output_format_in_group_export_response,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,252,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,254,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: Support is required for a server,SHALL,Server,,false,"","",2.2.4.02,bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_parameters_group-since_in_group_export_response,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,255,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_since`: Support is … optional for a client,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,257,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,258,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_type`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,260,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,261,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_elements`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,263,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,264,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`patient`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,266,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,267,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,269,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,270,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html#grouplevelexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,Not Tested,Not Tested +hl7.fhir.uv.bulkdata_2.0.0,272,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,Patient Level Export: The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,273,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,Patient Level Export: URL: [base]/Patient/$export,SHALL,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,274,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,,false,"","",2.3.4.01,bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_parameters_group-output_format_in_patient_export_response,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,275,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: Support is … optional for a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,277,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: Support is required for a server,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,278,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_since`: Support is … optional for a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,280,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,281,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_type`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,283,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,284,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_elements`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,286,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,287,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`patient`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,289,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,290,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`includeAssociatedData`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,292,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: Support is optional for a server ,MAY,Server,,false,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,293,https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html#patientlevelexport,`_typeFilter`: Support is optional for … a client,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,295,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,All exchanges described herein between a client and a server SHALL be secured using Transport Layer Security (TLS) Protocol Version 1.2 (RFC5246) or a more recent version of TLS.,SHALL,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,296,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#privacy-and-security-considerations,Use of mutual TLS is OPTIONAL.,MAY,Client,,false,NA,NA,NA,NA,, +hl7.fhir.uv.bulkdata_2.0.0,297,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---all-patients,"[If the server supports Bulk Data Patient Export, the endpoint SHALL be] `[fhir base]/Patient/$export`",SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,298,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---group-of-patients,"[If the server supports Bulk Data Group Export, the endpoint SHALL be] `[fhir base]/Group/[id]/$export`",SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,299,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint---system-level-export,"[If the server supports Bulk Data System Level Export, the endpoint SHALL be] `[fhir base]/$export`",SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,300,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success,[A Bulk Data server SHALL respond to a successful Bulk Data Kickoff Request with] HTTP Status Code of `202 Accepted`,SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,301,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success,[A Bulk Data server SHALL respond to a successful Bulk Data Kickoff Request with] `Content-Location` header with the absolute URL of an endpoint for subsequent status requests (polling location),SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,302,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success,[A Bulk Data server MAY respond to a successful Bulk Data Kickoff Request with] a FHIR `OperationOutcome` resource in the body in JSON format,MAY,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,303,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-eg-unsupported-search-parameter,[A Bulk Data server SHALL respond to an errored Bulk Data Kickoff Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,304,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-eg-unsupported-search-parameter,"[When a Bulk Data server responds to an errored Bulk Data Kickoff Request,] [t]he body SHALL be a FHIR OperationOutcome resource in JSON format",SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,305,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint,[A Bulk Data server SHALL support Delete Requests at the endpoint] `DELETE [polling content location]`,SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,306,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-1,[A Bulk Data server SHALL respond to a successful Delete Request with] HTTP Status Code of `202 Accepted`,SHALL,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,307,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---success-1,[A Bulk Data server MAY respond to a successful Delete Request with] a FHIR `OperationOutcome` resource in the body in JSON format,MAY,Server,,,,,,,NA,NA +hl7.fhir.uv.bulkdata_2.0.0,308,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status,[A Bulk Data server SHALL respond to an errored Bulk Data Delete Request with] HTTP Status Code of `4XX` or `5XX`,SHALL,Server,,,"","","2.2.3.02, 2.3.3.02, 2.4.3.02","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_cancel_group_stu2-bulk_data_group_export_cancel_stu2, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_cancel_group_stu2-bulk_data_patient_export_cancel_stu2, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_cancel_group_stu2-bulk_data_system_export_cancel_stu2",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,309,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---error-status,"[When a Bulk Data server responds to an errored Bulk Data Delete Request,] [t]he body SHALL be a FHIR OperationOutcome resource in JSON format",SHALL,Server,,,"","","2.2.3.02, 2.3.3.02, 2.4.3.02","bulk_data_v200-bulk_data_export_tests_v200-bulk_data_group_export_v200-bulk_data_group_export_cancel_group_stu2-bulk_data_group_export_cancel_stu2, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_patient_export_v200-bulk_data_patient_export_cancel_group_stu2-bulk_data_patient_export_cancel_stu2, bulk_data_v200-bulk_data_export_tests_v200-bulk_data_system_export_v200-bulk_data_system_export_cancel_group_stu2-bulk_data_system_export_cancel_stu2",NA,NA +hl7.fhir.uv.bulkdata_2.0.0,310,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#endpoint-1,[A Bulk Data server SHALL support Status Requests at the endpoint] `GET [polling content location]`,SHALL,Server,,,,,,,NA,NA diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_cancel_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_cancel_test.rb index e6b8cf8..19fec56 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_cancel_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_cancel_test.rb @@ -15,7 +15,10 @@ class BulkDataExportCancelTest < Inferno::Test After a bulk data request has been started, a client MAY send a delete request to the URL provided in the Content-Location header to cancel the request. Bulk Data Server MUST support client's delete request and return HTTP Status Code of "202 Accepted" DESCRIPTION - # link 'http://hl7.org/fhir/uv/bulkdata/STU1.0.1/export/index.html#bulk-data-delete-request' + # link 'http://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#bulk-data-delete-request' + + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@305', + 'hl7.fhir.uv.bulkdata_1.0.0@306' input :smart_auth_info, type: :auth_info, diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_kick_off_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_kick_off_test.rb index a0c2b5d..20b0a67 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_kick_off_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_kick_off_test.rb @@ -19,6 +19,10 @@ class BulkDataKickOffTest < Inferno::Test DESCRIPTION # link 'http://hl7.org/fhir/uv/bulkdata/STU1.0.1/export/index.html#response---success' + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@28', + 'hl7.fhir.uv.bulkdata_1.0.0@300', + 'hl7.fhir.uv.bulkdata_1.0.0@301' + input :smart_auth_info, type: :auth_info, options: { mode: 'access' }, diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_operation_support_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_operation_support_test.rb index 08353d1..e5a537c 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_operation_support_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_operation_support_test.rb @@ -19,7 +19,7 @@ class BulkDataExportOperationSupportTest < Inferno::Test declares the standard bulk data export OperationDefinition provided in the Bulk Data specification, nor does it attempt to resolve any non-standard OperationDefinitions to verify if it is a constrained version of the - standard OperationDefintion. + standard OperationDefinition. This test will provide a warning if no operations are declared via the `CapabilityStatement.rest.resource.operation.name` element. It will diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_ndjson_download_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_ndjson_download_test.rb index 338805f..bcdee27 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_ndjson_download_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_ndjson_download_test.rb @@ -21,6 +21,8 @@ class BulkDataNDJSONDownloadTest < Inferno::Test DESCRIPTION # link 'http://hl7.org/fhir/uv/bulkdata/STU1.0.1/export/index.html#file-request' + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@201' + input :bulk_download_url input :requires_access_token input :smart_auth_info, diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_no_auth_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_no_auth_test.rb index 19453a2..fc45fd5 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_no_auth_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_no_auth_test.rb @@ -20,6 +20,8 @@ class BulkDataExportNoAuthRejectTest < Inferno::Test DESCRIPTION # link 'http://hl7.org/fhir/uv/bulkdata/STU1.0.1/export/index.html#bulk-data-kick-off-request' + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@27' + input :smart_auth_info, type: :auth_info, options: { mode: 'access' }, diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_output_check_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_output_check_test.rb index b417507..34b4c8e 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_output_check_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_output_check_test.rb @@ -24,6 +24,14 @@ class BulkDataOutputCheckTest < Inferno::Test DESCRIPTION # link 'http://hl7.org/fhir/uv/bulkdata/STU1.0.1/export/index.html#response---complete-status' + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@164', + 'hl7.fhir.uv.bulkdata_1.0.0@165', + 'hl7.fhir.uv.bulkdata_1.0.0@166', + 'hl7.fhir.uv.bulkdata_1.0.0@168', + 'hl7.fhir.uv.bulkdata_1.0.0@169', + 'hl7.fhir.uv.bulkdata_1.0.0@170', + 'hl7.fhir.uv.bulkdata_1.0.0@175' + input :status_response output :status_output, :bulk_download_url diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_status_check_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_status_check_test.rb index e924740..c6858f5 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_status_check_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_status_check_test.rb @@ -22,6 +22,23 @@ class BulkDataStatusCheckTest < Inferno::Test DESCRIPTION # link 'http://hl7.org/fhir/uv/bulkdata/STU1.0.1/export/index.html#bulk-data-status-request' + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@132', + 'hl7.fhir.uv.bulkdata_1.0.0@144', + 'hl7.fhir.uv.bulkdata_1.0.0@145', + 'hl7.fhir.uv.bulkdata_1.0.0@147', + 'hl7.fhir.uv.bulkdata_1.0.0@150', + 'hl7.fhir.uv.bulkdata_1.0.0@151', + 'hl7.fhir.uv.bulkdata_1.0.0@152', + 'hl7.fhir.uv.bulkdata_1.0.0@155', + 'hl7.fhir.uv.bulkdata_1.0.0@156', + 'hl7.fhir.uv.bulkdata_1.0.0@157', + 'hl7.fhir.uv.bulkdata_1.0.0@159', + 'hl7.fhir.uv.bulkdata_1.0.0@160', + 'hl7.fhir.uv.bulkdata_1.0.0@161', + 'hl7.fhir.uv.bulkdata_1.0.0@191', + 'hl7.fhir.uv.bulkdata_1.0.0@192', + 'hl7.fhir.uv.bulkdata_1.0.0@193' + input :polling_url, :bulk_timeout input :smart_auth_info, type: :auth_info, diff --git a/lib/bulk_data_test_kit/v1.0.1/bulk_data_valid_resources_test.rb b/lib/bulk_data_test_kit/v1.0.1/bulk_data_valid_resources_test.rb index 6b62d49..5d6e23b 100644 --- a/lib/bulk_data_test_kit/v1.0.1/bulk_data_valid_resources_test.rb +++ b/lib/bulk_data_test_kit/v1.0.1/bulk_data_valid_resources_test.rb @@ -18,6 +18,10 @@ class BulkDataValidResourcesTest < Inferno::Test number of error messages it will display to 20. DESCRIPTION + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@207', + 'hl7.fhir.uv.bulkdata_1.0.0@208', + 'hl7.fhir.uv.bulkdata_1.0.0@209' + input :smart_auth_info, type: :auth_info input :status_output input :requires_access_token diff --git a/lib/bulk_data_test_kit/v1.0.1/group/bulk_data_group_export_group.rb b/lib/bulk_data_test_kit/v1.0.1/group/bulk_data_group_export_group.rb index f9bf68a..229728b 100644 --- a/lib/bulk_data_test_kit/v1.0.1/group/bulk_data_group_export_group.rb +++ b/lib/bulk_data_test_kit/v1.0.1/group/bulk_data_group_export_group.rb @@ -17,6 +17,10 @@ class BulkDataGroupExportGroup < Inferno::TestGroup description <<~DESCRIPTION Verify that group level export on the Bulk Data server follow the Bulk Data Access Implementation Guide DESCRIPTION + + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@224', + 'hl7.fhir.uv.bulkdata_1.0.0@249' + id :bulk_data_group_export_group input :smart_auth_info, @@ -54,7 +58,7 @@ class BulkDataGroupExportGroup < Inferno::TestGroup declares the standard Group export OperationDefinition provided in the Bulk Data specification, nor does it attempt to resolve any non-standard OperationDefinitions to verify if it is a constrained version of the - standard OperationDefintion. + standard OperationDefinition. This test will provide a warning if no operations are declared at `Group/[group_id]/$export`, via the diff --git a/lib/bulk_data_test_kit/v1.0.1/patient/bulk_data_patient_export_group.rb b/lib/bulk_data_test_kit/v1.0.1/patient/bulk_data_patient_export_group.rb index f83ec88..c6aaa74 100644 --- a/lib/bulk_data_test_kit/v1.0.1/patient/bulk_data_patient_export_group.rb +++ b/lib/bulk_data_test_kit/v1.0.1/patient/bulk_data_patient_export_group.rb @@ -15,6 +15,9 @@ class BulkDataPatientExportGroup < Inferno::TestGroup description <<~DESCRIPTION Verify that patient level export on the Bulk Data server follow the Bulk Data Access Implementation Guide DESCRIPTION + + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@272' + id :bulk_data_patient_export_group input :smart_auth_info, diff --git a/lib/bulk_data_test_kit/v1.0.1/system_export/bulk_data_system_export_group.rb b/lib/bulk_data_test_kit/v1.0.1/system_export/bulk_data_system_export_group.rb index 91e6f1c..19796ce 100644 --- a/lib/bulk_data_test_kit/v1.0.1/system_export/bulk_data_system_export_group.rb +++ b/lib/bulk_data_test_kit/v1.0.1/system_export/bulk_data_system_export_group.rb @@ -15,6 +15,9 @@ class BulkDataSystemExportGroup < Inferno::TestGroup description <<~DESCRIPTION Verify that system level export on the Bulk Data server follow the Bulk Data Access Implementation Guide DESCRIPTION + + verifies_requirements 'hl7.fhir.uv.bulkdata_1.0.0@229' + id :bulk_data_system_export_group input :smart_auth_info, diff --git a/lib/bulk_data_test_kit/v2.0.0/bulk_data_export_cancel_test.rb b/lib/bulk_data_test_kit/v2.0.0/bulk_data_export_cancel_test.rb index 6e4b0b7..b8fe165 100644 --- a/lib/bulk_data_test_kit/v2.0.0/bulk_data_export_cancel_test.rb +++ b/lib/bulk_data_test_kit/v2.0.0/bulk_data_export_cancel_test.rb @@ -16,6 +16,10 @@ class BulkDataExportCancelTest < Inferno::Test http://hl7.org/fhir/uv/bulkdata/STU2/export.html#bulk-data-delete-request DESCRIPTION + verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@122', + 'hl7.fhir.uv.bulkdata_2.0.0@308', + 'hl7.fhir.uv.bulkdata_2.0.0@309' + id :bulk_data_export_cancel_stu2 input :cancelled_polling_url diff --git a/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_outputFormat_param_test.rb b/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_outputFormat_param_test.rb index 42f0f31..cbbea1b 100644 --- a/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_outputFormat_param_test.rb +++ b/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_outputFormat_param_test.rb @@ -6,6 +6,12 @@ module BulkDataTestKit module BulkDataV200 class BulkDataGroupOutputFormatParamTest < BulkDataV200::BulkDataOutputFormatParamTest id :output_format_in_group_export_response + verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@47', + 'hl7.fhir.uv.bulkdata_2.0.0@49', + 'hl7.fhir.uv.bulkdata_2.0.0@51', + 'hl7.fhir.uv.bulkdata_2.0.0@52', + 'hl7.fhir.uv.bulkdata_2.0.0@251' + input :group_id config( diff --git a/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_since_param_test.rb b/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_since_param_test.rb index 10d0b01..bd132ca 100644 --- a/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_since_param_test.rb +++ b/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_since_param_test.rb @@ -6,6 +6,9 @@ module BulkDataTestKit module BulkDataV200 class BulkDataGroupSinceParamTest < BulkDataV200::BulkDataSinceParamTest id :since_in_group_export_response + + verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@53','hl7.fhir.uv.bulkdata_2.0.0@254' + input :group_id config( diff --git a/lib/bulk_data_test_kit/v2.0.0/bulk_data_since_param_test.rb b/lib/bulk_data_test_kit/v2.0.0/bulk_data_since_param_test.rb index b711065..feaf47a 100644 --- a/lib/bulk_data_test_kit/v2.0.0/bulk_data_since_param_test.rb +++ b/lib/bulk_data_test_kit/v2.0.0/bulk_data_since_param_test.rb @@ -15,7 +15,7 @@ class BulkDataSinceParamTest < Inferno::Test This test verifies that the server accepts an export request with the `[_since](http://hl7.org/fhir/uv/bulkdata/STU2/export.html#query-parameters)` query parameter. It initiates a new export using a _since parameter of - one week ago, and ensures that the export was initiated succesfully. + one week ago, and ensures that the export was initiated successfully. The test does not attempt to verify that resources returned were modified after the _since date that was requested, because the Bulk Data @@ -27,6 +27,8 @@ class BulkDataSinceParamTest < Inferno::Test After the export was successfully initiated, it is then cancelled. DESCRIPTION + verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@53' + input :smart_auth_info, type: :auth_info, options: { mode: 'access' }, diff --git a/lib/bulk_data_test_kit/v2.0.0/bulk_data_smart_backend_services_v200_group.rb b/lib/bulk_data_test_kit/v2.0.0/bulk_data_smart_backend_services_v200_group.rb index c5d32b6..5684445 100644 --- a/lib/bulk_data_test_kit/v2.0.0/bulk_data_smart_backend_services_v200_group.rb +++ b/lib/bulk_data_test_kit/v2.0.0/bulk_data_smart_backend_services_v200_group.rb @@ -25,6 +25,7 @@ class BulkDataSmartBackendServicesV200Group < Inferno::TestGroup } group from: :backend_services_authorization, + verifies_requirements: ['hl7.fhir.uv.bulkdata_2.0.0@2', 'hl7.fhir.uv.bulkdata_2.0.0@19'], config: { inputs: { url: { name: :bulk_server_url }, diff --git a/lib/bulk_data_test_kit/v2.0.0/patient/bulk_data_patient_export_parameters_group.rb b/lib/bulk_data_test_kit/v2.0.0/patient/bulk_data_patient_export_parameters_group.rb index 5b79704..14eb8ac 100644 --- a/lib/bulk_data_test_kit/v2.0.0/patient/bulk_data_patient_export_parameters_group.rb +++ b/lib/bulk_data_test_kit/v2.0.0/patient/bulk_data_patient_export_parameters_group.rb @@ -24,7 +24,8 @@ class BulkDataPatientExportParameters < Inferno::TestGroup id: :output_format_in_patient_export_response, config: { options: { resource_type: 'Patient', bulk_export_url: 'Patient/$export' } - } + }, + verifies_requirements: ['hl7.fhir.uv.bulkdata_2.0.0@47','hl7.fhir.uv.bulkdata_2.0.0@49','hl7.fhir.uv.bulkdata_2.0.0@51','hl7.fhir.uv.bulkdata_2.0.0@52','hl7.fhir.uv.bulkdata_2.0.0@274'] test from: :since_in_export_response, id: :since_in_patient_export_response, diff --git a/lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_parameters_group.rb b/lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_parameters_group.rb index 280e360..4533e4a 100644 --- a/lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_parameters_group.rb +++ b/lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_parameters_group.rb @@ -24,13 +24,15 @@ class BulkDataSystemExportParameters < Inferno::TestGroup id: :output_format_in_system_export_response, config: { options: { resource_type: 'system', bulk_export_url: '$export' } - } + }, + verifies_requirements: ['hl7.fhir.uv.bulkdata_2.0.0@47','hl7.fhir.uv.bulkdata_2.0.0@49','hl7.fhir.uv.bulkdata_2.0.0@51','hl7.fhir.uv.bulkdata_2.0.0@52','hl7.fhir.uv.bulkdata_2.0.0@231'] test from: :since_in_export_response, id: :since_in_system_export_response, config: { options: { resource_type: 'system', bulk_export_url: '$export' } - } + }, + verifies_requirements: ['hl7.fhir.uv.bulkdata_2.0.0@53','hl7.fhir.uv.bulkdata_2.0.0@234'] end end end diff --git a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_auth_verification_group.rb b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_auth_verification_group.rb index 6549051..cdeac3f 100644 --- a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_auth_verification_group.rb +++ b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_auth_verification_group.rb @@ -8,7 +8,8 @@ class BulkClientDataAuthVerification < Inferno::TestGroup title 'Review Authentication Interactions' run_as_group - test from: :bulk_data_client_token_smart_bsca_verification + test from: :bulk_data_client_token_smart_bsca_verification, + verifies_requirements: ['hl7.fhir.uv.bulkdata_2.0.0@15', 'hl7.fhir.uv.bulkdata_2.0.0@16'] test from: :smart_client_token_use_verification, config: { options: { access_request_tags: [KICKOFF_TAG, STATUS_TAG, OUTPUT_TAG, DELETE_TAG] } diff --git a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_test.rb b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_test.rb index 82fd19c..457c557 100644 --- a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_test.rb +++ b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_test.rb @@ -14,8 +14,6 @@ class DeleteTest < Inferno::Test id :bulk_data_client_delete - verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@119' - run do assert load_tagged_requests(DELETE_TAG).any?, fail_message end diff --git a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_output_test.rb b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_output_test.rb index d54add3..aa0ccfd 100644 --- a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_output_test.rb +++ b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_output_test.rb @@ -13,8 +13,6 @@ class OutputTest < Inferno::Test id :bulk_data_client_output - verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@200' - run do assert load_tagged_requests(OUTPUT_TAG).any?, fail_message end diff --git a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_status_test.rb b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_status_test.rb index 36e8894..fb42067 100644 --- a/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_status_test.rb +++ b/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_status_test.rb @@ -14,8 +14,6 @@ class StatusTest < Inferno::Test id :bulk_data_client_status - verifies_requirements 'hl7.fhir.uv.bulkdata_2.0.0@123' - run do assert load_tagged_requests(STATUS_TAG).any?, fail_message end diff --git a/lib/requirements_config.yaml b/lib/requirements_config.yaml index ba747aa..49d5bad 100644 --- a/lib/requirements_config.yaml +++ b/lib/requirements_config.yaml @@ -1,12 +1,15 @@ test_kit_id: bulk-data-test-kit suites: -# - id: bulk_data_v101 -# class_name: BulkDataTestKit::BulkDataV101::BulkDataTestSuite -# suite_actor: Server + - id: bulk_data_v101 + class_name: BulkDataTestKit::BulkDataV101::BulkDataTestSuite + suite_actor: Server - id: bulk_data_v200 class_name: BulkDataTestKit::BulkDataV200::BulkDataTestSuite suite_actor: Server + - id: bulk_data_v200_client + class_name: BulkDataTestKit::BulkDataV200Client::BulkDataClientTestSuite + suite_actor: Client requirement_sets: - id: hl7.fhir.uv.bulkdata_2.0.0