Ontario eReferral - eConsult HL7® FHIR® Implementation Guide

FHIR Artifacts > Structure Definition: Bundle Profile

Structure Definition: Bundle Profile

Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/eReferralBundle

Simplifier project page: Bundle

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

Bundle	I		Bundle	There are no (further) constraints on this element Element Id Bundle Short description Contains a collection of resources Definition A container for a collection of resources. Data Type Bundle Constraints bdl-7:FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) `(type = 'history') or entry.where(fullUrl.exists()).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 mandatory for batch/transaction/history, otherwise prohibited `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))` bdl-4:entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))` bdl-12:A message must have a MessageHeader as the first resource `type = 'message' implies entry.first().resource.is(MessageHeader)` 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')` bdl-11:A document must have a Composition as the first resource `type = 'document' implies entry.first().resource.is(Composition)` bdl-10:A document must have a date `type = 'document' implies (timestamp.hasValue())` Mappings rim:Entity. Role, or Act v2:N/A rim:N/A cda:ClinicalDocument, if bundle.type = document
identifier	S Σ	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 bundle that won't change as a bundle 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier cda:ClinicalDocument.id
type	S Σ	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 is 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 is intended to be used. BundleType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.class
timestamp	S Σ	1..1	instant	There are no (further) constraints on this element Element Id Bundle.timestamp Short description When the bundle was assembled Definition The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. Comments 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. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.init cda:ClinicalDocument.effectiveTime
total	Σ I	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 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
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. Comments 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
relation	Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.link.relation Short description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Definition A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.link.url Short description Reference details for the link Definition The reference details for the link. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
entry	S Σ I	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 ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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()` Mappings rim:n/a
link	S Σ	0..*	see (link)	There are no (further) constraints on this element Element Id Bundle.entry.link Short description Links related to this entry Definition A series of links that provide context to this entry.
relation	S Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.entry.link.relation Short description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Definition A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	S Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.link.url Short description Reference details for the link Definition The reference details for the link. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
fullUrl	S Σ	0..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.fullUrl Short description URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified. Comments fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
resource	S Σ	0..1	Resource	There are no (further) constraints on this element Element Id Bundle.entry.resource Short description A resource in the bundle Definition The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. Data Type Resource Mappings rim:Entity. Role, or Act
search	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.search Short description Search related information Definition Information about the search process that lead to the creation of this entry. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
mode	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Bundle.entry.search.mode Short description match \| include \| outcome - why this is in the result set Definition Why this 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. Comments There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Data Type code Binding 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. SearchEntryMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
score	Σ	0..1	decimal	There are no (further) constraints on this element Element Id Bundle.entry.search.score Short description Search ranking (between 0 and 1) Definition When searching, the server's search ranking score for the entry. Comments Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
request	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.request Short description Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
method	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Bundle.entry.request.method Short description GET \| HEAD \| POST \| PUT \| DELETE \| PATCH Definition In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. HTTPVerb (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	S Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.request.url Short description URL for HTTP equivalent of this entry Definition The URL for this entry, relative to the root (the address to which the request is posted). Comments E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifNoneMatch	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifNoneMatch Short description For managing cache currency Definition If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifModifiedSince	Σ	0..1	instant	There are no (further) constraints on this element Element Id Bundle.entry.request.ifModifiedSince Short description For managing cache currency Definition Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Comments Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifMatch	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifMatch Short description For managing update contention Definition Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifNoneExist	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifNoneExist Short description For conditional creates Definition Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
response	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.response Short description Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
status	S Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.entry.response.status Short description Status response code (text optional) Definition The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
location	S Σ	0..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.response.location Short description The location (if the operation returns a location) Definition The location header created by processing this operation, populated if the operation returns a location. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
etag	S Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.response.etag Short description The Etag for the resource (if relevant) Definition The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Comments Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
lastModified	S Σ	0..1	instant	There are no (further) constraints on this element Element Id Bundle.entry.response.lastModified Short description Server's date time modified Definition The date/time that the resource was modified on the server. Comments This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
outcome	S Σ	0..1	Resource	There are no (further) constraints on this element Element Id Bundle.entry.response.outcome Short description OperationOutcome with hints and warnings (for batch/transaction) Definition An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. Comments For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. Data Type Resource Mappings rim:Entity. Role, or Act
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 A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Hybrid View

Bundle	I		Bundle	There are no (further) constraints on this element Element Id Bundle Short description Contains a collection of resources Definition A container for a collection of resources. Data Type Bundle Constraints bdl-7:FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) `(type = 'history') or entry.where(fullUrl.exists()).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 mandatory for batch/transaction/history, otherwise prohibited `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))` bdl-4:entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))` bdl-12:A message must have a MessageHeader as the first resource `type = 'message' implies entry.first().resource.is(MessageHeader)` 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')` bdl-11:A document must have a Composition as the first resource `type = 'document' implies entry.first().resource.is(Composition)` bdl-10:A document must have a date `type = 'document' implies (timestamp.hasValue())` Mappings rim:Entity. Role, or Act v2:N/A rim:N/A cda:ClinicalDocument, if bundle.type = document
identifier	S Σ	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 bundle that won't change as a bundle 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier cda:ClinicalDocument.id
type	S Σ	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 is 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 is intended to be used. BundleType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.class
timestamp	S Σ	1..1	instant	There are no (further) constraints on this element Element Id Bundle.timestamp Short description When the bundle was assembled Definition The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. Comments 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. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.init cda:ClinicalDocument.effectiveTime
total	Σ I	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 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
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. Comments 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
relation	Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.link.relation Short description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Definition A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.link.url Short description Reference details for the link Definition The reference details for the link. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
entry	S Σ I	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 ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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()` Mappings rim:n/a
link	S Σ	0..*	see (link)	There are no (further) constraints on this element Element Id Bundle.entry.link Short description Links related to this entry Definition A series of links that provide context to this entry.
relation	S Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.entry.link.relation Short description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Definition A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	S Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.link.url Short description Reference details for the link Definition The reference details for the link. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
fullUrl	S Σ	0..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.fullUrl Short description URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified. Comments fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
resource	S Σ	0..1	Resource	There are no (further) constraints on this element Element Id Bundle.entry.resource Short description A resource in the bundle Definition The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. Data Type Resource Mappings rim:Entity. Role, or Act
search	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.search Short description Search related information Definition Information about the search process that lead to the creation of this entry. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
mode	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Bundle.entry.search.mode Short description match \| include \| outcome - why this is in the result set Definition Why this 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. Comments There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Data Type code Binding 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. SearchEntryMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
score	Σ	0..1	decimal	There are no (further) constraints on this element Element Id Bundle.entry.search.score Short description Search ranking (between 0 and 1) Definition When searching, the server's search ranking score for the entry. Comments Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
request	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.request Short description Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
method	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Bundle.entry.request.method Short description GET \| HEAD \| POST \| PUT \| DELETE \| PATCH Definition In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. HTTPVerb (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	S Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.request.url Short description URL for HTTP equivalent of this entry Definition The URL for this entry, relative to the root (the address to which the request is posted). Comments E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifNoneMatch	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifNoneMatch Short description For managing cache currency Definition If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifModifiedSince	Σ	0..1	instant	There are no (further) constraints on this element Element Id Bundle.entry.request.ifModifiedSince Short description For managing cache currency Definition Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Comments Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifMatch	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifMatch Short description For managing update contention Definition Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifNoneExist	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifNoneExist Short description For conditional creates Definition Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
response	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.response Short description Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
status	S Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.entry.response.status Short description Status response code (text optional) Definition The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
location	S Σ	0..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.response.location Short description The location (if the operation returns a location) Definition The location header created by processing this operation, populated if the operation returns a location. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
etag	S Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.response.etag Short description The Etag for the resource (if relevant) Definition The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Comments Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
lastModified	S Σ	0..1	instant	There are no (further) constraints on this element Element Id Bundle.entry.response.lastModified Short description Server's date time modified Definition The date/time that the resource was modified on the server. Comments This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
outcome	S Σ	0..1	Resource	There are no (further) constraints on this element Element Id Bundle.entry.response.outcome Short description OperationOutcome with hints and warnings (for batch/transaction) Definition An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. Comments For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. Data Type Resource Mappings rim:Entity. Role, or Act
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 A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Snapshot View

Bundle	I		Bundle	There are no (further) constraints on this element Element Id Bundle Short description Contains a collection of resources Definition A container for a collection of resources. Data Type Bundle Constraints bdl-7:FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) `(type = 'history') or entry.where(fullUrl.exists()).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 mandatory for batch/transaction/history, otherwise prohibited `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))` bdl-4:entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))` bdl-12:A message must have a MessageHeader as the first resource `type = 'message' implies entry.first().resource.is(MessageHeader)` 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')` bdl-11:A document must have a Composition as the first resource `type = 'document' implies entry.first().resource.is(Composition)` bdl-10:A document must have a date `type = 'document' implies (timestamp.hasValue())` Mappings rim:Entity. Role, or Act v2:N/A rim:N/A cda:ClinicalDocument, if bundle.type = document
identifier	S Σ	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 bundle that won't change as a bundle 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier cda:ClinicalDocument.id
type	S Σ	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 is 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 is intended to be used. BundleType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.class
timestamp	S Σ	1..1	instant	There are no (further) constraints on this element Element Id Bundle.timestamp Short description When the bundle was assembled Definition The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle. Comments 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. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.init cda:ClinicalDocument.effectiveTime
total	Σ I	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 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. 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
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. Comments 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
relation	Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.link.relation Short description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Definition A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.link.url Short description Reference details for the link Definition The reference details for the link. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
entry	S Σ I	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 ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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()` Mappings rim:n/a
link	S Σ	0..*	see (link)	There are no (further) constraints on this element Element Id Bundle.entry.link Short description Links related to this entry Definition A series of links that provide context to this entry.
relation	S Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.entry.link.relation Short description See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Definition A name which details the functional use for this link - see http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	S Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.link.url Short description Reference details for the link Definition The reference details for the link. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
fullUrl	S Σ	0..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.fullUrl Short description URI for resource (Absolute URL server address or URI for UUID/OID) Definition The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified. Comments fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id. Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL). Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
resource	S Σ	0..1	Resource	There are no (further) constraints on this element Element Id Bundle.entry.resource Short description A resource in the bundle Definition The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. Data Type Resource Mappings rim:Entity. Role, or Act
search	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.search Short description Search related information Definition Information about the search process that lead to the creation of this entry. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
mode	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Bundle.entry.search.mode Short description match \| include \| outcome - why this is in the result set Definition Why this 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. Comments There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence. Data Type code Binding 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. SearchEntryMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
score	Σ	0..1	decimal	There are no (further) constraints on this element Element Id Bundle.entry.search.score Short description Search ranking (between 0 and 1) Definition When searching, the server's search ranking score for the entry. Comments Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order. See Patient Match for the EMPI search which relates to this element. Data Type decimal Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
request	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.request Short description Additional execution information (transaction/batch/history) Definition Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
method	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Bundle.entry.request.method Short description GET \| HEAD \| POST \| PUT \| DELETE \| PATCH Definition In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. HTTPVerb (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	S Σ	1..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.request.url Short description URL for HTTP equivalent of this entry Definition The URL for this entry, relative to the root (the address to which the request is posted). Comments E.g. for a Patient Create, the method would be "POST" and the URL would be "Patient". For a Patient Update, the method would be PUT and the URL would be "Patient/[id]". Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifNoneMatch	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifNoneMatch Short description For managing cache currency Definition If the ETag values match, return a 304 Not Modified status. See the API documentation for "Conditional Read". Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifModifiedSince	Σ	0..1	instant	There are no (further) constraints on this element Element Id Bundle.entry.request.ifModifiedSince Short description For managing cache currency Definition Only perform the operation if the last updated date matches. See the API documentation for "Conditional Read". Comments Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifMatch	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifMatch Short description For managing update contention Definition Only perform the operation if the Etag value matches. For more information, see the API section "Managing Resource Contention". Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
ifNoneExist	Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.request.ifNoneExist Short description For conditional creates Definition Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for "Conditional Create". This is just the query portion of the URL - what follows the "?" (not including the "?"). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
response	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id Bundle.entry.response Short description Results of execution (transaction/batch/history) Definition Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
status	S Σ	1..1	string	There are no (further) constraints on this element Element Id Bundle.entry.response.status Short description Status response code (text optional) Definition The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
location	S Σ	0..1	uri	There are no (further) constraints on this element Element Id Bundle.entry.response.location Short description The location (if the operation returns a location) Definition The location header created by processing this operation, populated if the operation returns a location. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
etag	S Σ	0..1	string	There are no (further) constraints on this element Element Id Bundle.entry.response.etag Short description The Etag for the resource (if relevant) Definition The Etag for the resource, if the operation for the entry produced a versioned resource (see Resource Metadata and Versioning and Managing Resource Contention). Comments Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
lastModified	S Σ	0..1	instant	There are no (further) constraints on this element Element Id Bundle.entry.response.lastModified Short description Server's date time modified Definition The date/time that the resource was modified on the server. Comments This has to match the same time in the meta header (meta.lastUpdated) if a resource is included. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
outcome	S Σ	0..1	Resource	There are no (further) constraints on this element Element Id Bundle.entry.response.outcome Short description OperationOutcome with hints and warnings (for batch/transaction) Definition An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. Comments For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned. This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error. Data Type Resource Mappings rim:Entity. Role, or Act
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 A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to 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 Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Table View

Bundle		..
Bundle.identifier		..
Bundle.type		..
Bundle.timestamp		1..
Bundle.entry		..
Bundle.entry.link		..
Bundle.entry.link.relation		..
Bundle.entry.link.url		..
Bundle.entry.fullUrl		..
Bundle.entry.resource		..
Bundle.entry.request		..
Bundle.entry.request.method		..
Bundle.entry.request.url		..
Bundle.entry.response		..
Bundle.entry.response.status		..
Bundle.entry.response.location		..
Bundle.entry.response.etag		..
Bundle.entry.response.lastModified		..
Bundle.entry.response.outcome		..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "eReferralBundle",
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/eReferralBundle",
    "version": "1.0.0",
    "name": "EReferralBundle",
    "title": "Bundle",
    "status": "draft",
    "fhirVersion": "4.0.0",
    "kind": "resource",
    "abstract": false,
    "type": "Bundle",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Bundle.identifier",
                "path": "Bundle.identifier",
                "mustSupport": true
            },
            {
                "id": "Bundle.type",
                "path": "Bundle.type",
                "mustSupport": true
            },
            {
                "id": "Bundle.timestamp",
                "path": "Bundle.timestamp",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Bundle.entry",
                "path": "Bundle.entry",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.link",
                "path": "Bundle.entry.link",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.link.relation",
                "path": "Bundle.entry.link.relation",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.link.url",
                "path": "Bundle.entry.link.url",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.fullUrl",
                "path": "Bundle.entry.fullUrl",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.resource",
                "path": "Bundle.entry.resource",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.request",
                "path": "Bundle.entry.request",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.request.method",
                "path": "Bundle.entry.request.method",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.request.url",
                "path": "Bundle.entry.request.url",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response",
                "path": "Bundle.entry.response",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.status",
                "path": "Bundle.entry.response.status",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.location",
                "path": "Bundle.entry.response.location",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.etag",
                "path": "Bundle.entry.response.etag",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.lastModified",
                "path": "Bundle.entry.response.lastModified",
                "mustSupport": true
            },
            {
                "id": "Bundle.entry.response.outcome",
                "path": "Bundle.entry.response.outcome",
                "mustSupport": true
            }
        ]
    }
}

Usage

A Bundle resource (type=message) is used to package together a collection of FHIR Resource instances to be sent from one system to another. The Bundle SHALL have an entry for each of the FHIR Resources required to convey information about the business event, starting with the MessageHeader which SHALL always be first.

Notes

The following rules apply to message type Bundles.

.id

used to uniquely identify a message instance
populate this element with a UUID each time a message is sent
note: a FHIR message contains two identifiers that are unique within the message stream, rules:
- a Bundle.id (this element) SHALL be assigned each time the message is sent
- a MessageHeader.id SHALL be assigned when the message is created

.meta.profile

used to declare conformance to this profile
populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/eReferralBundle|1.0.0

.type

declares that the Bundle contains a message
populate with a fixed value: message

.timestamp

populate with the instant in time when the Bundle was created
format: YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z).

.entry

create an entry for each of the FHIR Resources required to convey information about the business event
the MessageHeader SHALL be the first entry

.entry.fullUrl

each entry in the Bundle SHALL have a fullUrl which is the identity of the resource in the entry
if a persistent identity for the resource is not available to use in the Bundle, a UUID SHOULD be used (urn:uuid:...)

.entry.resource

SHALL be populated with the resource for this entry

.entry.request

SHALL NOT be populated

.entry.response

SHALL NOT be populated