{
"description": null,
"_filename": "StructureDefinition-BulkExportStatus.json",
"package_name": "io.health-samurai.core.r4",
"date": null,
"derivation": "specialization",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "BulkExportStatus",
"abstract": false,
"type": "BulkExportStatus",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2601.0",
"status": "active",
"id": "acb730d2-c184-471f-b6e9-deceb92aef00",
"kind": "resource",
"url": "http://health-samurai.io/fhir/core/StructureDefinition/BulkExportStatus",
"version": "0.2601.0",
"differential": {
"element": [ {
"id": "BulkExportStatus",
"max": "*",
"min": 0,
"path": "BulkExportStatus"
}, {
"id": "BulkExportStatus.url",
"max": "1",
"min": 0,
"path": "BulkExportStatus.url",
"type": [ {
"code": "string"
} ],
"short": "URL where the client can check the export status."
}, {
"id": "BulkExportStatus.status",
"max": "1",
"min": 1,
"path": "BulkExportStatus.status",
"type": [ {
"code": "string"
} ],
"short": "Current status of the bulk export operation.",
"constraint": [ {
"key": "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')"
} ]
}, {
"id": "BulkExportStatus.transactionTime",
"max": "1",
"min": 0,
"path": "BulkExportStatus.transactionTime",
"type": [ {
"code": "dateTime"
} ],
"short": "Time when the bulk export was initiated."
}, {
"id": "BulkExportStatus.request",
"max": "1",
"min": 0,
"path": "BulkExportStatus.request",
"type": [ {
"code": "string"
} ],
"short": "Original request that initiated this export."
}, {
"id": "BulkExportStatus.requiresAccessToken",
"max": "1",
"min": 0,
"path": "BulkExportStatus.requiresAccessToken",
"type": [ {
"code": "boolean"
} ],
"short": "Whether an access token is required to download the exported files."
}, {
"id": "BulkExportStatus.requester",
"max": "1",
"min": 0,
"path": "BulkExportStatus.requester",
"type": [ {
"code": "Reference"
} ],
"short": "Reference to the user or client that requested the export."
}, {
"id": "BulkExportStatus.output",
"max": "*",
"min": 0,
"path": "BulkExportStatus.output",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Information about the exported data files."
}, {
"id": "BulkExportStatus.output.type",
"max": "1",
"min": 0,
"path": "BulkExportStatus.output.type",
"type": [ {
"code": "string"
} ],
"short": "FHIR resource type for this output file."
}, {
"id": "BulkExportStatus.output.url",
"max": "1",
"min": 0,
"path": "BulkExportStatus.output.url",
"type": [ {
"code": "string"
} ],
"short": "URL where the client can download this output file."
}, {
"id": "BulkExportStatus.output.count",
"max": "1",
"min": 0,
"path": "BulkExportStatus.output.count",
"type": [ {
"code": "integer"
} ],
"short": "Number of resources in this output file."
}, {
"id": "BulkExportStatus.error",
"max": "*",
"min": 0,
"path": "BulkExportStatus.error",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Information about errors that occurred during export."
}, {
"id": "BulkExportStatus.error.type",
"max": "1",
"min": 0,
"path": "BulkExportStatus.error.type",
"type": [ {
"code": "string"
} ],
"short": "Type of the resource that caused the error."
}, {
"id": "BulkExportStatus.error.url",
"max": "1",
"min": 0,
"path": "BulkExportStatus.error.url",
"type": [ {
"code": "string"
} ],
"short": "URL with detailed error information."
}, {
"id": "BulkExportStatus.error.count",
"max": "1",
"min": 0,
"path": "BulkExportStatus.error.count",
"type": [ {
"code": "integer"
} ],
"short": "Number of resources that encountered errors."
}, {
"id": "BulkExportStatus.extension",
"path": "BulkExportStatus.extension",
"short": "Additional information about the export.",
"extension": [ {
"url": "http://health-samurai.io/fhir/core/StructureDefinition/custom-type",
"valueCode": "any"
} ]
}, {
"id": "BulkExportStatus.params",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Parameters specified for the bulk export request."
}, {
"id": "BulkExportStatus.params.since",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.since",
"type": [ {
"code": "dateTime"
} ],
"short": "Export only resources modified after this date."
}, {
"id": "BulkExportStatus.params.requester",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.requester",
"type": [ {
"code": "Reference"
} ],
"short": "Reference to the user or client that requested the export."
}, {
"id": "BulkExportStatus.params.output-format",
"max": "1",
"min": 1,
"path": "BulkExportStatus.params.output-format",
"type": [ {
"code": "string"
} ],
"short": "Format of the exported data files.",
"constraint": [ {
"key": "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')"
} ]
}, {
"id": "BulkExportStatus.params.output-file-ext",
"max": "1",
"min": 1,
"path": "BulkExportStatus.params.output-file-ext",
"type": [ {
"code": "string"
} ],
"short": "File extension for the exported files.",
"constraint": [ {
"key": "enum-2",
"human": "Output file extension must be one of: .ndjson, .ndjson.gz",
"severity": "error",
"expression": "%context.subsetOf('.ndjson' | '.ndjson.gz')"
} ]
}, {
"id": "BulkExportStatus.params.export-level",
"max": "1",
"min": 1,
"path": "BulkExportStatus.params.export-level",
"type": [ {
"code": "string"
} ],
"short": "Level at which to perform the export (patient, group, or system).",
"constraint": [ {
"key": "enum-3",
"human": "Export level must be one of: patient, group, system",
"severity": "error",
"expression": "%context.subsetOf('patient' | 'group' | 'system')"
} ]
}, {
"id": "BulkExportStatus.params.gzip?",
"max": "1",
"min": 1,
"path": "BulkExportStatus.params.gzip?",
"type": [ {
"code": "boolean"
} ],
"short": "Whether to compress the exported files using gzip."
}, {
"id": "BulkExportStatus.params.fhir?",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.fhir?",
"type": [ {
"code": "boolean"
} ],
"short": "Whether to export in FHIR format."
}, {
"id": "BulkExportStatus.params.types",
"max": "*",
"min": 0,
"path": "BulkExportStatus.params.types",
"type": [ {
"code": "string"
} ],
"short": "List of resource types to include in the export."
}, {
"id": "BulkExportStatus.params.tenant",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.tenant",
"type": [ {
"code": "string"
} ],
"short": "Tenant identifier for multi-tenant environments."
}, {
"id": "BulkExportStatus.params.patient-ids",
"max": "*",
"min": 0,
"path": "BulkExportStatus.params.patient-ids",
"type": [ {
"code": "string"
} ],
"short": "List of patient IDs to export data for."
}, {
"id": "BulkExportStatus.params.group-id",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.group-id",
"type": [ {
"code": "string"
} ],
"short": "ID of the group to export data for, when export-level is 'group'."
}, {
"id": "BulkExportStatus.params.storage",
"max": "1",
"min": 1,
"path": "BulkExportStatus.params.storage",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Storage configuration for exported files."
}, {
"id": "BulkExportStatus.params.storage.type",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.storage.type",
"type": [ {
"code": "string"
} ],
"short": "Type of storage backend to use.",
"constraint": [ {
"key": "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')"
} ]
}, {
"id": "BulkExportStatus.params.storage.bucket",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.storage.bucket",
"type": [ {
"code": "string"
} ],
"short": "Name of the storage bucket to use."
}, {
"id": "BulkExportStatus.params.storage.account",
"max": "1",
"min": 0,
"path": "BulkExportStatus.params.storage.account",
"type": [ {
"code": "Reference"
} ],
"short": "Reference to account with credentials for accessing the storage."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}