Bundle | Medplum
On this page
A container for a collection of resources.
- Schema
- Usage
- Relationships
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| identifier | Identifier | Persistent identifier for the bundle | |
| Details | |||
| A persistent identifier for the bundle that won't change as a bundle is copied from server to server. | |||
| Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique. | |||
| type | ✓ | code | document |
| Details | |||
| Indicates the purpose of this bundle - how it is intended to be used. | |||
| It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types. | |||
| timestamp | instant | When the bundle was assembled | |
| Details | |||
| The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. | |||
| For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. | |||
| Usage: |
- document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
- message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
- history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
- searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
- transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning
The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself. | | total | | unsignedInt | If search, the total number of matches
Details
If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources. | | link | | BundleLink[] | Links related to this Bundle
Details
A series of links that provide context to this bundle.
Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).
Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.
This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. | | id | | string | Unique id for inter-element referencing
Details
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | | extension | | Extension[] | Additional content defined by implementations
Details
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | | modifierExtension | | Extension[] | Extensions that cannot be ignored even if unrecognized
Details
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | | relation | ✓ | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Details
A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. | | url | ✓ | uri | Reference details for the link
Details
The reference details for the link. | | entry | | BundleEntry[] | Entry in the bundle - will have a resource or information
Details
An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only). |
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[0].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[0].resource |
| timestamp | date | When the bundle was assembled | Bundle.timestamp |
| type | token | document | message |
Inherited Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Logical id of this artifact | |
| Details | |||
| The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||
| The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||
| meta | Meta | Metadata about the resource | |
| Details | |||
| The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||
| implicitRules | uri | A set of rules under which this content was created | |
| Details | |||
| A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||
| Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. | |||
| language | code | Language of the resource content | |
| Details | |||
| The base language in which the resource is written. | |||
| Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |