Bundle class

A container for a collection of resources.

Inheritance
Implemented types

Constructors

Bundle.new({List<BundleEntry>? entry, String? id, Identifier? identifier, String? implicitRules, String? language, List<BundleLink>? link, Meta? meta, Signature? signature, String? timestamp, int? total, required String type})
Bundle.fromJson(Map<String, dynamic> json)
factory

Properties

entry → List<BundleEntry>?
Entry in the bundle - will have a resource or information An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
Logical id of this artifact The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
finalinherited
identifier → Identifier?
Persistent identifier for the bundle 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.
final
implicitRules → String?
A set of rules under which this content was created 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.
finalinherited
language → String?
Language of the resource content 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).
finalinherited
Links related to this Bundle 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.
final
meta → Meta?
Metadata about the resource 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.
finalinherited
resourceType → String
Resource Type Name
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
signature → Signature?
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.
final
timestamp → String?
When the bundle was assembled 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:
final
total → int?
If search, the total number of matches 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.
final
type → String
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.
final

Methods

copyWith({List<BundleEntry>? entry, String? id, Identifier? identifier, String? implicitRules, String? language, List<BundleLink>? link, Meta? meta, Signature? signature, String? timestamp, int? total, String? type}) → Bundle
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fhirResourceType → const String
Resource Type Name (for serialization)