Bulk Module Resources

Resources for configuration and management Aidbox Bulk operations.

BulkExportStatus

NameCard.TypeDescription
BulkExportStatus
error
0..*
BackboneElement

Information about errors that occurred during export.

type
0..1
string

Type of the resource that caused the error.

url
0..1
string

URL with detailed error information.

count
0..1
integer

Number of resources that encountered errors.

extension
0..1

Additional information about the export.

output
0..*

Information about the exported data files.

type
0..1
string

FHIR resource type for this output file.

url
0..1
string

URL where the client can download this output file.

count
0..1
integer

Number of resources in this output file.

params
0..1
BackboneElement

Parameters specified for the bulk export request.

since
0..1
dateTime

Export only resources modified after this date.

requester
0..1
Reference

Reference to the user or client that requested the export.

output-format
0..1
string

Format of the exported data files.

Allowed values: application/fhir+ndjson | application/ndjson+fhir | application/ndjson | ndjson | application/fhir+ndjson+gzip | application/fhir+gzip+ndjson | application/ndjson+fhir+gzip | application/ndjson+gzip+fhir | application/gzip+fhir+ndjson | application/gzip+ndjson+fhir

storage
0..1
BackboneElement

Storage configuration for exported files.

type
0..1
string

Type of storage backend to use.

Allowed values: test-delay | test-cloud | aidbox | gcp | aws | azure

bucket
0..1
string

Name of the storage bucket to use.

account
0..1
Reference

Reference to account with credentials for accessing the storage.

output-file-ext
0..1
string

File extension for the exported files.

Allowed values: .ndjson | .ndjson.gz

fhir?
0..1
boolean

Whether to export in FHIR format.

types
0..*
string

List of resource types to include in the export.

tenant
0..1
string

Tenant identifier for multi-tenant environments.

patient-ids
0..*
string

List of patient IDs to export data for.

export-level
0..1
string

Level at which to perform the export (patient, group, or system).

Allowed values: patient | group | system

gzip?
0..1
boolean

Whether to compress the exported files using gzip.

group-id
0..1
string

ID of the group to export data for, when export-level is 'group'.

request
0..1
string

Original request that initiated this export.

requester
0..1
Reference

Reference to the user or client that requested the export.

requiresAccessToken
0..1
boolean

Whether an access token is required to download the exported files.

status
0..1
string

Current status of the bulk export operation.

Allowed values: accepted | in-progress | completed | error | cancelled

transactionTime
0..1
dateTime

Time when the bulk export was initiated.

url
0..1
string

URL where the client can check the export status.

BulkImportStatus

NameCard.TypeDescription
BulkImportStatus
_source
0..1
string

System Property. DO NOT USE IT.

contentEncoding
0..1
string

Encoding of the imported content (gzip or plain).

Allowed values: gzip | plain

inputFormat
0..1
string

Format of the input data files.

Allowed values: application/fhir+ndjson

inputs
0..*
BackboneElement

Information about input files processed during import.

time
0..1
integer

Time taken to process this input file in milliseconds.

resourceType
1..1
string

Type of resources contained in this input file.

url
0..1
string

Url of imported file.

ts
0..1
dateTime

Time when the import operation completed.

total
0..1
integer

Total number of imported resources

status
0..1
string

Import progress status

duration
0..1
integer

Import duration time

mode
0..1
string

Mode of import operation (bulk or transaction).

Allowed values: bulk | transaction

source
0..1
string

Source location of the imported data.

status
0..1
string

Current status of the import operation.

Allowed values: active | failed | cancelled | finished

storageDetail
0..1
BackboneElement

Details about the storage used for the import.

type
0..1
string

Allowed values: file | https

time
0..1
BackboneElement

Timing information for the import operation.

end
0..1
dateTime

Time when the import operation completed.

start
0..1
dateTime

Time when the import operation started.

type
0..1
string

Type of data being imported (aidbox or fhir).

Allowed values: aidbox | fhir

update
0..1
boolean

Whether to update existing resources during import.

DisabledIndex

NameCard.TypeDescription
DisabledIndex
indexdef
0..1
string

SQL definition of the index.

indexname
0..1
string

Name of the database index that has been disabled.

restore
0..1
BackboneElement

Information about the index restoration process.

start
0..1
dateTime

Time when the index restoration started.

end
0..1
dateTime

Time when the index restoration completed.

duration
0..1
integer

Duration of the index restoration in milliseconds.

schemaname
0..1
string

Name of the database schema containing the index.

status
0..1
string

Current status of the index (restored or disabled).

Allowed values: restored | disabled

tablename
0..1
string

Name of the table associated with this index.

tablespace
0..1
string

Tablespace where the index is stored.

LoaderFile

NameCard.TypeDescription
LoaderFile
bucket
0..1
string

Storage bucket where the file is located.

end
0..1
dateTime

Time when the file loading process completed.

error
0..1
BackboneElement

Information about errors encountered during file loading.

source
0..1
string

Source of the error.

Allowed values: postgres | aws | aidbox

code
0..1
string

Error code or identifier.

file
0..1
string

Path or name of the file being loaded.

last-modified
0..1
string

Last modification timestamp of the file.

loaded
0..1
integer

Number of resources successfully loaded from this file.

message
0..1
string

Status or error message related to the file loading process.

size
0..1
number

Size of the file in bytes.

start
0..1
dateTime

Time when the file loading process started.

status
0..1
string

Current status of the file loading process.

Allowed values: pending | in-progress | done | error | skiped

type
0..1
string

Type of the file or contained resources.