This
page
is
part
of
the
FHIR
Specification
v6.0.0-ballot3:
v6.0.0-ballot4:
Release
6
Ballot
(3rd
Draft)
(1st
Full
Ballot)
(see
Ballot
Notes
).
The
current
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
for
published
versions
FHIR
Infrastructure
Work
Group
|
|
Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/document-bundle
This profile holds all the requirements and constraints related to a FHIR document.
This profile was published on Wed, Mar 11, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - FHIR Core WG.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from Bundle .
Summary
Mandatory:
7
elements
Fixed
Value:
1
element
Prohibited:
5
elements
This indicates the differences between this profile and the base Bundle structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
0 .. * | Bundle | Represents a FHIR document | |
|
1.. 1 | Identifier | Persistent identifier for the bundle | |
|
1.. 1 | uri | The namespace for the identifier value | |
|
1.. 1 | string | The value that is unique | |
|
1 .. 1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Fixed Value: document |
|
|
1.. 1 | instant | When the bundle was assembled | |
|
0 .. 0 | Total matches across all pages | ||
|
1.. * | BackboneElement | Entry in the bundle - will have a resource or information | |
|
1.. 1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
|
1.. 1 | Resource | A resource in the bundle | |
|
0 .. 0 | Search related information | ||
|
0 .. 0 | Additional execution information (transaction/batch/history) | ||
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. 0 | OperationOutcome with issues about the Bundle | ||
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Bundle structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
0..* | Bundle |
Represents
a
FHIR
document
|
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required
|
|||||
|
Σ
C
|
1..1 | Identifier | Persistent identifier for the bundle | ||||
|
0..1 |
|
Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
|||||
|
?! Σ | 0..1 | code |
usual
|
official
|
temp
|
secondary
|
old
(If
known)
Binding: IdentifierUse ( required |
||||
|
Σ | 0..1 | CodeableConcept |
Description
of
identifier
Binding: Identifier Type Codes ( extensible |
||||
|
Σ | 1..1 | uri |
The
namespace
for
the
identifier
value
Example General: http://www.acme.com/identifiers/patient |
||||
|
Σ
C
|
1..1 | string |
The
value
that
is
unique
Example General: 123456 |
||||
|
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|
Σ | 0..1 | Reference ( Organization ) | Organization that issued id (may be just text) | ||||
|
Σ
C
|
1..1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Binding: Bundle Type ( required Fixed Value: document |
||||
|
Σ
C
|
1..1 | instant | When the bundle was assembled | ||||
|
Σ
C
|
0..* | BackboneElement |
Links
related
to
this
Bundle
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ
C
|
1..1 | code |
See
http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: Link Relation Types ( required ) |
||||
|
Σ
C
|
1..1 | uri | Reference details for the link | ||||
|
Σ
C
|
1..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 0..* | See link (Bundle) |
Links
related
to
this
entry
|
||||
|
Σ
C
|
1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
|
Σ
C
|
1..1 | Resource | A resource in the bundle | ||||
|
Σ | 0..1 | Signature | Digital Signature (deprecated: use Provenance Signatures) | ||||
|
||||||||
<!-- DocumentBundle --><Bundle xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
<<implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <identifier> I 1..1 Identifier <!-- I 1..1 Persistent identifier for the bundle --> <use value="[code]"/><!-- I 0..1 usual | official | temp | secondary | old (If known) --> <type><!-- I 0..1 CodeableConcept Description of identifier --></type> <system value="[uri]"/><!-- I 1..1 The namespace for the identifier value --> <value value="[string]"/><!-- I 1..1 The value that is unique --> <period><!-- I 0..1 Period Time period when id is/was valid for use --></period> <assigner><!-- I 0..1 Reference(Organization) Organization that issued id (may be just text) --></assigner> </identifier> <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification --> <timestamp value="[instant]"/><!-- I 1..1 When the bundle was assembled --> <total value="[unsignedInt]"/><!-- I 0..0 Total matches across all pages --> <link> I 0..* BackboneElement <!-- I 0..* Links related to this Bundle --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <relation value="[code]"/><!-- I 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 --> <url value="[uri]"/><!-- I 1..1 Reference details for the link --> </link> <entry> I 1..* BackboneElement <!-- I 1..* Entry in the bundle - will have a resource or information --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link Links related to this entry --></link> <fullUrl value="[uri]"/><!-- I 1..1 URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) --> <resource><!-- 1..1 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 0..0 BackboneElement <!-- I 0..0 Additional execution information (transaction/batch/history) --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry><</signature><signature><!-- I 0..1 Signature Digital Signature (deprecated: use Provenance Signatures) --></signature> <issues><!-- 0..0 Resource OperationOutcome with issues about the Bundle --></issues> </Bundle>
{ // DocumentBundle
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"identifier" : { Identifier }, // I R! Persistent identifier for the bundle
"type" : "document", // I R!
"timestamp" : "<instant>", // I R! When the bundle was assembled
"link" : [{ BackboneElement }], // ILinks related to this Bundle
"entry" : [{ BackboneElement }], // I R! Entry in the bundle - will have a resource or information
"
"signature" : { Signature } // IDigital Signature (deprecated: use Provenance Signatures)
}
This structure is derived from Bundle .
Differential View
This indicates the differences between this profile and the base Bundle structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
0 .. * | Bundle | Represents a FHIR document | |
|
1.. 1 | Identifier | Persistent identifier for the bundle | |
|
1.. 1 | uri | The namespace for the identifier value | |
|
1.. 1 | string | The value that is unique | |
|
1 .. 1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Fixed Value: document |
|
|
1.. 1 | instant | When the bundle was assembled | |
|
0 .. 0 | Total matches across all pages | ||
|
1.. * | BackboneElement | Entry in the bundle - will have a resource or information | |
|
1.. 1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
|
1.. 1 | Resource | A resource in the bundle | |
|
0 .. 0 | Search related information | ||
|
0 .. 0 | Additional execution information (transaction/batch/history) | ||
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. 0 | OperationOutcome with issues about the Bundle | ||
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Bundle structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
0..* | Bundle |
Represents
a
FHIR
document
|
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required
|
|||||
|
Σ
C
|
1..1 | Identifier | Persistent identifier for the bundle | ||||
|
0..1 |
|
Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
|||||
|
?! Σ | 0..1 | code |
usual
|
official
|
temp
|
secondary
|
old
(If
known)
Binding: IdentifierUse ( required |
||||
|
Σ | 0..1 | CodeableConcept |
Description
of
identifier
Binding: Identifier Type Codes ( extensible |
||||
|
Σ | 1..1 | uri |
The
namespace
for
the
identifier
value
Example General: http://www.acme.com/identifiers/patient |
||||
|
Σ
C
|
1..1 | string |
The
value
that
is
unique
Example General: 123456 |
||||
|
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
|
Σ | 0..1 | Reference ( Organization ) | Organization that issued id (may be just text) | ||||
|
Σ
C
|
1..1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Binding: Bundle Type ( required Fixed Value: document |
||||
|
Σ
C
|
1..1 | instant | When the bundle was assembled | ||||
|
Σ
C
|
0..* | BackboneElement |
Links
related
to
this
Bundle
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ
C
|
1..1 | code |
See
http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: Link Relation Types ( required ) |
||||
|
Σ
C
|
1..1 | uri | Reference details for the link | ||||
|
Σ
C
|
1..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
Σ | 0..* | See link (Bundle) |
Links
related
to
this
entry
|
||||
|
Σ
C
|
1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
|
Σ
C
|
1..1 | Resource | A resource in the bundle | ||||
|
Σ | 0..1 | Signature | Digital Signature (deprecated: use Provenance Signatures) | ||||
|
||||||||
XML Template
<!-- DocumentBundle --><Bundle xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
<<implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <identifier> I 1..1 Identifier <!-- I 1..1 Persistent identifier for the bundle --> <use value="[code]"/><!-- I 0..1 usual | official | temp | secondary | old (If known) --> <type><!-- I 0..1 CodeableConcept Description of identifier --></type> <system value="[uri]"/><!-- I 1..1 The namespace for the identifier value --> <value value="[string]"/><!-- I 1..1 The value that is unique --> <period><!-- I 0..1 Period Time period when id is/was valid for use --></period> <assigner><!-- I 0..1 Reference(Organization) Organization that issued id (may be just text) --></assigner> </identifier> <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification --> <timestamp value="[instant]"/><!-- I 1..1 When the bundle was assembled --> <total value="[unsignedInt]"/><!-- I 0..0 Total matches across all pages --> <link> I 0..* BackboneElement <!-- I 0..* Links related to this Bundle --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <relation value="[code]"/><!-- I 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 --> <url value="[uri]"/><!-- I 1..1 Reference details for the link --> </link> <entry> I 1..* BackboneElement <!-- I 1..* Entry in the bundle - will have a resource or information --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link Links related to this entry --></link> <fullUrl value="[uri]"/><!-- I 1..1 URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) --> <resource><!-- 1..1 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 0..0 BackboneElement <!-- I 0..0 Additional execution information (transaction/batch/history) --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry><</signature><signature><!-- I 0..1 Signature Digital Signature (deprecated: use Provenance Signatures) --></signature> <issues><!-- 0..0 Resource OperationOutcome with issues about the Bundle --></issues> </Bundle>
JSON Template
{ // DocumentBundle
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"identifier" : { Identifier }, // I R! Persistent identifier for the bundle
"type" : "document", // I R!
"timestamp" : "<instant>", // I R! When the bundle was assembled
"link" : [{ BackboneElement }], // ILinks related to this Bundle
"entry" : [{ BackboneElement }], // I R! Entry in the bundle - will have a resource or information
"
"signature" : { Signature } // IDigital Signature (deprecated: use Provenance Signatures)
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Bundle.language | All Languages | required | All Languages |
| Bundle.identifier.use | IdentifierUse | required | IdentifierUse |
| Bundle.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Bundle.type | Bundle Type | required | Bundle Type |
| Bundle.link.relation | Link Relation Types | required | Link Relation Types |
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method |
|
required |
|