Bundle

Bundle	C		Resource	Element id Bundle Short description Contains a collection of resources Definition A container for a collection of resources. Data type Resource Constraints 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 element Element id Bundle.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The 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 id
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Bundle.meta Short description Metadata about the resource Definition The 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 Meta
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Bundle.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Comments 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. Data type uri
language		0..1	codeBinding	There are no (further) constraints on this element Element id Bundle.language Short description Language of the resource content Definition The base language in which the resource is written. Comments 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). Data type code Binding A human language. CommonLanguages (extensible) Binding extensions maxValueSet AllLanguages
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element id Bundle.identifier Short description Persistent identifier for the bundle Definition A persistent identifier for the batch that won't change as a batch is copied from server to server. Comments 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. Data type Identifier Mappings w5: id
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Bundle.type Short description document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Definition Indicates the purpose of this bundle - how it was intended to be used. Comments 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. Data type code Binding Indicates the purpose of a bundle - how it was intended to be used. BundleType (required) Mappings w5: class
total	Σ C	0..1	unsignedInt	There are no (further) constraints on this element Element id Bundle.total Short description If search, the total number of matches Definition If 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). Comments 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. Data type unsignedInt Conditions 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 id Bundle.link Short description Links related to this Bundle Definition A series of links that provide context to this bundle. Data type BackboneElement
entry	Σ C	0..*	BackboneElement	There are no (further) constraints on this element Element id Bundle.entry Short description Entry in the bundle - will have a resource, or information Definition An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only). Data type BackboneElement Constraints 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 element Element id Bundle.signature Short description Digital Signature Definition Digital Signature - base64 encoded. XML-DSIg or a JWT. Requirements 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. Comments 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. Data type Signature