Package com.ibm.fhir.model.resource

Class Bundle

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Bundle
extends Resource
    A container for a collection of resources.

    Maturity level: FMM5 (Normative)

    • Method Detail

      • getIdentifier

        public Identifier getIdentifier()
        A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
        Returns:
        An immutable object of type Identifier that may be null.

      • getType

        public BundleType getType()
        Indicates the purpose of this bundle - how it is intended to be used.
        Returns:
        An immutable object of type BundleType that is non-null.

      • getTimestamp

        public Instant getTimestamp()
        The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
        Returns:
        An immutable object of type Instant that may be null.

      • getTotal

        public UnsignedInt getTotal()
        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.
        Returns:
        An immutable object of type UnsignedInt that may be null.

      • getLink

        public List<Bundle.Link> getLink()
        A series of links that provide context to this bundle.
        Returns:
        An unmodifiable list containing immutable objects of type Bundle.Link that may be empty.

      • getEntry

        public List<Bundle.Entry> getEntry()
        An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
        Returns:
        An unmodifiable list containing immutable objects of type Bundle.Entry that may be empty.

      • getSignature

        public Signature getSignature()
        Digital Signature - base64 encoded. XML-DSig or a JWT.
        Returns:
        An immutable object of type Signature that may be null.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object