bulk_data_test_kit 0.12.2 → 0.12.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/bulk_data_test_kit/requirements/bulk_data_test_kit_requirements.csv +959 -0
- data/lib/bulk_data_test_kit/requirements/generated/bulk_data_v101_requirements_coverage.csv +342 -0
- data/lib/bulk_data_test_kit/requirements/generated/bulk_data_v200_client_requirements_coverage.csv +113 -0
- data/lib/bulk_data_test_kit/requirements/generated/bulk_data_v200_requirements_coverage.csv +473 -0
- data/lib/bulk_data_test_kit/requirements/hl7.fhir.uv.bulkdata_1.0.0_reqs.xlsx +0 -0
- data/lib/bulk_data_test_kit/requirements/hl7.fhir.uv.bulkdata_2.0.0_reqs.xlsx +0 -0
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_cancel_test.rb +3 -0
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_kick_off_test.rb +4 -0
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_export_operation_support_test.rb +1 -1
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_no_auth_test.rb +2 -0
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_output_check_test.rb +8 -0
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_status_check_test.rb +17 -0
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_test_suite.rb +16 -0
- data/lib/bulk_data_test_kit/v1.0.1/bulk_data_valid_resources_test.rb +4 -0
- data/lib/bulk_data_test_kit/v1.0.1/group/bulk_data_group_export_group.rb +4 -1
- data/lib/bulk_data_test_kit/v1.0.1/patient/bulk_data_patient_export_group.rb +3 -0
- data/lib/bulk_data_test_kit/v1.0.1/system_export/bulk_data_system_export_group.rb +3 -0
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_export_cancel_test.rb +4 -0
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_export_test_group.rb +48 -2
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_outputFormat_param_test.rb +6 -0
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_group_since_param_test.rb +3 -0
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_patient_export_test_group.rb +48 -2
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_since_param_test.rb +3 -1
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_smart_backend_services_v200_group.rb +1 -0
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_system_export_test_group.rb +46 -2
- data/lib/bulk_data_test_kit/v2.0.0/bulk_data_test_suite.rb +16 -0
- data/lib/bulk_data_test_kit/v2.0.0/group/bulk_data_group_export_cancel_group.rb +4 -0
- data/lib/bulk_data_test_kit/v2.0.0/patient/bulk_data_patient_export_cancel_group.rb +4 -0
- data/lib/bulk_data_test_kit/v2.0.0/patient/bulk_data_patient_export_parameters_group.rb +2 -1
- data/lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_cancel_group.rb +4 -0
- data/lib/bulk_data_test_kit/v2.0.0/system_export/bulk_data_system_export_parameters_group.rb +4 -2
- data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_auth_verification_group.rb +2 -1
- data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_delete_test.rb +0 -2
- data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_output_test.rb +0 -2
- data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_status_test.rb +0 -2
- data/lib/bulk_data_test_kit/v2.0.0_client/bulk_data_client_test_suite.rb +15 -0
- data/lib/bulk_data_test_kit/version.rb +2 -2
- data/lib/bulk_data_test_kit.rb +0 -1
- metadata +25 -15
- data/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_out_of_scope_requirements.csv +0 -1
- data/lib/bulk_data_test_kit/requirements/bulk-data-test-kit_requirements.csv +0 -465
- data/lib/bulk_data_test_kit/requirements/generated/bulk-data-test-kit_requirements_coverage.csv +0 -442
- data/lib/inferno_requirements_tools/ext/inferno_core/runnable.rb +0 -22
- data/lib/inferno_requirements_tools/rake/rakefile_template +0 -37
- data/lib/inferno_requirements_tools/tasks/collect_requirements.rb +0 -233
- data/lib/inferno_requirements_tools/tasks/requirements_coverage.rb +0 -283
- data/lib/requirements_config.yaml +0 -14
- data/lib/template_requirements_config.yaml +0 -11
|
@@ -0,0 +1,342 @@
|
|
|
1
|
+
Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,Bulk Data Access v1.0.1 Server Short ID(s),Bulk Data Access v1.0.1 Server Full ID(s)
|
|
2
|
+
hl7.fhir.uv.bulkdata_1.0.0,2,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
3
|
+
hl7.fhir.uv.bulkdata_1.0.0,3,https://hl7.org/fhir/uv/bulkdata/stu1/export/#security-considerations,Use of mutual TLS is OPTIONAL.,MAY,Server,false,,,"",""
|
|
4
|
+
hl7.fhir.uv.bulkdata_1.0.0,4,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,false,,,"",""
|
|
5
|
+
hl7.fhir.uv.bulkdata_1.0.0,7,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
6
|
+
hl7.fhir.uv.bulkdata_1.0.0,8,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
7
|
+
hl7.fhir.uv.bulkdata_1.0.0,11,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
8
|
+
hl7.fhir.uv.bulkdata_1.0.0,27,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.1.02, 2.3.1.02, 2.4.1.02","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_no_auth_reject, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_no_auth_reject, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_no_auth_reject"
|
|
9
|
+
hl7.fhir.uv.bulkdata_1.0.0,28,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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 [[definition](http://hl7.org/fhir/R4/async.html].,SHALL,Server,false,,,"2.2.1.03, 2.3.1.03, 2.4.1.03","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_kick_off, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_kick_off, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_kick_off"
|
|
10
|
+
hl7.fhir.uv.bulkdata_1.0.0,33,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
11
|
+
hl7.fhir.uv.bulkdata_1.0.0,34,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
12
|
+
hl7.fhir.uv.bulkdata_1.0.0,37,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
13
|
+
hl7.fhir.uv.bulkdata_1.0.0,38,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
14
|
+
hl7.fhir.uv.bulkdata_1.0.0,42,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
15
|
+
hl7.fhir.uv.bulkdata_1.0.0,47,https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters,`_outputFormat`: Optionality for Server: optional,MAY,Server,false,,,"",""
|
|
16
|
+
hl7.fhir.uv.bulkdata_1.0.0,49,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport",`_outputFormat `: The server SHALL support [Newline Delimited JSON](http://ndjson.org),SHALL,Server,false,,,"",""
|
|
17
|
+
hl7.fhir.uv.bulkdata_1.0.0,50,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport",`_outputFormat `: The server … MAY choose to support additional output formats,MAY,Server,false,,,"",""
|
|
18
|
+
hl7.fhir.uv.bulkdata_1.0.0,51,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport",`_outputFormat `: The server SHALL accept the full content type of `application/fhir+ndjson`,SHALL,Server,false,,,"",""
|
|
19
|
+
hl7.fhir.uv.bulkdata_1.0.0,52,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport",`_outputFormat `: The server SHALL accept ... the abbreviated representations `application/ndjson` and `ndjson`.,SHALL,Server,false,,,"",""
|
|
20
|
+
hl7.fhir.uv.bulkdata_1.0.0,53,https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters,`_since`: Optionality for Server: optional,MAY,Server,false,,,"",""
|
|
21
|
+
hl7.fhir.uv.bulkdata_1.0.0,59,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#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,,,"",""
|
|
22
|
+
hl7.fhir.uv.bulkdata_1.0.0,60,https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters,`_type`: Optionality for Server: optional,MAY,Server,false,,,"",""
|
|
23
|
+
hl7.fhir.uv.bulkdata_1.0.0,62,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport",`_type`: The response SHALL be filtered to only include resources of the specified resource types(s).,SHALL,Server,true,,,"",""
|
|
24
|
+
hl7.fhir.uv.bulkdata_1.0.0,63,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport","`_type`: If this parameter is omitted, the server SHALL return all supported resources within the scope of the client authorization",SHALL,Server,true,,,"",""
|
|
25
|
+
hl7.fhir.uv.bulkdata_1.0.0,65,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport","`_type`: For … Group-level requests, the [Patient Compartment](https://www.hl7.org/fhir/compartmentdefinition-patient.html) SHOULD be used as a point of reference for recommended resources to be returned.",SHOULD,Server,true,,,"",""
|
|
26
|
+
hl7.fhir.uv.bulkdata_1.0.0,66,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport","`_type`: For Patient- ...level requests, the [Patient Compartment](https://www.hl7.org/fhir/compartmentdefinition-patient.html) SHOULD be used as a point of reference for recommended resources to be returned.",SHOULD,Server,true,,,"",""
|
|
27
|
+
hl7.fhir.uv.bulkdata_1.0.0,67,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport",`_type`: other resources outside of the [Patient Compartment](https://www.hl7.org/fhir/compartmentdefinition-patient.html) 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,,,"",""
|
|
28
|
+
hl7.fhir.uv.bulkdata_1.0.0,69,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport",`_type`:A server that is unable to support `_type` SHOULD return an error and FHIR `OperationOutcome ` resource,SHOULD,Server,true,,,"",""
|
|
29
|
+
hl7.fhir.uv.bulkdata_1.0.0,107,"https://hl7.org/fhir/uv/bulkdata/stu1/export/#query-parameters, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export/#bulkdataexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export/#grouplevelexport, https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export/#patientlevelexport","Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the [Argonaut Implementation Guide](http://www.fhir.org/guides/argonaut/r2/) [or the [US Core Implementation Guide](http://www.hl7.org/fhir/us/core/)]",MAY,Server,false,,,"",""
|
|
30
|
+
hl7.fhir.uv.bulkdata_1.0.0,118,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
31
|
+
hl7.fhir.uv.bulkdata_1.0.0,125,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
32
|
+
hl7.fhir.uv.bulkdata_1.0.0,127,https://hl7.org/fhir/uv/bulkdata/stu1/export/#bulk-data-status-request,The server SHOULD keep an accounting of status queries received from a given client,SHOULD,Server,true,,,"",""
|
|
33
|
+
hl7.fhir.uv.bulkdata_1.0.0,128,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
34
|
+
hl7.fhir.uv.bulkdata_1.0.0,129,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
35
|
+
hl7.fhir.uv.bulkdata_1.0.0,131,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
36
|
+
hl7.fhir.uv.bulkdata_1.0.0,132,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
37
|
+
hl7.fhir.uv.bulkdata_1.0.0,133,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
38
|
+
hl7.fhir.uv.bulkdata_1.0.0,134,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
39
|
+
hl7.fhir.uv.bulkdata_1.0.0,136,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
40
|
+
hl7.fhir.uv.bulkdata_1.0.0,137,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
41
|
+
hl7.fhir.uv.bulkdata_1.0.0,138,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---error-status-1,"[When a Bulk Data server responds to an errored Bulk Data Delete Request,] the server SHALL return a FHIR OperationOutcome resource in JSON format.",SHALL,Server,false,,,"",""
|
|
42
|
+
hl7.fhir.uv.bulkdata_1.0.0,141,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
43
|
+
hl7.fhir.uv.bulkdata_1.0.0,142,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
44
|
+
hl7.fhir.uv.bulkdata_1.0.0,143,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
45
|
+
hl7.fhir.uv.bulkdata_1.0.0,144,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
46
|
+
hl7.fhir.uv.bulkdata_1.0.0,145,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
47
|
+
hl7.fhir.uv.bulkdata_1.0.0,146,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"[When a Bulk Data server responds to a successful Status Request that has completed, it] MAY return an Expires header indicating when the files listed will no longer be available for access.",MAY,Server,false,,,"",""
|
|
48
|
+
hl7.fhir.uv.bulkdata_1.0.0,147,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
49
|
+
hl7.fhir.uv.bulkdata_1.0.0,148,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
50
|
+
hl7.fhir.uv.bulkdata_1.0.0,149,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"[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,,,"",""
|
|
51
|
+
hl7.fhir.uv.bulkdata_1.0.0,150,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
52
|
+
|
|
53
|
+
`transactionTime`: required",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
54
|
+
hl7.fhir.uv.bulkdata_1.0.0,151,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
55
|
+
|
|
56
|
+
`transactionTime`: type: FHIR instant",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
57
|
+
hl7.fhir.uv.bulkdata_1.0.0,152,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
58
|
+
|
|
59
|
+
`transactionTime`: Indicates the server's time when the query is run.",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
60
|
+
hl7.fhir.uv.bulkdata_1.0.0,153,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
61
|
+
|
|
62
|
+
`transactionTime`: The response SHOULD NOT include any resources modified after this instant",SHOULD,Server,false,,,"",""
|
|
63
|
+
hl7.fhir.uv.bulkdata_1.0.0,154,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
64
|
+
|
|
65
|
+
`transactionTime`: The response … SHALL include any matching resources modified up to and including this instant.",SHALL,Server,false,,,"",""
|
|
66
|
+
hl7.fhir.uv.bulkdata_1.0.0,155,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
67
|
+
|
|
68
|
+
Required Fields:
|
|
69
|
+
|
|
70
|
+
`request`: required",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
71
|
+
hl7.fhir.uv.bulkdata_1.0.0,156,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
72
|
+
|
|
73
|
+
Required Fields:
|
|
74
|
+
|
|
75
|
+
`request`: type: String",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
76
|
+
hl7.fhir.uv.bulkdata_1.0.0,157,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"""Response - Complete Status:
|
|
77
|
+
|
|
78
|
+
`request`: The full URL of the original Bulk Data kick-off request.",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
79
|
+
hl7.fhir.uv.bulkdata_1.0.0,159,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
80
|
+
|
|
81
|
+
Required Fields:
|
|
82
|
+
|
|
83
|
+
`requiresAccessToken`: required",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
84
|
+
hl7.fhir.uv.bulkdata_1.0.0,160,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
85
|
+
|
|
86
|
+
Required Fields:
|
|
87
|
+
|
|
88
|
+
`requiresAccessToken`: type: Boolean",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
89
|
+
hl7.fhir.uv.bulkdata_1.0.0,161,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
90
|
+
|
|
91
|
+
`requiresAccessToken`: Indicates whether downloading the generated files requires the same authorization mechanism as the $export operation itself.",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
92
|
+
hl7.fhir.uv.bulkdata_1.0.0,162,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
93
|
+
|
|
94
|
+
`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,,,"",""
|
|
95
|
+
hl7.fhir.uv.bulkdata_1.0.0,163,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
96
|
+
|
|
97
|
+
`requiresAccessToken`: Value MAY be false for file servers that use access-control schemes other than OAuth 2.0",MAY,Server,false,,,"",""
|
|
98
|
+
hl7.fhir.uv.bulkdata_1.0.0,164,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
99
|
+
|
|
100
|
+
Required Fields:
|
|
101
|
+
|
|
102
|
+
`output`: required",SHALL,Server,false,,,"2.2.1.05, 2.3.1.05, 2.4.1.05","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_output_check"
|
|
103
|
+
hl7.fhir.uv.bulkdata_1.0.0,165,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
104
|
+
|
|
105
|
+
Required Fields:
|
|
106
|
+
|
|
107
|
+
`output`: type: [JSON] array",SHALL,Server,false,,,"2.2.1.05, 2.3.1.05, 2.4.1.05","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_output_check"
|
|
108
|
+
hl7.fhir.uv.bulkdata_1.0.0,166,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
109
|
+
|
|
110
|
+
`output`:
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
An array of file items with one entry for each generated file.",SHALL,Server,false,,,"2.2.1.05, 2.3.1.05, 2.4.1.05","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_output_check"
|
|
115
|
+
hl7.fhir.uv.bulkdata_1.0.0,167,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
116
|
+
|
|
117
|
+
`output`:
|
|
118
|
+
|
|
119
|
+
If no resources are returned from the kick-off request, the server SHOULD return an empty array.",SHOULD,Server,true,,,"",""
|
|
120
|
+
hl7.fhir.uv.bulkdata_1.0.0,168,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
121
|
+
|
|
122
|
+
`output`:
|
|
123
|
+
|
|
124
|
+
Each file item SHALL contain the following fields:
|
|
125
|
+
|
|
126
|
+
- `type`
|
|
127
|
+
|
|
128
|
+
- `url`",SHALL,Server,false,,,"2.2.1.05, 2.3.1.05, 2.4.1.05","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_output_check"
|
|
129
|
+
hl7.fhir.uv.bulkdata_1.0.0,169,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
130
|
+
|
|
131
|
+
`output`:
|
|
132
|
+
|
|
133
|
+
`type` - the FHIR resource type that is contained in the file.",SHALL,Server,false,,,"2.2.1.05, 2.3.1.05, 2.4.1.05","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_output_check"
|
|
134
|
+
hl7.fhir.uv.bulkdata_1.0.0,170,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
135
|
+
|
|
136
|
+
`output`:
|
|
137
|
+
|
|
138
|
+
`type`: Each file SHALL contain resources of only one type",SHALL,Server,false,,,"2.2.1.05, 2.3.1.05, 2.4.1.05","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_output_check"
|
|
139
|
+
hl7.fhir.uv.bulkdata_1.0.0,171,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
140
|
+
|
|
141
|
+
`output`:
|
|
142
|
+
|
|
143
|
+
`type`: a server MAY create more than one file for each resource type returned",MAY,Server,false,,,"",""
|
|
144
|
+
hl7.fhir.uv.bulkdata_1.0.0,172,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
145
|
+
|
|
146
|
+
`output`:
|
|
147
|
+
|
|
148
|
+
`type`: The number of resources contained in a file MAY vary between servers.",MAY,Server,false,,,"",""
|
|
149
|
+
hl7.fhir.uv.bulkdata_1.0.0,173,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
150
|
+
|
|
151
|
+
`output`:
|
|
152
|
+
|
|
153
|
+
`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,,,"",""
|
|
154
|
+
hl7.fhir.uv.bulkdata_1.0.0,174,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
155
|
+
|
|
156
|
+
`output`:
|
|
157
|
+
|
|
158
|
+
`type`: any resource MAY have a ""contained"" array that includes referenced resources of other types.",MAY,Server,false,,,"",""
|
|
159
|
+
hl7.fhir.uv.bulkdata_1.0.0,175,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
160
|
+
|
|
161
|
+
`output`:
|
|
162
|
+
|
|
163
|
+
`url`: the absolute path to the file.",SHALL,Server,false,,,"2.2.1.05, 2.3.1.05, 2.4.1.05","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_output_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_output_check"
|
|
164
|
+
hl7.fhir.uv.bulkdata_1.0.0,176,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
165
|
+
|
|
166
|
+
`output`:
|
|
167
|
+
|
|
168
|
+
`url`: The format of the file SHOULD reflect that requested in the `_outputFormat` parameter of the initial kick-off request.",SHOULD,Server,false,,,"",""
|
|
169
|
+
hl7.fhir.uv.bulkdata_1.0.0,177,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
170
|
+
|
|
171
|
+
`output`:
|
|
172
|
+
|
|
173
|
+
Each file item MAY contain the following fields:
|
|
174
|
+
|
|
175
|
+
- `count`",MAY,Server,false,,,"",""
|
|
176
|
+
hl7.fhir.uv.bulkdata_1.0.0,178,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
177
|
+
|
|
178
|
+
`output`:
|
|
179
|
+
|
|
180
|
+
`count`: the number of resources in the file, represented as a JSON number.",SHALL,Server,false,,,"",""
|
|
181
|
+
hl7.fhir.uv.bulkdata_1.0.0,190,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
182
|
+
|
|
183
|
+
`deleted`: The request.method element SHALL be set to DELETE.",SHALL,Server,false,,,"",""
|
|
184
|
+
hl7.fhir.uv.bulkdata_1.0.0,191,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
185
|
+
|
|
186
|
+
Required Fields:
|
|
187
|
+
|
|
188
|
+
`error`: required",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
189
|
+
hl7.fhir.uv.bulkdata_1.0.0,192,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
190
|
+
|
|
191
|
+
Required Fields:
|
|
192
|
+
|
|
193
|
+
`error`: type: Array",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
194
|
+
hl7.fhir.uv.bulkdata_1.0.0,193,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
195
|
+
|
|
196
|
+
`error`: Array of message file items following the same structure as the output array.",SHALL,Server,false,,,"2.2.1.04, 2.3.1.04, 2.4.1.04","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_status_check, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_status_check"
|
|
197
|
+
hl7.fhir.uv.bulkdata_1.0.0,194,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
198
|
+
|
|
199
|
+
`error`: Error, warning, and information messages related to the export SHOULD be included here (not in output).",SHOULD,Server,false,,,"",""
|
|
200
|
+
hl7.fhir.uv.bulkdata_1.0.0,195,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
201
|
+
|
|
202
|
+
`error`: If there are no relevant messages, the server SHOULD return an empty array.",SHOULD,Server,true,,,"",""
|
|
203
|
+
hl7.fhir.uv.bulkdata_1.0.0,196,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
204
|
+
|
|
205
|
+
`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,,,"",""
|
|
206
|
+
hl7.fhir.uv.bulkdata_1.0.0,197,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
207
|
+
|
|
208
|
+
`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,,,"",""
|
|
209
|
+
hl7.fhir.uv.bulkdata_1.0.0,198,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
210
|
+
|
|
211
|
+
Required Fields:
|
|
212
|
+
|
|
213
|
+
`extension`: optional",SHALL,Server,false,,,"",""
|
|
214
|
+
hl7.fhir.uv.bulkdata_1.0.0,199,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---complete-status,"Response - Complete Status:
|
|
215
|
+
|
|
216
|
+
Required Fields:
|
|
217
|
+
|
|
218
|
+
`extension`: type: JSON object",SHALL,Server,false,,,"",""
|
|
219
|
+
hl7.fhir.uv.bulkdata_1.0.0,202,https://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#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,,,"",""
|
|
220
|
+
hl7.fhir.uv.bulkdata_1.0.0,203,https://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#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,,,"",""
|
|
221
|
+
hl7.fhir.uv.bulkdata_1.0.0,204,https://hl7.org/fhir/uv/bulkdata/stu1/export/#endpoint-2,[A Bulk Data server SHALL support Output File Requests at the endpoint] `GET [url from status request output field]`,SHALL,Server,false,,,"",""
|
|
222
|
+
hl7.fhir.uv.bulkdata_1.0.0,206,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---success-2,[A Bulk Data server SHALL respond to a successful Output File Request with] HTTP status of `200 OK`,SHALL,Server,false,,,"",""
|
|
223
|
+
hl7.fhir.uv.bulkdata_1.0.0,207,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.2.03, 2.3.2.03, 2.4.2.03","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_validation-bulk_data_group_valid_resources, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_validation-bulk_data_patient_valid_resources, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_validation-bulk_data_system_valid_resources"
|
|
224
|
+
hl7.fhir.uv.bulkdata_1.0.0,208,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.2.03, 2.3.2.03, 2.4.2.03","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_validation-bulk_data_group_valid_resources, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_validation-bulk_data_patient_valid_resources, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_validation-bulk_data_system_valid_resources"
|
|
225
|
+
hl7.fhir.uv.bulkdata_1.0.0,209,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"2.2.2.03, 2.3.2.03, 2.4.2.03","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_validation-bulk_data_group_valid_resources, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_validation-bulk_data_patient_valid_resources, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_validation-bulk_data_system_valid_resources"
|
|
226
|
+
hl7.fhir.uv.bulkdata_1.0.0,210,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,,,"",""
|
|
227
|
+
hl7.fhir.uv.bulkdata_1.0.0,218,https://hl7.org/fhir/uv/bulkdata/stu1/authorization/,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,false,,,"",""
|
|
228
|
+
hl7.fhir.uv.bulkdata_1.0.0,229,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export.html#bulkdataexport,The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern [[definition](http://hl7.org/fhir/R4/async.html],SHALL,Server,false,,,2.4.1,bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group
|
|
229
|
+
hl7.fhir.uv.bulkdata_1.0.0,230,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export.html#bulkdataexport,_outputFormat: The server SHALL support Newline Delimited JSON,SHALL,Server,false,,,"",""
|
|
230
|
+
hl7.fhir.uv.bulkdata_1.0.0,231,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export.html#bulkdataexport,`_outputFormat`: Support is required for a server,SHALL,Server,false,,,"",""
|
|
231
|
+
hl7.fhir.uv.bulkdata_1.0.0,234,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export.html#bulkdataexport,`_since`: Support is required for a server,SHALL,Server,false,,,"",""
|
|
232
|
+
hl7.fhir.uv.bulkdata_1.0.0,237,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-export.html#bulkdataexport,`_type`: Support is optional for a server,MAY,Server,false,,,"",""
|
|
233
|
+
hl7.fhir.uv.bulkdata_1.0.0,249,https://hl7.org/fhir/uv/bulkdata/stu1/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,,,2.2.1,bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group
|
|
234
|
+
hl7.fhir.uv.bulkdata_1.0.0,250,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export.html#grouplevelexport,Group Level Export: URL: [base]/Group/[id]/$export,SHALL,Server,false,,,"",""
|
|
235
|
+
hl7.fhir.uv.bulkdata_1.0.0,251,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export.html#grouplevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,false,,,"",""
|
|
236
|
+
hl7.fhir.uv.bulkdata_1.0.0,254,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export.html#grouplevelexport,`_since`: Support is required for a server,SHALL,Server,false,,,"",""
|
|
237
|
+
hl7.fhir.uv.bulkdata_1.0.0,257,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-group-export.html#grouplevelexport,`_type`: Support is optional for a server,MAY,Server,false,,,"",""
|
|
238
|
+
hl7.fhir.uv.bulkdata_1.0.0,272,https://hl7.org/fhir/uv/bulkdata/stu1/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,,,2.3.1,bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group
|
|
239
|
+
hl7.fhir.uv.bulkdata_1.0.0,273,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export.html#patientlevelexport,Patient Level Export: URL: [base]/Patient/$export,SHALL,Server,false,,,"",""
|
|
240
|
+
hl7.fhir.uv.bulkdata_1.0.0,274,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export.html#patientlevelexport,`_outputFormat`: Support is required for a server,SHALL,Server,false,,,"",""
|
|
241
|
+
hl7.fhir.uv.bulkdata_1.0.0,277,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export.html#patientlevelexport,`_since`: Support is required for a server,MAY,Server,false,,,"",""
|
|
242
|
+
hl7.fhir.uv.bulkdata_1.0.0,280,https://hl7.org/fhir/uv/bulkdata/stu1/OperationDefinition-patient-export.html#patientlevelexport,`_type`: Support is optional for a server,MAY,Server,false,,,"",""
|
|
243
|
+
hl7.fhir.uv.bulkdata_1.0.0,297,https://hl7.org/fhir/uv/bulkdata/stu1/export/#endpoint---all-patients,"[If the server supports Bulk Data Patient Export, the endpoint SHALL be] `[fhir base]/Patient/$export`",SHALL,Server,false,,,"",""
|
|
244
|
+
hl7.fhir.uv.bulkdata_1.0.0,298,https://hl7.org/fhir/uv/bulkdata/stu1/export/#endpoint---group-of-patients,"[If the server supports Bulk Data Group Export, the endpoint SHALL be] `[fhir base]/Group/[id]/$export`",SHALL,Server,false,,,"",""
|
|
245
|
+
hl7.fhir.uv.bulkdata_1.0.0,299,https://hl7.org/fhir/uv/bulkdata/stu1/export/#endpoint---system-level-export,"[If the server supports Bulk Data System Level Export, the endpoint SHALL be] `[fhir base]/$export`",SHALL,Server,false,,,"",""
|
|
246
|
+
hl7.fhir.uv.bulkdata_1.0.0,300,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---success,[A Bulk Data server SHALL respond to a successful Bulk Data Kickoff Request with] HTTP Status Code of `202 Accepted`,SHALL,Server,true,,,"2.2.1.03, 2.3.1.03, 2.4.1.03","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_kick_off, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_kick_off, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_kick_off"
|
|
247
|
+
hl7.fhir.uv.bulkdata_1.0.0,301,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,true,,,"2.2.1.03, 2.3.1.03, 2.4.1.03","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_group-bulk_data_group_kick_off, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_group-bulk_data_patient_kick_off, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_group-bulk_data_system_kick_off"
|
|
248
|
+
hl7.fhir.uv.bulkdata_1.0.0,302,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,true,,,"",""
|
|
249
|
+
hl7.fhir.uv.bulkdata_1.0.0,303,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,true,,,"",""
|
|
250
|
+
hl7.fhir.uv.bulkdata_1.0.0,304,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,true,,,"",""
|
|
251
|
+
hl7.fhir.uv.bulkdata_1.0.0,305,https://hl7.org/fhir/uv/bulkdata/stu1/export/#endpoint,[A Bulk Data server SHALL support Delete Requests at the endpoint] `DELETE [polling content location]`,SHALL,Server,false,,,"2.2.3.01, 2.3.3.01, 2.4.3.01","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_cancel_group-bulk_data_export_group_cancel, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_cancel_group-bulk_data_patient_export_cancel, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_cancel_group-bulk_data_system_export_cancel"
|
|
252
|
+
hl7.fhir.uv.bulkdata_1.0.0,306,https://hl7.org/fhir/uv/bulkdata/stu1/export/#response---success-1,[A Bulk Data server SHALL respond to a successful Delete Request with] HTTP Status Code of `202 Accepted`,SHALL,Server,true,,,"2.2.3.01, 2.3.3.01, 2.4.3.01","bulk_data_v101-bulk_data_export_tests_v101-bulk_data_group_export_v101-bulk_data_group_export_cancel_group-bulk_data_export_group_cancel, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_patient_export_v101-bulk_data_patient_export_cancel_group-bulk_data_patient_export_cancel, bulk_data_v101-bulk_data_export_tests_v101-bulk_data_system_export_v101-bulk_data_system_export_cancel_group-bulk_data_system_export_cancel"
|
|
253
|
+
hl7.fhir.uv.bulkdata_1.0.0,307,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,true,,,"",""
|
|
254
|
+
hl7.fhir.uv.bulkdata_1.0.0,308,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,true,,,"",""
|
|
255
|
+
hl7.fhir.uv.bulkdata_1.0.0,309,https://hl7.org/fhir/uv/bulkdata/stu1/export/#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,true,,,"",""
|
|
256
|
+
hl7.fhir.uv.bulkdata_1.0.0,310,https://hl7.org/fhir/uv/bulkdata/stu1/export/#endpoint-1,[A Bulk Data server SHALL support Status Requests at the endpoint] `GET [polling content location]`,SHALL,Server,false,,,"",""
|
|
257
|
+
hl7.fhir.uv.bulkdata_1.0.0,311,https://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#headers,The [Prefer] header SHALL be set to respond-async [https://tools.ietf.org/html/rfc7240](https://tools.ietf.org/html/rfc7240),SHALL,Server,false,,,"",""
|
|
258
|
+
hl7.fhir.uv.bulkdata_1.0.0,312,https://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#query-parameters,[When using the query parameter _type] resource references MAY be relative URLs with the format <resource type>/<id>,MAY,Server,true,,,"",""
|
|
259
|
+
hl7.fhir.uv.bulkdata_1.0.0,313,https://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#query-parameters,[When using the query parameter _type] resource references MAY be ... absolute URLs with the same structure rooted in the base URL for the server from which the export was performed.,MAY,Server,true,,,"",""
|
|
260
|
+
hl7.fhir.uv.bulkdata_1.0.0,314,https://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#query-parameters,[When using the query parameter _type resource] references … [SHALL] be resolved by looking for a resource with the specified type and id within the file set.,SHALL,Server,true,,,"",""
|
|
261
|
+
hl7.fhir.uv.bulkdata_1.0.0,315,https://hl7.org/fhir/uv/bulkdata/STU1/export/index.html#response---complete-status,The value of an [custom] extension element SHALL be a pre-coordinated JSON object. [It SHALL NOT use 'extension' name to avoid confusion with the extension field],SHALL NOT,Server,false,,,"",""
|
|
262
|
+
hl7.fhir.uv.bulkdata_1.0.0,316,https://hl7.org/fhir/uv/bulkdata/STU1/authorization/index.html,[Servers MAY allow authentication and authorization of clients to access bulk data endpoints using [SMART Backend Services](https://hl7.org/fhir/uv/bulkdata/STU1/authorization/index.html)],MAY,Server,false,,,"",""
|
|
263
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,30,https://hl7.org/fhir/smart-app-launch/STU2.2/app-launch.html#response-3,The EHR responds with a SMART configuration JSON document as described in the [Conformance](https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html) section.,SHALL,Server,,,,1.1.01,bulk_data_v101-bulk_data_smart_backend_services_v101-bulk_data_smart_discovery_v101-well_known_endpoint
|
|
264
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,228,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#response,Servers [SHALL] respond [to requests to [base]/.well-known/smart-configuration] with a discovery response that meets [discovery requirements described in `client-confidential-asymmetric` authentication](https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#discovery-requirements). [from [base]/.well-known/smart-configuration],SHALL,Server,,,,"",""
|
|
265
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,231,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#request-1,All exchanges described herein between the client and the FHIR server SHALL be secured using TLS V1.2 or a more recent version of TLS .,SHALL,Server,,,,"",""
|
|
266
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,240,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#scopes,"The client is pre-authorized by the server. In other words, by the time a client initiates an access token request, the server has already associated the client with the authority to access certain data.",SHALL,Server,,,,"",""
|
|
267
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,241,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#scopes,"The client then includes a set of scopes in the access token request [`scope` parameter], which the server … [SHALL] apply [as] additional access restrictions following the SMART Scopes syntax.",SHALL,Server,,,,"",""
|
|
268
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,243,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#enforce-authorization,"[When a] Client explicitly asks for data that it is not authorized to see (e.g., a client asks for Observation resources but has scopes that only permit access to Patient resources) …a server SHOULD respond with a failure to the initial request.",SHOULD,Server,,,,"",""
|
|
269
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,244,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#enforce-authorization,"[When a] Client explicitly asks for data that the server does not support (e.g., a client asks for Practitioner resources but the server does not support FHIR access to Practitioner data) ... a server SHOULD respond with a failure to the initial request.",SHOULD,Server,,,,"",""
|
|
270
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,245,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#enforce-authorization,"[When a] Client explicitly asks for data that the server supports and that appears consistent with its access scopes – but some additional out-of-band rules/policies/restrictions prevents the client from being authorized to see these data... the server MAY withhold certain results from the response, and MAY indicate to the client that results were withheld by including OperationOutcome information in the “error” array for the response as a partial success.",MAY,Server,,,,"",""
|
|
271
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,246,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#enforce-authorization,"[When a server does not return data that the clien's scopes indicate it has access to, it] MAY indicate to the client that results were withheld by including OperationOutcome information in the “error” array for the response as a partial success.",MAY,Server,,,,"",""
|
|
272
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,247,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#enforce-authorization,"Rules regarding circumstances under which a client is required to obtain and present an access token along with a request are based on risk-management decisions that each FHIR resource service needs to [(SHALL)] make, considering the workflows involved, perceived risks, and the organization’s risk-management policies.",SHALL,Server,,,,"",""
|
|
273
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,248,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#enforce-authorization,Refresh tokens SHOULD NOT be issued.,SHOULD NOT,Server,,,,"",""
|
|
274
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,249,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#validate-authentication-jws,The FHIR authorization server [SHALL validate] a client’s authentication JWT according to the client-confidential-asymmetric authentication profile … [per the] [JWT validation rules](https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#signature-verification).,SHALL,Server,,,,"",""
|
|
275
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,250,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#evaluate-requested-access,"Once the client has been authenticated, the FHIR authorization server SHALL mediate the request to assure that the scope requested is within the scope pre-authorized to the client.",SHALL,Server,,,,"",""
|
|
276
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,251,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,"If an error is encountered during the authorization process, the FHIR authorization server SHALL respond with the appropriate error message defined in [Section 5.2 of the OAuth 2.0 specification](https://tools.ietf.org/html/rfc6749#page-45)",SHALL,Server,,,,"1.2.02, 1.2.03","bulk_data_v101-bulk_data_smart_backend_services_v101-backend_services_authorization-smart_backend_services_invalid_grant_type, bulk_data_v101-bulk_data_smart_backend_services_v101-backend_services_authorization-smart_backend_services_invalid_client_assertion"
|
|
277
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,252,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,"If an error is encountered during the authorization process, [t]he FHIR authorization server SHOULD include an `error_uri` or `error_description` as defined in OAuth 2.0.",SHOULD,Server,,,,"",""
|
|
278
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,253,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,"If the access token request is valid and authorized, the FHIR authorization server SHALL issue an access token in response.",SHALL,Server,,,,1.2.05,bulk_data_v101-bulk_data_smart_backend_services_v101-backend_services_authorization-smart_backend_services_auth_request_success
|
|
279
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,254,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,[When responding with an access token t]he `access_token` [parameter is] `required` [and] SHALL [contain] The access token issued by the FHIR authorization server.,SHALL,Server,,,,1.2.06,bulk_data_v101-bulk_data_smart_backend_services_v101-backend_services_authorization-smart_backend_services_auth_response_body
|
|
280
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,255,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,[When responding with an access token t]he `token_type` [parameter is] `required` [and] SHALL [contain] Fixed value: bearer.,SHALL,Server,,,,1.2.06,bulk_data_v101-bulk_data_smart_backend_services_v101-backend_services_authorization-smart_backend_services_auth_response_body
|
|
281
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,256,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,[When responding with an access token t]he `expires_in` [parameter is] `required` [and] SHALL [contain] The lifetime in seconds of the access token.,SHALL,Server,,,,1.2.06,bulk_data_v101-bulk_data_smart_backend_services_v101-backend_services_authorization-smart_backend_services_auth_response_body
|
|
282
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,257,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,"[When responding with an access token t]he recommended value [for the `expires_in` parameter] is 300, for a five-minute token lifetime.",SHOULD,Server,,,,"",""
|
|
283
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,258,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,[When responding with an access token t]he `scope` [parameter is] `required` [and] SHALL [contain s]cope of access authorized.,SHALL,Server,,,,1.2.06,bulk_data_v101-bulk_data_smart_backend_services_v101-backend_services_authorization-smart_backend_services_auth_response_body
|
|
284
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,259,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,[When responding with an access token t]he `scope` [parameter value] can be different from the scopes requested by the app.,SHALL,Server,,,,"",""
|
|
285
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,260,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,"to minimize risks associated with token redirection, the scope of each access token SHOULD encompass, and be limited to, the resources requested",SHOULD,Server,,,,"",""
|
|
286
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,261,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,[When responding with an access token a]ccess tokens issued under this [backed services] profile SHALL be short-lived,SHALL,Server,,,,"",""
|
|
287
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,262,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#issue-access-token,"[When responding with an access token t]he `expires_in` value SHOULD NOT exceed 300, which represents an expiration-time of five minutes.",SHOULD NOT,Server,,,,"",""
|
|
288
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,265,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#response-2,The resource server SHALL validate the access token and ensure that it has not expired,SHALL,Server,,,,"",""
|
|
289
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,266,https://hl7.org/fhir/smart-app-launch/STU2.2/backend-services.html#response-2,The resource server SHALL validate the access token and ensure … that its scope covers the requested resource,SHALL,Server,,,,"",""
|
|
290
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,285,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#advertising-server-support-for-this-profile,[A] server [SHALL advertise] its support for SMART Confidential Clients with Asymmetric Keys by including the `client-confidential-asymmetric` capability at is `.well-known/smart-configuration` endpoint;,SHALL,Server,,,,"",""
|
|
291
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,286,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#advertising-server-support-for-this-profile,"[When supporting the `client-confidential-asymmetric`capability a server's .well-known/smart-configuration`] configuration properties [SHALL] include ... `token_endpoint`,",SHALL,Server,,,,"",""
|
|
292
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,287,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#advertising-server-support-for-this-profile,"[When supporting the `client-confidential-asymmetric`capability a server's .well-known/smart-configuration`] configuration properties [SHALL] include ... `scopes_supported`,",SHALL,Server,,,,"",""
|
|
293
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,288,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#advertising-server-support-for-this-profile,[When supporting the `client-confidential-asymmetric`capability a server's .well-known/smart-configuration`] configuration properties [SHALL] include ...`token_endpoint_auth_methods_supported` (with values that include `private_key_jwt`),SHALL,Server,,,,"",""
|
|
294
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,289,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#advertising-server-support-for-this-profile,"[When supporting the `client-confidential-asymmetric`capability a server's .well-known/smart-configuration`] configuration properties [SHALL] include ... `token_endpoint_auth_signing_alg_values_supported` (with values that include at least one of `RS384`, `ES384`).",SHALL,Server,,,,"",""
|
|
295
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,296,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#registering-a-client-communicating-public-keys,[When registering clients to use the `client-confidential-asymmetric`capability] FHIR authorization servers SHALL support registration of client JWKs using … URL to JWK set,SHALL,Server,,,,"",""
|
|
296
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,297,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#registering-a-client-communicating-public-keys,[When registering clients to use the `client-confidential-asymmetric`capability] FHIR authorization servers SHALL support registration of client JWKs using ... JWK Set directly,SHALL,Server,,,,"",""
|
|
297
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,305,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#registering-a-client-communicating-public-keys,"[if Client supplies JWK set directly to the FHIR authorization server during registration for the `client-confidential-asymmetric`capability,] the FHIR authorization server SHALL protect the JWK Set from corruption.",SHALL,Server,,,,"",""
|
|
298
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,306,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#registering-a-client-communicating-public-keys,"[if Client supplies JWK set directly to the FHIR authorization server during registration fro the `client-confidential-asymmetric`capability,] the FHIR authorization server ... SHOULD remind the client to send an update whenever the key set changes.",SHOULD,Server,,,,"",""
|
|
299
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,310,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#registering-a-client-communicating-public-keys,The FHIR authorization server SHALL be capable of validating signatures with at least one of `RS384` or `ES384`.,SHALL,Server,,,,"",""
|
|
300
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,311,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#registering-a-client-communicating-public-keys,servers MAY support … additional algorithms for signature validation [when using the `client-confidential-asymmetric`capability].,MAY,Server,,,,"",""
|
|
301
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,316,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#registering-a-client-communicating-public-keys,"Upon registration, the client SHALL be assigned a `client_id`",SHALL,Server,,,,"",""
|
|
302
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,326,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#request,"When [the `jku` Authentication JWT header value is] absent, the FHIR authorization server SHOULD fall back on the JWK Set URL or the JWK Set supplied at registration time.",SHOULD,Server,,,,"",""
|
|
303
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,335,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#signature-verification,The FHIR authorization server SHALL validate the JWT according to the processing requirements defined in [Section 3 of RFC7523](https://tools.ietf.org/html/rfc7523#section-3) including validation of the signature on the JWT,SHALL,Server,,,,"",""
|
|
304
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,336,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#signature-verification,"The FHIR authorization server SHALL … check that the `jti` value has not been previously encountered for the given `iss` within the maximum allowed authentication JWT lifetime (e.g., 5 minutes). This check prevents replay attacks.",SHALL,Server,,,,"",""
|
|
305
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,337,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#signature-verification,The FHIR authorization server SHALL … ensure that the `client_id` provided is known and matches the JWT’s `iss` claim.,SHALL,Server,,,,"",""
|
|
306
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,338,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#signature-verification,"To resolve a key to verify signatures, a FHIR authorization server SHALL follow this algorithm:
|
|
307
|
+
|
|
308
|
+
1. If the `jku` header is present, verify that the jku is whitelisted (i.e., that it matches the JWKS URL value supplied at registration time for the specified `client_id`).
|
|
309
|
+
|
|
310
|
+
a. If the jku header is not whitelisted, the signature verification fails.
|
|
311
|
+
b. If the jku header is whitelisted, create a set of potential keys by dereferencing the jku URL. Proceed to step 3.
|
|
312
|
+
|
|
313
|
+
2. If the `jku` header is absent, create a set of potential key sources consisting of all keys found in the registration-time JWKS or found by dereferencing the registration-time JWK Set URL. Proceed to step 3.
|
|
314
|
+
|
|
315
|
+
3. Identify a set of candidate keys by filtering the potential keys to identify the single key where the `kid` matches the value supplied in the client's JWT header, and the kty is consistent with the signature algorithm supplied in the client's JWT header (e.g., `RSA` for a JWT using an RSA-based signature, or `EC` for a JWT using an EC-based signature). If no keys match, or more than one key matches, the verification fails.
|
|
316
|
+
|
|
317
|
+
4. Attempt to verify the JWK using the key identified in step 3.",SHALL,Server,,,,"",""
|
|
318
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,339,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#signature-verification,To retrieve the keys from a JWKS URL ... a FHIR authorization server [SHALL issue] a HTTP GET request for that URL to obtain a JWKS response.,SHALL,Server,,,,"",""
|
|
319
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,340,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#response,"If an error is encountered during the authentication process, the server SHALL respond with an `invalid_client error` as defined by the [OAuth 2.0 specification](https://tools.ietf.org/html/rfc6749#section-5.2).",SHALL,Server,,,,"",""
|
|
320
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,341,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#response,The FHIR authorization server SHALL NOT cache a JWKS for longer than the client’s cache-control header indicates.,SHALL NOT,Server,,,,"",""
|
|
321
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,342,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-asymmetric.html#response,The FHIR authorization server SHOULD cache a client’s JWK Set according to the client’s cache-control header; it doesn’t need to retrieve it anew every time.,SHALL NOT,Server,,,,"",""
|
|
322
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,344,https://hl7.org/fhir/smart-app-launch/STU2.2/client-confidential-symmetric.html#profile-audience-and-scope,This [ `client-confidential-symmetric`] profile is not intended for [severs to use with] SMART Backend Services clients.,SHALL NOT,Server,,,,"",""
|
|
323
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,372,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#using-well-known,FHIR endpoints requiring authorization SHALL serve a JSON document at the location formed by appending `/.well-known/smart-configuration` to their base URL.,SHALL,Server,,,,1.1.01,bulk_data_v101-bulk_data_smart_backend_services_v101-bulk_data_smart_discovery_v101-well_known_endpoint
|
|
324
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,373,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#using-well-known,"The server SHALL convey the FHIR OAuth authorization endpoints and any optional SMART Capabilities it supports using this “Well-Known Uniform Resource Identifiers (URIs)” JSON document (see [RFC5785](https://datatracker.ietf.org/doc/html/rfc5785)). Contrary to RFC5785 Appendix B.4, the `.well-known` path component may be appended even if the FHIR endpoint already contains a path component",SHALL,Server,,,,"",""
|
|
325
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,374,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#using-well-known,"Responses for `/.well-known/smart-configuration` requests SHALL be JSON, regardless of `Accept` headers provided in the request.",SHALL,Server,,,,1.1.01,bulk_data_v101-bulk_data_smart_backend_services_v101-bulk_data_smart_discovery_v101-well_known_endpoint
|
|
326
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,376,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#using-well-known,[In responses for `/.well-known/smart-configuration` requests] servers MAY ignore any client-supplied Accept headers,MAY,Server,,,,"",""
|
|
327
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,377,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#using-well-known,[In responses for `/.well-known/smart-configuration` requests] servers SHALL respond with application/json,SHALL,Server,,,,1.1.01,bulk_data_v101-bulk_data_smart_backend_services_v101-bulk_data_smart_discovery_v101-well_known_endpoint
|
|
328
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,380,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#response,A JSON document must be returned using the `application/json`mime type.,SHALL,Server,,,,"",""
|
|
329
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,381,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request] if the server’s capabilities include `sso-openid-connect`[the] ..Metadata`issuer`[is] required ... [and SHALL contain the] String conveying this system’s OpenID Connect Issuer URL,SHALL,Server,,,,"",""
|
|
330
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,382,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request] if the server’s capabilities include `sso-openid-connect`[the] ...Metadata ...`jwks_uri`[is] required [and Shall contain the] string conveying this system’s JSON Web Key Set URL,SHALL,Server,,,,"",""
|
|
331
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,383,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request] if server supports the `launch-ehr` or `launch-standalone` capability [the] ...Metadata ...`authorization_endpoint`[is] required … [and Shall contain the] URL to the OAuth2 authorization endpoint,SHALL,Server,,,,"",""
|
|
332
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,384,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`grant_types_supported`[is] required … [and Shall contain the] Array of grant types supported at the token endpoint. The options are “authorization_code” (when SMART App Launch is supported) and “client_credentials” (when SMART Backend Services is supported).,SHALL,Server,,,,"",""
|
|
333
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,385,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`token_endpoint`[is] required … [and Shall contain the] URL to the OAuth2 token endpoint.,SHALL,Server,,,,"",""
|
|
334
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,386,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,"[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`token_endpoint_auth_methods_supported`[is] OPTIONAL … [and Shall contain the] array of client authentication methods supported by the token endpoint. The options are “client_secret_post”, “client_secret_basic”, and “private_key_jwt”.",MAY,Server,,,,"",""
|
|
335
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,389,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`scopes_supported`[is] RECOMMENDED … [and Shall contain the] Array of scopes a client may request. See [scopes and launch context]. The server SHALL support all scopes listed here; additional scopes MAY be supported (so clients should not consider this an exhaustive list).,SHOULD,Server,,,,"",""
|
|
336
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,390,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`response_types_supported`[is] RECOMMENDED … [and Shall contain the] URL where an end-user can view which applications currently have access to data and can make adjustments to these access rights.,SHOULD,Server,,,,"",""
|
|
337
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,391,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`introspection_endpoint`[is] RECOMMENDED … [and Shall contain the] URL to a server’s introspection endpoint that can be used to validate a token.,SHOULD,Server,,,,"",""
|
|
338
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,392,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`revocation_endpoint`[is] RECOMMENDED … [and Shall contain the] URL to a server’s revoke endpoint that can be used to revoke a token.,SHOULD,Server,,,,"",""
|
|
339
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,393,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,"[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`capabilities`[is] REQUIRED … [and Shall contain the] Array of strings representing SMART capabilities (e.g., `sso-openid-connect` or `launch-standalone`) that the server supports.",SHALL,Server,,,,"",""
|
|
340
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,394,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,"[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`code_challenge_methods_supported`[is] REQUIRED … [and Shall contain the] Array of PKCE code challenge methods supported. The `S256` method SHALL be included in this list, and the `plain` method SHALL NOT be included in this list.",SHALL,Server,,,,"",""
|
|
341
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,438,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`registration_endpoint`[is] RECOMMENDED … [and Shall contain the] URL to the OAuth2 dynamic registration endpoint for this FHIR server.,SHOULD,Server,,,,"",""
|
|
342
|
+
hl7.fhir.uv.smart-app-launch_2.2.0,439,https://hl7.org/fhir/smart-app-launch/STU2.2/conformance.html#metadata,"[When responding to a `/.well-known/smart-configuration` request the] ...Metadata ...`associated_endpoints`[is] RECOMMENDED … [and Shall contain an a]rray of objects for endpoints that share the same authorization mechanism as this FHIR endpoint, each with a “url” and “capabilities” array.",SHOULD,Server,,,,"",""
|