description: Logical model describing a standard format to provide links to FHIR Bulk Data files and related metadata.
package_name: hl7.fhir.uv.bulkdata
derivation: specialization
name: BulkDataManifest
type: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest
elements:
  requiresAccessToken: {type: boolean, short: Token required to retrieve bulk data files, index: 2}
  deleted:
    type: BackboneElement
    short: Deleted Resource Files
    array: true
    index: 12
    elements:
      url: {type: url, short: File URL, index: 13}
      count: {type: integer, short: Resource Count, index: 14}
      fileSize: {type: integer, short: File Size, index: 15}
    required: [url]
  outputOrganizedByDetail: {type: string, short: Output Organized By Detail, index: 5}
  transactionTime: {type: instant, short: Timestamp for the data included in this manifest, index: 1}
  outcome:
    type: BackboneElement
    short: Outcome Files
    array: true
    index: 16
    elements:
      url: {type: url, short: File URL, index: 17}
      count: {type: integer, short: Resource Count, index: 18}
      fileSize: {type: integer, short: File Size, index: 19}
      countSeverity:
        type: BackboneElement
        short: Count by severity
        array: true
        index: 20
        elements:
          code:
            type: code
            short: Severity
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/issue-severity'}
            index: 21
          count: {type: integer, short: Count, index: 22}
        required: [count, code]
    required: [url]
  output:
    type: BackboneElement
    short: Output Files
    array: true
    index: 6
    elements:
      type: {type: string, short: FHIR Resource Type, index: 7}
      url: {type: url, short: File URL, index: 8}
      continuesInFile: {type: url, short: Continuation File URL, index: 9}
      count: {type: integer, short: Resource Count, index: 10}
      fileSize: {type: integer, short: File Size, index: 11}
    required: [url]
  outputFormat: {type: string, short: MIME type of the referenced bulk data files, index: 3}
  outputOrganizedBy: {type: string, short: Resource type used to organize output files, index: 4}
  link:
    type: BackboneElement
    short: Paging links
    constraint:
      bdm-link-relation-next: {human: Manifest links SHALL use a relation value of 'next'., source: 'http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest', severity: error, expression: relation = 'next'}
    array: true
    index: 23
    elements:
      relation: {type: string, short: Relation, index: 24}
      url: {type: url, short: Link URL, index: 25}
    required: [url, relation]
  manifestType: {type: canonical, short: Logical model that defines this manifest, index: 0}
package_version: 4.0.0-ballot
class: logical
kind: logical
url: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest
base: http://hl7.org/fhir/StructureDefinition/Element
version: 4.0.0-ballot
required: [transactionTime, requiresAccessToken]