FHIR IG analytics

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source1

{
  "resourceType": "OperationDefinition",
  "id": "async",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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-ballot",
  "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"
    }
  ]
}