Bulk Data Access IG
1.1.0 - STU 2 Ballot
Bulk Data Access IG
1.1.0 - STU 2 Ballot
This page is part of the FHIR Bulk Data Access (Flat FHIR) (v1.1.0: STU 2 (FHIR R4) Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.1. For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "OperationDefinition",
"id" : "export",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>BulkDataExport</h2><p>OPERATION: BulkDataExport</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export</pre><div><p>Export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the <a href=\"http://hl7.org/fhir/async.html\">FHIR Asynchronous Request Pattern</a></p>\n</div><p>URL: [base]/$export</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>_outputFormat</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The format for the requested bulk data files to be generated. Defaults to <code>application/fhir+ndjson</code>.</p>\n</div></td></tr><tr><td>IN</td><td>_since</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td><div><p>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 <code>_since</code> time).</p>\n</div></td></tr><tr><td>IN</td><td>_type</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A string of comma-delimited FHIR resource types. The response SHALL be filtered to only include resources of the specified resource types(s).</p>\n</div></td></tr><tr><td>IN</td><td>_elements</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Experimental. String of comma-delimited FHIR Elements. The server SHOULD omit unlisted, non-mandatory elements from the resources returned. Elements should be of the form <code>[resource type].[element name]</code> (eg. <code>Patient.id</code>) or <code>[element name]</code> (eg. <code>id</code>) and only root elements in a resource are permitted. If the resource type is omitted, the element should be returned for all resources in the response where it is applicable.</p>\n<p>Servers are not obliged to return just the requested elements. Servers SHOULD always return mandatory elements whether they are requested or not. Servers SHOULD mark the resources with the tag SUBSETTED to ensure that the incomplete resource is not actually used to overwrite a complete resource.</p>\n</div></td></tr><tr><td>IN</td><td>includeAssociatedData</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-include-associated-data.html\">http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data</a> (Extensible)</td><td><div><p>Experimental. Servers with support for the requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request.</p>\n</div></td></tr><tr><td>IN</td><td>_typeFilter</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Experimental. String of comma separated FHIR REST search queries. Servers with support for the requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria.</p>\n</div></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export",
"version" : "1.1.0",
"name" : "BulkDataExport",
"title" : "FHIR Bulk Data System Level Export",
"status" : "active",
"kind" : "operation",
"date" : "2020-08-16",
"publisher" : "HL7 International - FHIR Infrastructure Work Group",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"description" : "Export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html)",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"code" : "export",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "_outputFormat",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The format for the requested bulk data files to be generated. Defaults to `application/fhir+ndjson`.",
"type" : "string"
},
{
"name" : "_since",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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).",
"type" : "instant"
},
{
"name" : "_type",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A string of comma-delimited FHIR resource types. The response SHALL be filtered to only include resources of the specified resource types(s).",
"type" : "string"
},
{
"name" : "_elements",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Experimental. String of comma-delimited FHIR Elements. The server SHOULD omit unlisted, non-mandatory elements from the resources returned. Elements should be of the form `[resource type].[element name]` (eg. `Patient.id`) or `[element name]` (eg. `id`) and only root elements in a resource are permitted. If the resource type is omitted, the element should be returned for all resources in the response where it is applicable.\n\nServers are not obliged to return just the requested elements. Servers SHOULD always return mandatory elements whether they are requested or not. Servers SHOULD mark the resources with the tag SUBSETTED to ensure that the incomplete resource is not actually used to overwrite a complete resource.",
"type" : "string"
},
{
"name" : "includeAssociatedData",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Experimental. Servers with support for the requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request.",
"type" : "code",
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data"
}
},
{
"name" : "_typeFilter",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Experimental. String of comma separated FHIR REST search queries. Servers with support for the requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria.",
"type" : "string"
}
]
}
IG © 2021 HL7 International - FHIR Infrastructure Work Group and Boston Children's Hospital Package hl7.fhir.uv.bulkdata#1.1.0 based on FHIR 4.0.1. Generated 2021-04-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change