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

      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

      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

      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

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

      A nested sub-section within this section.
  • Constructor Details

  • Method Details

    • 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

      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

      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

      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

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

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

      Returns:
      Returns a reference to this for easy method chaining
    • hasAuthor

      public boolean hasAuthor()
    • addAuthor

      public Reference addAuthor()
    • addAuthor

    • getAuthorFirstRep

      Returns:
      The first repetition of repeating field author, creating it if it does not already exist
    • getAuthorTarget

      Deprecated.
      Use Reference#setResource(IBaseResource) instead
    • 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

      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

      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

      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

      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

      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

      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

      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

      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

      Returns:
      orderedBy (Specifies the order applied to the items in the section entries.)
    • hasOrderedBy

      public boolean hasOrderedBy()
    • setOrderedBy

      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

      Returns:
      Returns a reference to this for easy method chaining
    • hasEntry

      public boolean hasEntry()
    • addEntry

      public Reference addEntry()
    • addEntry

    • getEntryFirstRep

      Returns:
      The first repetition of repeating field entry, creating it if it does not already exist
    • getEntryTarget

      Deprecated.
      Use Reference#setResource(IBaseResource) instead
    • 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

      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

      Returns:
      section (A nested sub-section within this section.)
    • setSection

      Returns:
      Returns a reference to this for easy method chaining
    • hasSection

      public boolean hasSection()
    • addSection

    • addSection

    • getSectionFirstRep

      Returns:
      The first repetition of repeating field section, creating it if it does not already exist
    • 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

      Specified by:
      copy in class BackboneElement
    • copyValues

    • 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