FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.bulkdata
Resource TypeOperationDefinition
IdOperationDefinition-bulk-submit-status.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/bulk-data/OperationDefinition-bulk-submit-status.html
URLhttp://hl7.org/fhir/uv/bulkdata/OperationDefinition/bulk-submit-status
Version4.0.0-ballot
Statusactive
Date2025-01-27
NameBulkSubmitStatus
TitleFHIR Bulk Data Submit Status
Realmuv
Authorityhl7
DescriptionThis 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](async.html).
Typefalse
Kindoperation

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

Generated Narrative: OperationDefinition bulk-submit-status

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsubmitter1..1Identifier

The submitter must match a system and code specified by the Data Consumer (coordinated out-of-band or in an implementation guide specific to a use case).

INsubmissionId1..1string

The value must be unique for the submitter.

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.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "bulk-submit-status",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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-submit-status",
  "version": "4.0.0-ballot",
  "name": "BulkSubmitStatus",
  "title": "FHIR Bulk Data Submit Status",
  "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": "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](async.html).",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "affectsState": true,
  "code": "bulk-submit-status",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "name": "submitter",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The submitter must match a system and code specified by the Data Consumer (coordinated out-of-band or in an implementation guide specific to a use case).",
      "type": "Identifier"
    },
    {
      "name": "submissionId",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The value must be unique for the `submitter`.",
      "type": "string"
    },
    {
      "name": "_outputFormat",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "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`.",
      "type": "string"
    }
  ]
}