BulkDataAccess IG: STU1

FHIR Bulk Data Access, published by FHIR Project. This is not an authorized publication; it is the continuous build for version 1.0.0). 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: group-export

Formats: Narrative, XML, JSON

GroupLevelExport

OPERATION: GroupLevelExport

The official URL for this operation definition is:

http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export

FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified Group. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern

URL: [base]/Group/[id]/$export

Parameters

UseNameCardinalityTypeBindingDocumentation
IN_outputFormat0..1string

The format for the requested bulk data files to be generated as per FHIR Asynchronous Request Pattern. Defaults to application/fhir+ndjson.

IN_since0..1instant

Resources updated after this period will be included in the response.

IN_type0..1string

A string of comma-delimited FHIR resource types. Only resources of the specified resource types(s) SHOULD be included in the response. If this parameter is omitted, the server SHOULD return all supported resources within the scope of the client authorization. For non-system-level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned as well as other resources outside of the patient compartment that are helpful in interpreting the patient data such as Organization and Practitioner. Resource references MAY be relative URIs with the format <resource type>/<id>, or absolute URIs with the same structure rooted in the base URI for the server from which the export was performed. References will be resolved looking for a resource with the specified type and id within the file set. Note: Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the Argonaut Implementation Guide.