Package org.hl7.fhir.r4.model

Class Bundle

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.Bundle

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBundle, org.hl7.fhir.instance.model.api.IBaseResource

public class Bundle
extends Resource
implements org.hl7.fhir.instance.model.api.IBaseBundle

A container for a collection of resources.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Bundle.BundleEntryComponent
static class	Bundle.BundleEntryRequestComponent
static class	Bundle.BundleEntryResponseComponent
static class	Bundle.BundleEntrySearchComponent
static class	Bundle.BundleLinkComponent
static enum	Bundle.BundleType
static class	Bundle.BundleTypeEnumFactory
static enum	Bundle.HTTPVerb
static class	Bundle.HTTPVerbEnumFactory
static enum	Bundle.SearchEntryMode
static class	Bundle.SearchEntryModeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	COMPOSITION	Fluent Client search parameter constant for composition
protected List<Bundle.BundleEntryComponent>	entry	An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
protected Identifier	identifier	A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_COMPOSITION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MESSAGE	Constant for fluent queries to be used to add include statements.
protected List<Bundle.BundleLinkComponent>	link	A series of links that provide context to this bundle.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	MESSAGE	Fluent Client search parameter constant for message
protected Signature	signature	Digital Signature - base64 encoded.
static final String	SP_COMPOSITION	Search parameter: composition
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_MESSAGE	Search parameter: message
static final String	SP_TIMESTAMP	Search parameter: timestamp
static final String	SP_TYPE	Search parameter: type
protected InstantType	timestamp	The date/time that the bundle was assembled - i.e.
static final ca.uhn.fhir.rest.gclient.DateClientParam	TIMESTAMP	Fluent Client search parameter constant for timestamp
protected UnsignedIntType	total	If a set of search matches, this is the total number of entries of type 'match' across all pages in the search.
protected Enumeration<Bundle.BundleType>	type	Indicates the purpose of this bundle - how it is intended to be used.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseBundle

LINK_NEXT, LINK_PREV, LINK_SELF

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Bundle()	Constructor
Bundle(Enumeration<Bundle.BundleType> type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Bundle.BundleEntryComponent	addEntry()
Bundle	addEntry(Bundle.BundleEntryComponent t)
Bundle.BundleLinkComponent	addLink()
Bundle	addLink(Bundle.BundleLinkComponent t)
Bundle	copy()
void	copyValues(Bundle dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Bundle.BundleEntryComponent>	getEntry()
Bundle.BundleEntryComponent	getEntryFirstRep()
Identifier	getIdentifier()
List<Bundle.BundleLinkComponent>	getLink()
Bundle.BundleLinkComponent	getLink(String theRelation)	Returns the link which matches a given relation.
Bundle.BundleLinkComponent	getLinkFirstRep()
Bundle.BundleLinkComponent	getLinkOrCreate(String theRelation)	Returns the link which matches a given relation.
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Signature	getSignature()
Date	getTimestamp()
InstantType	getTimestampElement()
int	getTotal()
UnsignedIntType	getTotalElement()
Bundle.BundleType	getType()
Enumeration<Bundle.BundleType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasEntry()
boolean	hasIdentifier()
boolean	hasLink()
boolean	hasSignature()
boolean	hasTimestamp()
boolean	hasTimestampElement()
boolean	hasTotal()
boolean	hasTotalElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Bundle	setEntry(List<Bundle.BundleEntryComponent> theEntry)
Bundle	setIdentifier(Identifier value)
Bundle	setLink(List<Bundle.BundleLinkComponent> theLink)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Bundle	setSignature(Signature value)
Bundle	setTimestamp(Date value)
Bundle	setTimestampElement(InstantType value)
Bundle	setTotal(int value)
Bundle	setTotalElement(UnsignedIntType value)
Bundle	setType(Bundle.BundleType value)
Bundle	setTypeElement(Enumeration<Bundle.BundleType> value)
protected Bundle	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected Identifier identifier

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

type

protected Enumeration<Bundle.BundleType> type

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

timestamp

protected InstantType timestamp

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

total

protected UnsignedIntType total

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.

link

protected List<Bundle.BundleLinkComponent> link

A series of links that provide context to this bundle.

entry

protected List<Bundle.BundleEntryComponent> entry

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

signature

protected Signature signature

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

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Persistent identifier for the bundle
Type: token
Path: Bundle.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Persistent identifier for the bundle
Type: token
Path: Bundle.identifier

SP_COMPOSITION

public static final String SP_COMPOSITION

Search parameter: composition

Description: 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
Type: reference
Path: Bundle.entry(0).resource

See Also:

• Constant Field Values

COMPOSITION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSITION

Fluent Client search parameter constant for composition

Description: 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
Type: reference
Path: Bundle.entry(0).resource

INCLUDE_COMPOSITION

public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSITION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Bundle:composition".

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Type: token
Path: Bundle.type

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Type: token
Path: Bundle.type

SP_MESSAGE

public static final String SP_MESSAGE

Search parameter: message

Description: 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
Type: reference
Path: Bundle.entry(0).resource

See Also:

• Constant Field Values

MESSAGE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MESSAGE

Fluent Client search parameter constant for message

Description: 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
Type: reference
Path: Bundle.entry(0).resource

INCLUDE_MESSAGE

public static final ca.uhn.fhir.model.api.Include INCLUDE_MESSAGE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Bundle:message".

SP_TIMESTAMP

public static final String SP_TIMESTAMP

Search parameter: timestamp

Description: When the bundle was assembled
Type: date
Path: Bundle.timestamp

See Also:

• Constant Field Values

TIMESTAMP

public static final ca.uhn.fhir.rest.gclient.DateClientParam TIMESTAMP

Fluent Client search parameter constant for timestamp

Description: When the bundle was assembled
Type: date
Path: Bundle.timestamp

Constructor Details

Bundle

public Bundle()

Constructor

Bundle

public Bundle(Enumeration<Bundle.BundleType> type)

Constructor

Method Details

getIdentifier

public Identifier getIdentifier()

Returns:

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

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public Bundle setIdentifier(Identifier value)

Parameters:

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

getTypeElement

public Enumeration<Bundle.BundleType> getTypeElement()

Returns:

type (Indicates the purpose of this bundle - how it is intended to be used.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public Bundle setTypeElement(Enumeration<Bundle.BundleType> value)

Parameters:

value - type (Indicates the purpose of this bundle - how it is intended to be used.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public Bundle.BundleType getType()

Returns:

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

setType

public Bundle setType(Bundle.BundleType value)

Parameters:

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

getTimestampElement

public InstantType getTimestampElement()

Returns:

timestamp (The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value

hasTimestampElement

public boolean hasTimestampElement()

hasTimestamp

public boolean hasTimestamp()

setTimestampElement

public Bundle setTimestampElement(InstantType value)

Parameters:

value - timestamp (The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value

getTimestamp

public Date getTimestamp()

Returns:

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

setTimestamp

public Bundle setTimestamp(Date value)

Parameters:

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

getTotalElement

public UnsignedIntType getTotalElement()

Returns:

total (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.). This is the underlying object with id, value and extensions. The accessor "getTotal" gives direct access to the value

hasTotalElement

public boolean hasTotalElement()

hasTotal

public boolean hasTotal()

setTotalElement

public Bundle setTotalElement(UnsignedIntType value)

Parameters:

value - total (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.). This is the underlying object with id, value and extensions. The accessor "getTotal" gives direct access to the value

getTotal

public int getTotal()

Returns:

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.

setTotal

public Bundle setTotal(int value)

Parameters:

value - 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.

getLink

public List<Bundle.BundleLinkComponent> getLink()

Returns:

link (A series of links that provide context to this bundle.)

setLink

public Bundle setLink(List<Bundle.BundleLinkComponent> theLink)

Returns:

Returns a reference to this for easy method chaining

hasLink

public boolean hasLink()

addLink

public Bundle.BundleLinkComponent addLink()

addLink

public Bundle addLink(Bundle.BundleLinkComponent t)

getLinkFirstRep

public Bundle.BundleLinkComponent getLinkFirstRep()

Returns:

The first repetition of repeating field link, creating it if it does not already exist

getEntry

public List<Bundle.BundleEntryComponent> getEntry()

Returns:

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

setEntry

public Bundle setEntry(List<Bundle.BundleEntryComponent> theEntry)

Returns:

Returns a reference to this for easy method chaining

hasEntry

public boolean hasEntry()

addEntry

public Bundle.BundleEntryComponent addEntry()

addEntry

public Bundle addEntry(Bundle.BundleEntryComponent t)

getEntryFirstRep

public Bundle.BundleEntryComponent getEntryFirstRep()

Returns:

The first repetition of repeating field entry, creating it if it does not already exist

getSignature

public Signature getSignature()

Returns:

signature (Digital Signature - base64 encoded. XML-DSig or a JWT.)

hasSignature

public boolean hasSignature()

setSignature

public Bundle setSignature(Signature value)

Parameters:

value - signature (Digital Signature - base64 encoded. XML-DSig or a JWT.)

getLink

public Bundle.BundleLinkComponent getLink(String theRelation)

Returns the link which matches a given relation. If no link is found which matches the given relation, returns null. If more than one link is found which matches the given relation, returns the first matching BundleLinkComponent.

Parameters:

theRelation - The relation, such as "next", or "self. See the constants such as IBaseBundle.LINK_SELF and IBaseBundle.LINK_NEXT.

Returns:

Returns a matching BundleLinkComponent, or null

See Also:

• IBaseBundle.LINK_NEXT
• IBaseBundle.LINK_PREV
• IBaseBundle.LINK_SELF

getLinkOrCreate

public Bundle.BundleLinkComponent getLinkOrCreate(String theRelation)

Returns the link which matches a given relation. If no link is found which matches the given relation, creates a new BundleLinkComponent with the given relation and adds it to this Bundle. If more than one link is found which matches the given relation, returns the first matching BundleLinkComponent.

Parameters:

theRelation - The relation, such as "next", or "self. See the constants such as IBaseBundle.LINK_SELF and IBaseBundle.LINK_NEXT.

Returns:

Returns a matching BundleLinkComponent, or null

See Also:

• IBaseBundle.LINK_NEXT
• IBaseBundle.LINK_PREV
• IBaseBundle.LINK_SELF

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Resource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Resource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class Resource

copy

public Bundle copy()

Specified by:

copy in class Resource

copyValues

public void copyValues(Bundle dst)

typedCopy

protected Bundle typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Resource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Resource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Resource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource