Bulk Data Access IG
4.0.0-ballot - STU 4 - Ballot International flag

Bulk Data Access IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bulk-data/ and changes regularly. See the Directory of published versions

Logical Model: Bulk Data Manifest

Official URL: http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest Version: 4.0.0-ballot
Standards status: Trial-use Maturity Level: 5 Computable Name: BulkDataManifest
Other Identifiers: OID:2.16.840.1.113883.4.642.40.74.42.1

Logical model describing a standard format to provide links to FHIR Bulk Data files and related metadata.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BulkDataManifest 0..* Element Bulk Data Manifest

Elements defined in Ancestors:@id, extension
... manifestType 0..1 canonical() Logical model that defines this manifest
... transactionTime 1..1 instant Timestamp for the data included in this manifest
... requiresAccessToken 1..1 boolean Token required to retrieve bulk data files
... outputOrganizedBy 0..1 string Resource type used to organize output files
... outputOrganizedByDetail 0..1 string Output Organized By Detail
... output 0..* BackboneElement Output Files
.... type 0..1 string FHIR Resource Type
.... url 1..1 url File URL
.... continuesInFile 0..1 url Continuation File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... deleted 0..* BackboneElement Deleted Resource Files
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... outcome 0..* BackboneElement Outcome Files
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
.... countSeverity 0..* BackboneElement Count by severity
..... code 1..1 code Severity
Binding: IssueSeverity (required)
..... count 1..1 integer Count
... link C 0..* BackboneElement Paging links
Constraints: bdm-link-relation-next
.... relation 1..1 string Relation
.... url 1..1 url Link URL

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BulkDataManifest.outcome.​countSeverity.code Base required IssueSeverity 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdm-link-relation-next error BulkDataManifest.link Manifest links SHALL use a relation value of 'next'. relation = 'next'
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BulkDataManifest 0..* Element Bulk Data Manifest

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... manifestType 0..1 canonical() Logical model that defines this manifest
... requiresAccessToken 1..1 boolean Token required to retrieve bulk data files
... outputFormat 0..1 string MIME type of the referenced bulk data files
... outputOrganizedBy 0..1 string Resource type used to organize output files
... outputOrganizedByDetail 0..1 string Output Organized By Detail
... output 0..* BackboneElement Output Files
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 string FHIR Resource Type
.... url 1..1 url File URL
.... continuesInFile 0..1 url Continuation File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... deleted 0..* BackboneElement Deleted Resource Files
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... outcome 0..* BackboneElement Outcome Files
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
.... countSeverity 0..* BackboneElement Count by severity
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Severity
Binding: IssueSeverity (required)
..... count 1..1 integer Count
... link C 0..* BackboneElement Paging links
Constraints: bdm-link-relation-next
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation 1..1 string Relation
.... url 1..1 url Link URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BulkDataManifest.outcome.​countSeverity.code Base required IssueSeverity 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdm-link-relation-next error BulkDataManifest.link Manifest links SHALL use a relation value of 'next'. relation = 'next'
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(9 nested mandatory elements)

Maturity: 5

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BulkDataManifest 0..* Element Bulk Data Manifest

Elements defined in Ancestors:@id, extension
... manifestType 0..1 canonical() Logical model that defines this manifest
... transactionTime 1..1 instant Timestamp for the data included in this manifest
... requiresAccessToken 1..1 boolean Token required to retrieve bulk data files
... outputOrganizedBy 0..1 string Resource type used to organize output files
... outputOrganizedByDetail 0..1 string Output Organized By Detail
... output 0..* BackboneElement Output Files
.... type 0..1 string FHIR Resource Type
.... url 1..1 url File URL
.... continuesInFile 0..1 url Continuation File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... deleted 0..* BackboneElement Deleted Resource Files
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... outcome 0..* BackboneElement Outcome Files
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
.... countSeverity 0..* BackboneElement Count by severity
..... code 1..1 code Severity
Binding: IssueSeverity (required)
..... count 1..1 integer Count
... link C 0..* BackboneElement Paging links
Constraints: bdm-link-relation-next
.... relation 1..1 string Relation
.... url 1..1 url Link URL

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
BulkDataManifest.outcome.​countSeverity.code Base required IssueSeverity 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdm-link-relation-next error BulkDataManifest.link Manifest links SHALL use a relation value of 'next'. relation = 'next'

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BulkDataManifest 0..* Element Bulk Data Manifest

Elements defined in Ancestors:@id, extension
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... manifestType 0..1 canonical() Logical model that defines this manifest
... requiresAccessToken 1..1 boolean Token required to retrieve bulk data files
... outputFormat 0..1 string MIME type of the referenced bulk data files
... outputOrganizedBy 0..1 string Resource type used to organize output files
... outputOrganizedByDetail 0..1 string Output Organized By Detail
... output 0..* BackboneElement Output Files
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 string FHIR Resource Type
.... url 1..1 url File URL
.... continuesInFile 0..1 url Continuation File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... deleted 0..* BackboneElement Deleted Resource Files
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
... outcome 0..* BackboneElement Outcome Files
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... url 1..1 url File URL
.... count 0..1 integer Resource Count
.... fileSize 0..1 integer File Size
.... countSeverity 0..* BackboneElement Count by severity
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Severity
Binding: IssueSeverity (required)
..... count 1..1 integer Count
... link C 0..* BackboneElement Paging links
Constraints: bdm-link-relation-next
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation 1..1 string Relation
.... url 1..1 url Link URL

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
BulkDataManifest.outcome.​countSeverity.code Base required IssueSeverity 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdm-link-relation-next error BulkDataManifest.link Manifest links SHALL use a relation value of 'next'. relation = 'next'
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(9 nested mandatory elements)

Maturity: 5

 

Other representations of profile: CSV, Excel