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
| Official URL: http://hl7.org/fhir/uv/bulkdata/OperationDefinition/patient-export | Version: 4.0.0 | ||||
| Standards status: Trial-use | Maturity Level: 5 | Computable Name: PatientLevelExport | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.74.33.7 | |||||
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 HTTP POST and the FHIR Asynchronous Bulk Interaction Pattern.
Language: en
URL: [base]/Patient/$export
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _outputFormat | 0..1 | string | Support is required for a Data Provider, optional for a Data Consumer. The format of the bulk data files generated through the FHIR Asynchronous Bulk Interaction Pattern. Defaults to | ||
| IN | _since | 0..1 | instant | Support is required for a Data Provider, optional for a Data Consumer. Resources will be included in the response if their state has changed after the supplied time (e.g., if | ||
| IN | _until | 0..1 | instant | Support is optional for a Data Provider, optional for a Data Consumer. Resources will be included in the response if their state has changed before the supplied time (e.g., if | ||
| IN | _type | 0..* | uri | ResourceType (Extensible) | Support is optional for a Data Provider, optional for a Data Consumer. The response SHALL be filtered to only include resources of the specified resource type(s), except for related resources included by the Data Provider to provide context about the resources being exported (see processing model) and additional resources included as a result of the Relative values are prefixed by To specify multiple types, multiple repetitions of this parameter are used - callers cannot use a single parameter with comma-delimited values. Note that versions 3.0.0 and earlier of this IG supplied If this parameter is omitted, the Data Provider SHALL return all supported resources within the scope of the Data Consumer's authorization, though implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the US Core Implementation Guide. For Patient- and Group-level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned. Implementers should be aware that the Patient Compartment may not include all resources associated with a patient; for example, resources associated with a patient indirectly through membership in a Group may fall outside of the Patient Compartment. However, 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). When this behavior is supported, a Data Provider SHOULD document this support (for example, as narrative text, or by including a GraphDefinition Resource). A Data Provider that is unable to support For example, a | |
| IN | _elements | 0..* | string | Support is optional for a Data Provider, optional for a Data Consumer. When provided, the Data Provider SHOULD omit unlisted, non-mandatory elements from the resources returned. Elements SHOULD be of the form A Data Provider is not obliged to return just the requested elements. A Data Provider SHOULD always return mandatory elements whether they are requested or not. For guidance on indicating that resources are being returned with omitted elements, see the FHIR specification's definition of A Data Provider that is unable to support | ||
| IN | patient | 0..* | Reference (Patient) | Support is optional for a Data Provider, optional for a Data Consumer. Not applicable to system level export requests. When provided, the Data Provider SHALL NOT return resources in the patient compartments belonging to patients outside of this list. This restriction does not apply to additional resources included as a result of the A Data Provider that is unable to support the | ||
| IN | includeAssociatedData | 0..* | Coding | Include Associated Data Value Set (Extensible) | Support is optional for a Data Provider, optional for a Data Consumer. When provided, requests the inclusion of additional resources associated with the resources otherwise selected for export. When omitted, no additional resources are included as a result of this parameter. See the A Data Provider that is unable to support the requested | |
| IN | _typeFilter | 0..* | string | Support is optional for a Data Provider, optional for a Data Consumer. String of a FHIR REST search query. When provided, a Data Provider with support for the parameter and requested search queries SHALL filter the data in the response for resource types referenced in the A Data Provider unable to support the requested | ||
| IN | organizeOutputBy | 0..1 | uri | ResourceType (Extensible) | Support is optional for a Data Provider, optional for a Data Consumer. URI of a FHIR resource type (see When provided, a Data Provider with support for the parameter SHALL organize the resources in output files by instances of the specified resource type, including a header for each resource of the type specified in the parameter, followed by the resource and resources in the output that contain references to that resource. When omitted, Data Providers SHALL organize each output file with resources of only a single type. See details, example manifest, and example output file. A Data Provider unable to structure output by the requested | |
| IN | allowPartialManifests | 0..1 | boolean | Support is optional for a Data Provider, optional for a Data Consumer. When provided, a Data Provider with support for the parameter MAY distribute the bulk data output files among multiple manifests, providing links for Data Consumers to page through the manifests (see details). Prior to all of the files in the export being available, the Data Provider MAY return a manifest with files that are available in an in-progress status response, and subsequently update the manifest with a paging link to a new manifest when additional files are ready for download (see details). |