Bundle
Bundle C Resource Element idBundle
Short descriptionContains a collection of resources
DefinitionA container for a collection of resources.
Data typeConstraints- bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct() - bdl-9: A document must have an identifier with a system and a value
type = 'document' implies (identifier.system.exists() and identifier.value.exists()) - bdl-3: entry.request only for some types of bundles
entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history' - bdl-4: entry.response only for some types of bundles
entry.response.empty() or type = 'batch-response' or type = 'transaction-response' - bdl-1: total only when a search or history
total.empty() or (type = 'searchset') or (type = 'history') - bdl-2: entry.search only when a search
entry.search.empty() or (type = 'searchset')
Mappings- rim: Entity. Role, or Act
- v2: N/A
- rim: N/A
- w5: infrastructure.structure
id Σ 0..1 id There are no (further) constraints on this elementElement idBundle.id
Short descriptionLogical id of this artifact
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data type meta Σ 0..1 Meta There are no (further) constraints on this elementElement idBundle.meta
Short descriptionMetadata about the resource
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Data type implicitRules Σ ?! 0..1 uri There are no (further) constraints on this elementElement idBundle.implicitRules
Short descriptionA set of rules under which this content was created
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
CommentsAsserting 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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Data type language 0..1 codeBinding There are no (further) constraints on this elementElement idBundle.language
Short descriptionLanguage of the resource content
DefinitionThe base language in which the resource is written.
CommentsLanguage 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 it 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).
Data typeBindingA human language.
Binding extensionsmaxValueSet AllLanguages
identifier Σ 0..1 Identifier There are no (further) constraints on this elementElement idBundle.identifier
Short descriptionPersistent identifier for the bundle
DefinitionA persistent identifier for the batch that won't change as a batch is copied from server to server.
CommentsPersistent 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.
Data typeMappings- w5: id
type Σ 1..1 codeBinding There are no (further) constraints on this elementElement idBundle.type
Short descriptiondocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
DefinitionIndicates the purpose of this bundle - how it was intended to be used.
CommentsIt'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.
Data typeBindingIndicates the purpose of a bundle - how it was intended to be used.
Mappings- w5: class
total Σ C 0..1 unsignedInt There are no (further) constraints on this elementElement idBundle.total
Short descriptionIf search, the total number of matches
DefinitionIf a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
CommentsOnly 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.
Data typeConditionsThe cardinality or value of this element may be affected by these constraints: bdl-1
link Σ 0..* BackboneElement There are no (further) constraints on this elementElement idBundle.link
Short descriptionLinks related to this Bundle
DefinitionA series of links that provide context to this bundle.
Data type entry Σ C 0..* BackboneElement There are no (further) constraints on this elementElement idBundle.entry
Short descriptionEntry in the bundle - will have a resource, or information
DefinitionAn entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
Data typeConstraints- bdl-8: fullUrl cannot be a version specific reference
fullUrl.contains('/_history/').not() - bdl-5: must be a resource unless there's a request or response
resource.exists() or request.exists() or response.exists()
signature Σ 0..1 Signature There are no (further) constraints on this elementElement idBundle.signature
Short descriptionDigital Signature
DefinitionDigital Signature - base64 encoded. XML-DSIg or a JWT.
RequirementsThis element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.
CommentsThe signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
Data type
| Bundle | C | Resource | Element idBundleShort description Contains a collection of resources DefinitionA container for a collection of resources.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idBundle.idShort description Logical id of this artifact DefinitionThe 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 | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idBundle.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idBundle.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idBundle.languageShort description Language of the resource content DefinitionThe 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 it 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). A human language. Binding extensions
| |||
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idBundle.identifierShort description Persistent identifier for the bundle DefinitionA persistent identifier for the batch that won't change as a batch 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 | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idBundle.typeShort description document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection DefinitionIndicates the purpose of this bundle - how it was 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. Indicates the purpose of a bundle - how it was intended to be used. Mappings
| ||
| total | Σ C | 0..1 | unsignedInt | There are no (further) constraints on this element Element idBundle.totalShort description If search, the total number of matches DefinitionIf a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this 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. The cardinality or value of this element may be affected by these constraints: bdl-1 | ||
| link | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.linkShort description Links related to this Bundle DefinitionA series of links that provide context to this bundle. | ||
| entry | Σ C | 0..* | BackboneElement | There are no (further) constraints on this element Element idBundle.entryShort description Entry in the bundle - will have a resource, or information DefinitionAn entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
| ||
| signature | Σ | 0..1 | Signature | There are no (further) constraints on this element Element idBundle.signatureShort description Digital Signature DefinitionDigital Signature - base64 encoded. XML-DSIg or a JWT. This element allows capturing signatures on documents. It also allows signatures on messages, transactions or even query responses. It may support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient. The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific. |