core.medplumclient.bulkexport
Home > @medplum/core > MedplumClient > bulkExport
MedplumClient.bulkExport() method
Performs Bulk Data Export operation request flow. See The FHIR "Bulk Data Export" for full details: https://build.fhir.org/ig/HL7/bulk-data/export.html\#bulk-data-export
Signature:
bulkExport(exportLevel?: string, resourceTypes?: string, since?: string, options?: MedplumRequestOptions): Promise<Partial<BulkDataExport>>;
Parameters
Parameter | Type | Description |
|---|---|---|
exportLevel | string | (Optional) Optional export level. Defaults to system level export. 'Group/:id' - Group of Patients, 'Patient' - All Patients. |
resourceTypes | string | (Optional) A string of comma-delimited FHIR resource types. |
since | string | (Optional) 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). |
options | (Optional) Optional fetch options. |
Returns:
Promise<Partial<BulkDataExport>>
Bulk Data Response containing links to Bulk Data files. See "Response - Complete Status" for full details: https://build.fhir.org/ig/HL7/bulk-data/export.html\#response\-\-\-complete-status