FHIR IG Statistics: OperationDefinition/bulk-export

Resources that use this resource

Resources that this resource uses

No resources found

Narrative

No narrative content found in resource

Source

{
  "resourceType": "OperationDefinition",
  "id": "bulk-export",
  "text": {
    "status": "extensions"
  },
  "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/OperationDefinition/bulk-export",
  "name": "BulkDataExport",
  "title": "FHIR Bulk Data System Level Export",
  "status": "draft",
  "kind": "operation",
  "publisher": "Canada Health Infoway",
  "contact": [
    {
      "name": "Canada Health Infoway",
      "telecom": [
        {
          "system": "email",
          "value": "interoperability@infoway-inforoute.ca"
        }
      ]
    }
  ],
  "description": "FHIR Operation to export data from a FHIR server whether or not it is associated with a patient. This supports use cases like backing up a server, or exporting terminology data by restricting the resources returned using the _type parameter. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html)",
  "code": "export",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "name": "_outputFormat",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Support is required for a server, optional for a client. The format for the requested Bulk Data files to be generated as per [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html). Defaults to `application/fhir+ndjson`. The server SHALL support [Newline Delimited JSON](http://ndjson.org), but MAY choose to support additional output formats. The server SHALL accept the full content type of `application/fhir+ndjson` as well as the abbreviated representations `application/ndjson` and `ndjson`.",
      "type": "string"
    },
    {
      "name": "_since",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Support is required for a server, optional for a client. Resources will be included in the response if their state has changed after the supplied time (e.g., if `Resource.meta.lastUpdated` is later than the supplied `_since` time). For resources where the server does not maintain a last updated time, the server MAY include these resources in a response irrespective of the `_since` value supplied by a client.",
      "type": "instant"
    },
    {
      "name": "_type",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Support is optional for server and a client.\n\nA string of comma-delimited FHIR resource types.\n\nThe response SHALL be filtered to only include resources of the specified resource types(s).\n\nIf this parameter is omitted, the server SHALL return all supported resources within the scope of the client authorization, though implementations MAY limit the resources returned to specific subsets of FHIR.\n\nA server that is unable to support `_type` SHOULD return an error and FHIR `OperationOutcome` resource so the client can re-submit a request omitting the `_type` parameter. If the client explicitly asks for export of resources that the Bulk Data server doesn't support, or asks for only resource types that are outside the Patient Compartment, the server SHOULD return details via a FHIR `OperationOutcome` resource in an error response to the request. When a `Prefer: handling=lenient` header is included in the request, the server MAY process the request instead of returning an error.\n\nFor example `_type=Observation` could be used to filter a given export response to return only FHIR `Observation` resources.",
      "type": "string"
    }
  ]
}