BulkDataExport
User specific configuration for the Medplum application.
- Schema
Elements
Name | Required | Type | Description |
---|---|---|---|
status | ✓ | code | active | error | completed DetailsThe status of the request. |
requestTime | ✓ | instant | DetailsIndicates the server's time when the query is requested. |
transactionTime | instant | DetailsIndicates 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. | |
request | ✓ | uri | DetailsThe full URL of the original Bulk Data kick-off request. In the case of a POST request, this URL will not include the request parameters. |
requiresAccessToken | boolean | DetailsIndicates whether downloading the generated files requires the same authorization mechanism as the $export operation itself. | |
output | BulkDataExportOutput[] | DetailsAn 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. | |
type | ✓ | code | DetailsThe FHIR resource type that is contained in the file. |
url | ✓ | uri | DetailsThe absolute path to the file. The format of the file SHOULD reflect that requested in the _outputFormat parameter of the initial kick-off request. |
deleted | BulkDataExportDeleted[] | DetailsAn array of deleted file items following the same structure as the output array. | |
type | ✓ | code | DetailsThe FHIR resource type that is contained in the file. |
url | ✓ | uri | DetailsThe absolute path to the file. The format of the file SHOULD reflect that requested in the _outputFormat parameter of the initial kick-off request. |
error | BulkDataExportError[] | DetailsArray of message file items following the same structure as the output array. | |
type | ✓ | code | DetailsThe FHIR resource type that is contained in the file. |
url | ✓ | uri | DetailsThe absolute path to the file. The format of the file SHOULD reflect that requested in the _outputFormat parameter of the initial kick-off request. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
status | token | The name of the access policy | BulkDataExport.status |
Inherited Elements
Name | Required | Type | Description |
---|---|---|---|
id | string | Logical id of this artifact DetailsThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | DetailsThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | DetailsA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | DetailsThe base language in which the resource is written. | |
text | Narrative | Text summary of the resource, for human interpretation DetailsA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | Resource[] | Contained, inline Resources DetailsThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | Extension[] | Additional content defined by implementations DetailsMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | Extension[] | Extensions that cannot be ignored DetailsMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |