Package org.hl7.fhir.r4.model

Class 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 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.

      • author

        protected List<Reference> author
        Identifies who is responsible for the information in this section, not necessarily who typed it in.

      • authorTarget

        protected List<Resource> authorTarget
        The actual objects that are the target of the reference (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).

      • focusTarget

        protected Resource focusTarget
        The actual object that is the target of the reference (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.

      • mode

        protected Enumeration<Composition.SectionMode> 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.

      • 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.

    • 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

      • 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()

      • getAuthor

        public List<Reference> getAuthor()
        Returns:
        author (Identifies who is responsible for the information in this section, not necessarily who typed it in.)

      • 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).)

      • 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).)

      • getFocusTarget

        public Resource getFocusTarget()
        Returns:
        focus The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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).)

      • setFocusTarget

        public Composition.SectionComponent setFocusTarget​(Resource value)
        Parameters:
        value - focus The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)

      • getModeElement

        public Enumeration<Composition.SectionMode> 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

      • hasMode

        public boolean hasMode()

      • setModeElement

        public Composition.SectionComponent setModeElement​(Enumeration<Composition.SectionMode> 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 Composition.SectionMode 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​(Composition.SectionMode 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.

      • getEntry

        public List<Reference> getEntry()
        Returns:
        entry (A reference to the actual resource from which the narrative in the section is derived.)

      • getEntryFirstRep

        public Reference getEntryFirstRep()
        Returns:
        The first repetition of repeating field entry, creating it if it does not already exist

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class BackboneElement