This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot1:
Release
6
Ballot
(1st
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
FHIR
Infrastructure
Work
Group
|
Maturity Level : 0 | Informative | Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/search-set-bundle
This profile holds all the requirements and constraints related to a FHIR search 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: searchset |
|
|
0 .. * | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
Slice: Unordered, Closed by value:search.mode |
|
|
0 ..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
|
1.. 1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
|
1.. 1 | OperationOutcome | A resource in the bundle | |
|
||||
|
1.. 1 | code |
match
|
include
-
why
this
is
in
the
result
set
Required Pattern: outcome |
|
|
0 .. 0 | |||
|
0 .. 0 | |||
|
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 | |||
|
0 .. 0 | |||
|
0 .. 1 | OperationOutcome | Issues with the Bundle | |
Documentation
for
this
format
|
||||
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 ): IETF language tag for a human language
|
|||||
|
Σ
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 ): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: searchset |
||||
|
Σ
C
|
0..1 | instant | When the bundle was assembled | ||||
|
Σ
C
|
0..1 | unsignedInt | If search, the total number of matches | ||||
|
Σ
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:search.mode 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 |
||||
|
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 ): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
||||
|
Σ | 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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..1 | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
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..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 | OperationOutcome | 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
|
||||
|
Σ | 1..1 | code |
match
|
include
-
why
this
is
in
the
result
set
Binding: Search Entry Mode ( required ): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. Required Pattern: outcome |
||||
|
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
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..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
|
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 ): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
||||
|
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
|
Σ
|
0..1 | Signature | Digital Signature | ||||
|
Σ
C
|
0..1 | OperationOutcome | Issues with the Bundle | ||||
Documentation
for
this
format
|
||||||||
<!-- SearchSetBundle --><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..1 If search, the total number of matches --> <link> I 0..* BackboneElement <!-- I 0..* Links related to this Bundle --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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:search.mode in the specified orderClosed--> <entry> I 0..1 BackboneElement <!-- I 0..1 Entry in the bundle - will have a resource or information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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 OperationOutcome A resource in the bundle --></resource> <search> I 0..1 BackboneElement <!-- I 0..1 Search related information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <mode value="[code]"/><!-- I 1..1 match | include - why this is in the result set --> <score value="[decimal]"/><!-- I 0..1 Search ranking (between 0 and 1) --> </search> <request> I 0..0 BackboneElement <!-- I 0..0 Additional execution information (transaction/batch/history) --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* Entry in the bundle - will have a resource or information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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..1 BackboneElement <!-- I 0..1 Search related information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <mode value="[code]"/><!-- I 0..1 match | include - why this is in the result set --> <score value="[decimal]"/><!-- I 0..1 Search ranking (between 0 and 1) --> </search> <request> I 0..0 BackboneElement <!-- I 0..0 Additional execution information (transaction/batch/history) --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <signature><!-- I 0..1 Signature Digital Signature --></signature> <issues><!-- 0..1 Resource Issues with the Bundle --></issues> </Bundle>
{ // SearchSetBundle
// 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
"total" : "<unsignedInt>", // IIf search, the total number of matches
"link" : [{ BackboneElement }], // ILinks related to this Bundle
"entry" : [ // sliced by value:search.mode in the specified order, Closed
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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" : { OperationOutcome }, // R! A resource in the bundle
"search" : { BackboneElement }, // ISearch related information
}
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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
"search" : { BackboneElement }, // ISearch related information
},
],
"signature" : { Signature }, // IDigital Signature
"issues" : { Resource(OperationOutcome) }, //Issues with the Bundle
}
This structure is derived from Bundle .
Summary
Mandatory:
0
element
(+5
nested
mandatory
elements)
Prohibited:
4
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: searchset |
|
|
0 .. * | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
Slice: Unordered, Closed by value:search.mode |
|
|
0 ..1 | BackboneElement | Entry in the bundle - will have a resource or information | |
|
1.. 1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
|
1.. 1 | OperationOutcome | A resource in the bundle | |
|
||||
|
1.. 1 | code |
match
|
include
-
why
this
is
in
the
result
set
Required Pattern: outcome |
|
|
0 .. 0 | |||
|
0 .. 0 | |||
|
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 | |||
|
0 .. 0 | |||
|
0 .. 1 | OperationOutcome | Issues with the Bundle | |
Documentation
for
this
format
|
||||
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 ): IETF language tag for a human language
|
|||||
|
Σ
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 ): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: searchset |
||||
|
Σ
C
|
0..1 | instant | When the bundle was assembled | ||||
|
Σ
C
|
0..1 | unsignedInt | If search, the total number of matches | ||||
|
Σ
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:search.mode 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 |
||||
|
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 ): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
||||
|
Σ | 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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..1 | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
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..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 | OperationOutcome | 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
|
||||
|
Σ | 1..1 | code |
match
|
include
-
why
this
is
in
the
result
set
Binding: Search Entry Mode ( required ): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. Required Pattern: outcome |
||||
|
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
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..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
|
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 ): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
||||
|
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
|
Σ
|
0..1 | Signature | Digital Signature | ||||
|
Σ
C
|
0..1 | OperationOutcome | Issues with the Bundle | ||||
Documentation
for
this
format
|
||||||||
XML Template
<!-- SearchSetBundle --><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..1 If search, the total number of matches --> <link> I 0..* BackboneElement <!-- I 0..* Links related to this Bundle --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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:search.mode in the specified orderClosed--> <entry> I 0..1 BackboneElement <!-- I 0..1 Entry in the bundle - will have a resource or information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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 OperationOutcome A resource in the bundle --></resource> <search> I 0..1 BackboneElement <!-- I 0..1 Search related information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <mode value="[code]"/><!-- I 1..1 match | include - why this is in the result set --> <score value="[decimal]"/><!-- I 0..1 Search ranking (between 0 and 1) --> </search> <request> I 0..0 BackboneElement <!-- I 0..0 Additional execution information (transaction/batch/history) --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <entry> I 0..* BackboneElement <!-- I 0..* Entry in the bundle - will have a resource or information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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..1 BackboneElement <!-- I 0..1 Search related information --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <mode value="[code]"/><!-- I 0..1 match | include - why this is in the result set --> <score value="[decimal]"/><!-- I 0..1 Search ranking (between 0 and 1) --> </search> <request> I 0..0 BackboneElement <!-- I 0..0 Additional execution information (transaction/batch/history) --> </request> <response> I 0..0 BackboneElement <!-- I 0..0 Results of execution (transaction/batch/history) --> </response> </entry> <signature><!-- I 0..1 Signature Digital Signature --></signature> <issues><!-- 0..1 Resource Issues with the Bundle --></issues> </Bundle>
JSON Template
{ // SearchSetBundle
// 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
"total" : "<unsignedInt>", // IIf search, the total number of matches
"link" : [{ BackboneElement }], // ILinks related to this Bundle
"entry" : [ // sliced by value:search.mode in the specified order, Closed
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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" : { OperationOutcome }, // R! A resource in the bundle
"search" : { BackboneElement }, // ISearch related information
}
{ // Entry in the bundle - will have a resource or information // I
// from Element: extension
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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
"search" : { BackboneElement }, // ISearch related information
},
],
"signature" : { Signature }, // IDigital Signature
"issues" : { Resource(OperationOutcome) }, //Issues with 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 | H T T P Verb | required | H T T P Verb |
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method | H T T P Verb | required | H T T P Verb |
| Bundle.entry.search.mode | Search Entry Mode | required | Search Entry Mode |
| Bundle.entry.request.method | H T T P Verb | required | H T T P Verb |