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/batch-bundle
This profile holds all the requirements and constraints related to a FHIR batch bundle.
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 indicates the differences between this profile and the base Bundle structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
Bundle | |||
|
1 .. 1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Required Pattern: bundle |
|
|
0 .. 0 | Total matches across all pages | ||
|
0 .. * | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
Slice: Unordered, Closed by value:request.method |
|
|
0 .. * | 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 | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: PUT |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | BackboneElement | Entry in the bundle - will have a resource or information | |
|
1.. 1 | Resource | A resource in the bundle | |
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: POST |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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.) | |
|
0 .. 0 | A resource in the bundle | ||
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: GET |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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.) | |
|
0 .. 0 | A resource in the bundle | ||
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: DELETE |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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 | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: PATCH |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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.) | |
|
0 .. 0 | A resource in the bundle | ||
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: HEAD |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. 1 | OperationOutcome | 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 |
Contains
a
collection
of
resources
|
||||
|
Σ | 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
|
0..1 | Identifier | Persistent identifier for the bundle | ||||
|
Σ
C
|
1..1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Binding: Bundle Type ( required Required Pattern: bundle |
||||
|
Σ
C
|
0..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
|
0 .. * | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
Slice: Unordered, Closed by value:request.method |
||||
|
Content/Rules for all slices | |||||||
|
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
|
0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
|
Σ
C
|
0..1 | Resource | A resource in the bundle | ||||
|
Σ
C
|
0..1 | BackboneElement | Search related 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..1 | code |
match
|
include
-
why
this
is
in
the
result
set
Binding: Search Entry Mode ( required |
||||
|
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
|
Σ
C
|
0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
|
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
|
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
|
||||
|
Σ | 1..1 | string | Status response code (text optional) | ||||
|
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
|
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
|
Σ | 0..1 | instant | Server's date time modified | ||||
|
Σ | 0..1 | OperationOutcome | OperationOutcome with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | 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 | ||||
|
Σ
C
|
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: PUT |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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
|
0..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 | ||||
|
Σ
C
|
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: POST |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: GET |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: DELETE |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | ||||
|
Σ
C
|
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: PATCH |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: HEAD |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ | 0..1 | Signature | Digital Signature (deprecated: use Provenance Signatures) | ||||
|
Σ
C
|
0..1 | OperationOutcome | OperationOutcome with issues about the Bundle | ||||
|
||||||||
<!-- BatchBundle --><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 0..1 Identifier Persistent identifier for the bundle --></identifier> <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification --> <timestamp value="[instant]"/><!-- I 0..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 sliced by value:request.method in the specified orderClosed--> <entry> I 0..* BackboneElement <!-- I 0..* 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 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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 0..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 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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><!-- 0..0 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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><!-- 0..0 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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><!-- 0..0 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </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..1 Resource OperationOutcome with issues about the Bundle --></issues> </Bundle>
{ // BatchBundle
// 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 }, // IPersistent identifier for the bundle
"type" : "<code>", // I R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
"timestamp" : "<instant>", // IWhen the bundle was assembled
"link" : [{ BackboneElement }], // ILinks related to this Bundle
"entry" : [ // sliced by value:request.method in the specified order, Closed
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, // R! A resource in the bundle
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // IURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, // R! A resource in the bundle
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
}
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, // R! A resource in the bundle
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
],
"
"signature" : { Signature }, // IDigital Signature (deprecated: use Provenance Signatures)
"issues" : { Resource(OperationOutcome) }, //OperationOutcome with issues about the Bundle
}
This structure is derived from Bundle .
Summary
Mandatory:
0
element
(+14
nested
mandatory
elements)
Prohibited:
16
elements
Slices
This structure defines the following Slices :
Differential View
This indicates the differences between this profile and the base Bundle structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
Bundle | |||
|
1 .. 1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Required Pattern: bundle |
|
|
0 .. 0 | Total matches across all pages | ||
|
0 .. * | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
Slice: Unordered, Closed by value:request.method |
|
|
0 .. * | 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 | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: PUT |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | BackboneElement | Entry in the bundle - will have a resource or information | |
|
1.. 1 | Resource | A resource in the bundle | |
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: POST |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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.) | |
|
0 .. 0 | A resource in the bundle | ||
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: GET |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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.) | |
|
0 .. 0 | A resource in the bundle | ||
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: DELETE |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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 | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: PATCH |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. * | 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.) | |
|
0 .. 0 | A resource in the bundle | ||
|
0 .. 0 | Search related information | ||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: HEAD |
|
|
0 .. 0 | Results of execution (transaction/batch/history) | ||
|
0 .. 1 | OperationOutcome | 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 |
Contains
a
collection
of
resources
|
||||
|
Σ | 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
|
0..1 | Identifier | Persistent identifier for the bundle | ||||
|
Σ
C
|
1..1 | code |
document
|
message
|
transaction
|
transaction-response
|
batch
|
batch-response
|
history
|
searchset
|
collection
|
subscription-notification
Binding: Bundle Type ( required Required Pattern: bundle |
||||
|
Σ
C
|
0..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
|
0 .. * | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
Slice: Unordered, Closed by value:request.method |
||||
|
Content/Rules for all slices | |||||||
|
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
|
0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
|
Σ
C
|
0..1 | Resource | A resource in the bundle | ||||
|
Σ
C
|
0..1 | BackboneElement | Search related 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..1 | code |
match
|
include
-
why
this
is
in
the
result
set
Binding: Search Entry Mode ( required |
||||
|
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
|
Σ
C
|
0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
|
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
|
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
|
||||
|
Σ | 1..1 | string | Status response code (text optional) | ||||
|
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
|
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
|
Σ | 0..1 | instant | Server's date time modified | ||||
|
Σ | 0..1 | OperationOutcome | OperationOutcome with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | 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 | ||||
|
Σ
C
|
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: PUT |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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
|
0..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 | ||||
|
Σ
C
|
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: POST |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: GET |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: DELETE |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | ||||
|
Σ
C
|
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: PATCH |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ
C
|
0..* | 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 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
|
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 |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Binding:
for
details.
Required Pattern: HEAD |
||||
|
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
|
Σ | 0..1 | string | For managing cache validation | ||||
|
Σ | 0..1 | instant | For managing cache currency | ||||
|
Σ | 0..1 | string | For managing update contention | ||||
|
Σ | 0..1 | string | For conditional creates | ||||
|
Σ | 0..1 | Signature | Digital Signature (deprecated: use Provenance Signatures) | ||||
|
Σ
C
|
0..1 | OperationOutcome | OperationOutcome with issues about the Bundle | ||||
|
||||||||
XML Template
<!-- BatchBundle --><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 0..1 Identifier Persistent identifier for the bundle --></identifier> <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification --> <timestamp value="[instant]"/><!-- I 0..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 sliced by value:request.method in the specified orderClosed--> <entry> I 0..* BackboneElement <!-- I 0..* 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 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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 0..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 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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><!-- 0..0 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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><!-- 0..0 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* 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><!-- 0..0 Resource A resource in the bundle --></resource> <search> I 0..0 BackboneElement <!-- I 0..0 Search related information --> </search> <request> I 1..1 BackboneElement <!-- I 1..1 Additional execution information (transaction/batch/history) --> <modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH --> <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry --> <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation --> <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency --> <ifMatch value="[string]"/><!-- I 0..1 For managing update contention --> <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates --> </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..1 Resource OperationOutcome with issues about the Bundle --></issues> </Bundle>
JSON Template
{ // BatchBundle
// 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 }, // IPersistent identifier for the bundle
"type" : "<code>", // I R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
"timestamp" : "<instant>", // IWhen the bundle was assembled
"link" : [{ BackboneElement }], // ILinks related to this Bundle
"entry" : [ // sliced by value:request.method in the specified order, Closed
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, // R! A resource in the bundle
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // IURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, // R! A resource in the bundle
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
}
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, // R! A resource in the bundle
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
},
],
"
"signature" : { Signature }, // IDigital Signature (deprecated: use Provenance Signatures)
"issues" : { Resource(OperationOutcome) }, //OperationOutcome with issues about the Bundle
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| Bundle.language | All Languages | required | All Languages |
| 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 |
|
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method |
|
required |
|
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method |
|
required |
|
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method |
|
required |
|
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method |
|
required |
|
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method |
|
required |
|
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method |
|
required |
|