Data Model Libraries
    Preparing search index...

    Interface IDomainResource

    Represents a domain-level resource that extends the core IResource with additional properties like text, contained resources, and extensions. This interface builds upon foundational FHIR interfaces (IResource, IBase, IBaseExtension, IBaseModifierExtension).

    interface IDomainResource {
        getText: () => Narrative;
        setText: (value: undefined | Narrative) => this;
        hasText: () => boolean;
        getContained: () => IResource[];
        setContained: (value: undefined | IResource[]) => this;
        addContained: (value: undefined | IResource) => this;
        hasContained: () => boolean;
        getExtension: () => IExtension[];
        setExtension: (extension: undefined | IExtension[]) => this;
        addExtension: (extension: undefined | IExtension) => this;
        hasExtension: (url?: string) => boolean;
        getModifierExtension: () => IExtension[];
        setModifierExtension: (extension: undefined | IExtension[]) => this;
        addModifierExtension: (extension: undefined | IExtension) => this;
        hasModifierExtension: (url?: string) => boolean;
        resourceType: () => string;
        getIdElement: () => IdType;
        setIdElement: (element: undefined | IdType) => this;
        hasIdElement: () => boolean;
        getId: () => undefined | string;
        setId: (value: undefined | string) => this;
        hasId: () => boolean;
        getMeta: () => Meta;
        setMeta: (value: undefined | Meta) => this;
        hasMeta: () => boolean;
        getImplicitRulesElement: () => UriType;
        setImplicitRulesElement: (element: undefined | UriType) => this;
        hasImplicitRulesElement: () => boolean;
        getImplicitRules: () => undefined | string;
        setImplicitRules: (value: undefined | string) => this;
        hasImplicitRules: () => boolean;
        getLanguageElement: () => CodeType;
        setLanguageElement: (element: undefined | CodeType) => this;
        hasLanguageElement: () => boolean;
        getLanguage: () => undefined | string;
        setLanguage: (value: undefined | string) => this;
        hasLanguage: () => boolean;
        fhirType: () => string;
        isEmpty: () => boolean;
        copy: () => any;
        toJSON: () => undefined | Value;
        isRequiredFieldsEmpty: () => boolean;
        isResource: () => boolean;
        isDataType: () => boolean;
        isComplexDataType: () => boolean;
        isPrimitive: () => boolean;
        isBooleanPrimitive: () => boolean;
        isStringPrimitive: () => boolean;
        isNumberPrimitive: () => boolean;
        isBigIntPrimitive: () => boolean;
        isDateTimePrimitive: () => boolean;
        getExtensionByUrl: (url: string) => undefined | IExtension;
        removeExtension: (url: string) => void;
        getModifierExtensionByUrl: (url: string) => undefined | IExtension;
        removeModifierExtension: (url: string) => void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

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

    Properties

    getText: () => Narrative

    Type Declaration

    setText: (value: undefined | Narrative) => this

    Assigns the provided value to the text property.

    Type Declaration

      • (value: undefined | Narrative): this

      • Parameters

        Returns this

        this

    hasText: () => boolean

    Assigns the provided value to the text property.

    Type Declaration

      • (): boolean

      • Returns boolean

        this

    getContained: () => IResource[]

    Type Declaration

    setContained: (value: undefined | IResource[]) => this

    Assigns the provided Resource array value to the contained property.

    Type Declaration

      • (value: undefined | IResource[]): this

      • Parameters

        • value: undefined | IResource[]

          the contained array value

        Returns this

        this

    addContained: (value: undefined | IResource) => this

    Add the provided Resource value to the contained array property.

    Type Declaration

      • (value: undefined | IResource): this

      • Parameters

        • value: undefined | IResource

          the contained value

        Returns this

        this

    hasContained: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getExtension: () => IExtension[]

    Type Declaration

    setExtension: (extension: undefined | IExtension[]) => this

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

    Type Declaration

      • (extension: undefined | IExtension[]): this

      • Parameters

        • extension: undefined | IExtension[]

          array of Extensions

        Returns this

        this

    addExtension: (extension: undefined | IExtension) => this

    Adds the provided Extension to the extension property array.

    Type Declaration

      • (extension: undefined | IExtension): this

      • Parameters

        • extension: undefined | IExtension

          the Extension value to add to the extension property array

        Returns this

        this

    hasExtension: (url?: string) => boolean

    Determines if the extension property exists.

    Type Declaration

      • (url?: string): boolean

      • 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

    getModifierExtension: () => IExtension[]

    Type Declaration

    setModifierExtension: (extension: undefined | IExtension[]) => this

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

    Type Declaration

      • (extension: undefined | IExtension[]): this

      • Parameters

        • extension: undefined | IExtension[]

          array of Extensions

        Returns this

        this

    addModifierExtension: (extension: undefined | IExtension) => this

    Adds the provided Extension to the modifierExtension property array.

    Type Declaration

      • (extension: undefined | IExtension): this

      • Parameters

        • extension: undefined | IExtension

          the Extension value to add to the modifierExtension property array

        Returns this

        this

    hasModifierExtension: (url?: string) => boolean

    Determines if the modifierExtension property exists.

    Type Declaration

      • (url?: string): boolean

      • 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

    resourceType: () => string

    Type Declaration

      • (): string

      • Returns string

        the FHIR resource type as defined by the FHIR specification

    getIdElement: () => IdType

    Type Declaration

      • (): IdType

      • Returns IdType

        the id property value as a PrimitiveType

    setIdElement: (element: undefined | IdType) => this

    Assigns the provided PrimitiveType value to the id property.

    Type Declaration

      • (element: undefined | IdType): this

      • Parameters

        • element: undefined | IdType

          the id value

        Returns this

        this

    hasIdElement: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getId: () => undefined | string

    Type Declaration

      • (): undefined | string

      • Returns undefined | string

        the id property value as a primitive value

    setId: (value: undefined | string) => this

    Assigns the provided value to the meta property.

    Type Declaration

      • (value: undefined | string): this

      • Parameters

        • value: undefined | string

          the meta value

        Returns this

        this

    hasId: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getMeta: () => Meta

    Type Declaration

      • (): Meta

      • Returns Meta

        the meta property value as a Meta

    setMeta: (value: undefined | Meta) => this

    Assigns the provided value to the meta property.

    Type Declaration

      • (value: undefined | Meta): this

      • Parameters

        • value: undefined | Meta

          the meta value

        Returns this

        this

    hasMeta: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getImplicitRulesElement: () => UriType

    Type Declaration

      • (): UriType

      • Returns UriType

        the implicitRules property value as a PrimitiveType

    setImplicitRulesElement: (element: undefined | UriType) => this

    Assigns the provided PrimitiveType value to the implicitRules property.

    Type Declaration

      • (element: undefined | UriType): this

      • Parameters

        • element: undefined | UriType

          the implicitRules value

        Returns this

        this

    hasImplicitRulesElement: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getImplicitRules: () => undefined | string

    Type Declaration

      • (): undefined | string

      • Returns undefined | string

        the implicitRules property value as a primitive value

    setImplicitRules: (value: undefined | string) => this

    Assigns the provided primitive value to the implicitRules property.

    Type Declaration

      • (value: undefined | string): this

      • Parameters

        • value: undefined | string

          the implicitRules value

        Returns this

        this

    PrimitiveTypeError for invalid primitive types

    hasImplicitRules: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getLanguageElement: () => CodeType

    Type Declaration

    setLanguageElement: (element: undefined | CodeType) => this

    Assigns the provided PrimitiveType value to the language property.

    Type Declaration

      • (element: undefined | CodeType): this

      • Parameters

        • element: undefined | CodeType

          the language value

        Returns this

        this

    hasLanguageElement: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getLanguage: () => undefined | string

    Type Declaration

      • (): undefined | string

      • Returns undefined | string

        the language property value as a primitive value

    setLanguage: (value: undefined | string) => this

    Assigns the provided primitive value to the language property.

    Type Declaration

      • (value: undefined | string): this

      • Parameters

        • value: undefined | string

          the language value

        Returns this

        this

    PrimitiveTypeError for invalid primitive types

    hasLanguage: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    fhirType: () => string

    Type Declaration

      • (): string

      • Returns string

        the FHIR type defined in the FHIR standard

    isEmpty: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

        true if the instance is empty; false otherwise

    copy: () => any

    Creates a copy of the current instance.

    Type Declaration

      • (): any

      • Returns any

        the a new instance copied from the current instance

    toJSON: () => undefined | Value

    Type Declaration

      • (): undefined | Value

      • Returns undefined | Value

        the JSON value

    isRequiredFieldsEmpty: () => boolean

    Type Declaration

      • (): boolean

      • 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

    isResource: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

        true if the instance is a FHIR resource; false otherwise

    isDataType: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    isComplexDataType: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    isPrimitive: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    isBooleanPrimitive: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    isStringPrimitive: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    isNumberPrimitive: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    isBigIntPrimitive: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    isDateTimePrimitive: () => boolean

    Type Declaration

      • (): boolean

      • Returns boolean

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

    getExtensionByUrl: (url: string) => undefined | IExtension

    Returns the Extension having the provided url.

    Type Declaration

      • (url: string): undefined | IExtension

      • Parameters

        • url: string

          the url that identifies a specific Extension

        Returns undefined | IExtension

    AssertionError for invalid url

    removeExtension: (url: string) => void

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

    Type Declaration

      • (url: string): void

      • Parameters

        • url: string

          the url that identifies a specific Extension to remove

        Returns void

    AssertionError for invalid url

    getModifierExtensionByUrl: (url: string) => undefined | IExtension

    Returns the Extension having the provided url.

    Type Declaration

      • (url: string): undefined | IExtension

      • Parameters

        • url: string

          the url that identifies a specific Extension

        Returns undefined | IExtension

    AssertionError for invalid url

    removeModifierExtension: (url: string) => void

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

    Type Declaration

      • (url: string): void

      • Parameters

        • url: string

          the url that identifies a specific Extension to remove

        Returns void

    AssertionError for invalid url

    Settings

    Member Visibility

    On This Page

    Properties