R6 Ballot (1st Draft)
FoundationThis page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| FHIR Infrastructure Work Group | Maturity Level: 0 | Informative | Use Context: Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/batch-bundle
This profile holds all the requirements and constraints related to a FHIR batch bundle.
This profile was published on Wed, Mar 11, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - FHIR Core WG.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This indicates the differences between this profile and the base Bundle structure.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | Bundle | |||
  type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Required Pattern: bundle | |
| total | 0..0 | |||
  Slices for entry | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by value:request.method | |
   entry:put | 0..* | BackboneElement | Entry in the bundle - will have a resource or information | |
  fullUrl | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| resource | 1..1 | Resource | A resource in the bundle | |
| search | 0..0 | |||
 request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
  method | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: PUT | |
 response | 0..0 | |||
| entry:post | 0..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| resource | 1..1 | Resource | A resource in the bundle | |
| search | 0..0 | |||
| request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| method | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
| response | 0..0 | |||
| entry:get | 0..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| fullUrl | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| resource | 0..0 | |||
| search | 0..0 | |||
| request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| method | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: GET | |
| response | 0..0 | |||
| entry:delete | 0..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| fullUrl | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| resource | 0..0 | |||
| search | 0..0 | |||
| request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| method | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: DELETE | |
| response | 0..0 | |||
| entry:patch | 0..* | BackboneElement | Entry in the bundle - will have a resource or information | |
| fullUrl | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| resource | 1..1 | Resource | A resource in the bundle | |
| search | 0..0 | |||
| request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| method | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: PATCH | |
| response | 0..0 | |||
 entry:head | 0..* | BackboneElement | Entry in the bundle - will have a resource or information | |
 fullUrl | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| resource | 0..0 | |||
| search | 0..0 | |||
| request | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| method | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: HEAD | |
| response | 0..0 | |||
| issues | 0..1 | OperationOutcome | Issues with the Bundle | |
| Documentation for this format | ||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Bundle structure.
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle | C | 0..* | Bundle | Contains a collection of resources | ||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: All Languages (required): IETF language tag for a human language
| |||||
| identifier | ΣC | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type | Σ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: bundle | ||||
| timestamp | ΣC | 0..1 | instant | When the bundle was assembled | ||||
| link | ΣC | 0..* | BackboneElement | Links related to this Bundle | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relation | ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: Link Relation Types (required) | ||||
| url | ΣC | 1..1 | uri | Reference details for the link | ||||
| Slices for entry | ΣC | 0..* | BackboneElement | Entry 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..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource | ΣC | 0..1 | Resource | A resource in the bundle | ||||
| search | ΣC | 0..1 | BackboneElement | Search related information | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode | Σ | 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. | ||||
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request | ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ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. | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| response | ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | Σ | 1..1 | string | Status response code (text optional) | ||||
| location | Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag | Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified | Σ | 0..1 | instant | Server's date time modified | ||||
| outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| entry:put | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource | ΣC | 1..1 | Resource | A resource in the bundle | ||||
 request | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method | Σ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 | ||||
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch | Σ | 0..1 | string | For managing cache validation | ||||
| ifModifiedSince | Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch | Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist | Σ | 0..1 | string | For conditional creates | ||||
| entry:post | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl | ΣC | 0..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource | ΣC | 1..1 | Resource | A resource in the bundle | ||||
| request | ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
|