Package ca.uhn.fhir.model.dstu2.composite

Class ResourceReferenceDt

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.base.composite.BaseResourceReferenceDt
ca.uhn.fhir.model.dstu2.composite.ResourceReferenceDt
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseReference, org.hl7.fhir.instance.model.api.ICompositeType
public class ResourceReferenceDt extends ca.uhn.fhir.model.base.composite.BaseResourceReferenceDt implements ca.uhn.fhir.model.api.ICompositeDatatype
HAPI/FHIR ResourceReferenceDt Datatype (A reference from one resource to another)

Definition: A reference from one resource to another

Requirements:

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResourceReferenceDt()
    Constructor
    ResourceReferenceDt(ca.uhn.fhir.model.api.IResource theResource)
    Constructor which creates a resource reference containing the actual resource in question.
    ResourceReferenceDt(ca.uhn.fhir.model.primitive.IdDt theResourceId)
    Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)
    ResourceReferenceDt(String theId)
    Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)
    ResourceReferenceDt(org.hl7.fhir.instance.model.api.IIdType theResourceId)
    Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends ca.uhn.fhir.model.api.IElement>
    List<T>
    getAllPopulatedChildElementsOfType(Class<T> theType)
     
    ca.uhn.fhir.model.primitive.StringDt
    getDisplay()
    Gets the value(s) for display (Text alternative for the resource).
    ca.uhn.fhir.model.primitive.StringDt
    getDisplayElement()
     
    ca.uhn.fhir.model.primitive.IdDt
    getReference()
    Gets the value(s) for reference (Relative, internal or absolute URL reference).
    ca.uhn.fhir.model.primitive.IdDt
    getReferenceElement()
     
    boolean
    isEmpty()
     
    ResourceReferenceDt
    setDisplay(ca.uhn.fhir.model.primitive.StringDt theValue)
    Sets the value(s) for display (Text alternative for the resource)
    ResourceReferenceDt
    setDisplay(String theString)
    Sets the value for display (Text alternative for the resource)
    ResourceReferenceDt
    setReference(ca.uhn.fhir.model.primitive.IdDt theValue)
    Sets the value(s) for reference (Relative, internal or absolute URL reference)
    ResourceReferenceDt
    setReference(String theId)
    Sets the value for reference (Relative, internal or absolute URL reference)

    Methods inherited from class ca.uhn.fhir.model.base.composite.BaseResourceReferenceDt

    getResource, isBaseEmpty, loadResource, setReference, setResource, toString

    Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

    getElementSpecificId, getId, setElementSpecificId, setId, setId

    Methods inherited from class ca.uhn.fhir.model.api.BaseElement

    addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData

    Methods inherited from class java.lang.Object

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

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

    fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

    hasIdentifier

  • Constructor Details

    • ResourceReferenceDt

      public ResourceReferenceDt()
      Constructor

    • ResourceReferenceDt

      public ResourceReferenceDt(ca.uhn.fhir.model.api.IResource theResource)
      Constructor which creates a resource reference containing the actual resource in question.

      When using this in a server: Generally if this is serialized, it will be serialized as a contained resource, so this should not be used if the intent is not to actually supply the referenced resource. This is not a hard-and-fast rule however, as the server can be configured to not serialized this resource, or to load an ID and contain even if this constructor is not used.

      Parameters:
      theResource - The resource instance

    • ResourceReferenceDt

      public ResourceReferenceDt(String theId)
      Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)
      Parameters:
      theId - The reference itself

    • ResourceReferenceDt

      public ResourceReferenceDt(ca.uhn.fhir.model.primitive.IdDt theResourceId)
      Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)
      Parameters:
      theResourceId - The reference itself

    • ResourceReferenceDt

      public ResourceReferenceDt(org.hl7.fhir.instance.model.api.IIdType theResourceId)
      Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)
      Parameters:
      theResourceId - The reference itself

  • Method Details

    • isEmpty

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

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getReference

      public ca.uhn.fhir.model.primitive.IdDt getReference()
      Gets the value(s) for reference (Relative, internal or absolute URL reference). creating it if it does not exist. Will not return null.

      Definition: A reference to a location at which the other resource is found. The reference may a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources

      Specified by:
      getReference in class ca.uhn.fhir.model.base.composite.BaseResourceReferenceDt

    • getReferenceElement

      public ca.uhn.fhir.model.primitive.IdDt getReferenceElement()
      Specified by:
      getReferenceElement in interface org.hl7.fhir.instance.model.api.IBaseReference

    • setReference

      public ResourceReferenceDt setReference(ca.uhn.fhir.model.primitive.IdDt theValue)
      Sets the value(s) for reference (Relative, internal or absolute URL reference)

      Definition: A reference to a location at which the other resource is found. The reference may a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources

      Specified by:
      setReference in class ca.uhn.fhir.model.base.composite.BaseResourceReferenceDt

    • setReference

      public ResourceReferenceDt setReference(String theId)
      Sets the value for reference (Relative, internal or absolute URL reference)

      Definition: A reference to a location at which the other resource is found. The reference may a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources

      Specified by:
      setReference in interface org.hl7.fhir.instance.model.api.IBaseReference

    • getDisplay

      public ca.uhn.fhir.model.primitive.StringDt getDisplay()
      Gets the value(s) for display (Text alternative for the resource). creating it if it does not exist. Will not return null.

      Definition: Plain text narrative that identifies the resource in addition to the resource reference

    • setDisplay

      public ResourceReferenceDt setDisplay(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for display (Text alternative for the resource)

      Definition: Plain text narrative that identifies the resource in addition to the resource reference

    • setDisplay

      public ResourceReferenceDt setDisplay(String theString)
      Sets the value for display (Text alternative for the resource)

      Definition: Plain text narrative that identifies the resource in addition to the resource reference

      Specified by:
      setDisplay in interface org.hl7.fhir.instance.model.api.IBaseReference

    • getDisplayElement

      public ca.uhn.fhir.model.primitive.StringDt getDisplayElement()
      Specified by:
      getDisplayElement in interface org.hl7.fhir.instance.model.api.IBaseReference
      Specified by:
      getDisplayElement in class ca.uhn.fhir.model.base.composite.BaseResourceReferenceDt