Data Model Libraries
    Preparing search index...

    ElementDefinitionMappingComponent Class

    FHIR Specification

    • Short: Map element to another set of definitions
    • Definition: Identifies a concept from an external specification that roughly corresponds to this element.
    • Comment: Mappings are not necessarily specific enough for safe translation.
    • Requirements: Provides guidance to implementers familiar with or converting content from other specifications.

    Hierarchy (View Summary)

    • DataType
      • ElementDefinitionMappingComponent

    Implements

    Index

    Constructors

    Properties

    identity: null | IdType

    ElementDefinition.mapping.identity Element

    FHIR Specification

    • Short: Reference to mapping declaration
    • Definition: An internal reference to the definition of a mapping.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    language?: CodeType

    ElementDefinition.mapping.language Element

    FHIR Specification

    • Short: Computable language of mapping
    • Definition: Identifies the computable language in which mapping.map is expressed.
    • Comment: If omitted, then there can be no expectation of computational interpretation of the mapping.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    map: null | StringType

    ElementDefinition.mapping.map Element

    FHIR Specification

    • Short: Details of the mapping
    • Definition: Expresses what part of the target specification corresponds to this element.
    • Comment: For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    comment?: StringType

    ElementDefinition.mapping.comment Element

    FHIR Specification

    • Short: Comments about the mapping or its use
    • Definition: Comments that provide information about the mapping or its use.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinitionMappingComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ElementDefinitionMappingComponent

      ElementDefinitionMappingComponent data model or undefined for ElementDefinitionMappingComponent

      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