Class Composition.Section
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.Composition.Section
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- Composition
public static class Composition.Section extends BackboneElement
The root of the sections that make up the composition.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Composition.Section.Builder
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Composition.Section.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<Reference>
getAuthor()
Identifies who is responsible for the information in this section, not necessarily who typed it in.CodeableConcept
getCode()
A code identifying the kind of content contained within the section.CodeableConcept
getEmptyReason()
If the section is empty, why the list is empty.java.util.List<Reference>
getEntry()
A reference to the actual resource from which the narrative in the section is derived.Reference
getFocus()
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.SectionMode
getMode()
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.CodeableConcept
getOrderedBy()
Specifies the order applied to the items in the section entries.java.util.List<Composition.Section>
getSection()
A nested sub-section within this section.Narrative
getText()
A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human.String
getTitle()
The label for this particular section.boolean
hasChildren()
int
hashCode()
Composition.Section.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getTitle
public String getTitle()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getCode
public CodeableConcept getCode()
A code identifying the kind of content contained within the section. This must be consistent with the section title.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getAuthor
public java.util.List<Reference> getAuthor()
Identifies who is responsible for the information in this section, not necessarily who typed it in.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getFocus
public Reference getFocus()
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).- Returns:
- An immutable object of type
Reference
that may be null.
-
getText
public Narrative getText()
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.- Returns:
- An immutable object of type
Narrative
that may be null.
-
getMode
public SectionMode getMode()
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.- Returns:
- An immutable object of type
SectionMode
that may be null.
-
getOrderedBy
public CodeableConcept getOrderedBy()
Specifies the order applied to the items in the section entries.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getEntry
public java.util.List<Reference> getEntry()
A reference to the actual resource from which the narrative in the section is derived.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getEmptyReason
public CodeableConcept getEmptyReason()
If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getSection
public java.util.List<Composition.Section> getSection()
A nested sub-section within this section.- Returns:
- An unmodifiable list containing immutable objects of type
Composition.Section
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.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 interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Composition.Section.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static Composition.Section.Builder builder()
-
-