Data Model Libraries
    Preparing search index...

    ConceptMapGroupUnmappedComponent Class

    FHIR Specification

    • Short: What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
    • Definition: What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.
    • Comment: The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    conceptmapUnmappedModeEnum: ConceptmapUnmappedModeEnum

    FHIR CodeSystem: ConceptmapUnmappedMode

    mode: null | EnumCodeType

    ConceptMap.group.unmapped.mode Element

    FHIR Specification

    • Short: use-source-code | fixed | other-map
    • Definition: Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ConceptmapUnmappedModeEnum

    code?: CodeType

    ConceptMap.group.unmapped.code Element

    FHIR Specification

    • Short: Fixed code when mode = fixed
    • Definition: The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    display?: StringType

    ConceptMap.group.unmapped.display Element

    FHIR Specification

    • Short: Display for the code
    • Definition: The display for the code. The display is only provided to help editors when editing the concept map.
    • Comment: The display is ignored when processing the map.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    valueSet?: CanonicalType

    ConceptMap.group.unmapped.valueSet Element

    FHIR Specification

    • Short: Fixed code set when mode = fixed
    • Definition: The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    conceptMapRelationshipEnum: ConceptMapRelationshipEnum

    FHIR CodeSystem: ConceptMapRelationship

    relationship?: EnumCodeType

    ConceptMap.group.unmapped.relationship Element

    FHIR Specification

    • Short: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
    • Definition: The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'.
    • Comment: This element is labeled as a modifier because it may indicate that there is no mapping.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between
    • isSummary: false

    CodeSystem Enumeration: ConceptMapRelationshipEnum

    otherMap?: CanonicalType

    ConceptMap.group.unmapped.otherMap Element

    FHIR Specification

    • Short: canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
    • Definition: The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConceptMapGroupUnmappedComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConceptMapGroupUnmappedComponent

      ConceptMapGroupUnmappedComponent data model or undefined for ConceptMapGroupUnmappedComponent

      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