Package org.hl7.fhir.r5.model

Class Bundle.BundleEntryComponent

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.BackboneElement
org.hl7.fhir.r5.model.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:

  • Field Details

    • fullUrl

      protected UriType fullUrl
      The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: invoking a create invoking or responding to an operation where the body is not a single identified resource invoking or returning the results of a search or history operation.

    • resource

      protected Resource resource
      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.

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

  • Constructor Details

  • Method Details

    • getLink

      public List<Bundle.BundleLinkComponent> getLink()
      Returns:
      link (A series of links that provide context to this entry.)

    • setLink

      public Bundle.BundleEntryComponent 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.BundleEntryComponent 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 {3}

    • getFullUrlElement

      public UriType getFullUrlElement()
      Returns:
      fullUrl (The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: invoking a create invoking or responding to an operation where the body is not a single identified resource invoking or returning the results of a search or history operation.). This is the underlying object with id, value and extensions. The accessor "getFullUrl" gives direct access to the value

    • hasFullUrlElement

      public boolean hasFullUrlElement()

    • hasFullUrl

      public boolean hasFullUrl()

    • setFullUrlElement

      public Bundle.BundleEntryComponent setFullUrlElement(UriType value)
      Parameters:
      value - fullUrl (The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: invoking a create invoking or responding to an operation where the body is not a single identified resource invoking or returning the results of a search or history operation.). 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. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: invoking a create invoking or responding to an operation where the body is not a single identified resource invoking or returning the results of a search or history operation.

    • setFullUrl

      public Bundle.BundleEntryComponent setFullUrl(String value)
      Parameters:
      value - The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. 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. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when: invoking a create invoking or responding to an operation where the body is not a single identified resource invoking or returning the results of a search or history operation.

    • getResource

      public Resource getResource()
      Returns:
      resource (The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.)

    • hasResource

      public boolean hasResource()

    • setResource

      public Bundle.BundleEntryComponent setResource(Resource value)
      Parameters:
      value - resource (The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.)

    • getSearch

      public Bundle.BundleEntrySearchComponent getSearch()
      Returns:
      search (Information about the search process that lead to the creation of this entry.)

    • hasSearch

      public boolean hasSearch()

    • setSearch

      public Bundle.BundleEntryComponent setSearch(Bundle.BundleEntrySearchComponent value)
      Parameters:
      value - search (Information about the search process that lead to the creation of this entry.)

    • 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.)

    • hasRequest

      public boolean hasRequest()

    • setRequest

      public Bundle.BundleEntryComponent setRequest(Bundle.BundleEntryRequestComponent value)
      Parameters:
      value - 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.)

    • hasResponse

      public boolean hasResponse()

    • setResponse

      public Bundle.BundleEntryComponent setResponse(Bundle.BundleEntryResponseComponent value)
      Parameters:
      value - 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.)

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class BackboneElement

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class BackboneElement
      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 BackboneElement
      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 BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class BackboneElement
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • copy

      public Bundle.BundleEntryComponent copy()
      Specified by:
      copy in class BackboneElement

    • copyValues

      public void copyValues(Bundle.BundleEntryComponent dst)

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class BackboneElement

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class BackboneElement

    • isEmpty

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

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class BackboneElement
      Returns:
      the FHIR type name of the instance (not the java class name)

    • 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