description: null
package_name: io.health-samurai.core.r4b
derivation: specialization
name: BulkExportStatus
type: BulkExportStatus
elements:
  requiresAccessToken: {type: boolean, short: Whether an access token is required to download the exported files., index: 4}
  request: {type: string, short: Original request that initiated this export., index: 3}
  transactionTime: {type: dateTime, short: Time when the bulk export was initiated., index: 2}
  params:
    type: BackboneElement
    short: Parameters specified for the bulk export request.
    index: 15
    elements:
      tenant: {type: string, short: Tenant identifier for multi-tenant environments., index: 24}
      gzip?: {type: boolean, short: Whether to compress the exported files using gzip., index: 21}
      fhir?: {type: boolean, short: Whether to export in FHIR format., index: 22}
      since: {type: dateTime, short: Export only resources modified after this date., index: 16}
      group-id: {type: string, short: 'ID of the group to export data for, when export-level is ''group''.', index: 26}
      output-format:
        type: string
        short: Format of the exported data files.
        constraint:
          enum-1: {human: 'Output format must be one of: application/fhir+ndjson, application/ndjson, ndjson', severity: error, expression: '%context.subsetOf(''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'')'}
        index: 18
      output-file-ext:
        type: string
        short: File extension for the exported files.
        constraint:
          enum-2: {human: 'Output file extension must be one of: .ndjson, .ndjson.gz', severity: error, expression: '%context.subsetOf(''.ndjson'' | ''.ndjson.gz'')'}
        index: 19
      types: {type: string, short: List of resource types to include in the export., array: true, index: 23}
      patient-ids: {type: string, short: List of patient IDs to export data for., array: true, index: 25}
      export-level:
        type: string
        short: Level at which to perform the export (patient, group, or system).
        constraint:
          enum-3: {human: 'Export level must be one of: patient, group, system', severity: error, expression: '%context.subsetOf(''patient'' | ''group'' | ''system'')'}
        index: 20
      requester: {type: Reference, short: Reference to the user or client that requested the export., index: 17}
      storage:
        type: BackboneElement
        short: Storage configuration for exported files.
        index: 27
        elements:
          type:
            type: string
            short: Type of storage backend to use.
            constraint:
              enum-4: {human: 'Storage type must be one of: test-delay, test-cloud, aidbox, gcp, aws, azure', severity: error, expression: '%context.subsetOf(''test-delay'' | ''test-cloud'' | ''aidbox'' | ''gcp'' | ''aws'' | ''azure'')'}
            index: 28
          bucket: {type: string, short: Name of the storage bucket to use., index: 29}
          account: {type: Reference, short: Reference to account with credentials for accessing the storage., index: 30}
    required: [output-format, storage, output-file-ext, export-level, 'gzip?']
  output:
    type: BackboneElement
    short: Information about the exported data files.
    array: true
    index: 6
    elements:
      type: {type: string, short: FHIR resource type for this output file., index: 7}
      url: {type: string, short: URL where the client can download this output file., index: 8}
      count: {type: integer, short: Number of resources in this output file., index: 9}
  extension: {short: Additional information about the export., index: 14}
  requester: {type: Reference, short: Reference to the user or client that requested the export., index: 5}
  status:
    type: string
    short: Current status of the bulk export operation.
    constraint:
      enum-5: {human: 'Status must be one of: accepted, in-progress, completed, error, cancelled', severity: error, expression: '%context.subsetOf(''accepted'' | ''in-progress'' | ''completed'' | ''error'' | ''cancelled'')'}
    index: 1
  url: {type: string, short: URL where the client can check the export status., index: 0}
  error:
    type: BackboneElement
    short: Information about errors that occurred during export.
    array: true
    index: 10
    elements:
      type: {type: string, short: Type of the resource that caused the error., index: 11}
      url: {type: string, short: URL with detailed error information., index: 12}
      count: {type: integer, short: Number of resources that encountered errors., index: 13}
package_version: 0.2601.0
extensions: {}
class: resource
kind: resource
url: http://health-samurai.io/fhir/core/StructureDefinition/BulkExportStatus
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 0.2601.0
required: [status]