Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

FHIR Infrastructure icon Work Group Maturity Level: 0Informative Use Context: Any

The canonical URL for this profile is:

http://hl7.org/fhir/StructureDefinition/batch-bundle

This profile holds all the requirements and constraints related to a FHIR batch bundle.

This profile was published on Wed, Mar 11, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - FHIR Core WG.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Bundle.

Summary

Mandatory: 0 element (+14 nested mandatory elements)
Prohibited: 16 elements

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of value:request.method (Closed)

This indicates the differences between this profile and the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle Bundle
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: bundle
... total 0..0
... Slices for entry 0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by value:request.method
.... entry:put 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 1..1ResourceA resource in the bundle
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: PUT
..... response 0..0
.... entry:post 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 1..1ResourceA resource in the bundle
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
..... response 0..0
.... entry:get 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..0
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: GET
..... response 0..0
.... entry:delete 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..0
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: DELETE
..... response 0..0
.... entry:patch 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 1..1ResourceA resource in the bundle
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: PATCH
..... response 0..0
.... entry:head 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..0
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: HEAD
..... response 0..0

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C icon0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier ΣC icon0..1IdentifierPersistent identifier for the bundle
... type ΣC icon1..1codedocument | 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: bundle
... timestamp ΣC icon0..1instantWhen the bundle was assembled
... link ΣC icon0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣC icon1..1codeSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: Link Relation Types (required)
.... url ΣC icon1..1uriReference details for the link
... Slices for entry ΣC icon0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by value:request.method
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
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon0..1ResourceA resource in the bundle
..... search ΣC icon0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC icon0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC icon0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:put ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon1..1ResourceA resource in the bundle
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: PUT
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:post ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon1..1ResourceA resource in the bundle
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: POST
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:get ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: GET
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:delete ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: DELETE
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:patch ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon1..1ResourceA resource in the bundle
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: PATCH
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:head ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: HEAD
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
... signature ΣTU0..1SignatureDigital Signature
... issues ΣC icon0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format icon
<!-- BatchBundle -->doco

<Bundle xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <identifier><!-- I 0..1 Identifier Persistent identifier for the bundle --></identifier>
 <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification   -->
 <timestamp value="[instant]"/><!-- I 0..1 When the bundle was assembled -->
 <total value="[unsignedInt]"/><!-- I 0..0 If search, the total number of matches -->
 <link> I 0..* BackboneElement  <!-- I 0..* Links related to this Bundle -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <relation value="[code]"/><!-- I 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1   -->
  <url value="[uri]"/><!-- I 1..1 Reference details for the link -->
 </link>
 <-- entry sliced by value:request.method  in the specified orderClosed-->
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 1..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 0..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 1..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..0 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..0 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 1..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..0 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <signature><!-- I 0..1 Signature Digital Signature --></signature>
 <issues><!-- 0..1 Resource Issues with the Bundle --></issues>
</Bundle>
{ // BatchBundle
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "identifier" : { Identifier }, // IPersistent identifier for the bundle
    "type" : "<code>", // I R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
    "timestamp" : "<instant>", // IWhen the bundle was assembled
    "link" : [{ BackboneElement }], // ILinks related to this Bundle
    "entry" : [ //  sliced by value:request.method  in the specified order, Closed 
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "resource" : { Resource }, // R! A resource in the bundle
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // IURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "resource" : { Resource }, // R! A resource in the bundle
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      }
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "resource" : { Resource }, // R! A resource in the bundle
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
    ],
    "signature" : { Signature }, // IDigital Signature
    "issues" : { Resource(OperationOutcome) }, //Issues with the Bundle
  }

This structure is derived from Bundle.

Summary

Mandatory: 0 element (+14 nested mandatory elements)
Prohibited: 16 elements

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of value:request.method (Closed)

Differential View

This indicates the differences between this profile and the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle Bundle
... type 1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: bundle
... total 0..0
... Slices for entry 0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by value:request.method
.... entry:put 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 1..1ResourceA resource in the bundle
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: PUT
..... response 0..0
.... entry:post 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 1..1ResourceA resource in the bundle
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: POST
..... response 0..0
.... entry:get 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..0
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: GET
..... response 0..0
.... entry:delete 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..0
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: DELETE
..... response 0..0
.... entry:patch 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 1..1ResourceA resource in the bundle
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: PATCH
..... response 0..0
.... entry:head 0..*BackboneElementEntry in the bundle - will have a resource or information
..... fullUrl 1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..0
..... search 0..0
..... request 1..1BackboneElementAdditional execution information (transaction/batch/history)
...... method 1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Required Pattern: HEAD
..... response 0..0

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Bundle structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C icon0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier ΣC icon0..1IdentifierPersistent identifier for the bundle
... type ΣC icon1..1codedocument | 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: bundle
... timestamp ΣC icon0..1instantWhen the bundle was assembled
... link ΣC icon0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation ΣC icon1..1codeSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: Link Relation Types (required)
.... url ΣC icon1..1uriReference details for the link
... Slices for entry ΣC icon0..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by value:request.method
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
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon0..1ResourceA resource in the bundle
..... search ΣC icon0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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.

...... score Σ0..1decimalSearch ranking (between 0 and 1)
..... request ΣC icon0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC icon0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:put ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon1..1ResourceA resource in the bundle
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: PUT
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:post ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon1..1ResourceA resource in the bundle
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: POST
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:get ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: GET
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:delete ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: DELETE
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:patch ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC icon1..1ResourceA resource in the bundle
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: PATCH
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
.... entry:head ΣC icon0..*BackboneElementEntry 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl ΣC icon1..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... request ΣC icon1..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC icon1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: H T T P Verb (required): HTTP verbs (in the HTTP command line). See HTTP rfc icon for details.


Required Pattern: HEAD
...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
... signature ΣTU0..1SignatureDigital Signature
... issues ΣC icon0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format icon

XML Template

<!-- BatchBundle -->doco

<Bundle xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <identifier><!-- I 0..1 Identifier Persistent identifier for the bundle --></identifier>
 <type value="[code]"/><!-- I 1..1 document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification   -->
 <timestamp value="[instant]"/><!-- I 0..1 When the bundle was assembled -->
 <total value="[unsignedInt]"/><!-- I 0..0 If search, the total number of matches -->
 <link> I 0..* BackboneElement  <!-- I 0..* Links related to this Bundle -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <relation value="[code]"/><!-- I 1..1 See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1   -->
  <url value="[uri]"/><!-- I 1..1 Reference details for the link -->
 </link>
 <-- entry sliced by value:request.method  in the specified orderClosed-->
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 1..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 0..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 1..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..0 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..0 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 1..1 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <entry> I 0..* BackboneElement  <!-- I 0..* Entry in the bundle - will have a resource or information -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <link><!-- See http://hl7.org/fhir/StructureDefinition/Bundle#Bundle.link  Links related to this entry --></link>
  <fullUrl value="[uri]"/><!-- I 1..1 
      URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) -->
  <resource><!-- 0..0 Resource A resource in the bundle --></resource>
  <search> I 0..0 BackboneElement  <!-- I 0..0 Search related information -->
  </search>
  <request> I 1..1 BackboneElement  <!-- I 1..1 Additional execution information (transaction/batch/history) -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <method value="[code]"/><!-- I 1..1 GET | HEAD | POST | PUT | DELETE | PATCH   -->
   <url value="[uri]"/><!-- I 1..1 URL for HTTP equivalent of this entry -->
   <ifNoneMatch value="[string]"/><!-- I 0..1 For managing cache validation -->
   <ifModifiedSince value="[instant]"/><!-- I 0..1 For managing cache currency -->
   <ifMatch value="[string]"/><!-- I 0..1 For managing update contention -->
   <ifNoneExist value="[string]"/><!-- I 0..1 For conditional creates -->
  </request>
  <response> I 0..0 BackboneElement  <!-- I 0..0 Results of execution (transaction/batch/history) -->
  </response>
 </entry>
 <signature><!-- I 0..1 Signature Digital Signature --></signature>
 <issues><!-- 0..1 Resource Issues with the Bundle --></issues>
</Bundle>

JSON Template

{ // BatchBundle
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "identifier" : { Identifier }, // IPersistent identifier for the bundle
    "type" : "<code>", // I R! document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
    "timestamp" : "<instant>", // IWhen the bundle was assembled
    "link" : [{ BackboneElement }], // ILinks related to this Bundle
    "entry" : [ //  sliced by value:request.method  in the specified order, Closed 
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "resource" : { Resource }, // R! A resource in the bundle
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // IURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "resource" : { Resource }, // R! A resource in the bundle
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      }
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "resource" : { Resource }, // R! A resource in the bundle
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
      { // Entry in the bundle - will have a resource or information // I
        // from Element: extension
        "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored even if unrecognized
// value[x]: Links related to this entry. One of these 0:
        "fullUrl" : "<uri>", // I R! URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
        "request" : { BackboneElement }, // I R! Additional execution information (transaction/batch/history)
      },
    ],
    "signature" : { Signature }, // IDigital Signature
    "issues" : { Resource(OperationOutcome) }, //Issues with the Bundle
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

PathNameConformanceValueSet
Bundle.languageAll LanguagesrequiredAll Languages
Bundle.typeBundle TyperequiredBundle Type
Bundle.link.relationLink Relation TypesrequiredLink Relation Types
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
Bundle.entry.search.modeSearch Entry ModerequiredSearch Entry Mode
Bundle.entry.request.methodH T T P VerbrequiredH T T P Verb
. .