{
  "description": "The expected capabilities of a Data Provider actor (e.g., EHR systems, data warehouses, and other clinical and administrative systems that aim to interoperate by sharing large FHIR datasets) which is responsible for providing responses to requests submitted by a Data Consumer actor. Systems implementing this capability statement SHOULD meet the requirements set by the Bulk Data Access Implementation Guide. A Data Consumer MAY choose from this list to access necessary data based on use cases and other contextual requirements.",
  "_filename": "CapabilityStatement-bulk-data.json",
  "package_name": "hl7.fhir.uv.bulkdata",
  "format": [ "application/fhir+json" ],
  "date": "2021-07-29",
  "publisher": "HL7 International / FHIR Infrastructure",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "instantiates": [ "http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data" ],
  "name": "BulkDataIGCapabilityStatement",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "FHIR Bulk Data Access Implementation Guide",
  "package_version": "4.0.0-ballot",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 5
  }, {
    "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"
      } ]
    }
  } ],
  "status": "active",
  "id": "c5ae69f6-e3e5-4ca2-aa93-56a8034929a7",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata" ],
  "url": "http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data",
  "version": "4.0.0-ballot",
  "contact": [ {
    "name": "HL7 International / FHIR Infrastructure",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fiwg",
      "system": "url"
    }, {
      "value": "fhir@lists.HL7.org",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Group",
      "operation": [ {
        "name": "export",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export",
        "documentation": "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in the specified [Group](https://www.hl7.org/fhir/group.html).\n\nIf a Data Provider's FHIR server supports Group-level data export, it SHOULD support reading and searching for the `Group` resource. This enables Data Consumers to discover available groups based on stable characteristics such as `Group.identifier`.\n\nThe [Patient Compartment](https://www.hl7.org/fhir/compartmentdefinition-patient.html) SHOULD be used as a point of reference for recommended resources to be returned and, where applicable, Patient resources SHOULD be returned. Other resources outside of the patient compartment that are helpful in interpreting the patient data (such as Organization and Practitioner) MAY also be returned."
      } ]
    }, {
      "type": "Patient",
      "operation": [ {
        "name": "export",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/patient-export",
        "documentation": "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients.\n\nThe [Patient Compartment](https://www.hl7.org/fhir/compartmentdefinition-patient.html) SHOULD be used as a point of reference for recommended resources to be returned and, where applicable, Patient resources SHOULD be returned. Other resources outside of the patient compartment that are helpful in interpreting the patient data (such as Organization and Practitioner) MAY also be returned."
      } ]
    } ],
    "security": {
      "description": "Data Providers SHOULD implement OAuth 2.0 access management in accordance with the [SMART Backend Services: Authorization Guide](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": [ {
      "name": "export",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export",
      "documentation": "FHIR Operation to export data from a Data Provider's FHIR server, whether or not it is associated with a patient. This supports use cases like backing up a Data Provider's FHIR server, or exporting terminology data by restricting the resources returned using the `_type` parameter."
    } ],
    "documentation": "These FHIR Operations initiate the generation of data to which the Data Consumer is authorized, whether that be all patients, a subset (defined group) of patients, or all available data contained in a Data Provider's FHIR server.\n\nThe Data Provider's FHIR server SHALL limit the data returned to only those FHIR resources for which the Data Consumer is authorized.\n\nThe Data Provider's FHIR server SHALL support invocation of this operation using HTTP POST and the [FHIR Asynchronous Bulk Interaction Pattern](async.html). Request parameters SHALL be supplied using the FHIR [Parameters Resource](https://www.hl7.org/fhir/parameters.html). GET requests SHALL NOT be used to kick off a Bulk Data Export Operation."
  } ]
}