Annotation (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.Type
    - - org.hl7.fhir.dstu3.model.Annotation

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, ICompositeType
```
public class Annotation
extends Type
implements ICompositeType
```
A text note which also contains information about who made the statement and when.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Type`	`author` The individual responsible for making the annotation.
`protected StringType`	`text` The text of the annotation.
`protected DateTimeType`	`time` Indicates when this particular annotation was made.

Fields inherited from class org.hl7.fhir.dstu3.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

Annotation()
Constructor

Annotation(StringType text)
Constructor

Constructors
Constructor and Description
`Annotation()` Constructor
`Annotation(StringType text)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Annotation`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`Type`	`getAuthor()`
`Reference`	`getAuthorReference()`
`StringType`	`getAuthorStringType()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getText()`
`StringType`	`getTextElement()`
`Date`	`getTime()`
`DateTimeType`	`getTimeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAuthor()`
`boolean`	`hasAuthorReference()`
`boolean`	`hasAuthorStringType()`
`boolean`	`hasText()`
`boolean`	`hasTextElement()`
`boolean`	`hasTime()`
`boolean`	`hasTimeElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Annotation`	`setAuthor(Type value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Annotation`	`setText(String value)`
`Annotation`	`setTextElement(StringType value)`
`Annotation`	`setTime(Date value)`
`Annotation`	`setTimeElement(DateTimeType value)`
`protected Annotation`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - author
```
protected Type author
```
    The individual responsible for making the annotation.
  - time
```
protected DateTimeType time
```
    Indicates when this particular annotation was made.
  - text
```
protected StringType text
```
    The text of the annotation.
- Constructor Detail
  - Annotation
```
public Annotation()
```
    Constructor
  - Annotation
```
public Annotation(StringType text)
```
    Constructor
- Method Detail
  - getAuthor
```
public Type getAuthor()
```
    Returns:
    
    author (The individual responsible for making the annotation.)
  - getAuthorReference
```
public Reference getAuthorReference()
                             throws FHIRException
```
    Returns:
    
    author (The individual responsible for making the annotation.)
    
    Throws:
    
    FHIRException
  - hasAuthorReference
```
public boolean hasAuthorReference()
```
  - getAuthorStringType
```
public StringType getAuthorStringType()
                               throws FHIRException
```
    Returns:
    
    author (The individual responsible for making the annotation.)
    
    Throws:
    
    FHIRException
  - hasAuthorStringType
```
public boolean hasAuthorStringType()
```
  - hasAuthor
```
public boolean hasAuthor()
```
  - setAuthor
```
public Annotation setAuthor(Type value)
```
    Parameters:
    
    value - author (The individual responsible for making the annotation.)
  - getTimeElement
```
public DateTimeType getTimeElement()
```
    Returns:
    
    time (Indicates when this particular annotation was made.). This is the underlying object with id, value and extensions. The accessor "getTime" gives direct access to the value
  - hasTimeElement
```
public boolean hasTimeElement()
```
  - hasTime
```
public boolean hasTime()
```
  - setTimeElement
```
public Annotation setTimeElement(DateTimeType value)
```
    Parameters:
    
    value - time (Indicates when this particular annotation was made.). This is the underlying object with id, value and extensions. The accessor "getTime" gives direct access to the value
  - getTime
```
public Date getTime()
```
    Returns:
    
    Indicates when this particular annotation was made.
  - setTime
```
public Annotation setTime(Date value)
```
    Parameters:
    
    value - Indicates when this particular annotation was made.
  - getTextElement
```
public StringType getTextElement()
```
    Returns:
    
    text (The text of the annotation.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
  - hasTextElement
```
public boolean hasTextElement()
```
  - hasText
```
public boolean hasText()
```
  - setTextElement
```
public Annotation setTextElement(StringType value)
```
    Parameters:
    
    value - text (The text of the annotation.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
  - getText
```
public String getText()
```
    Returns:
    
    The text of the annotation.
  - setText
```
public Annotation setText(String value)
```
    Parameters:
    
    value - The text of the annotation.
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class Element
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class Element
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class Element
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class Element
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class Element
  - copy
```
public Annotation copy()
```
    Overrides:
    
    copy in class Type
  - typedCopy
```
protected Annotation typedCopy()
```
    Specified by:
    
    typedCopy 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 Element

Class Annotation

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.Element

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

author

time

text

Constructor Detail

Annotation

Annotation

Method Detail

getAuthor

getAuthorReference

hasAuthorReference

getAuthorStringType

hasAuthorStringType

hasAuthor

setAuthor

getTimeElement

hasTimeElement

hasTime

setTimeElement

getTime

setTime

getTextElement

hasTextElement

hasText

setTextElement

getText

setText

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow

isEmpty