<status value="active"/> <date value="2026-05-06T20:38:15+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <name value="HL7 International / FHIR Infrastructure"/> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.HL7.org"/> </telecom> </contact> <description value="FHIR based approach for exporting large data sets from a FHIR server to a client application"/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> </coding> </jurisdiction> <packageId value="hl7.fhir.uv.bulkdata"/> <license value="CC0-1.0"/> <fhirVersion value="4.0.1"/> <dependsOn id="hl7tx"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment"> <valueMarkdown value="Automatically added as a dependency - all IGs depend on HL7 Terminology"/> </extension> <uri value="http://terminology.hl7.org/ImplementationGuide/hl7.terminology"/> <packageId value="hl7.terminology.r4"/> <version value="7.1.0"/> </dependsOn> <dependsOn id="hl7ext"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment"> <valueMarkdown value="Automatically added as a dependency - all IGs depend on the HL7 Extension Pack"/> </extension> <uri value="http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions"/> <packageId value="hl7.fhir.uv.extensions.r4"/> <version value="5.2.0"/> </dependsOn> <definition> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="copyrightyear"/> </extension> <extension url="value"> <valueString value="2025+"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="releaselabel"/> </extension> <extension url="value"> <valueString value="STU 4"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="excludettl"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="excludexml"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="excludemap"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="path-history"/> </extension> <extension url="value"> <valueString value="http://hl7.org/fhir/uv/bulkdata/history.html"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="autoload-resources"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="path-liquid"/> </extension> <extension url="value"> <valueString value="template/liquid"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="path-liquid"/> </extension> <extension url="value"> <valueString value="input/liquid"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="path-qa"/> </extension> <extension url="value"> <valueString value="temp/qa"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="path-temp"/> </extension> <extension url="value"> <valueString value="temp/pages"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="path-output"/> </extension> <extension url="value"> <valueString value="output"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="path-suppressed-warnings"/> </extension> <extension url="value"> <valueString value="input/ignoreWarnings.txt"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="template-html"/> </extension> <extension url="value"> <valueString value="template-page.html"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="template-md"/> </extension> <extension url="value"> <valueString value="template-page-md.html"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-contact"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-context"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-copyright"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-jurisdiction"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-license"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-publisher"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-version"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="apply-wg"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="active-tables"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="fmm-definition"/> </extension> <extension url="value"> <valueString value="http://hl7.org/fhir/versions.html#maturity"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="propagate-status"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="excludelogbinaryformat"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="tabbed-snapshots"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="i18n-default-lang"/> </extension> <extension url="value"> <valueString value="en"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="wantGen-ttl"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="wantGen-ttl-html"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="wantGen-xml"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueString value="wantGen-xml-html"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency"> <valueCode value="hl7.fhir.uv.tools.r4#1.1.2"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="copyrightyear"/> </extension> <extension url="value"> <valueString value="2025+"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="releaselabel"/> </extension> <extension url="value"> <valueString value="STU 4"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="excludettl"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="excludexml"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="excludemap"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="path-history"/> </extension> <extension url="value"> <valueString value="http://hl7.org/fhir/uv/bulkdata/history.html"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="autoload-resources"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="path-liquid"/> </extension> <extension url="value"> <valueString value="template/liquid"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="path-liquid"/> </extension> <extension url="value"> <valueString value="input/liquid"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="path-qa"/> </extension> <extension url="value"> <valueString value="temp/qa"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="path-temp"/> </extension> <extension url="value"> <valueString value="temp/pages"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="path-output"/> </extension> <extension url="value"> <valueString value="output"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="path-suppressed-warnings"/> </extension> <extension url="value"> <valueString value="input/ignoreWarnings.txt"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="template-html"/> </extension> <extension url="value"> <valueString value="template-page.html"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="template-md"/> </extension> <extension url="value"> <valueString value="template-page-md.html"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-contact"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-context"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-copyright"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-jurisdiction"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-license"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-publisher"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-version"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="apply-wg"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="active-tables"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="fmm-definition"/> </extension> <extension url="value"> <valueString value="http://hl7.org/fhir/versions.html#maturity"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="propagate-status"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="excludelogbinaryformat"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="tabbed-snapshots"/> </extension> <extension url="value"> <valueString value="true"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="i18n-default-lang"/> </extension> <extension url="value"> <valueString value="en"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="wantGen-ttl"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="wantGen-ttl-html"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="wantGen-xml"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"> <extension url="code"> <valueCode value="wantGen-xml-html"/> </extension> <extension url="value"> <valueString value="false"/> </extension> </extension> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="StructureDefinition:resource"/> </extension> <reference> <reference value="StructureDefinition/bulk-cohort-group"/> </reference> <name value="Bulk Cohort Group"/> <description value="This Group resource profile enables the creation of patient cohorts, practitioner cohorts, and sets of devices based on characteristics defined using FHIR RESTful search filters. It can be used to constrain the population included in a bulk export request."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Group"/> </extension> <reference> <reference value="Group/BulkCohortGroupExample"/> </reference> <name value="Bulk Cohort Group Example"/> <description value="Blue cross plan member group with members filtered to patients that have an active diagnosis of diabetes on their problem list and an ambulatory encounter in January 2024"/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/bulk-cohort-group"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="StructureDefinition:logical"/> </extension> <reference> <reference value="StructureDefinition/BulkDataManifest"/> </reference> <name value="Bulk Data Manifest"/> <description value="Logical model describing a standard format to provide links to FHIR Bulk Data files and related metadata."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format"> <valueCode value="application/fhir+json"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Binary"/> </extension> <reference> <reference value="Binary/BulkDataManifestByTypeExample"/> </reference> <name value="Bulk Data Manifest Example By Resource Type"/> <description value="Example Bulk Data output manifest when organizeOutputBy is not populated."/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format"> <valueCode value="application/fhir+json"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Binary"/> </extension> <reference> <reference value="Binary/BulkDataManifestOrganizedByPatientExample"/> </reference> <name value="Bulk Data Manifest Example Organized By Patient"/> <description value="Example Bulk Data output manifest when organizeOutputBy is Patient and allowPartialManifests is true."/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="StructureDefinition:logical"/> </extension> <reference> <reference value="StructureDefinition/BulkPublishManifest"/> </reference> <name value="Bulk Publish Manifest"/> <description value="Logical model describing the manifest returned by a $bulk-publish endpoint. Extends BulkDataManifest with fields to support incremental updates through epochs and to advertise a Data Provider's update cadence."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format"> <valueCode value="application/fhir+json"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Binary"/> </extension> <reference> <reference value="Binary/BulkPublishManifestIncrementalUpdateExample"/> </reference> <name value="Bulk Publish Manifest After First Incremental Update"/> <description value="Example Bulk Publish manifest after the first incremental update."/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format"> <valueCode value="application/fhir+json"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Binary"/> </extension> <reference> <reference value="Binary/BulkPublishManifestEpochStartExample"/> </reference> <name value="Bulk Publish Manifest at Epoch Start"/> <description value="Example Bulk Publish manifest at the epoch start."/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationDefinition"/> </extension> <reference> <reference value="OperationDefinition/bulk-publish"/> </reference> <name value="Bulk Publish Operation Definition"/> <description value="FHIR Operation to publish bulk data files for retrieval by Data Consumers. A Data Provider responds to GET requests at a path ending in `/$bulk-publish` by returning a Bulk Data Publish Manifest containing metadata and links to available Bulk Data files. Unlike `$export`, this operation does not initiate on-demand data generation; instead, it provides access to static or periodically updated datasets published by the Data Provider. The Bulk Publish API does not require a FHIR server implementation; many Data Providers may implement it using a simple HTTP server that returns a manifest in response to GET requests."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationDefinition"/> </extension> <reference> <reference value="OperationDefinition/bulk-submit"/> </reference> <name value="Bulk Submit Operation Definition"/> <description value="FHIR Operation through which an authenticated and authorized Data Provider submits Bulk FHIR Data to a Data Consumer and receives status information regarding the Data Consumer's receipt and processing of the data. The Data Provider provides one or more manifest URLs pointing to pre-coordinated FHIR data sets, along with metadata needed for the Data Consumer to retrieve and process the files."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationOutcome"/> </extension> <reference> <reference value="OperationOutcome/submit-status-resource-operationoutcome-example"/> </reference> <name value="Bulk Submit Resource-Level Status OperationOutcome Example"/> <description value="Example OperationOutcome describing resource-level validation failures for a bulk submit."/> <exampleBoolean value="true"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="StructureDefinition:logical"/> </extension> <reference> <reference value="StructureDefinition/BulkSubmitStatusManifest"/> </reference> <name value="Bulk Submit Status Manifest"/> <description value="Logical model describing the status manifest returned by a Data Consumer in response to a $bulk-submit-status polling request. Extends BulkDataManifest with a submissionId linking the manifest to the originating submission, and a manifestUrl on output and error items linking them back to the Data Provider's submitted manifests."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format"> <valueCode value="application/fhir+json"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Binary"/> </extension> <reference> <reference value="Binary/BulkSubmitStatusManifestExample"/> </reference> <name value="Bulk Submit Status Manifest Example"/> <description value="Example bulk submit status manifest returned by a Data Consumer."/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkSubmitStatusManifest"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationOutcome"/> </extension> <reference> <reference value="OperationOutcome/submit-status-manifest-operationoutcome-example"/> </reference> <name value="Bulk Submit Status Manifest-Level OperationOutcome Example"/> <description value="Example OperationOutcome describing manifest-level submit status."/> <exampleBoolean value="true"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationDefinition"/> </extension> <reference> <reference value="OperationDefinition/bulk-submit-status"/> </reference> <name value="Bulk Submit Status Operation Definition"/> <description value="This operation receives status updates about the submission after a Data Provider has kicked off a Bulk Submit operation. For example, the Data Consumer may indicate files it was unable to retrieve, resources that failed validation, or resources that could not be merged into an existing data set. The Data Consumer may also return processed data such as computed quality measures or de-identified versions of the submitted data. The Data Provider receives a `202 Accepted` response with a `Content-Location` header and then polls that URL according to the [FHIR Asynchronous Bulk Interaction Pattern](async.html)."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="CapabilityStatement"/> </extension> <reference> <reference value="CapabilityStatement/bulk-data"/> </reference> <name value="Capability Statement"/> <description value="The expected capabilities of a Data Provider actor (e.g., EHR systems, data warehouses, and other clinical and administrative systems that aim to interoperate by sharing large FHIR datasets) which is responsible for providing responses to requests submitted by a Data Consumer actor. Systems implementing this capability statement SHOULD meet the requirements set by the Bulk Data Access Implementation Guide. A Data Consumer MAY choose from this list to access necessary data based on use cases and other contextual requirements."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Bundle"/> </extension> <reference> <reference value="Bundle/deleted-resource-transaction-bundle-example"/> </reference> <name value="Deleted Resource Transaction Bundle Example"/> <description value="Example transaction bundle representing a deleted resource in a bulk data deleted output file."/> <exampleBoolean value="true"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationOutcome"/> </extension> <reference> <reference value="OperationOutcome/export-error-operationoutcome-example"/> </reference> <name value="Export Error OperationOutcome Example"/> <description value="Example OperationOutcome returned in the body of an error status response for a bulk data export."/> <exampleBoolean value="true"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationDefinition"/> </extension> <reference> <reference value="OperationDefinition/async"/> </reference> <name value="FHIR Asynchronous Bulk Interaction Pattern Operation Definition"/> <description value="Common kick-off request parameters for operations and defined interactions that implement the [FHIR Asynchronous Bulk Interaction Pattern](async.html). This pattern supports asynchronous generation of large FHIR datasets and is triggered by the `Prefer: respond-async` header on the underlying request."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationDefinition"/> </extension> <reference> <reference value="OperationDefinition/group-export"/> </reference> <name value="Group Level Export Operation Definition"/> <description value="FHIR Operation through which an authenticated and authorized Data Consumer requests a detailed set of FHIR resources of diverse resource types pertaining to all members of the specified [Group](https://www.hl7.org/fhir/group.html) from a Data Provider. The Data Provider's FHIR Resource Server SHALL support invocation of this operation using the [FHIR Asynchronous Bulk Interaction Pattern](async.html)"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="CodeSystem"/> </extension> <reference> <reference value="CodeSystem/include-associated-data"/> </reference> <name value="Include Associated Data Code System"/> <description value="Metadata inclusion options for Bulk Data Access Export Operation includeAssociatedData parameter"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="ValueSet"/> </extension> <reference> <reference value="ValueSet/include-associated-data"/> </reference> <name value="Include Associated Data Value Set"/> <description value="Metadata inclusion options for Bulk Data Access Export Operation includeAssociatedData parameter"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="StructureDefinition:extension"/> </extension> <reference> <reference value="StructureDefinition/member-filter"/> </reference> <name value="Member Filter"/> <description value="Extension to define the population of the group using FHIR REST API parameters. For example, the following extension would limit the population of the group to patients with an ambulatory encounter in January 2024: ``` "modifierExtension" : [{ "url" : "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/member-filter", "valueExpression" : { "language" : "application/x-fhir-query", "expression" : "Encounter?class=http://terminology.hl7.org/CodeSystem/v3-ActCode|AMB&date=ge2024-01-01&date=le2024-01-31" } }] ```"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="StructureDefinition:extension"/> </extension> <reference> <reference value="StructureDefinition/members-refreshed"/> </reference> <name value="Members Refreshed"/> <description value="Extension used by a server to indicate to a client when the members in a dynamic group were last updated. For example, the following extension would indicate that the group members were last updated January 1st 2024: ``` "Extension" : [{ "url" : "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/members-refreshed", "valueDateTime" : "2024-01-01T13:28:17-05:00" }] ```"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format"> <valueCode value="application/fhir+json"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Binary"/> </extension> <reference> <reference value="Binary/BulkDataManifestMinimalExample"/> </reference> <name value="Minimal Bulk Data Manifest"/> <description value="Example Bulk Data output manifest when organizeOutputBy is Patient and allowPartialManifests is true."/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implementationguide-resource-format"> <valueCode value="application/fhir+json"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="Binary"/> </extension> <reference> <reference value="Binary/BulkPublishManifestMinimalExample"/> </reference> <name value="Minimal Bulk Publish Manifest"/> <description value="Example minimal, non-incremental Bulk Publish manifest."/> <exampleCanonical value="http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="StructureDefinition:extension"/> </extension> <reference> <reference value="StructureDefinition/operation-not-supported"/> </reference> <name value="Operation Not Supported"/> <description value="Extension used in a CapabilityStatement to indicate that the parent resource type or search parameter is not supported for use in a bulk data export operation. For example, the following extension would indicate that the `AllergyIntolerance.clinical-status` search parameter can not be used in a `_typeFilter` parameter on this server. ``` "searchParam": [{ "name": "clinical-status", "type": "token", "extension": [{ "url": "http://hl7.org/fhir/uv/bulkdata/Extension/operation-not-supported", "valueCanonical": "http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data" }] }] ```"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationDefinition"/> </extension> <reference> <reference value="OperationDefinition/patient-export"/> </reference> <name value="Patient Level Export Operation Definition"/> <description value="FHIR Operation through which an authenticated and authorized Data Consumer requests a detailed set of FHIR resources of diverse resource types pertaining to all patients from a Data Provider. The Data Provider's FHIR Resource Server SHALL support invocation of this operation using the [FHIR Asynchronous Bulk Interaction Pattern](async.html)"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="ValueSet"/> </extension> <reference> <reference value="ValueSet/submission-status"/> </reference> <name value="Submission Status Value Set"/> <description value="Status codes for the Bulk Data Submit operation `submissionStatus` parameter."/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="ValueSet"/> </extension> <reference> <reference value="ValueSet/group-type-subset"/> </reference> <name value="Subset of GroupType Value Set"/> <description value="Value Set to constrain the type element in a Group to person, practitioner and device"/> <exampleBoolean value="false"/> </resource> <resource> <extension url="http://hl7.org/fhir/tools/StructureDefinition/resource-information"> <valueString value="OperationDefinition"/> </extension> <reference> <reference value="OperationDefinition/export"/> </reference> <name value="System Level Export Operation Definition"/> <description value="FHIR Operation through which an authenticated and authorized Data Consumer may request bulk FHIR data from a Data Provider, whether or not the data is associated with a patient. This supports use cases like backing up a Data Provider's FHIR server, or exporting terminology data by restricting the resources returned using the _type parameter. The Data Provider's FHIR Resource Server SHALL support invocation of this operation using the [FHIR Asynchronous Bulk Interaction Pattern](async.html)"/> <exampleBoolean value="false"/> </resource> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="toc.html"/> </extension> <nameUrl value="toc.html"/> <title value="Table of Contents"/> <generation value="html"/> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="index.html"/> </extension> <nameUrl value="index.html"/> <title value="Home"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="export.html"/> </extension> <nameUrl value="export.html"/> <title value="Export"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="publish.html"/> </extension> <nameUrl value="publish.html"/> <title value="Publish"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="submit.html"/> </extension> <nameUrl value="submit.html"/> <title value="Submit"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="group.html"/> </extension> <nameUrl value="group.html"/> <title value="Groups"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="authorization.html"/> </extension> <nameUrl value="authorization.html"/> <title value="SMART Backend Services Authorization"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="async.html"/> </extension> <nameUrl value="async.html"/> <title value="Asynchronous Bulk Interaction Pattern"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="abbreviations.html"/> </extension> <nameUrl value="abbreviations.html"/> <title value="Abbreviations"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="changes.html"/> </extension> <nameUrl value="changes.html"/> <title value="Change Log"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="downloads.html"/> </extension> <nameUrl value="downloads.html"/> <title value="Downloads"/> <generation value="html"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="tools.html"/> </extension> <nameUrl value="tools.html"/> <title value="Tools"/> <generation value="markdown"/> </page> <page> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="informative"/> </extension> <extension url="http://hl7.org/fhir/tools/StructureDefinition/ig-page-name"> <valueUrl value="ImplementationGuide-hl7.fhir.uv.bulkdata.html"/> </extension> <nameUrl value="ImplementationGuide-hl7.fhir.uv.bulkdata.html"/> <title value="Bulk Data Implementation Guide Resource"/> <generation value="markdown"/> </page> </page> <parameter> <code value="path-resource"/> <value value="input/capabilities"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/examples"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/extensions"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/models"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/operations"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/profiles"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/resources"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/vocabulary"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/maps"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/testing"/> </parameter> <parameter> <code value="path-resource"/> <value value="input/history"/> </parameter> <parameter> <code value="path-resource"/> <value value="fsh-generated/resources"/> </parameter> <parameter> <code value="path-pages"/> <value value="template/config"/> </parameter> <parameter> <code value="path-pages"/> <value value="input/assets"/> </parameter> <parameter> <code value="path-pages"/> <value value="input/images"/> </parameter> <parameter> <code value="path-tx-cache"/> <value value="input-cache/txcache"/> </parameter> </definition> </ImplementationGuide>

Generated Narrative: ImplementationGuide hl7.fhir.uv.bulkdata

Language: en

BulkDataAccessIG

The official URL for this implementation guide is:

http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata

FHIR based approach for exporting large data sets from a FHIR server to a client application