Package com.ibm.fhir.model.type

Class Narrative

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.Narrative

All Implemented Interfaces:

Visitable

@Generated("com.ibm.fhir.tools.CodeGenerator")
public class Narrative
extends Element

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Narrative.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static Narrative	EMPTY

Fields inherited from class com.ibm.fhir.model.type.Element

extension, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static Narrative.Builder	builder()
boolean	equals(Object obj)
Xhtml	getDiv()	The actual narrative content, a stripped down version of XHTML.
NarrativeStatus	getStatus()	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.
boolean	hasChildren()
int	hashCode()
Narrative.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Field Detail

EMPTY

public static final Narrative EMPTY

Method Detail

getStatus

public NarrativeStatus getStatus()

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.

Returns:

An immutable object of type NarrativeStatus that is non-null.

getDiv

public Xhtml getDiv()

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

Returns:

An immutable object of type Xhtml that is non-null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class Element

accept

public void accept(String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public Narrative.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class Element

builder

public static Narrative.Builder builder()