Bulk Data Access IG
4.0.0 - STU 4 International flag

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

OperationDefinition: Bulk Submit Status Operation Definition

Official URL: http://hl7.org/fhir/uv/bulkdata/OperationDefinition/bulk-submit-status Version: 4.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: BulkSubmitStatus
Other Identifiers: OID:2.16.840.1.113883.4.642.40.74.33.3

This operation receives status updates about the submission after a Data Provider has kicked off a Bulk Submit operation. For example, the Data Consumer may indicate files it was unable to retrieve, resources that failed validation, or resources that could not be merged into an existing data set. The Data Consumer may also return processed data such as computed quality measures or de-identified versions of the submitted data. The Data Provider receives a 202 Accepted response with a Content-Location header and then polls that URL according to the FHIR Asynchronous Bulk Interaction Pattern.

Language: en

URL: [base]/$bulk-submit-status

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsubmitter1..1Identifier

SHALL match the submitter system and value supplied in the $bulk-submit request(s) for this submission.

INsubmissionId1..1string

SHALL match a submissionId previously supplied by this submitter in a $bulk-submit request.

IN_outputFormat0..1string

The format for the generated bulk data files used to return OperationOutcome resources related to the submission status and, when applicable, other resources. Servers SHALL support ndjson, and MAY 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. Defaults to application/fhir+ndjson.