Data Model Libraries
    Preparing search index...

    Extension Class

    Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.

    The ability to add extensions in a structured way is what keeps FHIR resources simple.

    FHIR Specification

    • Short: Optional Extensions Element
    • Definition: Optional Extension Element - found in all resources.
    • FHIR Version: 4.0.1

    Hierarchy

    • Extension
      • Extension
    Index

    Constructors

    Properties

    Methods

    getValueBase64BinaryType hasValueBase64BinaryType getValueBooleanType hasValueBooleanType getValueCanonicalType hasValueCanonicalType getValueCodeType hasValueCodeType getValueDateType hasValueDateType getValueDateTimeType hasValueDateTimeType getValueDecimalType hasValueDecimalType getValueIdType hasValueIdType getValueInstantType hasValueInstantType getValueIntegerType hasValueIntegerType getValueMarkdownType hasValueMarkdownType getValueOidType hasValueOidType getValuePositiveIntType hasValuePositiveIntType getValueStringType hasValueStringType getValueTimeType hasValueTimeType getValueUnsignedIntType hasValueUnsignedIntType getValueUriType hasValueUriType getValueUrlType hasValueUrlType getValueUuidType hasValueUuidType getValueAddress hasValueAddress getValueAge hasValueAge getValueAnnotation hasValueAnnotation getValueAttachment hasValueAttachment getValueCodeableConcept hasValueCodeableConcept getValueCoding hasValueCoding getValueContactPoint hasValueContactPoint getValueCount hasValueCount getValueDistance hasValueDistance getValueDuration hasValueDuration getValueHumanName hasValueHumanName getValueIdentifier hasValueIdentifier getValueMoney hasValueMoney getValuePeriod hasValuePeriod getValueQuantity hasValueQuantity getValueRange hasValueRange getValueRatio hasValueRatio getValueReference hasValueReference getValueSampledData hasValueSampledData getValueSignature hasValueSignature getValueTiming hasValueTiming getValueContactDetail hasValueContactDetail getValueContributor hasValueContributor getValueDataRequirement hasValueDataRequirement getValueExpression hasValueExpression getValueParameterDefinition hasValueParameterDefinition getValueRelatedArtifact hasValueRelatedArtifact getValueTriggerDefinition hasValueTriggerDefinition getValueUsageContext hasValueUsageContext getValueDosage hasValueDosage getValueMeta hasValueMeta getUrl setUrl hasUrl getValue setValue hasValue fhirType isEmpty copy isComplexDataType toJSON getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    url: null | string

    Extension.url Element

    FHIR Specification

    • Short: identifies the meaning of the extension
    • Definition: Source of the definition for the extension code - a logical name or a URL.
    • Comment: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
    • FHIR Type: uri
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    value?: IDataType

    Extension.value[x] Element

    FHIR Specification

    • Short: Value of extension
    • Definition: Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
    • FHIR Types:
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Returns null | string

      the url property value as a fhirUri if defined; else null

    • Assigns the provided primitive value to the url property.

      Parameters

      • value: string

        the url value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

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

    • Returns undefined | IDataType

      the value property value as a DataType object if defined; else undefined

    • Assigns the provided DataType object value to the value property.

      Parameters

      • value: undefined | IDataType

        the value object value

      Returns this

      this

      @OpenDataTypes()

    • Returns boolean

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

    • Returns string

      the FHIR type defined in the FHIR standard

    • Returns boolean

      true if the instance is empty; false otherwise

    • Creates a copy of the current instance.

      Returns Extension

      the a new instance copied from the current instance

    • Returns boolean

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

    • Returns undefined | Value

      the JSON value or undefined if the instance is empty

      FhirError if the instance is missing required properties

    • 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

    • Returns IExtension[]

      the array of extension values

    • 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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Protected

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

      Parameters

      • dest: Extension

        the copied instance

      Returns void