davinci_pdex_test_kit 0.12.1 → 0.12.2
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/davinci_pdex_test_kit/pdex_payer_client/visual_inspection_and_attestation/authentication.rb +34 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_client/visual_inspection_and_attestation/must_support.rb +40 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_client/visual_inspection_and_attestation/provenance.rb +32 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_client/visual_inspection_and_attestation/receive_must_support.rb +34 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_client/visual_inspection_and_attestation.rb +24 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_client_suite.rb +17 -3
- data/lib/davinci_pdex_test_kit/pdex_payer_server/urls.rb +27 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/bulk_data_transmission_restrictions.rb +33 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/consent_failure.rb +40 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/consent_requirements.rb +40 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/hrex_must_support.rb +35 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/licensing.rb +37 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/member_auth.rb +81 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/mtls.rb +61 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/payer_consent_compliance.rb +33 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/prior_authorization_decisions.rb +35 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/provenance_records.rb +40 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/read_and_search_hrex.rb +35 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation/resources_in_capability_statement.rb +35 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server/visual_inspection_and_attestation.rb +39 -0
- data/lib/davinci_pdex_test_kit/pdex_payer_server_suite.rb +26 -0
- data/lib/davinci_pdex_test_kit/pdex_provider_client_suite.rb +8 -0
- data/lib/davinci_pdex_test_kit/requirements/{generated/davinci-pdex-test-kit_requirements_coverage.csv → davinci_pdex_test_kit_requirements.csv} +108 -59
- data/lib/davinci_pdex_test_kit/requirements/generated/pdex_payer_client_requirements_coverage.csv +29 -0
- data/lib/davinci_pdex_test_kit/requirements/generated/pdex_payer_server_requirements_coverage.csv +479 -0
- data/lib/davinci_pdex_test_kit/requirements/hl7.fhir.us.davinci-pdex_2.0.0_reqs.xlsx +0 -0
- data/lib/davinci_pdex_test_kit/version.rb +2 -2
- data/lib/davinci_pdex_test_kit.rb +0 -1
- metadata +35 -20
- data/lib/davinci_pdex_test_kit/requirements/davinci-pdex-test-kit_out_of_scope_requirements.csv +0 -1
- data/lib/davinci_pdex_test_kit/requirements/davinci-pdex-test-kit_requirements.csv +0 -66
- data/lib/inferno_requirements_tools/ext/inferno_core/runnable.rb +0 -22
- data/lib/inferno_requirements_tools/rake/rakefile_template +0 -19
- data/lib/inferno_requirements_tools/tasks/collect_requirements.rb +0 -228
- data/lib/inferno_requirements_tools/tasks/requirements_coverage.rb +0 -284
- data/lib/requirements_config.yaml +0 -17
data/lib/davinci_pdex_test_kit/requirements/generated/pdex_payer_server_requirements_coverage.csv
ADDED
@@ -0,0 +1,479 @@
|
|
1
|
+
Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,Da Vinci PDex Payer Server Test Suite Short ID(s),Da Vinci PDex Payer Server Test Suite Full ID(s)
|
2
|
+
hl7.fhir.us.davinci-pdex_2.0.0,1,https://hl7.org/fhir/us/davinci-pdex/STU2/#intellectual-property,Implementers ... of this specification SHALL abide by the license requirements for each terminology content artifact utilized within a functioning implementation.,SHALL,Server,false,,,3.01,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_licensing_test
|
3
|
+
hl7.fhir.us.davinci-pdex_2.0.0,2,https://hl7.org/fhir/us/davinci-pdex/STU2/#intellectual-property,Terminology licenses SHALL be obtained from the Third-Party IP owner for each code system and/or other specified artifact used.,SHALL,Server,false,,,3.01,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_licensing_test
|
4
|
+
hl7.fhir.us.davinci-pdex_2.0.0,3,https://hl7.org/fhir/us/davinci-pdex/STU2/index.html#must-support,"For profiles defined in [US Core and referenced by PDex], the meaning of Must Support [for Servers] is established in [the US Core IG [must support section](https://hl7.org/fhir/us/core/STU3.1.1/general-guidance.html#must-support)].",SHALL,Server,false,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
5
|
+
hl7.fhir.us.davinci-pdex_2.0.0,5,https://hl7.org/fhir/us/davinci-pdex/STU2/index.html#must-support,"For profiles defined in [DaVinci HRex and referenced by PDex], the meaning of Must Support [for Servers] is established in [the HRex IG [Conformance section](https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html)].",SHALL,Server,false,,,3.03,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_must_support_defined_by_hrex_test
|
6
|
+
hl7.fhir.us.davinci-pdex_2.0.0,7,https://hl7.org/fhir/us/davinci-pdex/STU2/index.html#must-support,"[For profiles defined in the PDex IG, Servers SHALL follow] Must Support requirements … [from] the US Core Implementation Guide [[must support section](https://hl7.org/fhir/us/core/STU3.1.1/general-guidance.html#must-support)].",SHALL,Server,false,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
7
|
+
hl7.fhir.us.davinci-pdex_2.0.0,9,https://hl7.org/fhir/us/davinci-pdex/STU2/overview.html#overview,All data exchanged by Health Plans using the interactions covered in this IG SHALL be transformed to FHIR R4 resources.,SHALL,Server,false,,,2,pdex_payer_server-api_and_ms_coverage
|
8
|
+
hl7.fhir.us.davinci-pdex_2.0.0,11,https://hl7.org/fhir/us/davinci-pdex/STU2/overview.html#patient-everything-exchange-via-alternate-secure-transport,The use of the Bulk FHIR specification for transmission of member data SHALL honor jurisdictional and personal privacy restrictions that are relevant to a member’s health record.,SHALL,Server,false,,,3.09,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_bulk_data_transmission_restrictions_test
|
9
|
+
hl7.fhir.us.davinci-pdex_2.0.0,12,https://hl7.org/fhir/us/davinci-pdex/STU2/overview.html#provenance,Health Plans SHALL incorporate provenance records that they receive as part of any exchange of FHIR data.,SHALL,Server,false,,,3.05,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_provenance_test
|
10
|
+
hl7.fhir.us.davinci-pdex_2.0.0,13,https://hl7.org/fhir/us/davinci-pdex/STU2/overview.html#provenance,"Health Plans SHALL provide Provenance records [for each non-Provenance instance] that, at a minimum, indicate that they are playing the role of Transmitter of the data in any PDex information exchange.",SHALL,Server,false,,,3.05,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_provenance_test
|
11
|
+
hl7.fhir.us.davinci-pdex_2.0.0,14,https://hl7.org/fhir/us/davinci-pdex/STU2/introduction.html#implementation-hierarchy-and-priorities,"[F]or profiles and APIs identified in this IG, the FHIR R4 version SHALL be used.",SHALL,Server,false,,,2,pdex_payer_server-api_and_ms_coverage
|
12
|
+
hl7.fhir.us.davinci-pdex_2.0.0,15,https://hl7.org/fhir/us/davinci-pdex/STU2/introduction.html#pdex-data-payloads,All resources available via a FHIR API endpoint SHALL be declared in a FHIR CapabilityStatement.,SHALL,Server,false,,,3.02,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_capability_statement_declaration_test
|
13
|
+
hl7.fhir.us.davinci-pdex_2.0.0,16,https://hl7.org/fhir/us/davinci-pdex/STU2/introduction.html#pdex-data-payloads,The Read and Search Operations SHALL be supported for the FHIR Profiles [that are part of the member health history].,SHALL,Server,false,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
14
|
+
hl7.fhir.us.davinci-pdex_2.0.0,17,https://hl7.org/fhir/us/davinci-pdex/STU2/introduction.html#capabilitystatement,The Read ... Operation... SHALL be supported for … Resource Type … Coverage [using the [HRex Coverage](https://hl7.org/fhir/us/davinci-hrex/STU1/StructureDefinition-hrex-coverage.html) profile].,SHALL,Server,false,,,3.04,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_coverage_interaction_support_test
|
15
|
+
hl7.fhir.us.davinci-pdex_2.0.0,18,https://hl7.org/fhir/us/davinci-pdex/STU2/introduction.html#capabilitystatement,The ... Search Operation... SHALL be supported for … Resource Type … Coverage [using the [HRex Coverage](https://hl7.org/fhir/us/davinci-hrex/STU1/StructureDefinition-hrex-coverage.html) profile].,SHALL,Server,false,,,3.04,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_coverage_interaction_support_test
|
16
|
+
hl7.fhir.us.davinci-pdex_2.0.0,19,https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#data-payloads,All resources and operations available via a FHIR API endpoint SHALL be declared in a FHIR CapabilityStatement.,SHALL,Server,false,,,3.02,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_capability_statement_declaration_test
|
17
|
+
hl7.fhir.us.davinci-pdex_2.0.0,20,"https://hl7.org/fhir/us/davinci-pdex/STU2/overview.html#oauth20-or-smart-on-fhir-member-authorized-exchange,https://hl7.org/fhir/us/davinci-pdex/STU2/member-authorizedoauth2exchange.html,https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#oauth20-and-fhir-api","[When a payer allows their member to authorize information sharing, a]fter authenticating to the (source) Health Plan’s authorization server, the Member SHALL be presented with an Authorization screen that enables them to approve the sharing of information with their intended application, service or (target) Health Plan.",SHALL,Server,false,,,3.10,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_authorized_exchange_test
|
18
|
+
hl7.fhir.us.davinci-pdex_2.0.0,21,https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#oauth20-and-fhir-api,"For this authorization [of data sharing by a member] to occur the Application, service or (target) Health Plan will require OAuth 2.0 client application credentials, which ... the (source) Health Plan [SHALL issue during client] register[ation]",SHALL,Server,false,,,3.10,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_authorized_exchange_test
|
19
|
+
hl7.fhir.us.davinci-pdex_2.0.0,22,"https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#oauth20-and-fhir-api,https://hl7.org/fhir/us/davinci-pdex/STU2/member-authorizedoauth2exchange.htm","The Authorization process [of data sharing by a member], in accordance with applicable privacy policy, SHALL provide a mechanism to support current regulations allowing members the right to decide what information is permitted to be exchanged.",SHALL,Server,false,,,3.10,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_authorized_exchange_test
|
20
|
+
hl7.fhir.us.davinci-pdex_2.0.0,23,"https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#oauth20-and-fhir-api,https://hl7.org/fhir/us/davinci-pdex/STU2/member-authorizedoauth2exchange.htm","After successfully authorizing [data sharing with] an application [on behalf of the Member,] an Access Token ... SHALL be returned to the requesting application.",SHALL,Server,false,,,3.10,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_authorized_exchange_test
|
21
|
+
hl7.fhir.us.davinci-pdex_2.0.0,24,"https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#oauth20-and-fhir-api,https://hl7.org/fhir/us/davinci-pdex/STU2/member-authorizedoauth2exchange.htm","After successfully authorizing [data sharing with] an application [on behalf of the Member,] an … Optional Refresh Token ... [MAY] be returned to the requesting application.",MAY,Server,false,,,"",""
|
22
|
+
hl7.fhir.us.davinci-pdex_2.0.0,25,https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#oauth20-and-fhir-api,The scopes of the access token [returned by the server for data sharing on behalf of a member] SHALL be restricted to the authorizing Member’s information and the scopes approved.,SHALL,Server,false,,,3.10,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_authorized_exchange_test
|
23
|
+
hl7.fhir.us.davinci-pdex_2.0.0,26,https://hl7.org/fhir/us/davinci-pdex/STU2/pdeximplementationactorsinteractionsdatapayloadsandmethods.html#oauth20-and-fhir-api,Any subsequent Access Token [returned by the server for data sharing on behalf of the member] issued based on the Refresh Token SHALL be restricted (at least) to the same restrictions.,SHALL,Server,false,,,3.10,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_authorized_exchange_test
|
24
|
+
hl7.fhir.us.davinci-pdex_2.0.0,30,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#member-match-with-consent,Health Plans SHALL support the $member-match operation.,SHALL,Server,false,,,"1.1.01, 1.3.01","pdex_payer_server-payer_to_payer_workflow-pdex_workflow_member_match-pdex_member_match_operation_in_cap_stmt, pdex_payer_server-payer_to_payer_workflow-pdex_workflow_everything-pdex_patient_operation_in_cap_stmt_validation"
|
25
|
+
hl7.fhir.us.davinci-pdex_2.0.0,31,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#member-match-with-consent,"[Before allowing a $member-match operation, Servers SHALL e]stablish a secure connection [with the client payer] via mTLS.",SHALL,Server,false,,,3.11,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_payer_to_payer_mtls
|
26
|
+
hl7.fhir.us.davinci-pdex_2.0.0,32,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#member-match-with-consent,[Servers SHALL allow clients to u]se mTLS secure connection to perform OAuth2.0 Dynamic Client Registration to acquire OAuth2.0 client credentials,SHALL,Server,false,,,3.11,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_payer_to_payer_mtls
|
27
|
+
hl7.fhir.us.davinci-pdex_2.0.0,33,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#member-match-with-consent,[Servers SHALL allow clients to u]se Client Credentials to acquire OAuth2.0 token to perform $member-match operation,SHALL,Server,false,,,3.11,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_payer_to_payer_mtls
|
28
|
+
hl7.fhir.us.davinci-pdex_2.0.0,34,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#member-match-with-consent,"If a Patient ID is returned from $member-match, [Servers SHALL allow clients to make] a request for an OAuth2.0 Access Token that is scoped to the identified shared member",SHALL,Server,false,,,3.11,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_payer_to_payer_mtls
|
29
|
+
hl7.fhir.us.davinci-pdex_2.0.0,35,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#the-member-match-operation,In the case where a [member] match is confirmed the receiving payer will: … [r]eturn a Unique Patient Identifier (Patient FHIR ID) in the $member-match Operation Response.,SHALL,Server,true,,,1.1.08,pdex_payer_server-payer_to_payer_workflow-pdex_workflow_member_match-pdex_member_match_identifier_to_id
|
30
|
+
hl7.fhir.us.davinci-pdex_2.0.0,36,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#the-member-match-operation,When no [member] match is found ... a 422 Unprocessable entity status code will be returned [by the receiving payer].,SHALL,Server,true,,,2.1.1.05,pdex_payer_server-api_and_ms_coverage-member_match_failure_cases-pdex_no_member_matches-pdex_member_match_has_no_matches
|
31
|
+
hl7.fhir.us.davinci-pdex_2.0.0,37,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#the-member-match-operation,"When … multiple matches are found, a 422 Unprocessable entity status code will be returned [by the receiving payer].",SHALL,Server,true,,,2.1.2.05,pdex_payer_server-api_and_ms_coverage-member_match_failure_cases-pdex_multiple_member_matches-pdex_member_match_has_multiple_matches
|
32
|
+
hl7.fhir.us.davinci-pdex_2.0.0,38,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#the-member-match-operation,"If the receiving payer matches to a unique member but is unable to comply with the consent request, a Patient ID SHALL NOT be returned in the $member-match response",SHALL NOT,Server,true,,,3.12,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_match_consent_failure_test
|
33
|
+
hl7.fhir.us.davinci-pdex_2.0.0,39,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#the-member-match-operation,"If the receiving payer matches to a unique member but is unable to comply with the consent request [e.g., because they do not support the requested data segmentation policy], … a 422 status code SHALL be returned with an Operation Outcome that indicates that the consent request could not be complied with.",SHALL,Server,true,,,3.12,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_member_match_consent_failure_test
|
34
|
+
hl7.fhir.us.davinci-pdex_2.0.0,40,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#evaluation-of-consent,"[Servers SHALL consider consent requirements to be met only if]
|
35
|
+
- Member Identity is matched
|
36
|
+
- Consent Policy (Everything or only Non-Sensitive data) matches the data release segmentation capabilities of the receiving payer
|
37
|
+
- Date period for consent is valid
|
38
|
+
- Payer requesting retrieval of data is matched.",SHALL,Server,false,,,3.07,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_consent_requirements_test
|
39
|
+
hl7.fhir.us.davinci-pdex_2.0.0,42,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#data-retrieval-methods,"Each of the above methods[, query all clinical resource individually, $everything, and $export,] SHALL support the retrieval of the profiles and resources [in the scope of the member health history, defined in the Server CapabilityStatement]",SHALL,Server,false,,,"1.2, 1.3, 1.4.1","pdex_payer_server-payer_to_payer_workflow-pdex_workflow_clinical_data, pdex_payer_server-payer_to_payer_workflow-pdex_workflow_everything, pdex_payer_server-payer_to_payer_workflow-pdex_workflow_export-pdex_patient_export"
|
40
|
+
hl7.fhir.us.davinci-pdex_2.0.0,43,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#query-all-clinical-resources-individually,Health Plans SHALL support search of a member’s clinical data.,SHALL,Server,false,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
41
|
+
hl7.fhir.us.davinci-pdex_2.0.0,44,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#query-all-clinical-resources-individually,[Servers SHALL support] the _revInclude and _include parameters to ... retrieve the associated Provenance and supporting records.,SHALL,Server,false,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
42
|
+
hl7.fhir.us.davinci-pdex_2.0.0,45,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#constraining-data-based-upon-permissions-of-the-requestor,The FHIR Server SHALL constrain the data returned from the server to a requester based upon the access permissions of the requester.,SHALL,Server,false,,,3.08,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_payer_consent_compliance_test
|
43
|
+
hl7.fhir.us.davinci-pdex_2.0.0,46,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#everything-operation,Health Plans SHOULD support the use of the $everything operation… defined in the FHIR R4 specification here: https://www.hl7.org/fhir/operation-patient-everything.html,SHOULD,Server,false,,,1.3.02,pdex_payer_server-payer_to_payer_workflow-pdex_workflow_everything-Test02
|
44
|
+
hl7.fhir.us.davinci-pdex_2.0.0,47,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#bulk-fhir-asynchronous-protocols,"Payer-to-Payer Data Exchange SHOULD support the use of Bulk FHIR methods, as defined in the HL7 FHIR [Bulk Data Access Implementation Guide](https://hl7.org/fhir/uv/bulkdata/authorization/) [[corrected link](https://hl7.org/fhir/uv/bulkdata/STU2/)].",SHOULD,Server,false,,,1.4.1.01,pdex_payer_server-payer_to_payer_workflow-pdex_workflow_export-pdex_patient_export-pdex_patient_export_in_cap_stmt
|
45
|
+
hl7.fhir.us.davinci-pdex_2.0.0,48,https://hl7.org/fhir/us/davinci-pdex/STU2/datamapping.html#data-mapping,Health Plans SHALL map claims and clinical information for a member to US Core v3.1.1 FHIR Resources based on R4.,SHALL,Server,false,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
46
|
+
hl7.fhir.us.davinci-pdex_2.0.0,49,https://hl7.org/fhir/us/davinci-pdex/STU2/datamapping.html#data-mapping,"Where a US Core FHIR R4 Resource is not defined Health Plans SHALL map claims and clinical information to FHIR Profiles defined in this IG, or the Da Vinci HRex IG.",SHALL,Server,true,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
47
|
+
hl7.fhir.us.davinci-pdex_2.0.0,50,https://hl7.org/fhir/us/davinci-pdex/STU2/datamapping.html#providing-data-in-sub-element-fields,"If a field is marked as required (cardinality n.., where n>0) the Health Plan SHALL populate the field.",SHALL,Server,true,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
48
|
+
hl7.fhir.us.davinci-pdex_2.0.0,51,https://hl7.org/fhir/us/davinci-pdex/STU2/datamapping.html#providing-data-in-sub-element-fields,"For a field specified as MUST SUPPORT and the cardinality is 0.., the Health Plan SHALL be capable of populating the field and do so if the relevant data exists.",SHALL,Server,true,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
49
|
+
hl7.fhir.us.davinci-pdex_2.0.0,52,https://hl7.org/fhir/us/davinci-pdex/STU2/datamapping.html#providing-data-in-sub-element-fields,"For a field specified as MUST SUPPORT and the cardinality is 0.., the Health Plan SHALL … [populate] the field ... if the relevant data exists.",SHALL,Server,true,,,2.2,pdex_payer_server-api_and_ms_coverage-pdex_fhir_api_coverage
|
50
|
+
hl7.fhir.us.davinci-pdex_2.0.0,54,https://hl7.org/fhir/us/davinci-pdex/STU2/usecasescenarios.html#versioning-of-fhir-data,"If a payer chooses to support FHIR resource data versioning of related resource references, the referring resource **SHALL** use the vread format of reference: `[type]/[id]/_history/[vid]`",MAY,Server,true,,,"",""
|
51
|
+
hl7.fhir.us.davinci-pdex_2.0.0,55,https://hl7.org/fhir/us/davinci-pdex/STU2/usecasescenarios.html#versioning-of-fhir-data,Supporting versioning of FHIR data implies supporting the [vread](https://www.hl7.org/fhir/http.html#vread) and [history](https://www.hl7.org/fhir/http.html#history) interactions in the FHIR specification.,MAY,Server,true,,,"",""
|
52
|
+
hl7.fhir.us.davinci-pdex_2.0.0,56,https://hl7.org/fhir/us/davinci-pdex/STU2/StructureDefinition-pdex-priorauthorization.html,"Payers SHALL make available pending and active prior authorization decisions and related clinical documentation and forms for items and services, not including prescription drugs, including the date the prior authorization was approved, the date the authorization ends, as well as the units and services approved and those used to date, no later than one (1) business day after a provider initiates a prior authorization for the beneficiary or there is a change of status for the prior authorization.",SHALL,Server,false,,,3.06,pdex_payer_server-pdex_server_visual_inspection_and_attestation-pdex_prior_authorization_decisions_test
|
53
|
+
hl7.fhir.us.davinci-pdex_2.0.0,57,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#bulk-fhir-asynchronous-protocols,The request/retrieval [for the Payer-to-Payer Exchange] of data SHOULD use the [FHIR Bulk Data Patient Level Export](https://hl7.org/fhir/uv/bulkdata/OperationDefinition-patient-export.html).,SHOULD,Server,false,,,1.4,pdex_payer_server-payer_to_payer_workflow-pdex_workflow_export
|
54
|
+
hl7.fhir.us.davinci-pdex_2.0.0,58,https://hl7.org/fhir/us/davinci-pdex/STU2/payertopayerexchange.html#bulk-fhir-asynchronous-protocols,The request/retrieval [for the Payer-to-Payer Exchange] of data SHOULD use the … [Bulk Data Export Operation Request Flow](https://hl7.org/fhir/uv/bulkdata/export.html#bulk-data-export-operation-request-flow).,SHOULD,Server,false,,,1.4,pdex_payer_server-payer_to_payer_workflow-pdex_workflow_export
|
55
|
+
hl7.fhir.us.davinci-pdex_2.0.0,59,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,"In the context of an HRex compliant IG, mustSupport on any data element **SHALL** be interpreted [to mean that] … Data Sources **SHALL** be capable of populating the data element when sharing resources compliant with the profile. I.e. the system must be able to demonstrate the population and sharing of the element",SHALL,Server,false,,,"",""
|
56
|
+
hl7.fhir.us.davinci-pdex_2.0.0,60,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,"In the context of an HRex compliant IG, mustSupport on any data element **SHALL** be interpreted [to mean that] … it is acceptable to omit the [must support] element if the [data source] system doesn't have values in a particular instance.",MAY,Server,true,,,"",""
|
57
|
+
hl7.fhir.us.davinci-pdex_2.0.0,62,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,"In the context of an HRex compliant IG, mustSupport on any data element **SHALL** be interpreted [to mean that] … [i]f the minimum cardinality of an element is greater than 0 – i.e. the element is ‘required’, then the element **SHALL** be present in the instance",SHALL,Server,true,,,"",""
|
58
|
+
hl7.fhir.us.davinci-pdex_2.0.0,63,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,"In the context of an HRex compliant IG, mustSupport on any data element **SHALL** be interpreted [to mean that] … [i]f the minimum cardinality of an element is greater than 0 – i.e. the element is ‘required’, then the element ... **SHALL** have a value unless:
|
59
|
+
|
60
|
+
- The profile explicitly declares the dataAbsentReason extension or other extension for the element, in which case an extension can be present in place of the value. [or]
|
61
|
+
- The profile is inherited from U.S. Core, in which case a dataAbsentReason extension may be sent in place of the value even where dataAbsentReason is not explicitly declared in the profile.",SHALL,Server,true,,,"",""
|
62
|
+
hl7.fhir.us.davinci-pdex_2.0.0,65,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,"In the context of an HRex compliant IG, mustSupport on any data element **SHALL** be interpreted [to mean that] … [w]here the value set for an element includes concepts such as “unknown”, “refused to answer”, “not available” or where dataAbsentReason is explicitly referenced in a profile, then Data Sources **SHALL** use these values/that extension to communicate the reason for missing data.",SHALL,Server,true,,,"",""
|
63
|
+
hl7.fhir.us.davinci-pdex_2.0.0,67,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,[Data sources] are free to include additional data [beyond the must support elements],MAY,Server,false,,,"",""
|
64
|
+
hl7.fhir.us.davinci-pdex_2.0.0,69,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,"[Data Sources] should be aware that they can't count on receivers storing, processing or doing anything other than ignoring data that is not marked as mustSupport.",SHOULD,Server,true,Not Verifiable,Can only be tested in the context of a specific trading partner,NA,NA
|
65
|
+
hl7.fhir.us.davinci-pdex_2.0.0,70,https://hl7.org/fhir/us/davinci-hrex/STU1/conformance.html,"Many of the profiles in this guide reference other FHIR resources that are US Core profiles. This is defined in the formal profile definitions. For example, US Core Patient. For any other references not formally defined in a US Core profiles, the referenced resource **SHOULD** be a US Core profile if a US Core profile exists for the resource type.",SHOULD,Server,true,,,"",""
|
66
|
+
hl7.fhir.us.davinci-pdex_2.0.0,71,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#notes,The response [from a server] from a failed $member-match … [SHALL be] “422 Unprocessable Entity Status Code”.,SHALL,Server,true,,,"",""
|
67
|
+
hl7.fhir.us.davinci-pdex_2.0.0,73,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#notes,"If the requesting system [of a $member-match request] was a payer with coverage for the member, the receiving system SHOULD create a linkage between their own member information and the Coverage provided by the requesting system.",SHOULD,Server,,,,"",""
|
68
|
+
hl7.fhir.us.davinci-pdex_2.0.0,74,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#notes,This [coverage] linkage can be used [by the receiver ofa $member-match request] to support subsequent queries by establishing a known ‘reason’ for [a know requestor to be] accessing a member’s information.,SHOULD,Server,,,,"",""
|
69
|
+
hl7.fhir.us.davinci-pdex_2.0.0,77,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#resolving-parameter-references,"Those references [to a Patient instance in the Coverage and Consent resources of the $member-match operation] SHALL be resolved to the parameter with the name “MemberPatient”,",SHALL,Server,,,,"",""
|
70
|
+
hl7.fhir.us.davinci-pdex_2.0.0,79,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic,[T]he algorithms used [to match patient records for the $member-match operation] should be robust,SHOULD,Server,,,,"",""
|
71
|
+
hl7.fhir.us.davinci-pdex_2.0.0,80,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic,Servers SHALL monitor for and take measures to prevent brute force attacks [using $member-match] where the same or similar set of demographics are repeatedly searched with differing card information in an attempt to achieve a match when the card information is unknown.,SHALL,Server,,,,"",""
|
72
|
+
hl7.fhir.us.davinci-pdex_2.0.0,81,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic,[For $member-match a] maximum of a SINGLE unique match SHALL be returned.,SHALL,Server,,,,"",""
|
73
|
+
hl7.fhir.us.davinci-pdex_2.0.0,82,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic,[For $member-match n]o match SHALL return a 422 status code.,SHALL,Server,,,,"",""
|
74
|
+
hl7.fhir.us.davinci-pdex_2.0.0,83,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#member-matching-logic,[For $member-match m]ultiple matches SHALL return a 422 status code.,SHALL,Server,,,,"",""
|
75
|
+
hl7.fhir.us.davinci-pdex_2.0.0,86,https://hl7.org/fhir/us/davinci-hrex/STU1/OperationDefinition-member-match.html#consent,"If the consent [provided on a $member-match request] is revoked on the data source’s side, then it simply stops sending information in response to a request.",SHALL,Server,,,,"",""
|
76
|
+
hl7.fhir.us.davinci-pdex_2.0.0,87,https://www.hl7.org/fhir/us/core/STU3.1.1/general-guidance.html#must-support,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
|
77
|
+
|
78
|
+
US Core Responders **SHALL** be capable of populating all data elements as part of the query results specified by the [US Core Server Capability Statement](https://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html).",SHALL,Server,false,,,"",""
|
79
|
+
hl7.fhir.us.davinci-pdex_2.0.0,89,https://www.hl7.org/fhir/us/core/STU3.1.1/general-guidance.html#must-support,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
|
80
|
+
|
81
|
+
In situations where information on a particular data element is not present and the reason for absence is unknown, US Core Responders SHALL NOT include the data elements in the resource instance returned as part of the query results.",SHOULD,Server,false,,,"",""
|
82
|
+
hl7.fhir.us.davinci-pdex_2.0.0,90,https://www.hl7.org/fhir/us/core/STU3.1.1/general-guidance.html#must-support,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
|
83
|
+
|
84
|
+
When information on a particular data element is not present, and the reason for absence is unknown, US Core Responders **SHALL NOT** include the data elements in the resource instance returned as part of the query results.",SHALL NOT,Server,true,,,"",""
|
85
|
+
hl7.fhir.us.davinci-pdex_2.0.0,92,https://www.hl7.org/fhir/us/core/STU3.1.1/general-guidance.html#must-support,"For querying and reading US Core Profiles, Must Support on any profile data element **SHALL** be interpreted as follows…:
|
86
|
+
|
87
|
+
In situations where information on a particular data element is missing and the US Core Responder knows the precise reason for the absence of data, US Core Responders **SHALL** send the reason for the missing information using values (such as nullFlavors) from the value set where they exist or using the dataAbsentReason extension.",SHALL,Server,true,,,"",""
|
88
|
+
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,,,"",""
|
89
|
+
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,,,"",""
|
90
|
+
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,,,"",""
|
91
|
+
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,false,,,"",""
|
92
|
+
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,,,"",""
|
93
|
+
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,,,"",""
|
94
|
+
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,,,"",""
|
95
|
+
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,,,"",""
|
96
|
+
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,,,"",""
|
97
|
+
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,,,"",""
|
98
|
+
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,,,"",""
|
99
|
+
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,,,"",""
|
100
|
+
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,,,"",""
|
101
|
+
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,,,"",""
|
102
|
+
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,,,"",""
|
103
|
+
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,,,"",""
|
104
|
+
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,,,"",""
|
105
|
+
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,,,"",""
|
106
|
+
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,,,"",""
|
107
|
+
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,,,"",""
|
108
|
+
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,,,"",""
|
109
|
+
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,,,"",""
|
110
|
+
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 [[definition](http://hl7.org/fhir/R4/async.html].,SHALL,Server,false,,,"",""
|
111
|
+
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,,,"",""
|
112
|
+
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 [[definition](http://hl7.org/fhir/R4/parameters.html)].,MAY,Server,false,,,"",""
|
113
|
+
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,,,"",""
|
114
|
+
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,,,"",""
|
115
|
+
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,,,"",""
|
116
|
+
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,,,"",""
|
117
|
+
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,,,"",""
|
118
|
+
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,,,"",""
|
119
|
+
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,,,"",""
|
120
|
+
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 [[link](https://hl7.org/fhir/uv/bulkdata/STU2/export.html#attachments)] below.,MAY,Server,false,,,"",""
|
121
|
+
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,,,"",""
|
122
|
+
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 <resource type>/<id>, 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,,,"",""
|
123
|
+
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,,,"",""
|
124
|
+
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,,,"",""
|
125
|
+
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,,,"",""
|
126
|
+
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,,,"",""
|
127
|
+
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,,,"",""
|
128
|
+
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,,,"",""
|
129
|
+
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,,,"",""
|
130
|
+
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,,,"",""
|
131
|
+
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,,,"",""
|
132
|
+
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","`_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,,,"",""
|
133
|
+
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,,,"",""
|
134
|
+
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,,,"",""
|
135
|
+
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,,,"",""
|
136
|
+
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,,,"",""
|
137
|
+
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,,,"",""
|
138
|
+
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,,,"",""
|
139
|
+
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,,,"",""
|
140
|
+
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,,,"",""
|
141
|
+
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,,,"",""
|
142
|
+
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,,,"",""
|
143
|
+
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,,,"",""
|
144
|
+
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,,,"",""
|
145
|
+
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,,,"",""
|
146
|
+
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,,,"",""
|
147
|
+
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,,,"",""
|
148
|
+
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,,,"",""
|
149
|
+
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,,,,"",""
|
150
|
+
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,,,"",""
|
151
|
+
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,,,"",""
|
152
|
+
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,,,"",""
|
153
|
+
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,,,"",""
|
154
|
+
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,,,"",""
|
155
|
+
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,,,"",""
|
156
|
+
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,,,"",""
|
157
|
+
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,,,"",""
|
158
|
+
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,,,"",""
|
159
|
+
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,,,"",""
|
160
|
+
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,,,"",""
|
161
|
+
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,,,"",""
|
162
|
+
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,,,"",""
|
163
|
+
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,,,"",""
|
164
|
+
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,,,"",""
|
165
|
+
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,,,"",""
|
166
|
+
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,,,"",""
|
167
|
+
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,,,"",""
|
168
|
+
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,true,,,"",""
|
169
|
+
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,,,"",""
|
170
|
+
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,,,"",""
|
171
|
+
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,,,"",""
|
172
|
+
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,,,"",""
|
173
|
+
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,,,"",""
|
174
|
+
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,,,"",""
|
175
|
+
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,,,"",""
|
176
|
+
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,,,"",""
|
177
|
+
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,,,"",""
|
178
|
+
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,,,"",""
|
179
|
+
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,,,"",""
|
180
|
+
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,,,"",""
|
181
|
+
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,,,"",""
|
182
|
+
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,,,"",""
|
183
|
+
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,,,"",""
|
184
|
+
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,,,"",""
|
185
|
+
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,,,"",""
|
186
|
+
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,,,"",""
|
187
|
+
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,,,"",""
|
188
|
+
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,,,"",""
|
189
|
+
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,,,"",""
|
190
|
+
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,,,"",""
|
191
|
+
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,,,"",""
|
192
|
+
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,,,"",""
|
193
|
+
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,,,"",""
|
194
|
+
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,,,"",""
|
195
|
+
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,,,"",""
|
196
|
+
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,,,"",""
|
197
|
+
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,,,"",""
|
198
|
+
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,,,"",""
|
199
|
+
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,,,"",""
|
200
|
+
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,,,"",""
|
201
|
+
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,,,"",""
|
202
|
+
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,,,"",""
|
203
|
+
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,,,"",""
|
204
|
+
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,,,"",""
|
205
|
+
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,,,"",""
|
206
|
+
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,,,"",""
|
207
|
+
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,,,"",""
|
208
|
+
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,,,"",""
|
209
|
+
hl7.fhir.uv.bulkdata_2.0.0,149,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, the] URLs [advertised in the response] MAY be served by file servers other than a FHIR-specific server.",MAY,Server,false,,,"",""
|
210
|
+
hl7.fhir.uv.bulkdata_2.0.0,150,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
211
|
+
|
212
|
+
`transactionTime`: required",SHALL,Server,false,,,"",""
|
213
|
+
hl7.fhir.uv.bulkdata_2.0.0,151,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
214
|
+
|
215
|
+
`transactionTime`: type: FHIR instant",SHALL,Server,false,,,"",""
|
216
|
+
hl7.fhir.uv.bulkdata_2.0.0,152,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
217
|
+
|
218
|
+
`transactionTime`: Indicates the server's time when the query is run.",SHALL,Server,false,,,"",""
|
219
|
+
hl7.fhir.uv.bulkdata_2.0.0,153,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
220
|
+
|
221
|
+
`transactionTime`: The response SHOULD NOT include any resources modified after this instant",SHOULD,Server,false,,,"",""
|
222
|
+
hl7.fhir.uv.bulkdata_2.0.0,154,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
223
|
+
|
224
|
+
`transactionTime`: The response … SHALL include any matching resources modified up to and including this instant.",SHALL,Server,false,,,"",""
|
225
|
+
hl7.fhir.uv.bulkdata_2.0.0,155,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
226
|
+
|
227
|
+
Required Fields:
|
228
|
+
|
229
|
+
`request`: required",SHALL,Server,false,,,"",""
|
230
|
+
hl7.fhir.uv.bulkdata_2.0.0,156,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
231
|
+
|
232
|
+
Required Fields:
|
233
|
+
|
234
|
+
`request`: type: String",SHALL,Server,false,,,"",""
|
235
|
+
hl7.fhir.uv.bulkdata_2.0.0,157,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"""Response - Complete Status:
|
236
|
+
|
237
|
+
`request`: The full URL of the original Bulk Data kick-off request.",SHALL,Server,false,,,"",""
|
238
|
+
hl7.fhir.uv.bulkdata_2.0.0,158,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
239
|
+
|
240
|
+
`request`: In the case of a POST request, this URL will not include the request parameters.",SHALL,Server,true,,,"",""
|
241
|
+
hl7.fhir.uv.bulkdata_2.0.0,159,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
242
|
+
|
243
|
+
Required Fields:
|
244
|
+
|
245
|
+
`requiresAccessToken`: required",SHALL,Server,false,,,"",""
|
246
|
+
hl7.fhir.uv.bulkdata_2.0.0,160,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
247
|
+
|
248
|
+
Required Fields:
|
249
|
+
|
250
|
+
`requiresAccessToken`: type: Boolean",SHALL,Server,false,,,"",""
|
251
|
+
hl7.fhir.uv.bulkdata_2.0.0,161,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
252
|
+
|
253
|
+
`requiresAccessToken`: Indicates whether downloading the generated files requires the same authorization mechanism as the $export operation itself.",SHALL,Server,false,,,"",""
|
254
|
+
hl7.fhir.uv.bulkdata_2.0.0,162,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
255
|
+
|
256
|
+
`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,,,"",""
|
257
|
+
hl7.fhir.uv.bulkdata_2.0.0,163,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
258
|
+
|
259
|
+
`requiresAccessToken`: Value MAY be false for file servers that use access-control schemes other than OAuth 2.0",MAY,Server,false,,,"",""
|
260
|
+
hl7.fhir.uv.bulkdata_2.0.0,164,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
261
|
+
|
262
|
+
Required Fields:
|
263
|
+
|
264
|
+
`output`: required",SHALL,Server,false,,,"",""
|
265
|
+
hl7.fhir.uv.bulkdata_2.0.0,165,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
266
|
+
|
267
|
+
Required Fields:
|
268
|
+
|
269
|
+
`output`: type: JSON array",SHALL,Server,false,,,"",""
|
270
|
+
hl7.fhir.uv.bulkdata_2.0.0,166,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
271
|
+
|
272
|
+
`output`:
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
An array of file items with one entry for each generated file.",SHALL,Server,false,,,"",""
|
277
|
+
hl7.fhir.uv.bulkdata_2.0.0,167,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
278
|
+
|
279
|
+
`output`:
|
280
|
+
|
281
|
+
If no resources are returned from the kick-off request, the server SHOULD return an empty array.",SHOULD,Server,true,,,"",""
|
282
|
+
hl7.fhir.uv.bulkdata_2.0.0,168,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
283
|
+
|
284
|
+
`output`:
|
285
|
+
|
286
|
+
Each file item SHALL contain the following fields:
|
287
|
+
|
288
|
+
- `type`
|
289
|
+
|
290
|
+
- `url`",SHALL,Server,false,,,"",""
|
291
|
+
hl7.fhir.uv.bulkdata_2.0.0,169,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
292
|
+
|
293
|
+
`output`:
|
294
|
+
|
295
|
+
`type` - the FHIR resource type that is contained in the file.",SHALL,Server,false,,,"",""
|
296
|
+
hl7.fhir.uv.bulkdata_2.0.0,170,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
297
|
+
|
298
|
+
`output`:
|
299
|
+
|
300
|
+
`type`: Each file SHALL contain resources of only one type",SHALL,Server,false,,,"",""
|
301
|
+
hl7.fhir.uv.bulkdata_2.0.0,171,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
302
|
+
|
303
|
+
`output`:
|
304
|
+
|
305
|
+
`type`: a server MAY create more than one file for each resource type returned",MAY,Server,false,,,"",""
|
306
|
+
hl7.fhir.uv.bulkdata_2.0.0,172,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
307
|
+
|
308
|
+
`output`:
|
309
|
+
|
310
|
+
`type`: The number of resources contained in a file MAY vary between servers.",MAY,Server,false,,,"",""
|
311
|
+
hl7.fhir.uv.bulkdata_2.0.0,173,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
312
|
+
|
313
|
+
`output`:
|
314
|
+
|
315
|
+
`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,,,"",""
|
316
|
+
hl7.fhir.uv.bulkdata_2.0.0,174,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
317
|
+
|
318
|
+
`output`:
|
319
|
+
|
320
|
+
`type`: any resource MAY have a ""contained"" array that includes referenced resources of other types.",MAY,Server,false,,,"",""
|
321
|
+
hl7.fhir.uv.bulkdata_2.0.0,175,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
322
|
+
|
323
|
+
`output`:
|
324
|
+
|
325
|
+
`url`: the absolute path to the file.",SHALL,Server,false,,,"",""
|
326
|
+
hl7.fhir.uv.bulkdata_2.0.0,176,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
327
|
+
|
328
|
+
`output`:
|
329
|
+
|
330
|
+
`url`: The format of the file SHOULD reflect that requested in the `_outputFormat` parameter of the initial kick-off request.",SHOULD,Server,false,,,"",""
|
331
|
+
hl7.fhir.uv.bulkdata_2.0.0,177,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
332
|
+
|
333
|
+
`output`:
|
334
|
+
|
335
|
+
Each file item MAY contain the following fields:
|
336
|
+
|
337
|
+
- `count`",MAY,Server,false,,,"",""
|
338
|
+
hl7.fhir.uv.bulkdata_2.0.0,178,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
339
|
+
|
340
|
+
`output`:
|
341
|
+
|
342
|
+
`count`: the number of resources in the file, represented as a JSON number.",SHALL,Server,false,,,"",""
|
343
|
+
hl7.fhir.uv.bulkdata_2.0.0,179,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
344
|
+
|
345
|
+
Required Fields:
|
346
|
+
|
347
|
+
`deleted`: optional",MAY,Server,false,,,"",""
|
348
|
+
hl7.fhir.uv.bulkdata_2.0.0,180,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
349
|
+
|
350
|
+
Required Fields:
|
351
|
+
|
352
|
+
`deleted`: type: JSON array",SHALL,Server,false,,,"",""
|
353
|
+
hl7.fhir.uv.bulkdata_2.0.0,181,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
354
|
+
|
355
|
+
`deleted`: An array of deleted file items following the same structure as the `output` array.",SHALL,Server,false,,,"",""
|
356
|
+
hl7.fhir.uv.bulkdata_2.0.0,182,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
357
|
+
|
358
|
+
`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,,,"",""
|
359
|
+
hl7.fhir.uv.bulkdata_2.0.0,183,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
360
|
+
|
361
|
+
`deleted`: If no resources have been deleted, ... the server MAY omit this key or MAY return an empty array.",MAY,Server,true,,,"",""
|
362
|
+
hl7.fhir.uv.bulkdata_2.0.0,184,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
363
|
+
|
364
|
+
`deleted`: If ... the _since parameter was not supplied, ... the server MAY omit this key or MAY return an empty array.",MAY,Server,true,,,"",""
|
365
|
+
hl7.fhir.uv.bulkdata_2.0.0,185,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
366
|
+
|
367
|
+
`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,,,"",""
|
368
|
+
hl7.fhir.uv.bulkdata_2.0.0,186,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
369
|
+
|
370
|
+
`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,,,"",""
|
371
|
+
hl7.fhir.uv.bulkdata_2.0.0,187,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
372
|
+
|
373
|
+
`deleted`: Each line in the output file SHALL contain a FHIR Bundle with a type of transaction",SHALL,Server,false,,,"",""
|
374
|
+
hl7.fhir.uv.bulkdata_2.0.0,188,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
375
|
+
|
376
|
+
`deleted`: transaction ... SHALL contain one or more entry items that reflect a deleted resource.",SHALL,Server,false,,,"",""
|
377
|
+
hl7.fhir.uv.bulkdata_2.0.0,189,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
378
|
+
|
379
|
+
`deleted`: In each entry, the request.url and request.method elements SHALL be populated.",SHALL,Server,false,,,"",""
|
380
|
+
hl7.fhir.uv.bulkdata_2.0.0,190,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
381
|
+
|
382
|
+
`deleted`: The request.method element SHALL be set to DELETE.",SHALL,Server,false,,,"",""
|
383
|
+
hl7.fhir.uv.bulkdata_2.0.0,191,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
384
|
+
|
385
|
+
Required Fields:
|
386
|
+
|
387
|
+
`error`: required",SHALL,Server,false,,,"",""
|
388
|
+
hl7.fhir.uv.bulkdata_2.0.0,192,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
389
|
+
|
390
|
+
Required Fields:
|
391
|
+
|
392
|
+
`error`: type: Array",SHALL,Server,false,,,"",""
|
393
|
+
hl7.fhir.uv.bulkdata_2.0.0,193,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
394
|
+
|
395
|
+
`error`: Array of message file items following the same structure as the output array.",SHALL,Server,false,,,"",""
|
396
|
+
hl7.fhir.uv.bulkdata_2.0.0,194,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
397
|
+
|
398
|
+
`error`: Error, warning, and information messages related to the export SHOULD be included here (not in output).",SHOULD,Server,false,,,"",""
|
399
|
+
hl7.fhir.uv.bulkdata_2.0.0,195,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
400
|
+
|
401
|
+
`error`: If there are no relevant messages, the server SHOULD return an empty array.",SHOULD,Server,true,,,"",""
|
402
|
+
hl7.fhir.uv.bulkdata_2.0.0,196,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
403
|
+
|
404
|
+
`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,,,"",""
|
405
|
+
hl7.fhir.uv.bulkdata_2.0.0,197,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
406
|
+
|
407
|
+
`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,,,"",""
|
408
|
+
hl7.fhir.uv.bulkdata_2.0.0,198,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
409
|
+
|
410
|
+
Required Fields:
|
411
|
+
|
412
|
+
`extension`: optional",SHALL,Server,false,,,"",""
|
413
|
+
hl7.fhir.uv.bulkdata_2.0.0,199,https://hl7.org/fhir/uv/bulkdata/STU2/export.html#response---complete-status,"Response - Complete Status:
|
414
|
+
|
415
|
+
Required Fields:
|
416
|
+
|
417
|
+
`extension`: type: JSON object",SHALL,Server,false,,,"",""
|
418
|
+
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,,,"",""
|
419
|
+
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,,,"",""
|
420
|
+
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,,,"",""
|
421
|
+
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,,,"",""
|
422
|
+
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,,,"",""
|
423
|
+
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,,,"",""
|
424
|
+
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,,,"",""
|
425
|
+
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,,,"",""
|
426
|
+
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,,,"",""
|
427
|
+
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,,,"",""
|
428
|
+
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,,,"",""
|
429
|
+
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,,,"",""
|
430
|
+
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,,,"",""
|
431
|
+
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,,,"",""
|
432
|
+
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,,,"",""
|
433
|
+
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,false,,,"",""
|
434
|
+
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 [[definition](https://hl7.org/fhir/uv/bulkdata/STU2/CapabilityStatement-bulk-data.html)] should meet the requirements set by the Bulk Data Access Implementation Guide.,SHOULD,Server,false,,,"",""
|
435
|
+
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 [[definition](https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-export.html)] using the FHIR Asynchronous Request Pattern [[definition](http://hl7.org/fhir/R4/async.html],SHALL,Server,true,,,"",""
|
436
|
+
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 [[definition](https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-group-export.html)] using the FHIR Asynchronous Request Pattern [[definition](http://hl7.org/fhir/R4/async.html],SHALL,Server,true,,,"",""
|
437
|
+
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 [[definition](https://hl7.org/fhir/uv/bulkdata/STU2/OperationDefinition-patient-export.html)] using the FHIR Asynchronous Request Pattern [[definition](http://hl7.org/fhir/R4/async.html],SHALL,Server,true,,,"",""
|
438
|
+
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,,,"",""
|
439
|
+
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 [[definition](http://hl7.org/fhir/R4/async.html].,SHALL,Server,false,,,"",""
|
440
|
+
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 [[definition](http://hl7.org/fhir/R4/parameters.html)].,MAY,Server,false,,,"",""
|
441
|
+
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 [[definition](http://hl7.org/fhir/R4/async.html],SHALL,Server,false,,,"",""
|
442
|
+
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,,,"",""
|
443
|
+
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,,,"",""
|
444
|
+
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,,,"",""
|
445
|
+
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,,,"",""
|
446
|
+
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,,,"",""
|
447
|
+
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,,,"",""
|
448
|
+
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,,,"",""
|
449
|
+
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,,,"",""
|
450
|
+
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,,,"",""
|
451
|
+
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,,,"",""
|
452
|
+
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,,,"",""
|
453
|
+
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,,,"",""
|
454
|
+
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,,,"",""
|
455
|
+
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,,,"",""
|
456
|
+
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,,,"",""
|
457
|
+
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,,,"",""
|
458
|
+
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,,,"",""
|
459
|
+
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,,,"",""
|
460
|
+
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,,,"",""
|
461
|
+
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,,,"",""
|
462
|
+
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,,,"",""
|
463
|
+
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,,,"",""
|
464
|
+
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,,,"",""
|
465
|
+
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,,,"",""
|
466
|
+
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,,,,"",""
|
467
|
+
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,,,,"",""
|
468
|
+
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,,,,"",""
|
469
|
+
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,,,,"",""
|
470
|
+
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,,,,"",""
|
471
|
+
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,,,,"",""
|
472
|
+
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,,,,"",""
|
473
|
+
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,,,,"",""
|
474
|
+
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,,,,"",""
|
475
|
+
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,,,,"",""
|
476
|
+
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,,,,"",""
|
477
|
+
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,,,,"",""
|
478
|
+
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,,,,"",""
|
479
|
+
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,,,,"",""
|