{
  "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.",
  "_filename": "OperationDefinition-async.json",
  "package_name": "hl7.fhir.uv.bulkdata",
  "date": "2026-04-10",
  "system": true,
  "publisher": "HL7 International / FHIR Infrastructure",
  "instance": false,
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "name": "AsynchronousBulkInteractionPattern",
  "type": "false",
  "experimental": null,
  "resourceType": "OperationDefinition",
  "title": "FHIR Asynchronous Bulk Interaction Pattern",
  "package_version": "4.0.0-ballot",
  "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"
      } ]
    }
  } ],
  "status": "active",
  "id": "9405dbdb-7904-4655-945a-d5e888537a9c",
  "kind": "operation",
  "url": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/async",
  "code": "async",
  "version": "4.0.0-ballot",
  "contact": [ {
    "name": "HL7 International / FHIR Infrastructure",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fiwg",
      "system": "url"
    }, {
      "value": "fhir@lists.HL7.org",
      "system": "email"
    } ]
  } ],
  "parameter": [ {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "_outputFormat",
    "type": "string",
    "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."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "_minimumFileSize",
    "type": "positiveInt",
    "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."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "_maximumFileSize",
    "type": "positiveInt",
    "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."
  } ]
}