Package com.ibm.fhir.model.type
Class Narrative.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Element>
-
- com.ibm.fhir.model.type.Element.Builder
-
- com.ibm.fhir.model.type.Narrative.Builder
-
- Enclosing class:
- Narrative
public static class Narrative.Builder extends Element.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.Element.Builder
extension, id
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Narrativebuild()Build theNarrativeNarrative.Builderdiv(Xhtml div)The actual narrative content, a stripped down version of XHTML.Narrative.Builderextension(Extension... extension)May be used to represent additional information that is not part of the basic definition of the element.Narrative.Builderextension(Collection<Extension> extension)May be used to represent additional information that is not part of the basic definition of the element.protected Narrative.Builderfrom(Narrative narrative)Narrative.Builderid(String id)Unique id for the element within a resource (for internal references).Narrative.Builderstatus(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.-
Methods inherited from class com.ibm.fhir.model.type.Element.Builder
from
-
-
-
-
Method Detail
-
id
public Narrative.Builder id(String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
idin classElement.Builder- Parameters:
id- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public Narrative.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list
- Overrides:
extensionin classElement.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public Narrative.Builder extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection
- Overrides:
extensionin classElement.Builder- Parameters:
extension- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
status
public Narrative.Builder status(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.This element is required.
- Parameters:
status- generated | extensions | additional | empty- Returns:
- A reference to this Builder instance
-
div
public Narrative.Builder div(Xhtml div)
The actual narrative content, a stripped down version of XHTML.This element is required.
- Parameters:
div- Limited xhtml content- Returns:
- A reference to this Builder instance
-
build
public Narrative build()
- Specified by:
buildin interfaceBuilder<Element>- Specified by:
buildin classElement.Builder- Returns:
- An immutable object of type
Narrative - Throws:
IllegalStateException- if the current state cannot be built into a valid Narrative per the base specification
-
from
protected Narrative.Builder from(Narrative narrative)
-
-