Package org.hl7.fhir.dstu2.model
Class Composition.SectionComponent
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.Element
-
- org.hl7.fhir.dstu2.model.BackboneElement
-
- org.hl7.fhir.dstu2.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
-
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptcodeA code identifying the kind of content contained within the section.protected CodeableConceptemptyReasonIf the section is empty, why the list is empty.protected List<Reference>entryA reference to the actual resource from which the narrative in the section is derived.protected List<Resource>entryTargetThe actual objects that are the target of the reference (A reference to the actual resource from which the narrative in the section is derived.)protected CodeTypemodeHow the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.protected CodeableConceptorderedBySpecifies the order applied to the items in the section entries.protected List<Composition.SectionComponent>sectionA nested sub-section within this section.protected NarrativetextA human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human.protected StringTypetitleThe label for this particular section.-
Fields inherited from class org.hl7.fhir.dstu2.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description SectionComponent()
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension
-
Methods inherited from class org.hl7.fhir.dstu2.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
-
-
-
-
Field Detail
-
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.
-
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.
-
mode
protected CodeType mode
How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
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.
-
entryTarget
protected List<Resource> entryTarget
The actual objects that are the target of the reference (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 Detail
-
SectionComponent
public SectionComponent()
-
-
Method Detail
-
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.)
-
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.)
-
getModeElement
public CodeType getModeElement()
- Returns:
mode(How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
-
hasModeElement
public boolean hasModeElement()
-
hasMode
public boolean hasMode()
-
setModeElement
public Composition.SectionComponent setModeElement(CodeType value)
- Parameters:
value-mode(How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
-
getMode
public String getMode()
- Returns:
- How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
setMode
public Composition.SectionComponent setMode(String value)
- Parameters:
value- How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
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.)
-
hasEntry
public boolean hasEntry()
-
addEntry
public Reference addEntry()
- Returns:
entry(A reference to the actual resource from which the narrative in the section is derived.)
-
addEntry
public Composition.SectionComponent addEntry(Reference t)
-
getEntryTarget
public List<Resource> getEntryTarget()
- Returns:
entry(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. A reference to the actual resource from which the narrative in the section is derived.)
-
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.)
-
hasSection
public boolean hasSection()
-
addSection
public Composition.SectionComponent addSection()
- Returns:
section(A nested sub-section within this section.)
-
addSection
public Composition.SectionComponent addSection(Composition.SectionComponent t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classBackboneElement
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public Composition.SectionComponent copy()
- Specified by:
copyin classBackboneElement
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classBackboneElement
-
-