Reference (HAPI FHIR Structures - HL7.org DSTU2 1.3 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.Element
  - - org.hl7.fhir.instance.model.Type
    - - org.hl7.fhir.instance.model.BaseReference
      - org.hl7.fhir.instance.model.Reference

All Implemented Interfaces:

Serializable, IBase, IBaseDatatype, IBaseHasExtensions, IBaseReference, ICompositeType
```
public class Reference
extends BaseReference
implements IBaseReference, ICompositeType
```
A reference from one resource to another.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Reference()`
`Reference(IAnyResource theResource)` Constructor
`Reference(IdType theReference)` Constructor
`Reference(String theReference)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Reference`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`getDisplay()`
`StringType`	`getDisplayElement()`
`String`	`getReference()`
`boolean`	`hasDisplay()`
`boolean`	`hasDisplayElement()`
`boolean`	`hasReference()`
`boolean`	`hasReferenceElement()`
`boolean`	`isEmpty()`
`Reference`	`setDisplay(String value)`
`Reference`	`setDisplayElement(StringType value)`
`Reference`	`setReference(String value)`
`Reference`	`setReferenceElement(StringType value)`

Methods inherited from class org.hl7.fhir.instance.model.BaseReference
getReferenceElement, getResource, setResource

Methods inherited from class org.hl7.fhir.instance.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getId, getIdElement, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseReference
getReferenceElement, getResource, setResource

- Constructor Detail
  - Reference
```
public Reference()
```
  - Reference
```
public Reference(String theReference)
```
    Constructor
    
    Parameters:
    
    theReference - The given reference string (e.g. "Patient/123" or "http://example.com/Patient/123")
  - Reference
```
public Reference(IdType theReference)
```
    Constructor
    
    Parameters:
    
    theReference - The given reference as an IdType (e.g. "Patient/123" or "http://example.com/Patient/123")
  - Reference
```
public Reference(IAnyResource theResource)
```
    Constructor
    
    Parameters:
    
    theResource - The resource represented by this reference
- Method Detail
  - hasReferenceElement
```
public boolean hasReferenceElement()
```
    Returns:
    
    reference (A reference to a location at which the other resource is found. The reference may be 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.). This is the underlying object with id, value and extensions. The accessor "getReference" gives direct access to the value
  - hasReference
```
public boolean hasReference()
```
  - setReferenceElement
```
public Reference setReferenceElement(StringType value)
```
    Parameters:
    
    value - reference (A reference to a location at which the other resource is found. The reference may be 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.). This is the underlying object with id, value and extensions. The accessor "getReference" gives direct access to the value
  - getReference
```
public String getReference()
```
    Returns:
    
    A reference to a location at which the other resource is found. The reference may be 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.
  - setReference
```
public Reference setReference(String value)
```
    Specified by:
    
    setReference in interface IBaseReference
    
    Parameters:
    
    value - A reference to a location at which the other resource is found. The reference may be 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.
  - getDisplayElement
```
public StringType getDisplayElement()
```
    Specified by:
    
    getDisplayElement in interface IBaseReference
    
    Returns:
    
    display (Plain text narrative that identifies the resource in addition to the resource reference.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
  - hasDisplayElement
```
public boolean hasDisplayElement()
```
  - hasDisplay
```
public boolean hasDisplay()
```
  - setDisplayElement
```
public Reference setDisplayElement(StringType value)
```
    Parameters:
    
    value - display (Plain text narrative that identifies the resource in addition to the resource reference.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
  - getDisplay
```
public String getDisplay()
```
    Returns:
    
    Plain text narrative that identifies the resource in addition to the resource reference.
  - setDisplay
```
public Reference setDisplay(String value)
```
    Specified by:
    
    setDisplay in interface IBaseReference
    
    Parameters:
    
    value - Plain text narrative that identifies the resource in addition to the resource reference.
  - copy
```
public Reference copy()
```
    Overrides:
    
    copy in class Type
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class Element
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class Element
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class BaseReference

Class Reference

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.BaseReference

Methods inherited from class org.hl7.fhir.instance.model.Element

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference

Reference

Reference

Reference

Method Detail

hasReferenceElement

hasReference

setReferenceElement

getReference

setReference

getDisplayElement

hasDisplayElement

hasDisplay

setDisplayElement

getDisplay

setDisplay

copy

equalsDeep

equalsShallow

isEmpty