FHIR IG analytics

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

No narrative content found in resource

Source1

{
  "description": "Status and progress of a FHIR Bulk Export operation.",
  "derivation": "specialization",
  "publisher": "Health Samurai",
  "fhirVersion": "4.3.0",
  "name": "BulkExportStatus",
  "abstract": false,
  "type": "BulkExportStatus",
  "resourceType": "StructureDefinition",
  "title": "Bulk Export Status",
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Workflow.Bulk"
    }
  ],
  "status": "active",
  "id": "BulkExportStatus",
  "kind": "resource",
  "url": "http://health-samurai.io/fhir/core/StructureDefinition/BulkExportStatus",
  "version": "0.2606.2",
  "differential": {
    "element": [
      {
        "id": "BulkExportStatus",
        "path": "BulkExportStatus",
        "min": 0,
        "max": "*"
      },
      {
        "id": "BulkExportStatus.url",
        "path": "BulkExportStatus.url",
        "short": "URL where the client can check the export status.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.status",
        "path": "BulkExportStatus.status",
        "short": "Current status of the bulk export operation.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "enum-5",
            "severity": "error",
            "human": "Status must be one of: accepted, in-progress, completed, error, cancelled",
            "expression": "%context.subsetOf('accepted' | 'in-progress' | 'completed' | 'error' | 'cancelled')"
          }
        ]
      },
      {
        "id": "BulkExportStatus.transactionTime",
        "path": "BulkExportStatus.transactionTime",
        "short": "Time when the bulk export was initiated.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "BulkExportStatus.request",
        "path": "BulkExportStatus.request",
        "short": "Original request that initiated this export.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.requiresAccessToken",
        "path": "BulkExportStatus.requiresAccessToken",
        "short": "Whether an access token is required to download the exported files.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "BulkExportStatus.requester",
        "path": "BulkExportStatus.requester",
        "short": "Reference to the user or client that requested the export.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BulkExportStatus.output",
        "path": "BulkExportStatus.output",
        "short": "Information about the exported data files.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BulkExportStatus.output.type",
        "path": "BulkExportStatus.output.type",
        "short": "FHIR resource type for this output file.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.output.url",
        "path": "BulkExportStatus.output.url",
        "short": "URL where the client can download this output file.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.output.count",
        "path": "BulkExportStatus.output.count",
        "short": "Number of resources in this output file.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "BulkExportStatus.error",
        "path": "BulkExportStatus.error",
        "short": "Information about errors that occurred during export.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BulkExportStatus.error.type",
        "path": "BulkExportStatus.error.type",
        "short": "Type of the resource that caused the error.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.error.url",
        "path": "BulkExportStatus.error.url",
        "short": "URL with detailed error information.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.error.count",
        "path": "BulkExportStatus.error.count",
        "short": "Number of resources that encountered errors.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "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",
        "path": "BulkExportStatus.params",
        "short": "Parameters specified for the bulk export request.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.since",
        "path": "BulkExportStatus.params.since",
        "short": "Export only resources modified after this date.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.until",
        "path": "BulkExportStatus.params.until",
        "short": "Export only resources modified before this date.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.requester",
        "path": "BulkExportStatus.params.requester",
        "short": "Reference to the user or client that requested the export.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.output-format",
        "path": "BulkExportStatus.params.output-format",
        "short": "Format of the exported data files.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "enum-1",
            "severity": "error",
            "human": "Output format must be one of: application/fhir+ndjson, application/ndjson, ndjson",
            "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",
        "path": "BulkExportStatus.params.output-file-ext",
        "short": "File extension for the exported files.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "enum-2",
            "severity": "error",
            "human": "Output file extension must be one of: .ndjson, .ndjson.gz",
            "expression": "%context.subsetOf('.ndjson' | '.ndjson.gz')"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.export-level",
        "path": "BulkExportStatus.params.export-level",
        "short": "Level at which to perform the export (patient, group, or system).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "enum-3",
            "severity": "error",
            "human": "Export level must be one of: patient, group, system",
            "expression": "%context.subsetOf('patient' | 'group' | 'system')"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.gzip?",
        "path": "BulkExportStatus.params.gzip?",
        "short": "Whether to compress the exported files using gzip.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.fhir?",
        "path": "BulkExportStatus.params.fhir?",
        "short": "Whether to export in FHIR format.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.types",
        "path": "BulkExportStatus.params.types",
        "short": "List of resource types to include in the export.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.tenant",
        "path": "BulkExportStatus.params.tenant",
        "short": "Tenant identifier for multi-tenant environments.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.patient-ids",
        "path": "BulkExportStatus.params.patient-ids",
        "short": "List of patient IDs to export data for.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.export-elements",
        "path": "BulkExportStatus.params.export-elements",
        "short": "Element names requested via _elements. One element name per entry (not comma-separated).",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.patient-errors",
        "path": "BulkExportStatus.params.patient-errors",
        "short": "Per-patient OperationOutcome for references ignored by onPatientError=ignore. Each entry is a full OperationOutcome resource with a single warning issue describing why the reference was dropped.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "OperationOutcome"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.group-id",
        "path": "BulkExportStatus.params.group-id",
        "short": "ID of the group to export data for, when export-level is 'group'.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.organization-id",
        "path": "BulkExportStatus.params.organization-id",
        "short": "Organization ID for OrgBAC-scoped bulk export.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.type-filters",
        "path": "BulkExportStatus.params.type-filters",
        "short": "FHIR search query strings for filtering exported resources in ResourceType?params format.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.consent-strategy",
        "path": "BulkExportStatus.params.consent-strategy",
        "short": "Consent-based patient filtering strategy: opt-in or opt-out.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://health-samurai.io/fhir/core/ValueSet/consent-strategy"
        }
      },
      {
        "id": "BulkExportStatus.params.consent-profile",
        "path": "BulkExportStatus.params.consent-profile",
        "short": "Consent StructureDefinition URL used for profile filtering.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.source-org-uri",
        "path": "BulkExportStatus.params.source-org-uri",
        "short": "Source organization identifier URI (system#value) from B2B token for payer-to-payer consent actor matching.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.recipient-org-uri",
        "path": "BulkExportStatus.params.recipient-org-uri",
        "short": "Recipient organization identifier URI (system#value) from Group.managingEntity for payer-to-payer consent actor matching.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.storage",
        "path": "BulkExportStatus.params.storage",
        "short": "Storage configuration for exported files.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.storage.type",
        "path": "BulkExportStatus.params.storage.type",
        "short": "Type of storage backend to use.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "constraint": [
          {
            "key": "enum-4",
            "severity": "error",
            "human": "Storage type must be one of: test-delay, test-cloud, aidbox, gcp, aws, azure",
            "expression": "%context.subsetOf('test-delay' | 'test-cloud' | 'aidbox' | 'gcp' | 'aws' | 'azure')"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.storage.bucket",
        "path": "BulkExportStatus.params.storage.bucket",
        "short": "Name of the storage bucket to use.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.storage.storage",
        "path": "BulkExportStatus.params.storage.storage",
        "short": "Azure storage account name (for workload identity).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.storage.container",
        "path": "BulkExportStatus.params.storage.container",
        "short": "Azure container name (for workload identity).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "BulkExportStatus.params.storage.account",
        "path": "BulkExportStatus.params.storage.account",
        "short": "Reference to account with credentials for accessing the storage.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      }
    ]
  },
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}