Bulk Data Access IG
4.0.0-ballot - STU 4 Ballot International flag

This page is part of the FHIR Bulk Data Access (Flat FHIR) (v4.0.0-ballot: STU 4 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 3.0.0. For a full list of available versions, see the Directory of published versions

OperationDefinition: FHIR Asynchronous Bulk Interaction Pattern Operation Definition

Official URL: http://hl7.org/fhir/uv/bulkdata/OperationDefinition/async Version: 4.0.0-ballot
Standards status: Trial-use Maturity Level: 5 Computable Name: AsynchronousBulkInteractionPattern
Other Identifiers: OID:2.16.840.1.113883.4.642.40.74.33.1

Common kick-off request parameters for operations and defined interactions that implement the FHIR Asynchronous Bulk Interaction Pattern. This pattern supports asynchronous generation of large FHIR datasets and is triggered by the Prefer: respond-async header on the underlying request.

Language: en

URL: [base]/$async

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
IN_outputFormat0..1string

Support is recommended for a server, optional for a client.

The format for the generated bulk data files. Defaults to application/fhir+ndjson. Currently, NDJSON SHALL be supported, though servers MAY also support other output formats. Servers SHALL support the full content type of application/fhir+ndjson as well as abbreviated representations including application/ndjson and ndjson.

For request types where the server supports either the FHIR Asynchronous Bulk Interaction Pattern or the Asynchronous Interaction Request Pattern, requests that include the _outputFormat parameter SHALL trigger the FHIR Asynchronous Bulk Interaction Pattern.

IN_minimumFileSize0..1positiveInt

Support is optional for a server, optional for a client.

Specifies the minimum size in bytes for generated NDJSON files. The value SHALL be a positive integer. If a server supports this parameter, it SHOULD construct files that meet or exceed this size unless doing so would violate the _maximumFileSize constraint.

IN_maximumFileSize0..1positiveInt

Support is optional for a server, optional for a client.

Specifies the maximum size in bytes for generated NDJSON files. The value SHALL be a positive integer and SHALL be greater than _minimumFileSize if both are specified. If a server supports this parameter, it SHALL construct files that do not exceed this size. The server MAY use a lower internal maximum.