{
  "description": "FHIR based approach for exporting large data sets from a FHIR server to a client application",
  "_filename": "ig-r4.json",
  "package_name": "hl7.fhir.uv.bulkdata",
  "definition": {
    "page": {
      "page": [ {
        "title": "Bulk Data IG Home Page",
        "nameUrl": "index.html",
        "generation": "markdown"
      }, {
        "title": "Bulk Data Export",
        "nameUrl": "export.html",
        "generation": "markdown"
      }, {
        "title": "SMART Backend Services Authorization",
        "nameUrl": "authorization.html",
        "generation": "markdown"
      }, {
        "title": "Bulk Data Abbreviations",
        "nameUrl": "abbreviations.html",
        "generation": "markdown"
      }, {
        "title": "IG Change History",
        "nameUrl": "changes.html",
        "generation": "markdown"
      }, {
        "title": "Downloads",
        "nameUrl": "downloads.html",
        "generation": "html"
      } ],
      "title": "Table of Contents",
      "nameUrl": "toc.html",
      "generation": "html"
    },
    "resource": [ {
      "name": "FHIR Bulk Data Access Implementation Guide",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CapabilityStatement"
      } ],
      "reference": {
        "reference": "CapabilityStatement/bulk-data"
      },
      "description": "The expected capabilities of a FHIR Resource Server 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 the queries submitted by a FHIR Bulk Data Client actor. Systems implementing this capability statement should meet the requirements set by the Bulk Data Access Implementation Guide. A FHIR Bulk Data Client has the option of choosing from this list to access necessary data based on use cases and other contextual requirements."
    }, {
      "name": "FHIR Bulk Data System Level Export",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/export"
      },
      "description": "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/async.html)"
    }, {
      "name": "FHIR Bulk Data Group Level Export",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/group-export"
      },
      "description": "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified [Group](https://www.hl7.org/fhir/group.html). The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html)"
    }, {
      "name": "FHIR Bulk Data Patient Level Export",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "OperationDefinition"
      } ],
      "reference": {
        "reference": "OperationDefinition/patient-export"
      },
      "description": "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients. The FHIR server SHALL support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/async.html)"
    }, {
      "name": "IncludeAssociatedData",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "ValueSet"
      } ],
      "reference": {
        "reference": "ValueSet/include-associated-data"
      },
      "description": "Metadata include options for Bulk Data Access Export Operation includeAssociatedData parameter"
    }, {
      "name": "IncludeAssociatedData",
      "extension": [ {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
        "valueString": "CodeSystem"
      } ],
      "reference": {
        "reference": "CodeSystem/include-associated-data"
      },
      "description": "Metadata include options for Bulk Data Access Export Operation includeAssociatedData parameter"
    } ],
    "parameter": [ {
      "code": "copyrightyear",
      "value": "2021"
    }, {
      "code": "releaselabel",
      "value": "STU 2 Ballot"
    }, {
      "code": "path-resource",
      "value": "input\\history"
    }, {
      "code": "path-liquid",
      "value": "templates\\liquid"
    }, {
      "code": "excludexml",
      "value": "true"
    }, {
      "code": "excludettl",
      "value": "true"
    }, {
      "code": "excludemap",
      "value": "true"
    }, {
      "code": "autoload-resources",
      "value": "true"
    }, {
      "code": "path-resource",
      "value": "input/capabilities"
    }, {
      "code": "path-resource",
      "value": "input/examples"
    }, {
      "code": "path-resource",
      "value": "input/extensions"
    }, {
      "code": "path-resource",
      "value": "input/models"
    }, {
      "code": "path-resource",
      "value": "input/operations"
    }, {
      "code": "path-resource",
      "value": "input/profiles"
    }, {
      "code": "path-resource",
      "value": "input/resources"
    }, {
      "code": "path-resource",
      "value": "input/vocabulary"
    }, {
      "code": "path-resource",
      "value": "input/testing"
    }, {
      "code": "path-resource",
      "value": "input/history"
    }, {
      "code": "path-resource",
      "value": "fsh-generated/resources"
    }, {
      "code": "path-pages",
      "value": "template/config"
    }, {
      "code": "path-pages",
      "value": "input/images"
    }, {
      "code": "path-liquid",
      "value": "template/liquid"
    }, {
      "code": "path-liquid",
      "value": "input/liquid"
    }, {
      "code": "path-qa",
      "value": "temp/qa"
    }, {
      "code": "path-temp",
      "value": "temp/pages"
    }, {
      "code": "path-output",
      "value": "output"
    }, {
      "code": "path-tx-cache",
      "value": "input-cache/txcache"
    }, {
      "code": "path-suppressed-warnings",
      "value": "input/ignoreWarnings.txt"
    }, {
      "code": "path-history",
      "value": "http://hl7.org/fhir/uv/bulkdata/history.html"
    }, {
      "code": "template-html",
      "value": "template-page.html"
    }, {
      "code": "template-md",
      "value": "template-page-md.html"
    }, {
      "code": "apply-contact",
      "value": "true"
    }, {
      "code": "apply-context",
      "value": "true"
    }, {
      "code": "apply-copyright",
      "value": "true"
    }, {
      "code": "apply-jurisdiction",
      "value": "true"
    }, {
      "code": "apply-license",
      "value": "true"
    }, {
      "code": "apply-publisher",
      "value": "true"
    }, {
      "code": "apply-version",
      "value": "true"
    }, {
      "code": "active-tables",
      "value": "true"
    } ]
  },
  "date": "2021-04-16T11:36:19+10:00",
  "publisher": "HL7 International - FHIR Infrastructure Work Group",
  "fhirVersion": [ "4.0.1" ],
  "license": "CC0-1.0",
  "jurisdiction": [ {
    "coding": [ {
      "code": "001",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
    } ]
  } ],
  "name": "BulkDataAccessIG",
  "type": null,
  "experimental": "false",
  "resourceType": "ImplementationGuide",
  "title": "Bulk Data Access IG",
  "package_version": "1.1.0",
  "status": "draft",
  "id": "ba453774-40e5-4553-8dcb-634e60ff7bf0",
  "kind": null,
  "url": "http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata",
  "version": "1.1.0",
  "packageId": "hl7.fhir.uv.bulkdata",
  "contact": [ {
    "telecom": [ {
      "value": "https://www.hl7.org/Special/committees/fiwg/index.cfm",
      "system": "url"
    } ]
  } ]
}