Data Model Libraries
    Preparing search index...

    Class BackboneElementAbstract

    Abstract BackboneElement Class

    Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.

    FHIR Specification

    • Short: Base for elements defined inside a resource
    • Definition: Base definition for all elements that are defined inside a resource - but not those in a data type.
    • FHIR Version: 4.0.1; Normative since 4.0.0

    FHIR BackboneElement

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    modifierExtension? initModifierExtension existsModifierExtension

    Methods

    getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension fhirType isEmpty copy toJSON getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    modifierExtension?: any

    BackboneElement.modifierExtension Element

    FHIR Specification

    • Short: Extensions that cannot be ignored even if unrecognized
    • Definition: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
    • Comment: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
    • Requirements: Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
    • FHIR Type: Extension
    • Cardinality: 0..*
    • isModifier: true
    • isModifierReason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    • isSummary: true
    initModifierExtension: any

    Ensures the modifierExtension property exists and if not initializes it to an empty array.

    existsModifierExtension: any

    Determines if modifierExtension property exists, and if not, determines if the modifierExtension array is empty.

    true if the modifierExtension property exists and has at least one element; false otherwise

    Methods

    • Assigns the provided array of Extension values to the modifierExtension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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 the Extension having the provided url.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      the Extension having the provided url

      AssertionError for invalid url

    • Adds the provided Extension to the modifierExtension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the modifierExtension property array

      Returns this

      this

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

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns string

      the FHIR type defined in the FHIR standard

    • Returns boolean

      true if the instance is empty; false otherwise

    • Returns undefined | Value

      the JSON value

    • 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

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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 resource; false otherwise

    • Returns boolean

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

    • Returns boolean

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

    • Protected

      Copies the current instance's elements into the provided object.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods