Data Model Libraries
    Preparing search index...

    Class DomainResourceAbstract

    Abstract DomainResource Class

    A resource that includes narrative, extensions, and contained resources.

    FHIR Specification

    • Short: A resource with narrative, extensions, and contained resources.
    • Definition: A resource that includes narrative, extensions, and contained resources.
    • FHIR Version: 4.0.1; Normative since 4.0.0

    FHIR DomainResource

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    text? contained? extension? modifierExtension? initContained initExtension existsExtension initModifierExtension existsModifierExtension

    Methods

    parse getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension fhirType isEmpty copy toJSON resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    Private Optionaltext

    text?: any

    DomainResource.text Element

    FHIR Specification

    • Short: Text summary of the resource, for human interpretation
    • Definition: A human-readable narrative that contains a summary of the resource and can be 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. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
    • Comment: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
    • FHIR Type: Narrative
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    contained?: any

    DomainResource.contained Element

    FHIR Specification

    • Short: Contained, inline Resources
    • Definition: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
    • Comment: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
    • FHIR Type: Resource
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    extension?: any

    DomainResource.extension Element

    FHIR Specification

    • Short: Additional content defined by implementations
    • Definition: May be used to represent additional information that is not part of the basic definition of the resource. 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.
    • 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.
    • FHIR Type: Extension
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    modifierExtension?: any

    DomainResource.modifierExtension Element

    FHIR Specification

    • Short: Extensions that cannot be ignored
    • Definition: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 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.
    • isSummary: false
    initContained: any

    Initialize the contained property

    initExtension: any

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

    existsExtension: any

    Determines if extension property exists, and if so, determines if the extension array is empty.

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

    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 so, determines if the modifierExtension array is empty.

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

    Methods

    • Parse the provided json to instantiate the data model.

      Parameters

      • _sourceJson: JsonObject

        JSON representing FHIR resource

      • Optional_optSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>)

      Returns undefined | IResource

      Data model or undefined

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Add the provided Resource value to the contained array property.

      Parameters

      • value: undefined | IResource

        the contained value

      Returns this

      this

    • Returns boolean

      true if the contained property 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

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

    • 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

      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 string

      the FHIR resource type as defined by the FHIR specification

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • 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

    • 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