This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot3:
Release
6
Ballot
(3rd
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
:
|
Trial Use | Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/history-bundle
This profile holds all the requirements and constraints related to a FHIR history 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: history |
|
|
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 | |||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: PUT |
|
|
1.. 1 | BackboneElement | Results of execution (transaction/batch/history) | |
|
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.) | |
|
0 .. 0 | |||
|
0 .. 0 | |||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: GET |
|
|
1.. 1 | BackboneElement | 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 | |||
|
0 .. 0 | |||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: DELETE |
|
|
1.. 1 | BackboneElement | Results of execution (transaction/batch/history) | |
|
0 .. 0 | |||
|
0 .. 1 | OperationOutcome |
|
|
|
||||
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
bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource bdl-14: entry.request.method PATCH not allowed for history bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. bdl-18: Self link is required for searchsets. bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements |
||||
|
Σ | 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: history |
||||
|
Σ
C
|
0..1 | instant | When the bundle was assembled | ||||
|
Σ
C
|
0..1 | unsignedInt |
|
||||
|
Σ
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 bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
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 |
|
OperationOutcome with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
0..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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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
|
1..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 with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
0..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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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
|
1..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 with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
0..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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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
|
1..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 with hints and warnings (for batch/transaction) | ||||
|
Σ
|
0..1 | Signature | Digital Signature | ||||
|
Σ
C
|
0..1 | OperationOutcome |
|
||||
|
||||||||
<!-- HistoryBundle --><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 Total matches across all pages --> <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:request.method in the specified orderClosed--><<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><<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation." class="dict"><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) --> <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> <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 1..1 BackboneElement <!-- I 1..1 Results of execution (transaction/batch/history) --> <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> <status value="[string]"/><!-- I 1..1 Status response code (text optional) --> <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </response> </entry><<entry> I 0..0 BackboneElement <!-- I 0..0 Entry in the bundle - will have a resource or information --> </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><<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation." class="dict"><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) --> <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> <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 1..1 BackboneElement <!-- I 1..1 Results of execution (transaction/batch/history) --> <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> <status value="[string]"/><!-- I 1..1 Status response code (text optional) --> <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </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><<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation." class="dict"><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) --> <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> <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 1..1 BackboneElement <!-- I 1..1 Results of execution (transaction/batch/history) --> <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> <status value="[string]"/><!-- I 1..1 Status response code (text optional) --> <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </response> </entry><<entry> I 0..0 BackboneElement <!-- I 0..0 Entry in the bundle - will have a resource or information --> </entry> <signature><!-- I 0..1 Signature Digital Signature --></signature><</issues><issues><!-- 0..1 Resource OperationOutcome with issues about the Bundle --></issues> </Bundle>
{ // HistoryBundle
// 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>", // ITotal matches across all pages
"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
"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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"
"
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"
"
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, //A resource in the bundle
"
"
"
"search" : { BackboneElement }, // ISearch related information
"request" : { BackboneElement }, // IAdditional execution information (transaction/batch/history)
"response" : { BackboneElement }, // IResults of execution (transaction/batch/history)
},
],
"signature" : { Signature }, // IDigital Signature
"
"issues" : { Resource(OperationOutcome) }, //OperationOutcome with issues about the Bundle
}
This structure is derived from Bundle .
Summary
Mandatory:
0
element
(+14
nested
mandatory
elements)
Prohibited:
8
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: history |
|
|
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 | |||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: PUT |
|
|
1.. 1 | BackboneElement | Results of execution (transaction/batch/history) | |
|
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.) | |
|
0 .. 0 | |||
|
0 .. 0 | |||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: GET |
|
|
1.. 1 | BackboneElement | 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 | |||
|
0 .. 0 | |||
|
1.. 1 | BackboneElement | Additional execution information (transaction/batch/history) | |
|
1 .. 1 | code |
GET
|
HEAD
|
POST
|
PUT
|
DELETE
|
PATCH
Required Pattern: DELETE |
|
|
1.. 1 | BackboneElement | Results of execution (transaction/batch/history) | |
|
0 .. 0 | |||
|
0 .. 1 | OperationOutcome |
|
|
|
||||
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
bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource bdl-14: entry.request.method PATCH not allowed for history bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'. bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document. bdl-18: Self link is required for searchsets. bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements |
||||
|
Σ | 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: history |
||||
|
Σ
C
|
0..1 | instant | When the bundle was assembled | ||||
|
Σ
C
|
0..1 | unsignedInt |
|
||||
|
Σ
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 bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
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 |
|
OperationOutcome with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
0..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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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
|
1..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 with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
0..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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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
|
1..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 with hints and warnings (for batch/transaction) | ||||
|
Σ
C
|
0..* | BackboneElement |
Entry
in
the
bundle
-
will
have
a
resource
or
information
bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
||||
|
0..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: H T T P Verb ( required ): HTTP verbs (in the HTTP command line). See HTTP rfc
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
|
1..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 with hints and warnings (for batch/transaction) | ||||
|
Σ
|
0..1 | Signature | Digital Signature | ||||
|
Σ
C
|
0..1 | OperationOutcome |
|
||||
|
||||||||
XML Template
<!-- HistoryBundle --><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 Total matches across all pages --> <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:request.method in the specified orderClosed--><<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><<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation." class="dict"><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) --> <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> <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 1..1 BackboneElement <!-- I 1..1 Results of execution (transaction/batch/history) --> <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> <status value="[string]"/><!-- I 1..1 Status response code (text optional) --> <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </response> </entry><<entry> I 0..0 BackboneElement <!-- I 0..0 Entry in the bundle - will have a resource or information --> </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><<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation." class="dict"><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) --> <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> <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 1..1 BackboneElement <!-- I 1..1 Results of execution (transaction/batch/history) --> <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> <status value="[string]"/><!-- I 1..1 Status response code (text optional) --> <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </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><<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: * invoking a create * invoking or responding to an operation where the body is not a single identified resource * invoking or returning the results of a search or history operation." class="dict"><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) --> <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> <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 1..1 BackboneElement <!-- I 1..1 Results of execution (transaction/batch/history) --> <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> <status value="[string]"/><!-- I 1..1 Status response code (text optional) --> <location value="[uri]"/><!-- I 0..1 The location (if the operation returns a location) --> <etag value="[string]"/><!-- I 0..1 The Etag for the resource (if relevant) --> <lastModified value="[instant]"/><!-- I 0..1 Server's date time modified --> <outcome><!-- 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction) --></outcome> </response> </entry><<entry> I 0..0 BackboneElement <!-- I 0..0 Entry in the bundle - will have a resource or information --> </entry> <signature><!-- I 0..1 Signature Digital Signature --></signature><</issues><issues><!-- 0..1 Resource OperationOutcome with issues about the Bundle --></issues> </Bundle>
JSON Template
{ // HistoryBundle
// 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>", // ITotal matches across all pages
"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
"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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"
"
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"
"
"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)
"response" : { BackboneElement }, // I R! Results of execution (transaction/batch/history)
},
{ //
{ // 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:
"<a href="history-bundle-definitions.html#Bundle.entry.fullUrl" title="The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation" class="dict">
"fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
"resource" : { Resource }, //A resource in the bundle
"
"
"
"search" : { BackboneElement }, // ISearch related information
"request" : { BackboneElement }, // IAdditional execution information (transaction/batch/history)
"response" : { BackboneElement }, // IResults of execution (transaction/batch/history)
},
],
"signature" : { Signature }, // IDigital Signature
"
"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 | 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 |
| 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 |