Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ExportManifest

Index

Properties

deleted?: ExportManifestFile<"Bundle">[]

An array of deleted file items following the same structure as the output array.

When a _since timestamp is supplied in the export request, this array SHALL be populated with output files containing FHIR Transaction Bundles that indicate which FHIR resources would have been returned, but have been deleted subsequent to that date. If no resources have been deleted or the _since parameter was not supplied, the server MAY omit this key or MAY return an empty array.

Each line in the output file SHALL contain a FHIR Bundle with a type of transaction which SHALL contain one or more entry items that reflect a deleted resource. In each entry, the request.url and request.method elements SHALL be populated. The request.method element SHALL be set to DELETE.

Example deleted resource bundle (represents one line in output file):

example
{
"resourceType": "Bundle",
"id": "bundle-transaction",
"meta": { "lastUpdated": "2020-04-27T02:56:00Z" },
"type": "transaction",
"entry":[{
"request": { "method": "DELETE", "url": "Patient/123" }
...
}]
}
error: ExportManifestFile<"OperationOutcome">[]

array of error file items following the same structure as the output array. Errors that occurred during the export should only be included here (not in output). If no errors occurred, the server SHOULD return an empty array. Only the OperationOutcome resource type is currently supported, so a server SHALL generate files in the same format as bulk data output files that contain OperationOutcome resources.

extension?: Record<string, any>

To support extensions, this implementation guide reserves the name extension and will never define a field with that name, allowing server implementations to use it to provide custom behavior and information. For example, a server may choose to provide a custom extension that contains a decryption key for encrypted ndjson files. The value of an extension element SHALL be a pre-coordinated JSON object.

output: ExportManifestFile<string>[]

an array of file items with one entry for each generated file. If no resources are returned from the kick-off request, the server SHOULD return an empty array.

request: string

the full URL of the original bulk data kick-off request

requiresAccessToken: boolean

indicates whether downloading the generated files requires a bearer access token. Value SHALL be true if both the file server and the FHIR API server control access using OAuth 2.0 bearer tokens. Value MAY be false for file servers that use access-control schemes other than OAuth 2.0, such as downloads from Amazon S3 bucket URLs or verifiable file servers within an organization's firewall.

transactionTime: string

indicates the server's time when the query is run. The response SHOULD NOT include any resources modified after this instant, and SHALL include any matching resources modified up to and including this instant. Note: To properly meet these constraints, a FHIR Server might need to wait for any pending transactions to resolve in its database before starting the export process.

Generated using TypeDoc