It is not necessary to provide an id for Bundles profiled in this IG. This element SHOULD be omitted for data minimization reasons.

n/a

• type @ resource

For data minimization reasons, this element SHOULD NOT be populated when generating a resource conforming to this profile for inclusion in one of the Bundles profiled in this IG.

Not including id may result in FHIR validation errors of resources. These errors can be ignored for the purposes of assessing conformance to this IG.

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

The patient who is the subject of the Bundle

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

Laboratory result

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

A container for a collection of resources.

It is not necessary to provide an id for Bundles profiled in this IG. This element SHOULD be omitted for data minimization reasons.

n/a

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should 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.

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

Indicates the purpose of this bundle - how it is intended to be used.

It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Indicates the purpose of a bundle - how it is intended to be used.

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

Usage:

• document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
• message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
• history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
• searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
• transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

A series of links that provide context to this bundle.

Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

• type @ resource

For data minimization reasons, this element SHOULD NOT be populated when generating a resource conforming to this profile for inclusion in one of the Bundles profiled in this IG.

Not including id may result in FHIR validation errors of resources. These errors can be ignored for the purposes of assessing conformance to this IG.

An Extension

An Extension

A series of links that provide context to this entry.

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Information about the search process that lead to the creation of this entry.

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.

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.

The patient who is the subject of the Bundle

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

An Extension

A series of links that provide context to this entry.

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

Demographics and other administrative information about an individual receiving a vaccination or infectious disease-related laboratory test.

Information about the search process that lead to the creation of this entry.

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.

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.

Laboratory result

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

An Extension

A series of links that provide context to this entry.

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

Measurements and simple assertions made about a patient, device or other subject.

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Information about the search process that lead to the creation of this entry.

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.

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.

Digital Signature - base64 encoded. XML-DSig or a JWT.

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.

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.

A container for a collection of resources.

It is not necessary to provide an id for Bundles profiled in this IG. This element SHOULD be omitted for data minimization reasons.

n/a

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should 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.

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

Indicates the purpose of this bundle - how it is intended to be used.

It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Indicates the purpose of a bundle - how it is intended to be used.

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

Usage:

• document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
• message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
• history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
• searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
• transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

A series of links that provide context to this bundle.

Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

• type @ resource

For data minimization reasons, this element SHOULD NOT be populated when generating a resource conforming to this profile for inclusion in one of the Bundles profiled in this IG.

Not including id may result in FHIR validation errors of resources. These errors can be ignored for the purposes of assessing conformance to this IG.

An Extension

An Extension

A series of links that provide context to this entry.

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Information about the search process that lead to the creation of this entry.

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.

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.

The patient who is the subject of the Bundle

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

An Extension

A series of links that provide context to this entry.

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

Demographics and other administrative information about an individual receiving a vaccination or infectious disease-related laboratory test.

Information about the search process that lead to the creation of this entry.

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.

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.

Laboratory result

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

An Extension

An Extension

A series of links that provide context to this entry.

Identifier for the contained resource that is locally unique within this Bundle. The identifier SHALL use resource:# format, where # is an integer incremented from 0 to n within the Bundle.

n/a

Measurements and simple assertions made about a patient, device or other subject.

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Information about the search process that lead to the creation of this entry.

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.

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.

Digital Signature - base64 encoded. XML-DSig or a JWT.

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.

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.