Package org.hl7.fhir.r5.model

Class Annotation

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.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 DataType
implements org.hl7.fhir.instance.model.api.ICompositeType

Annotation Type: A text note which also contains information about who made the statement and when.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected DataType	author	The individual responsible for making the annotation.
protected MarkdownType	text	The text of the annotation in markdown format.
protected DateTimeType	time	Indicates when this particular annotation was made.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
Annotation()	Constructor
Annotation(String text)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Annotation	copy()
void	copyValues(Annotation dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
DataType	getAuthor()
Reference	getAuthorReference()
StringType	getAuthorStringType()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getText()
MarkdownType	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> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Annotation	setAuthor(DataType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Annotation	setText(String value)
Annotation	setTextElement(MarkdownType value)
Annotation	setTime(Date value)
Annotation	setTimeElement(DateTimeType value)
protected Annotation	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getExtensionValue, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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 Details

author

protected DataType author

The individual responsible for making the annotation.

time

protected DateTimeType time

Indicates when this particular annotation was made.

text

protected MarkdownType text

The text of the annotation in markdown format.

Constructor Details

Annotation

public Annotation()

Constructor

Annotation

public Annotation(String text)

Constructor

Method Details

getAuthor

public DataType 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(DataType 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 MarkdownType getTextElement()

Returns:

text (The text of the annotation in markdown format.). 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(MarkdownType value)

Parameters:

value - text (The text of the annotation in markdown format.). 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 in markdown format.

setText

public Annotation setText(String value)

Parameters:

value - The text of the annotation in markdown format.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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 DataType

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Annotation copy()

Specified by:

copy in class DataType

copyValues

public void copyValues(Annotation dst)

typedCopy

protected Annotation typedCopy()

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