Bulk Data Access IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bulk-data/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
bulk-data CapabilityStatement to bulk-export (http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-export), and added separate bulk-submit and bulk-publish CapabilityStatements. Servers that declared conformance with STU3 by including http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data in CapabilityStatement.instantiates should use the new Bulk Export canonical URL.extension property on any manifest object had a value of a JSON object where the properties are the extension name and the values are the extension value. In STU4, the extension property contains an array of FHIR Extension elements.manifestType and outputFormat elements.request element.error element to outcome.outputOrganizedBy element type to uri.GET kick-off requests, requiring use of HTTP POST with a FHIR Parameters Resource.experimental label from the _elements and includeAssociatedData parameters.includeAssociatedData parameter type to a Coding from a code.includeAssociatedData behavior: when the parameter is omitted, no additional resources are included as a result of this parameter, so Provenance resources are no longer included by default unless they are part of the Data Provider's default export dataset or are requested using _type. Previously, when no provenance-related value was specified, Data Providers were required to include all available Provenance resources targeting resources in the Patient compartment for patient-level requests, and all available Provenance resources for system-level requests, unless _type excluded Provenance._type and organizeOutputBy parameter types to uri, with an extensible binding to the FHIR resource types value set.allowPartialManifests kick-off request parameter.organizeOutputBy kick-off request parameter._typeFilter kickoff parameter since it has been widely implemented, clarified its documentation and approach to boolean logic, and documented the interaction with other filters._until kickoff parameter on the Bulk Data kickoff request as an analog to the _since parameter to enable users to specify a cutoff modification timestamp for the resources in the response.POST of a Parameters Resource_since parameter in Group level kickoff requests to permit servers to return resources that have an earlier lastUpdated date for patients that were added to the group after the supplied date_type is populated_elements kickoff parameter to filter resource data elements in the responsepatient kickoff parameter to filter resources in the response by patient idincludeAssociatedData kickoff parameter and ValueSet for clients to indicate a set of pre-defined resources to omit or include with the responsePrefer: handling=lenient header is or is not providedAccept and Prefer header requirements from required to recommended for clients, with servers having discretion on whether to return an error or presume a default if omitted_since parameter is provided by a clientOperationOutcome response when the error indicates a failure to obtain a status rather than a failure of the underlying jobOperationOutcome in the body when servers are unable to provide thisDELETE request to the status endpoint following a complete status to signal to the server that it no longer needs to retain the output filesoutput.url field in the complete status response should be an absolute patherror field of the complete status response may include files containing OperationOutcome resources that are informational in naturedeleted field in complete status response where servers can list resources that should be removed from downstream systemsBinary resources and Attachment elementsAttachment.contentType in Attachments from a requirement to a recommendation to align with the core FHIR specrest.operation element to rest.resource.operation elements and correct the OperationDefinition URLs