Package org.hl7.fhir.r4.model

Class Bundle.BundleEntryComponent

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
    Enclosing class:
    Bundle
    public static class Bundle.BundleEntryComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
    See Also:
    Serialized Form

    • Field Detail

      • fullUrl

        protected UriType fullUrl
        The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified.

      • resource

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

      • request

        protected Bundle.BundleEntryRequestComponent request
        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.

      • response

        protected Bundle.BundleEntryResponseComponent response
        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.

    • Method Detail

      • hasLink

        public boolean hasLink()

      • getFullUrlElement

        public UriType getFullUrlElement()
        Returns:
        fullUrl (The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified.). This is the underlying object with id, value and extensions. The accessor "getFullUrl" gives direct access to the value

      • setFullUrlElement

        public Bundle.BundleEntryComponent setFullUrlElement​(UriType value)
        Parameters:
        value - fullUrl (The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified.). This is the underlying object with id, value and extensions. The accessor "getFullUrl" gives direct access to the value

      • getFullUrl

        public String getFullUrl()
        Returns:
        The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified.

      • setFullUrl

        public Bundle.BundleEntryComponent setFullUrl​(String value)
        Parameters:
        value - The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) Results from operations might involve resources that are not identified.

      • getResource

        public Resource getResource()
        Returns:
        resource (The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.)

      • getRequest

        public Bundle.BundleEntryRequestComponent getRequest()
        Returns:
        request (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.)

      • getResponse

        public Bundle.BundleEntryResponseComponent getResponse()
        Returns:
        response (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.)

      • 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

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class BackboneElement