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
| Page standards status: Trial-use | Maturity Level: 2 |
{
"resourceType" : "CapabilityStatement",
"id" : "bulk-submit",
"language" : "en",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement bulk-submit</b></p><a name=\"bulk-submit\"> </a><a name=\"hcbulk-submit\"> </a><h2 id=\"title\">Bulk Submit Capability Statement</h2><ul><li>Implementation Guide Version: 4.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Published on: 2026-11-06 </li><li>Published by: HL7 International / FHIR Infrastructure </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"index.html\">http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata</a></li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>These FHIR Operations are hosted by the Data Consumer and invoked by the Data Provider to submit Bulk Data files and to retrieve the status of a submission. See <a href=\"submit.html\">Bulk Submit</a>.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Data Consumers SHOULD implement OAuth 2.0 access management in accordance with the <a href=\"authorization.html\">SMART Backend Services Authorization Profile</a>. Implementations MAY include non-RESTful services that use authorization schemes other than OAuth 2.0, such as mutual TLS or signed URLs.</p>\n</div></blockquote><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-bulk-submit.html\">$bulk-submit</a></td><td><div><p>FHIR Operation invoked by a Data Provider to submit a manifest of Bulk Data files to the Data Consumer, or to replace or cancel a submission.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-bulk-submit-status.html\">$bulk-submit-status</a></td><td><div><p>FHIR Operation invoked by a Data Provider, using the <a href=\"async.html\">FHIR Asynchronous Bulk Interaction Pattern</a>, to retrieve a Bulk Submit Status manifest describing the processing of a submission.</p>\n</div></td></tr></tbody></table></div></div></div></div></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/CapabilityStatement/bulk-submit",
"version" : "4.0.0",
"name" : "BulkSubmitCapabilityStatement",
"title" : "Bulk Submit Capability Statement",
"status" : "active",
"experimental" : false,
"date" : "2026-11-06",
"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" : "The expected capabilities of a Data Consumer actor that accepts Bulk Submit requests. In Bulk Submit, the Data Consumer hosts the Submission Server, and the Data Provider invokes the `$bulk-submit` and `$bulk-submit-status` operations to submit data and to track the processing of a submission. Systems implementing this capability statement SHOULD meet the Bulk Submit requirements set by the Bulk Data Access Implementation Guide.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+json"
],
"implementationGuide" : [
🔗 "http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata"
],
"rest" : [
{
"mode" : "server",
"documentation" : "These FHIR Operations are hosted by the Data Consumer and invoked by the Data Provider to submit Bulk Data files and to retrieve the status of a submission. See [Bulk Submit](submit.html).",
"security" : {
"description" : "Data Consumers SHOULD implement OAuth 2.0 access management in accordance with the [SMART Backend Services Authorization Profile](authorization.html). Implementations MAY include non-RESTful services that use authorization schemes other than OAuth 2.0, such as mutual TLS or signed URLs."
},
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "bulk-submit",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/bulk-submit",
"documentation" : "FHIR Operation invoked by a Data Provider to submit a manifest of Bulk Data files to the Data Consumer, or to replace or cancel a submission."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "bulk-submit-status",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/bulk-submit-status",
"documentation" : "FHIR Operation invoked by a Data Provider, using the [FHIR Asynchronous Bulk Interaction Pattern](async.html), to retrieve a Bulk Submit Status manifest describing the processing of a submission."
}
]
}
]
}