Package org.hl7.fhir.r5.model

Class Composition.SectionComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.Composition.SectionComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

Composition

public static class Composition.SectionComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

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 List<Reference>	author	Identifies who is responsible for the information in this section, not necessarily who typed it in.
protected CodeableConcept	code	A code identifying the kind of content contained within the section.
protected CodeableConcept	emptyReason	If the section is empty, why the list is empty.
protected List<Reference>	entry	A reference to the actual resource from which the narrative in the section is derived.
protected Reference	focus	The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor.
protected CodeableConcept	orderedBy	Specifies the order applied to the items in the section entries.
protected List<Composition.SectionComponent>	section	A nested sub-section within this section.
protected Narrative	text	A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human.
protected StringType	title	The label for this particular section.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
SectionComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAuthor()
Composition.SectionComponent	addAuthor(Reference t)
Base	addChild(String name)
Reference	addEntry()
Composition.SectionComponent	addEntry(Reference t)
Composition.SectionComponent	addSection()
Composition.SectionComponent	addSection(Composition.SectionComponent t)
Composition.SectionComponent	copy()
void	copyValues(Composition.SectionComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getAuthor()
Reference	getAuthorFirstRep()
CodeableConcept	getCode()
CodeableConcept	getEmptyReason()
List<Reference>	getEntry()
Reference	getEntryFirstRep()
Reference	getFocus()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
CodeableConcept	getOrderedBy()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Composition.SectionComponent>	getSection()
Composition.SectionComponent	getSectionFirstRep()
Narrative	getText()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthor()
boolean	hasCode()
boolean	hasEmptyReason()
boolean	hasEntry()
boolean	hasFocus()
boolean	hasOrderedBy()
boolean	hasSection()
boolean	hasText()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Composition.SectionComponent	setAuthor(List<Reference> theAuthor)
Composition.SectionComponent	setCode(CodeableConcept value)
Composition.SectionComponent	setEmptyReason(CodeableConcept value)
Composition.SectionComponent	setEntry(List<Reference> theEntry)
Composition.SectionComponent	setFocus(Reference value)
Composition.SectionComponent	setOrderedBy(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Composition.SectionComponent	setSection(List<Composition.SectionComponent> theSection)
Composition.SectionComponent	setText(Narrative value)
Composition.SectionComponent	setTitle(String value)
Composition.SectionComponent	setTitleElement(StringType value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, 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, 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

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

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

title

protected StringType title

The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

code

protected CodeableConcept code

A code identifying the kind of content contained within the section. This must be consistent with the section title.

author

protected List<Reference> author

Identifies who is responsible for the information in this section, not necessarily who typed it in.

focus

protected Reference focus

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

text

protected Narrative text

A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

orderedBy

protected CodeableConcept orderedBy

Specifies the order applied to the items in the section entries.

entry

protected List<Reference> entry

A reference to the actual resource from which the narrative in the section is derived.

emptyReason

protected CodeableConcept emptyReason

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

section

protected List<Composition.SectionComponent> section

A nested sub-section within this section.

Constructor Details

SectionComponent

public SectionComponent()

Constructor

Method Details

getTitleElement

public StringType getTitleElement()

Returns:

title (The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

hasTitleElement

public boolean hasTitleElement()

hasTitle

public boolean hasTitle()

setTitleElement

public Composition.SectionComponent setTitleElement(StringType value)

Parameters:

value - title (The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Returns:

The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

setTitle

public Composition.SectionComponent setTitle(String value)

Parameters:

value - The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

getCode

public CodeableConcept getCode()

Returns:

code (A code identifying the kind of content contained within the section. This must be consistent with the section title.)

hasCode

public boolean hasCode()

setCode

public Composition.SectionComponent setCode(CodeableConcept value)

Parameters:

value - code (A code identifying the kind of content contained within the section. This must be consistent with the section title.)

getAuthor

public List<Reference> getAuthor()

Returns:

author (Identifies who is responsible for the information in this section, not necessarily who typed it in.)

setAuthor

public Composition.SectionComponent setAuthor(List<Reference> theAuthor)

Returns:

Returns a reference to this for easy method chaining

hasAuthor

public boolean hasAuthor()

addAuthor

public Reference addAuthor()

addAuthor

public Composition.SectionComponent addAuthor(Reference t)

getAuthorFirstRep

public Reference getAuthorFirstRep()

Returns:

The first repetition of repeating field author, creating it if it does not already exist {3}

getFocus

public Reference getFocus()

Returns:

focus (The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).)

hasFocus

public boolean hasFocus()

setFocus

public Composition.SectionComponent setFocus(Reference value)

Parameters:

value - focus (The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).)

getText

public Narrative getText()

Returns:

text (A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.)

hasText

public boolean hasText()

setText

public Composition.SectionComponent setText(Narrative value)

Parameters:

value - text (A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.)

getOrderedBy

public CodeableConcept getOrderedBy()

Returns:

orderedBy (Specifies the order applied to the items in the section entries.)

hasOrderedBy

public boolean hasOrderedBy()

setOrderedBy

public Composition.SectionComponent setOrderedBy(CodeableConcept value)

Parameters:

value - orderedBy (Specifies the order applied to the items in the section entries.)

getEntry

public List<Reference> getEntry()

Returns:

entry (A reference to the actual resource from which the narrative in the section is derived.)

setEntry

public Composition.SectionComponent setEntry(List<Reference> theEntry)

Returns:

Returns a reference to this for easy method chaining

hasEntry

public boolean hasEntry()

addEntry

public Reference addEntry()

addEntry

public Composition.SectionComponent addEntry(Reference t)

getEntryFirstRep

public Reference getEntryFirstRep()

Returns:

The first repetition of repeating field entry, creating it if it does not already exist {3}

getEmptyReason

public CodeableConcept getEmptyReason()

Returns:

emptyReason (If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.)

hasEmptyReason

public boolean hasEmptyReason()

setEmptyReason

public Composition.SectionComponent setEmptyReason(CodeableConcept value)

Parameters:

value - emptyReason (If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.)

getSection

public List<Composition.SectionComponent> getSection()

Returns:

section (A nested sub-section within this section.)

setSection

public Composition.SectionComponent setSection(List<Composition.SectionComponent> theSection)

Returns:

Returns a reference to this for easy method chaining

hasSection

public boolean hasSection()

addSection

public Composition.SectionComponent addSection()

addSection

public Composition.SectionComponent addSection(Composition.SectionComponent t)

getSectionFirstRep

public Composition.SectionComponent getSectionFirstRep()

Returns:

The first repetition of repeating field section, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public Composition.SectionComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Composition.SectionComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class BackboneElement

Returns:

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