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
| Official URL: http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-submit | Version: 4.0.0 | ||||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: BulkSubmitCapabilityStatement | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.74.13.4 | |||||
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.
Raw OpenAPI-Swagger Definition file | Download
Language: en
application/fhir+jsonNote to Implementers: FHIR Capabilities
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.
serverThese 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.
Data Consumers SHOULD implement OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Profile. Implementations MAY include non-RESTful services that use authorization schemes other than OAuth 2.0, such as mutual TLS or signed URLs.
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $bulk-submit | 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. |
| SHALL | $bulk-submit-status | FHIR Operation invoked by a Data Provider, using the FHIR Asynchronous Bulk Interaction Pattern, to retrieve a Bulk Submit Status manifest describing the processing of a submission. |