Bulk Data Access IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 2.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: 2.0.0 | |||
Active as of 2021-07-29 | Computable Name: PatientLevelExport |
FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern
Generated Narrative: OperationDefinition patient-export
URL: [base]/Patient/$export
Parameters
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | _outputFormat | 0..1 | string | Support is required for a server, optional for a client. The format for the requested Bulk Data files to be generated as per FHIR Asynchronous Request Pattern. Defaults to | ||
IN | _since | 0..1 | instant | Support is required for a server, optional for a client. Resources will be included in the response if their state has changed after the supplied time (e.g., if | ||
IN | _type | 0..* | string | Support is optional for a server and a client. A string of comma-delimited FHIR resource types. The response SHALL be filtered to only include resources of the specified resource types(s). If this parameter is omitted, the server SHALL return all supported resources within the scope of the client authorization, though implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the US Core Implementation Guide. For groups of patients, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned. 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 server SHOULD document this support (for example, as narrative text, or by including a GraphDefinition Resource). A server that is unable to support For example | ||
IN | _elements | 0..* | string | Experimental - support is optional for a server and a client. String of comma-delimited FHIR Elements. When provided, the server SHOULD omit unlisted, non-mandatory elements from the resources returned. Elements SHOULD be of the form A server is not obliged to return just the requested elements. A server SHOULD always return mandatory elements whether they are requested or not. A server SHOULD mark the resources with the tag A server that is unable to support | ||
IN | patient | 0..* | Reference (Patient) | Experimental - support is optional for a server and a client. This parameter is only valid in kickoff requests initiated through a HTTP POST request. When provided, the server SHALL NOT return resources in the patient compartments belonging to patients outside of this list. If a client requests patients who are not present on the server or are not members of the requested group, the server SHOULD return details via a FHIR A server that is unable to support the | ||
IN | includeAssociatedData | 0..* | code | Include Associated Data Value Set (Extensible) | Experimental - support is optional for a server and a client. String of comma-delimited values. When provided, 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. A server that is unable to support the requested If multiple conflicting values are included, the server SHALL apply the least restrictive value (value that will return the largest dataset). | |
IN | _typeFilter | 0..* | string | Experimental - support is optional for a server and a client. String of comma separated FHIR REST search queries. 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. FHIR search response parameters such as A server that that is unable to support the requested |