org.hl7.fhir.dstu3.model

Class Narrative

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.BaseNarrative

org.hl7.fhir.dstu3.model.Narrative

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, ICompositeType, INarrative

public class Narrative
extends BaseNarrative
implements INarrative

A human-readable formatted text, including images.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Narrative.NarrativeStatus
static class	Narrative.NarrativeStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected XhtmlNode	div The actual narrative content, a stripped down version of XHTML.
protected Enumeration<Narrative.NarrativeStatus>	status The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

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

extension, id

Constructor Summary

Constructors

Constructor and Description
Narrative() Constructor
Narrative(Enumeration<Narrative.NarrativeStatus> status, XhtmlNode div) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Narrative	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
XhtmlNode	getDiv()
Base[]	getProperty(int hash, String name, boolean checkValid)
Narrative.NarrativeStatus	getStatus()
Enumeration<Narrative.NarrativeStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasDiv()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
Narrative	setDiv(XhtmlNode value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Narrative	setStatus(Narrative.NarrativeStatus value)
Narrative	setStatusElement(Enumeration<Narrative.NarrativeStatus> value)
protected Narrative	typedCopy()

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

getDivAsString, getStatusAsString, setDivAsString, setStatusAsString

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.INarrative

getDivAsString, getStatusAsString, setDivAsString, setStatusAsString

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

status

protected Enumeration<Narrative.NarrativeStatus> status

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

div

protected XhtmlNode div

The actual narrative content, a stripped down version of XHTML.

Constructor Detail

Narrative

public Narrative()

Constructor

Narrative

public Narrative(Enumeration<Narrative.NarrativeStatus> status,
                 XhtmlNode div)

Constructor

Method Detail

getStatusElement

public Enumeration<Narrative.NarrativeStatus> getStatusElement()

Specified by:

getStatusElement in class BaseNarrative

Returns:

status (The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Narrative setStatusElement(Enumeration<Narrative.NarrativeStatus> value)

Parameters:

value - status (The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Narrative.NarrativeStatus getStatus()

Returns:

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

setStatus

public Narrative setStatus(Narrative.NarrativeStatus value)

Parameters:

value - The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

getDiv

public XhtmlNode getDiv()

Specified by:

getDiv in class BaseNarrative

Returns:

div (The actual narrative content, a stripped down version of XHTML.)

hasDiv

public boolean hasDiv()

setDiv

public Narrative setDiv(XhtmlNode value)

Specified by:

setDiv in class BaseNarrative

Parameters:

value - div (The actual narrative content, a stripped down version of XHTML.)

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

Overrides:

copy in class Type

typedCopy

protected Narrative 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

Specified by:

isEmpty in interface INarrative

Overrides:

isEmpty in class Element