Package org.hl7.fhir.dstu2.model

Class Annotation

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.Type

org.hl7.fhir.dstu2.model.Annotation

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class Annotation
extends Type
implements org.hl7.fhir.instance.model.api.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	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.dstu2.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
Annotation()
Annotation(StringType text)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Annotation	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Type	getAuthor()
Reference	getAuthorReference()
StringType	getAuthorStringType()
String	getText()
StringType	getTextElement()
Date	getTime()
DateTimeType	getTimeElement()
boolean	hasAuthor()
boolean	hasAuthorReference()
boolean	hasAuthorStringType()
boolean	hasText()
boolean	hasTextElement()
boolean	hasTime()
boolean	hasTimeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Annotation	setAuthor(Type value)
void	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.dstu2.model.Element

addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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()

Annotation

public Annotation(StringType text)

Method Detail

getAuthor

public Type getAuthor()

Returns:

author (The individual responsible for making the annotation.)

getAuthorReference

public Reference getAuthorReference()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

author (The individual responsible for making the annotation.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAuthorReference

public boolean hasAuthorReference()

getAuthorStringType

public StringType getAuthorStringType()
                               throws org.hl7.fhir.exceptions.FHIRException

Returns:

author (The individual responsible for making the annotation.)

Throws:

org.hl7.fhir.exceptions.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

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Element