Data Model Libraries
    Preparing search index...

    Class CompositionSectionComponent

    CompositionSectionComponent Class

    FHIR Specification

    • Short: Composition is broken into sections
    • Definition: The root of the sections that make up the composition.

    FHIR Composition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    title? code? author? focus? text? listModeEnum mode? orderedBy? entry? emptyReason? section?

    Methods

    parse getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getCode setCode hasCode getAuthor setAuthor addAuthor hasAuthor getFocus setFocus hasFocus getText setText hasText getModeEnumType setModeEnumType hasModeEnumType getModeElement setModeElement hasModeElement getMode setMode hasMode getOrderedBy setOrderedBy hasOrderedBy getEntry setEntry addEntry hasEntry getEmptyReason setEmptyReason hasEmptyReason getSection setSection addSection hasSection fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initAuthor initEntry initSection

    Constructors

    Properties

    title?: StringType

    Composition.section.title Element

    FHIR Specification

    • Short: Label for section (e.g. for ToC)
    • Definition: 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.
    • Comment: The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
    • Requirements: Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    Composition.section.code Element

    FHIR Specification

    • Short: Classification of section (recommended)
    • Definition: A code identifying the kind of content contained within the section. This must be consistent with the section title.
    • Comment: The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
    • Requirements: Provides computable standardized labels to topics within the document.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    author?: Reference[]

    Composition.section.author Element

    FHIR Specification

    focus?: Reference

    Composition.section.focus Element

    FHIR Specification

    • Short: Who/what the section is about, when it is not about the subject of composition
    • Definition: 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).
    • Comment: Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Private Optionaltext

    text?: Narrative

    Composition.section.text Element

    FHIR Specification

    • Short: Text summary of the section, for human interpretation
    • Definition: 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.
    • Comment: Document profiles may define what content should be represented in the narrative to ensure clinical safety.
    • FHIR Type: Narrative
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    listModeEnum: ListModeEnum

    FHIR CodeSystem: ListMode

    ListModeEnum

    mode?: EnumCodeType

    Composition.section.mode Element

    FHIR Specification

    • Short: working | snapshot | changes
    • Definition: 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.
    • Comment: This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
    • Requirements: Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ListModeEnum

    orderedBy?: CodeableConcept

    Composition.section.orderedBy Element

    FHIR Specification

    • Short: Order of section entries
    • Definition: Specifies the order applied to the items in the section entries.
    • Comment: Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
    • Requirements: Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Private Optionalentry

    entry?: Reference[]

    Composition.section.entry Element

    FHIR Specification

    • Short: A reference to data that supports this section
    • Definition: A reference to the actual resource from which the narrative in the section is derived.
    • Comment: If there are no entries in the list, an emptyReason SHOULD be provided.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    emptyReason?: CodeableConcept

    Composition.section.emptyReason Element

    FHIR Specification

    • Short: Why the section is empty
    • Definition: If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
    • Comment: The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.
    • Requirements: Allows capturing things like "none exist" or "not asked" which can be important for most lists.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    section?: CompositionSectionComponent[]

    Composition.section.section Element

    FHIR Specification

    • Short: Nested Section
    • Definition: A nested sub-section within this section.
    • Comment: Nested sections are primarily used to help human readers navigate to particular portions of the document.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided CompositionSectionComponent JSON to instantiate the CompositionSectionComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR CompositionSectionComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CompositionSectionComponent

      Returns undefined | CompositionSectionComponent

      CompositionSectionComponent data model or undefined for CompositionSectionComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the author property.

      Parameters

      • value: undefined | Reference[]

        the author array value

      Returns this

      this

      @ReferenceTargets('Composition.section.author', ['Practitioner','PractitionerRole','Device','Patient','RelatedPerson','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the author array property.

      Parameters

      • value: undefined | Reference

        the author value

      Returns this

      this

      @ReferenceTargets('Composition.section.author', ['Practitioner','PractitionerRole','Device','Patient','RelatedPerson','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetCodesetCodehasCodegetAuthorsetAuthoraddAuthorhasAuthorgetFocussetFocushasFocusgetTextsetTexthasTextgetModeEnumTypesetModeEnumTypehasModeEnumTypegetModeElementsetModeElementhasModeElementgetModesetModehasModegetOrderedBysetOrderedByhasOrderedBygetEntrysetEntryaddEntryhasEntrygetEmptyReasonsetEmptyReasonhasEmptyReasongetSectionsetSectionaddSectionhasSectionfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitAuthorinitEntryinitSection