Resources
Bundle
Resources
Bundle
A container for a collection of resources.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| identifier | No | Identifier | Persistent identifier for the bundle |
| type | Yes | code | document / message / transaction / transaction-response / batch / batch-response / history / searchset / collection |
| timestamp | No | instant | When the bundle was assembled |
| total | No | unsignedInt | If search, the total number of matches |
| link | No | BundleLink | Links related to this Bundle |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - relation | Yes | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
| - url | Yes | uri | Reference details for the link |
| entry | No | BundleEntry | Entry in the bundle - will have a resource or information |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - link | No | [] | Links related to this entry |
| - fullUrl | No | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
| - resource | No | Resource | A resource in the bundle |
| - search | No | BundleEntrySearch | Search related information |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - mode | No | code | match / include / outcome - why this is in the result set |
| - score | No | decimal | Search ranking (between 0 and 1) |
| - request | No | BundleEntryRequest | Additional execution information (transaction/batch/history) |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - method | Yes | code | GET / HEAD / POST / PUT / DELETE / PATCH |
| - url | Yes | uri | URL for HTTP equivalent of this entry |
| - ifNoneMatch | No | string | For managing cache currency |
| - ifModifiedSince | No | instant | For managing cache currency |
| - ifMatch | No | string | For managing update contention |
| - ifNoneExist | No | string | For conditional creates |
| - response | No | BundleEntryResponse | Results of execution (transaction/batch/history) |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - status | Yes | string | Status response code (text optional) |
| - location | No | uri | The location (if the operation returns a location) |
| - etag | No | string | The Etag for the resource (if relevant) |
| - lastModified | No | instant | Server’s date time modified |
| - outcome | No | OperationOutcome | OperationOutcome with hints and warnings (for batch/transaction) |
| signature | No | Signature | Digital Signature |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| composition | reference | The first resource in the bundle, if the bundle type is “document” - this is a composition, and this parameter provides access to search its contents | Bundle.entry.resource |
| identifier | token | Persistent identifier for the bundle | Bundle.identifier |
| message | reference | The first resource in the bundle, if the bundle type is “message” - this is a message header, and this parameter provides access to search its contents | Bundle.entry.resource |
| timestamp | date | When the bundle was assembled | Bundle.timestamp |
| type | token | document / message / transaction / transaction-response / batch / batch-response / history / searchset / collection | Bundle.type |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
To view the FHIR specification for this resource, see Bundle.