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

• Narrative Content
• JSON

: FHIR Asynchronous Bulk Interaction Pattern Operation Definition

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "async",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition async</b></p><a name=\"async\"> </a><a name=\"hcasync\"> </a><p>URL: [base]/$async</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Support is recommended for a server, optional for a client.</p>\n<p>The format for the generated bulk data files. Defaults to <code>application/fhir+ndjson</code>. Currently, <a href=\"http://ndjson.org/\">NDJSON</a> SHALL be supported, though servers MAY also support other output formats. Servers SHALL support the full content type of <code>application/fhir+ndjson</code> as well as abbreviated representations including <code>application/ndjson</code> and <code>ndjson</code>.</p>\n<p>For request types where the server supports either the FHIR Asynchronous Bulk Interaction Pattern or the <a href=\"https://hl7.org/fhir/async-bundle.html\">Asynchronous Interaction Request Pattern</a>, requests that include the <code>_outputFormat</code> parameter SHALL trigger the FHIR Asynchronous Bulk Interaction Pattern.</p>\n</div></td></tr><tr><td>IN</td><td>_minimumFileSize</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#positiveInt\">positiveInt</a></td><td/><td><div><p>Support is optional for a server, optional for a client.</p>\n<p>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 <code>_maximumFileSize</code> constraint.</p>\n</div></td></tr><tr><td>IN</td><td>_maximumFileSize</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#positiveInt\">positiveInt</a></td><td/><td><div><p>Support is optional for a server, optional for a client.</p>\n<p>Specifies the maximum size in bytes for generated NDJSON files. The value SHALL be a positive integer and SHALL be greater than <code>_minimumFileSize</code> 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.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 5
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/async",
  "version" : "4.0.0",
  "name" : "AsynchronousBulkInteractionPattern",
  "title" : "FHIR Asynchronous Bulk Interaction Pattern",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-04-10",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [
    {
      "name" : "HL7 International / FHIR Infrastructure",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        },
        {
          "system" : "email",
          "value" : "fhir@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "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.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "code" : "async",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "_outputFormat",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Support is recommended for a server, optional for a client.\n\nThe format for the generated bulk data files. Defaults to `application/fhir+ndjson`. Currently, [NDJSON](http://ndjson.org/) 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`.\n\nFor request types where the server supports either the FHIR Asynchronous Bulk Interaction Pattern or the [Asynchronous Interaction Request Pattern](https://hl7.org/fhir/async-bundle.html), requests that include the `_outputFormat` parameter SHALL trigger the FHIR Asynchronous Bulk Interaction Pattern.",
      "type" : "string"
    },
    {
      "name" : "_minimumFileSize",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Support is optional for a server, optional for a client.\n\nSpecifies 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.",
      "type" : "positiveInt"
    },
    {
      "name" : "_maximumFileSize",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Support is optional for a server, optional for a client.\n\nSpecifies 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.",
      "type" : "positiveInt"
    }
  ]
}