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:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseDatatype, IBaseReference, ICompositeType

public class ResourceReferenceDt
extends BaseResourceReferenceDt
implements ICompositeDatatype

HAPI/FHIR ResourceReferenceDt Datatype (A reference from one resource to another)

Definition: A reference from one resource to another

Requirements:

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceReferenceDt() Constructor
ResourceReferenceDt(IdDt theResourceId) Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)
ResourceReferenceDt(IIdType theResourceId) Constructor which accepts a reference directly (this can be an ID, a partial/relative URL or a complete/absolute URL)
ResourceReferenceDt(IResource theResource) Constructor which creates a resource reference containing the actual resource in question.
ResourceReferenceDt(String theId) 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 and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
StringDt	getDisplay() Gets the value(s) for display (Text alternative for the resource).
StringDt	getDisplayElement()
IdDt	getReference() Gets the value(s) for reference (Relative, internal or absolute URL reference).
IdDt	getReferenceElement()
boolean	isEmpty()
ResourceReferenceDt	setDisplay(String theString) Sets the value for display (Text alternative for the resource)
ResourceReferenceDt	setDisplay(StringDt theValue) Sets the value(s) for display (Text alternative for the resource)
ResourceReferenceDt	setReference(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, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceReferenceDt

public ResourceReferenceDt()

Constructor

ResourceReferenceDt

public ResourceReferenceDt(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(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(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 Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getReference

public 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 BaseResourceReferenceDt

getReferenceElement

public IdDt getReferenceElement()

Specified by:

getReferenceElement in interface IBaseReference

setReference

public ResourceReferenceDt setReference(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 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 IBaseReference

getDisplay

public 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(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 IBaseReference

getDisplayElement

public StringDt getDisplayElement()

Specified by:

getDisplayElement in interface IBaseReference

Overrides:

getDisplayElement in class BaseResourceReferenceDt