Data Model Libraries
    Preparing search index...

    ElementDefinitionTypeComponent Class

    FHIR Specification

    • Short: Data type and Profile for this element
    • Definition: The data type or resource that the value of this element is permitted to be.
    • Comment: The Type of the element can be left blank in a differential constraint, in which case the type is inherited from the resource. Abstract types are not permitted to appear as a type when multiple types are listed. (I.e. Abstract types cannot be part of a choice).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | UriType

    ElementDefinition.type.code Element

    FHIR Specification

    • Short: Data type or Resource (reference to definition)
    • Definition: URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
    • Comment: If the element is a reference to another resource, this element contains "Reference", and the targetProfile element defines what resources can be referenced. The targetProfile may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient).
    • FHIR Type: uri
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    profile?: CanonicalType[]

    ElementDefinition.type.profile Element

    FHIR Specification

    targetProfile?: CanonicalType[]

    ElementDefinition.type.targetProfile Element

    FHIR Specification

    • Short: Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
    • Definition: Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    resourceAggregationModeEnum: ResourceAggregationModeEnum

    FHIR CodeSystem: ResourceAggregationMode

    aggregation?: EnumCodeType[]

    ElementDefinition.type.aggregation Element

    FHIR Specification

    • Short: contained | referenced | bundled - how aggregated
    • Definition: If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
    • Comment: See Aggregation Rules for further clarification.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ResourceAggregationModeEnum

    referenceVersionRulesEnum: ReferenceVersionRulesEnum

    FHIR CodeSystem: ReferenceVersionRules

    versioning?: EnumCodeType

    ElementDefinition.type.versioning Element

    FHIR Specification

    • Short: either | independent | specific
    • Definition: Whether this reference needs to be version specific or version independent, or whether either can be used.
    • Comment: The base specification never makes a rule as to which form is allowed, but implementation guides may do this. See Aggregation Rules for further clarification.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ReferenceVersionRulesEnum

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinitionTypeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ElementDefinitionTypeComponent

      ElementDefinitionTypeComponent data model or undefined for ElementDefinitionTypeComponent

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

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

    • 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 the instance is a FHIR resource; 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