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

: Bulk Publish Operation Definition

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "bulk-publish",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition bulk-publish</b></p><a name=\"bulk-publish\"> </a><a name=\"hcbulk-publish\"> </a><p>URL: [base]/$bulk-publish</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></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2
    },
    {
      "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/bulk-publish",
  "version" : "4.0.0",
  "name" : "BulkDataPublish",
  "title" : "FHIR Bulk Data Publish",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-01-27",
  "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" : "FHIR Operation to publish bulk data files for retrieval by Data Consumers. A Data Provider responds to GET requests at a path ending in `/$bulk-publish` by returning a Bulk Data Publish Manifest containing metadata and links to available Bulk Data files. Unlike `$export`, this operation does not initiate on-demand data generation; instead, it provides access to static or periodically updated datasets published by the Data Provider. The Bulk Publish API does not require a FHIR server implementation; many Data Providers may implement it using a simple HTTP server that returns a manifest in response to GET requests.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "code" : "bulk-publish",
  "system" : true,
  "type" : false,
  "instance" : false
}