Data Model Libraries
    Preparing search index...

    ConceptMapPropertyComponent Class

    FHIR Specification

    • Short: Additional properties of the mapping
    • Definition: A property defines a slot through which additional information can be provided about a map from source -> target.
    • Comment: Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeType

    ConceptMap.property.code Element

    FHIR Specification

    • Short: Identifies the property on the mappings, and when referred to in the $translate operation
    • Definition: A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    uri?: UriType

    ConceptMap.property.uri Element

    FHIR Specification

    • Short: Formal identifier for the property
    • Definition: Reference to the formal meaning of the property.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    ConceptMap.property.description Element

    FHIR Specification

    • Short: Why the property is defined, and/or what it conveys
    • Definition: A description of the property - why it is defined, and how its value might be used.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    conceptmapPropertyTypeEnum: ConceptmapPropertyTypeEnum

    FHIR CodeSystem: ConceptmapPropertyType

    type_: null | EnumCodeType

    ConceptMap.property.type Element

    FHIR Specification

    • Short: Coding | string | integer | boolean | dateTime | decimal | code
    • Definition: The type of the property value.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ConceptmapPropertyTypeEnum

    system?: CanonicalType

    ConceptMap.property.system Element

    FHIR Specification

    • Short: The CodeSystem from which code values come
    • Definition: The CodeSystem that defines the codes from which values of type code in property values.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConceptMapPropertyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConceptMapPropertyComponent

      ConceptMapPropertyComponent data model or undefined for ConceptMapPropertyComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 complex or primitive datatype; false otherwise