Bulk Data Access IG: STU1 Ballot #1

This page is part of the FHIR Bulk Data Access (Flat FHIR) (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

OperationDefinition: patient-export

Formats: Narrative, XML, JSON

PatientLevelExport

OPERATION: PatientLevelExport

The official URL for this operation definition is: 

http://hl7.org/fhir/us/bulkdata/OperationDefinition/patient-export

Export data from a FHIR server for all data associated with patients. This supports use cases like transmitting all data about patients or clinical care between systems

URL: [base]/Patient/$$export

Parameters

UseNameCardinalityTypeBindingDocumentation
OUT_outputFormat0..1string

The format for the requested bulk data files to be generated. Servers MUST support Newline Delimited JSON, but MAY choose to support additional output formats. Servers MUST accept the full content type of application/fhir+ndjson as well as the abbreviated representations application/ndjson and ndjson. Defaults to application/fhir+ndjson

IN_since0..1instant

Resources updated after this period will be included in the response

OUT_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