FHIR
Infrastructure
![]() |
Maturity
Level
:
|
| Security Category : Not Classified | Compartments : Not linked to any defined compartments |
![]() |
This
page
has
been
approved
as
part
of
an
ANSI
![]() |
A container for a collection of resources.
One common operation performed with resources is to gather a collection of resources into a single instance with containing context. In FHIR this is referred to as "bundling" the resources together. These resource bundles are useful for a variety of different reasons, including:
There are two ways to collect resources together for transport and persistence purposes - contained resources , and bundles. There is an important difference between the two:
In
addition
to
these
two
technical
mechanisms,
there
are
three
administrative
and
infrastructure
resources
which
also
support
grouping
of
content:
content.
These
resources
do
not
contain
resources
directly,
but
instead
use
[Reference]
to
point
to
the
grouped
resources:
These
three
resources
represent
meaningful
groupings
of
the
resources
they
refer
to
(e.g.
a
discharge
medication
List,
a
Group
of
participants
for
a
clinical
trial,
a
set
of
resources
that
form
a
signed
document),
while
a
Bundle
is
merely
is
a
container
for
resources
used
for
transfer
and
storage.
This
resource
list
is
referenced
by
measurereport
not
exhaustive;
other
resources
also
provde
grouping
functionality.
No resources refer to this resource directly.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() |
| Resource |
Contains
a
collection
of
resources
+ Rule: total only when a search or history + Rule: entry.search only when a search + Rule: entry.request mandatory for batch/transaction/history, allowed for subscription-notification, otherwise prohibited + Rule: entry.response mandatory for batch-response/transaction-response/history, allowed for subscription-notification, otherwise prohibited + Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) + Rule: A document must have an identifier with a system and a value + + + + Elements defined in Ancestors: id , meta , implicitRules , language | |
![]() ![]() ![]() | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() ![]() | Σ | 1..1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
BundleType ( Required ) |
![]() ![]() ![]() | Σ | 0..1 | instant | When the bundle was assembled |
![]() ![]() ![]() | Σ I | 0..1 | unsignedInt | If search, the total number of matches |
![]() ![]() ![]() | Σ | 0..* | BackboneElement |
Links
related
to
this
Bundle
|
![]() ![]() ![]() ![]() | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Reference details for the link |
![]() ![]() ![]() | Σ I | 0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
+ Rule: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() | Σ | 0..* | see link |
Links
related
to
this
entry
|
![]() ![]() ![]() ![]() | Σ | 0..1 | uri |
|
![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() | Σ I | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code |
match
|
include
|
outcome
-
why
this
is
in
the
result
set
SearchEntryMode ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() | Σ I | 0..1 |
BackboneElement
| Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
HTTPVerb ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant |
For
managing
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() | Σ I | 0..1 | BackboneElement |
|
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri |
The
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string |
The
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() ![]() | Σ TU | 0..1 | Signature | Digital Signature |
![]() |
UML Diagram ( Legend )
XML Template
<Bundle xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language -->
<</identifier> < <<identifier><!-- 0..1 Identifier Persistent identifier for the bundle --></identifier> <type value="[code]"/><!-- 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification --> <timestamp value="[instant]"/><!-- 0..1 When the bundle was assembled --> <total value="[unsignedInt]"/><!--0..1 If search, the total number of matches --> <link> <!-- 0..* Links related to this Bundle --> <relation value="[string]"/><!-- 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 --> <url value="[uri]"/><!-- 1..1 Reference details for the link --> </link>
<<entry> <!-- 0..* Entry in the bundle - will have a resource or information --> <link><!-- 0..* Content as for Bundle.link Links related to this entry --></link><<a href=bundle-definitions.html#Bundle.entry.fullUrl class=dict title="The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:<* Results from operations might involve resources that are not identified."> <</resource> * Results from operations might involve resources that are not identified.">fullUrl value="[uri]"/><!-- 0..1 URI for resource (Absolute URL server address or URI for UUID/OID) --> <resource><!-- 0..1 Resource A resource in the bundle --></resource> <search> <!--0..1 Search related information -->
<<mode value="[code]"/><!-- 0..1 match | include | outcome - why this is in the result set --> <score value="[decimal]"/><!-- 0..1 Search ranking (between 0 and 1) --> </search>< <<request> <!--0..1 Additional execution information (transaction/batch/history) --> <method value="[code]"/><!-- 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- 0..1 For managing cache currency -->
<<ifModifiedSince value="[instant]"/><!-- 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- 0..1 For conditional creates --> </request><<response> <!--0..1 Results of execution (transaction/batch/history) --> <status value="[string]"/><!-- 1..1 Status response code (text optional) -->
< <<location value="[uri]"/><!-- 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </response> </entry><</signature><signature><!-- 0..1 Signature Digital Signature --></signature> </Bundle>
JSON Template
{"resourceType" : "Bundle", // from Resource: id, meta, implicitRules, and language
" " ""identifier" : { Identifier }, // Persistent identifier for the bundle "type" : "<code>", // R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification "timestamp" : "<instant>", // When the bundle was assembled "total" : "<unsignedInt>", // C? If search, the total number of matches "link" : [{ // Links related to this Bundle "relation" : "<string>", // R! See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 "url" : "<uri>" // R! Reference details for the link }],""entry" : [{ // Entry in the bundle - will have a resource or information "link" : [{ Content as for Bundle.link }], // Links related to this entry"<a href=bundle-definitions.html#Bundle.entry.fullUrl class=dict title="The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:"* Results from operations might involve resources that are not identified.">fullUrl " * Results from operations might involve resources that are not identified.">fullUrl" : "<uri>", // URI for resource (Absolute URL server address or URI for UUID/OID) "resource" : { Resource }, // A resource in the bundle "search" : { // C? Search related information""mode" : "<code>", // match | include | outcome - why this is in the result set "score" : <decimal> // Search ranking (between 0 and 1) }," ""request" : { // C? Additional execution information (transaction/batch/history) "method" : "<code>", // R! GET | HEAD | POST | PUT | DELETE | PATCH "url" : "<uri>", // R! URL for HTTP equivalent of this entry "ifNoneMatch" : "<string>", // For managing cache currency""ifModifiedSince" : "<instant>", // For managing cache currency "ifMatch" : "<string>", // For managing update contention "ifNoneExist" : "<string>" // For conditional creates },""response" : { // C? Results of execution (transaction/batch/history) "status" : "<string>", // R! Status response code (text optional)" ""location" : "<uri>", // The location (if the operation returns a location) "etag" : "<string>", // The Etag for the resource (if relevant) "lastModified" : "<instant>", // Server's date time modified "outcome" : { Resource } // OperationOutcome with hints and warnings (for batch/transaction) } }],""signature" : { Signature } // Digital Signature }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Bundle; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language
fhir: fhir: fhir:fhir:Bundle.identifier [ Identifier ]; # 0..1 Persistent identifier for the bundle fhir:Bundle.type [ code ]; # 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification fhir:Bundle.timestamp [ instant ]; # 0..1 When the bundle was assembled fhir:Bundle.total [ unsignedInt ]; # 0..1 If search, the total number of matches fhir:Bundle.link [ # 0..* Links related to this Bundle fhir:Bundle.link.relation [ string ]; # 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 fhir:Bundle.link.url [ uri ]; # 1..1 Reference details for the link ], ...;fhir:fhir:Bundle.entry [ # 0..* Entry in the bundle - will have a resource or information fhir:Bundle.entry.link [ See Bundle.link ], ... ; # 0..* Links related to this entryfhir:<a href=bundle-definitions.html#Bundle.entry.fullUrl class=dict title="The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:fhir:* Results from operations might involve resources that are not identified.">Bundle.entry.fullUrl fhir: * Results from operations might involve resources that are not identified.">Bundle.entry.fullUrl [ uri ]; # 0..1 URI for resource (Absolute URL server address or URI for UUID/OID) fhir:Bundle.entry.resource [ Resource ]; # 0..1 A resource in the bundle fhir:Bundle.entry.search [ # 0..1 Search related informationfhir:fhir:Bundle.entry.search.mode [ code ]; # 0..1 match | include | outcome - why this is in the result set fhir:Bundle.entry.search.score [ decimal ]; # 0..1 Search ranking (between 0 and 1) ];fhir: fhir:fhir:Bundle.entry.request [ # 0..1 Additional execution information (transaction/batch/history) fhir:Bundle.entry.request.method [ code ]; # 1..1 GET | HEAD | POST | PUT | DELETE | PATCH fhir:Bundle.entry.request.url [ uri ]; # 1..1 URL for HTTP equivalent of this entry fhir:Bundle.entry.request.ifNoneMatch [ string ]; # 0..1 For managing cache currencyfhir:fhir:Bundle.entry.request.ifModifiedSince [ instant ]; # 0..1 For managing cache currency fhir:Bundle.entry.request.ifMatch [ string ]; # 0..1 For managing update contention fhir:Bundle.entry.request.ifNoneExist [ string ]; # 0..1 For conditional creates ];fhir:fhir:Bundle.entry.response [ # 0..1 Results of execution (transaction/batch/history) fhir:Bundle.entry.response.status [ string ]; # 1..1 Status response code (text optional)fhir: fhir:fhir:Bundle.entry.response.location [ uri ]; # 0..1 The location (if the operation returns a location) fhir:Bundle.entry.response.etag [ string ]; # 0..1 The Etag for the resource (if relevant) fhir:Bundle.entry.response.lastModified [ instant ]; # 0..1 Server's date time modified fhir:Bundle.entry.response.outcome [ Resource ]; # 0..1 OperationOutcome with hints and warnings (for batch/transaction) ]; ], ...;fhir:fhir:Bundle.signature [ Signature ]; # 0..1 Digital Signature ]
Changes
since
DSTU2
R3
Bundle | |
|
|
|
|
Bundle.entry.request.method |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
23
28
tests
of
which
1
3
fail
to
execute
.
11
3
fail
round-trip
testing
and
11
16
r3
resources
are
invalid
(3836
(0
errors).
).
)
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() |
| Resource |
Contains
a
collection
of
resources
+ Rule: total only when a search or history + Rule: entry.search only when a search + Rule: entry.request mandatory for batch/transaction/history, allowed for subscription-notification, otherwise prohibited + Rule: entry.response mandatory for batch-response/transaction-response/history, allowed for subscription-notification, otherwise prohibited + Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) + Rule: A document must have an identifier with a system and a value + + + + Elements defined in Ancestors: id , meta , implicitRules , language | |
![]() ![]() ![]() | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() ![]() | Σ | 1..1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
BundleType ( Required ) |
![]() ![]() ![]() | Σ | 0..1 | instant | When the bundle was assembled |
![]() ![]() ![]() | Σ I | 0..1 | unsignedInt | If search, the total number of matches |
![]() ![]() ![]() | Σ | 0..* | BackboneElement |
Links
related
to
this
Bundle
|
![]() ![]() ![]() ![]() | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Reference details for the link |
![]() ![]() ![]() | Σ I | 0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
+ Rule: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() | Σ | 0..* | see link |
Links
related
to
this
entry
|
![]() ![]() ![]() ![]() | Σ | 0..1 | uri |
|
![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() | Σ I | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code |
match
|
include
|
outcome
-
why
this
is
in
the
result
set
SearchEntryMode ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() | Σ I | 0..1 |
BackboneElement
| Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
HTTPVerb ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant |
For
managing
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() | Σ I | 0..1 | BackboneElement |
|
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri |
The
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string |
The
|
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() ![]() | Σ TU | 0..1 | Signature | Digital Signature |
![]() |
XML Template
<Bundle xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language -->
<</identifier> < <<identifier><!-- 0..1 Identifier Persistent identifier for the bundle --></identifier> <type value="[code]"/><!-- 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification --> <timestamp value="[instant]"/><!-- 0..1 When the bundle was assembled --> <total value="[unsignedInt]"/><!--0..1 If search, the total number of matches --> <link> <!-- 0..* Links related to this Bundle --> <relation value="[string]"/><!-- 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 --> <url value="[uri]"/><!-- 1..1 Reference details for the link --> </link>
<<entry> <!-- 0..* Entry in the bundle - will have a resource or information --> <link><!-- 0..* Content as for Bundle.link Links related to this entry --></link><<a href=bundle-definitions.html#Bundle.entry.fullUrl class=dict title="The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:<* Results from operations might involve resources that are not identified."> <</resource> * Results from operations might involve resources that are not identified.">fullUrl value="[uri]"/><!-- 0..1 URI for resource (Absolute URL server address or URI for UUID/OID) --> <resource><!-- 0..1 Resource A resource in the bundle --></resource> <search> <!--0..1 Search related information -->
<<mode value="[code]"/><!-- 0..1 match | include | outcome - why this is in the result set --> <score value="[decimal]"/><!-- 0..1 Search ranking (between 0 and 1) --> </search>< <<request> <!--0..1 Additional execution information (transaction/batch/history) --> <method value="[code]"/><!-- 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- 0..1 For managing cache currency -->
<<ifModifiedSince value="[instant]"/><!-- 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- 0..1 For conditional creates --> </request><<response> <!--0..1 Results of execution (transaction/batch/history) --> <status value="[string]"/><!-- 1..1 Status response code (text optional) -->
< <<location value="[uri]"/><!-- 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </response> </entry><</signature><signature><!-- 0..1 Signature Digital Signature --></signature> </Bundle>
JSON Template
{"resourceType" : "Bundle", // from Resource: id, meta, implicitRules, and language
" " ""identifier" : { Identifier }, // Persistent identifier for the bundle "type" : "<code>", // R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification "timestamp" : "<instant>", // When the bundle was assembled "total" : "<unsignedInt>", // C? If search, the total number of matches "link" : [{ // Links related to this Bundle "relation" : "<string>", // R! See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 "url" : "<uri>" // R! Reference details for the link }],""entry" : [{ // Entry in the bundle - will have a resource or information "link" : [{ Content as for Bundle.link }], // Links related to this entry"<a href=bundle-definitions.html#Bundle.entry.fullUrl class=dict title="The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:"* Results from operations might involve resources that are not identified.">fullUrl " * Results from operations might involve resources that are not identified.">fullUrl" : "<uri>", // URI for resource (Absolute URL server address or URI for UUID/OID) "resource" : { Resource }, // A resource in the bundle "search" : { // C? Search related information""mode" : "<code>", // match | include | outcome - why this is in the result set "score" : <decimal> // Search ranking (between 0 and 1) }," ""request" : { // C? Additional execution information (transaction/batch/history) "method" : "<code>", // R! GET | HEAD | POST | PUT | DELETE | PATCH "url" : "<uri>", // R! URL for HTTP equivalent of this entry "ifNoneMatch" : "<string>", // For managing cache currency""ifModifiedSince" : "<instant>", // For managing cache currency "ifMatch" : "<string>", // For managing update contention "ifNoneExist" : "<string>" // For conditional creates },""response" : { // C? Results of execution (transaction/batch/history) "status" : "<string>", // R! Status response code (text optional)" ""location" : "<uri>", // The location (if the operation returns a location) "etag" : "<string>", // The Etag for the resource (if relevant) "lastModified" : "<instant>", // Server's date time modified "outcome" : { Resource } // OperationOutcome with hints and warnings (for batch/transaction) } }],""signature" : { Signature } // Digital Signature }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Bundle; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language
fhir: fhir: fhir:fhir:Bundle.identifier [ Identifier ]; # 0..1 Persistent identifier for the bundle fhir:Bundle.type [ code ]; # 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification fhir:Bundle.timestamp [ instant ]; # 0..1 When the bundle was assembled fhir:Bundle.total [ unsignedInt ]; # 0..1 If search, the total number of matches fhir:Bundle.link [ # 0..* Links related to this Bundle fhir:Bundle.link.relation [ string ]; # 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 fhir:Bundle.link.url [ uri ]; # 1..1 Reference details for the link ], ...;fhir:fhir:Bundle.entry [ # 0..* Entry in the bundle - will have a resource or information fhir:Bundle.entry.link [ See Bundle.link ], ... ; # 0..* Links related to this entryfhir:<a href=bundle-definitions.html#Bundle.entry.fullUrl class=dict title="The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:fhir:* Results from operations might involve resources that are not identified.">Bundle.entry.fullUrl fhir: * Results from operations might involve resources that are not identified.">Bundle.entry.fullUrl [ uri ]; # 0..1 URI for resource (Absolute URL server address or URI for UUID/OID) fhir:Bundle.entry.resource [ Resource ]; # 0..1 A resource in the bundle fhir:Bundle.entry.search [ # 0..1 Search related informationfhir:fhir:Bundle.entry.search.mode [ code ]; # 0..1 match | include | outcome - why this is in the result set fhir:Bundle.entry.search.score [ decimal ]; # 0..1 Search ranking (between 0 and 1) ];fhir: fhir:fhir:Bundle.entry.request [ # 0..1 Additional execution information (transaction/batch/history) fhir:Bundle.entry.request.method [ code ]; # 1..1 GET | HEAD | POST | PUT | DELETE | PATCH fhir:Bundle.entry.request.url [ uri ]; # 1..1 URL for HTTP equivalent of this entry fhir:Bundle.entry.request.ifNoneMatch [ string ]; # 0..1 For managing cache currencyfhir:fhir:Bundle.entry.request.ifModifiedSince [ instant ]; # 0..1 For managing cache currency fhir:Bundle.entry.request.ifMatch [ string ]; # 0..1 For managing update contention fhir:Bundle.entry.request.ifNoneExist [ string ]; # 0..1 For conditional creates ];fhir:fhir:Bundle.entry.response [ # 0..1 Results of execution (transaction/batch/history) fhir:Bundle.entry.response.status [ string ]; # 1..1 Status response code (text optional)fhir: fhir:fhir:Bundle.entry.response.location [ uri ]; # 0..1 The location (if the operation returns a location) fhir:Bundle.entry.response.etag [ string ]; # 0..1 The Etag for the resource (if relevant) fhir:Bundle.entry.response.lastModified [ instant ]; # 0..1 Server's date time modified fhir:Bundle.entry.response.outcome [ Resource ]; # 0..1 OperationOutcome with hints and warnings (for batch/transaction) ]; ], ...;fhir:fhir:Bundle.signature [ Signature ]; # 0..1 Digital Signature ]
Changes
since
DSTU2
Release
3
Bundle | |
|
|
|
|
Bundle.entry.request.method |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
R2
<-->
R3
<-->
R4
Conversion
Maps
(status
=
23
28
tests
of
which
1
3
fail
to
execute
.
11
3
fail
round-trip
testing
and
11
16
r3
resources
are
invalid
(3836
(0
errors).
).
)
Alternate
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
(
XML
,
+
JSON
),
,
XML
Schema
/
Schematron
(for
)
+
JSON
Schema
,
ShEx
(for
Turtle
)
,
the
spreadsheet
version
&
the
dependency
analysis
a
Path | Definition | Type | Reference |
---|---|---|---|
Bundle.type |
Indicates
the
purpose
of
a
bundle
-
how
it
| Required | BundleType |
Bundle.entry.search.mode |
Why
an
entry
is
in
the
result
set
-
whether
it's
included
as
a
match
or
because
of
an
_include
| Required | SearchEntryMode |
Bundle.entry.request.method | HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. | Required | HTTPVerb |
id | Level | Location | Description | Expression |
bdl-1
| Rule | (base) |
total
only
when
a
search
or
history
|
|
bdl-2
| Rule | (base) |
entry.search
only
when
a
search
|
|
bdl-3
| Rule | (base) |
entry.request
|
|
bdl-4
| Rule | (base) |
entry.response
|
|
bdl-5
| Rule | Bundle.entry |
must
be
a
resource
unless
there's
a
request
or
response
|
|
bdl-7
| Rule | (base) |
FullUrl
must
be
unique
in
a
bundle,
or
else
entries
with
the
same
fullUrl
must
have
different
meta.versionId
|
|
bdl-8
| Rule | Bundle.entry |
fullUrl
cannot
be
a
version
specific
reference
|
|
bdl-9
| Rule | (base) |
A
document
must
have
an
identifier
with
a
system
and
a
value
|
|
bdl-10 | Rule | (base) | A document must have a date | type = 'document' implies (meta.lastUpdated.hasValue()) |
bdl-11 | Rule | (base) | A document must have a Composition as the first resource | type = 'document' implies entry.first().resource.is(Composition) |
bdl-12 | Rule | (base) | A message must have a MessageHeader as the first resource | type = 'message' implies entry.first().resource.is(MessageHeader) |
bdl-13 | Rule | (base) | A subscription-notification must have a SubscriptionStatus as the first resource | type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) |
link
,
entry
,
and
search
/
request
/
response
can
all
have
extensions.
See
Patient
and
Location
for
examples
on
search
The content and rules for using a Bundle depend on the type of the bundle. Note that all bundle types use resource identity resolution as described below.
A
document
bundle
Bundle
(type
=
"document")
consists
of
a
series
of
entries,
the
first
of
which
is
a
Composition
.
Each
entry
element
SHALL
contain
a
resource.
See
Documents
for
further
information.
A
message
bundle
Bundle
(type
=
"message")
consists
of
a
series
of
entries,
the
first
of
which
is
a
MessageHeader
.
Each
entry
element
SHALL
contain
a
resource.
See
Messaging
for
further
information.
A set of search results (type = "searchset") consists of a series of 0 or more entries. Each entry element SHALL contain a resource. See Search for further information.
In addition, Bundle.total may be used to return the total number of resources that match the search, and that may be returned by following the "next" link .
For each entry, a search set can also contain two specific pieces of search related information:
An
A
change
history
(type
=
"history")
consists
of
a
series
of
0
or
more
entries.
Each
entry
element
SHALL
contain
a
request
element
that
describes
the
change
that
was
made,
made
and,
if
the
method
is
a
POST
or
PUT,
a
resource
that
represents
the
state
of
the
resource
at
the
conclusion
of
the
operation.
A
response
element
SHALL
also
be
present
so
that
consumers
can
access
the
location
header.
See
History
for
further
information.
In
addition,
Bundle.total
may
be
used
to
return
the
total
number
of
resources
that
are
included
in
the
change
history,
and
including
those
that
may
be
returned
by
following
the
"next"
link
.
A
transaction
(type
=
"transaction")
or
batch
(type
=
"batch")
consists
of
a
series
of
0
or
more
entries.
Each
entry
element
SHALL
contain
either
a
request
element,
or
a
resource
element
(or
both).
See
Transactions
for
further
information.
Each
entry
in
a
transaction
has
the
details
of
an
HTTP
operation
that
informs
the
system
processing
the
transaction
what
to
do
with
the
entry.
If
the
entry
method
is
a
'PUT'
or
'POST',
then
the
entry
SHALL
contain
a
resource
that
becomes
the
body
of
the
HTTP
operation.
If
there
is
no
request
element,
then
there
SHALL
be
a
resource
and
the
server
must
infer
whether
this
is
a
create
or
an
update
from
the
resource
identity
supplied.
See
Transactions
for
further
information.
A
transaction
response
(type
=
"transaction-response")
or
batch
response
(type="batch-response")
consists
of
a
series
of
0
or
more
entries,
entries:
1
for
each
entry
in
the
transaction
or
batch
it
is
in
response
to.
Each
entry
element
SHALL
contain
a
response
element
which
indicates
the
outcome
of
the
HTTP
operation
that
the
server
performed
for
the
entry.
A
collection
(type
=
"collection")
consists
of
a
series
of
0
or
more
entries.
No
particular
use
with
respect
to
the
FHIR
specification
is
associated
with
this
bundle.
Bundle.
Each
entry
element
SHALL
contain
a
resource.
Normative Candidate Note: This BundleType is not normative - it is still undergoing Trial Use while more experience is gathered.
A subscription notification (type = "subscription-notification") consists of a series of 1 or more entries, the first of which is a SubscriptionStatus . There may be additional contents, as specified by the subscription responsible for generating the notification. See Subscription for further information.
Except
for
transactions
and
batches,
Each
each
entry
in
a
Bundle
must
have
a
fullUrl
which
is
the
identity
of
the
resource
in
the
entry.
Note
that
this
is
not
a
versioned
reference
to
the
resource,
but
its
identity.
Where
a
resource
is
not
assigned
a
persistent
identity
that
can
be
used
in
the
bundle,
Bundle,
a
UUID
should
be
used
(urn:uuid:...).
For
transactions
and
batches,
entries
may
MAY
not
have
fullURLs
when
the
entry.request.method
=
POST,
and
the
resource
has
no
identity.
Note
that
even
in
this
case,
there
may
still
be
a
fullURL
in
a
transaction
on
a
POST
so
that
relationships
between
resources
can
be
represented
(see
Transactions
).
In
some
bundles,
a
A
given
version
of
a
resource
can
SHALL
only
appear
once:
Type
Rules
document
no
duplicates
message
no
duplicates
(generally
not,
unless
noted
explicitly
once
in
the
event
definition
e.g.
for
messaging
deltas?)
transaction
no
duplicates
allowed
transaction-response
no
duplicates
allowed
batch
no
duplicates
allowed
batch-response
no
duplicates
allowed
history
yes,
duplicates
are
allowed
searchset
no
duplicates
allowed
collection
yes,
duplicates
are
allowed,
though
generally
each
Bundle.
There
might,
however,
be
multiple
versions
of
a
single
resource
present
in
a
single
bundle.
This
would
not
be
expected
in
Bundles
of
type
history
,
and
also
might
be
necessitated
by
closely
tracking
Provenance.
Note
that
the
meaning
of
an
unversioned
reference
to
a
good
idea
resource
that
appears
multiple
times
is
potentially
ambiguous,
though
processors
may
have
additional
informaton
to
help
resolve
this
(e.g.
change
order
in
a
history
bundle).
When processing batches and transactions, it is at server discretion how to behave if multiple versions of a single resource are present.
The
Bundle
resource
is
a
packaging
construct
that
has
one
of
more
entries
that
are
other
kinds
of
resources.
Those
resources
themselves
have
references
to
other
resources
-
e.g.
an
Observation
that
refers
to
a
Patient.
The
referenced
resources
may
also
be
found
in
the
bundle.
Bundle.
For
example,
the
system
that
constructed
the
bundle
Bundle
may
have
included
both
the
observation
Observation
and
the
patient.
Patient.
The
content
of
the
references
between
resources
doesn't
change
because
of
the
bundle.
This section documents a method that resolves references correctly within a bundle. Note that this method does not define any new semantics; resolution is based on the way resource identity and resource references work.
Applications
reading
a
bundle
Bundle
should
always
look
for
a
resource
by
its
identity
in
the
bundle
first
before
trying
to
access
it
by
its
URL.
URL
externally.
How
to
resolve
a
reference
in
a
bundle:
Bundle:
Note, in addition, that a reference may be by identifier, and if it is, and there is no URL, it may be resolved by scanning the ids in the bundle. Note also that transactions may contain conditional references that must be resolved by the server before processing the matches.
If
the
reference
is
version
specific
(either
relative
or
absolute),
then
remove
the
version
from
the
URL
before
matching
fullUrl,
and
then
match
the
version
based
on
Resource.meta.versionId
.
Note
that
the
rules
for
resolving
references
in
contained
resources
are
the
same
as
those
for
resolving
resources
in
the
resource
that
contains
the
contained
resource.
Here
If
multiple
matches
are
found,
it
is
ambiguous
which
is
correct.
Applications
MAY
return
an
error
or
take
some
other
action
as
they
deem
appropriate.
There
is
an
example
Bundle
the
that
demonstrates
these
rules:
rules.
The Bundle resource type has an end-point like all most other resources. This end-point serves the usual interactions . Bundles are treated as static resources on the /Bundle end-point (i.e. when a batch, transaction, or message is POSTed to /Bundle, it is stored as is, and the content is not processed as batch, transaction, or message - instead, they are processed like normal resource, with indexing / auditing etc. Performing a GET /Bundle/[location] will return the same resource.
The
Bundle
end
point
does
have
two
special
search
parameters
-
composition
and
message
,
which
allow
for
chained
search
into
the
first
(special)
entries
in
document
and
message
resources.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
composition TU | reference |
The
first
resource
in
the
bundle,
if
the
bundle
type
is
"document"
-
this
is
a
composition,
and
this
parameter
provides
access
to
|
Bundle.entry[0].resource
| |
identifier TU | token | Persistent identifier for the bundle | Bundle.identifier | |
message TU | reference | The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents |
Bundle.entry[0].resource
| |
| date | When the bundle was assembled | Bundle.timestamp | |
type | token | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification | Bundle.type |