Bundle

ResourceFoundation · OtherNormativeMaturity 5

A container for a collection of resources.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

5 of 5 parameters tested

Structure

Show inherited elements (19)

Element	Card.	Type	Description
identifierΣ	0..1	Identifier	Persistent identifier for the bundle
typeRequiredΣ	1..1	code	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collectionBinding (required): bundle-type
timestampΣ	0..1	instant	When the bundle was assembled
totalΣ	0..1	unsignedInt	If search, the total number of matches
linkΣ	0..*	BackboneElement	Links related to this Bundle
relationRequiredΣ	1..1	string	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
urlRequiredΣ	1..1	uri	Reference details for the link
entryΣ	0..*	BackboneElement	Entry in the bundle - will have a resource or information
linkΣ	0..*	Same as Bundle.link	Links related to this entry
fullUrlΣ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resourceΣ	0..1	Resource	A resource in the bundle
searchΣ	0..1	BackboneElement	Search related information
modeΣ	0..1	code	match | include | outcome - why this is in the result setBinding (required): search-entry-mode
scoreΣ	0..1	decimal	Search ranking (between 0 and 1)
requestΣ	0..1	BackboneElement	Additional execution information (transaction/batch/history)
methodRequiredΣ	1..1	code	GET | HEAD | POST | PUT | DELETE | PATCHBinding (required): http-verb
urlRequiredΣ	1..1	uri	URL for HTTP equivalent of this entry
ifNoneMatchΣ	0..1	string	For managing cache currency
ifModifiedSinceΣ	0..1	instant	For managing cache currency
ifMatchΣ	0..1	string	For managing update contention
ifNoneExistΣ	0..1	string	For conditional creates
responseΣ	0..1	BackboneElement	Results of execution (transaction/batch/history)
statusRequiredΣ	1..1	string	Status response code (text optional)
locationΣ	0..1	uri	The location (if the operation returns a location)
etagΣ	0..1	string	The Etag for the resource (if relevant)
lastModifiedΣ	0..1	instant	Server's date time modified
outcomeΣ	0..1	Resource	OperationOutcome with hints and warnings (for batch/transaction)
signatureΣ	0..1	Signature	Digital Signature

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Bundle?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
composition	reference	The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents Bundle.entry[0].resource
identifier	token	Persistent identifier for the bundle Bundle.identifier
message	reference	The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents Bundle.entry[0].resource
timestamp	date	When the bundle was assembled Bundle.timestamp
type	token	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Bundle.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition