Data Model Libraries
    Preparing search index...

    Class ConceptMapGroupElementTargetComponent

    ConceptMapGroupElementTargetComponent Class

    FHIR Specification

    • Short: Concept in target system for element
    • Definition: A concept from the target value set that this concept maps to.
    • Comment: Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code?: CodeType

    ConceptMap.group.element.target.code Element

    FHIR Specification

    • Short: Code that identifies the target element
    • Definition: Identity (code or path) or the element/item that the map refers to.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    display?: StringType

    ConceptMap.group.element.target.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.element.target.valueSet Element

    FHIR Specification

    • Short: Identifies the set of target concepts
    • Definition: The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set.
    • Comment: If the the value set expansion is empty then the source concept(s) are unmapped and the behavior of ConceptMap.group.unmapped (if present) applies.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    conceptMapRelationshipEnum: ConceptMapRelationshipEnum

    FHIR CodeSystem: ConceptMapRelationship

    relationship: null | EnumCodeType

    ConceptMap.group.element.target.relationship Element

    FHIR Specification

    • Short: related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
    • Definition: The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).
    • Comment: This element is labeled as a modifier because it may indicate that there is no mapping.
    • FHIR Type: code
    • Cardinality: 1..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

    comment?: StringType

    ConceptMap.group.element.target.comment Element

    FHIR Specification

    • Short: Description of status/issues in mapping
    • Definition: A description of status/issues in mapping that conveys additional information not represented in the structured data.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ConceptMap.group.element.target.property Element

    FHIR Specification

    • Short: Property value for the source -> target mapping
    • Definition: A property value for this source -> target mapping.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ConceptMap.group.element.target.dependsOn Element

    FHIR Specification

    • Short: Other properties required for this mapping
    • Definition: A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ConceptMap.group.element.target.product Element

    FHIR Specification

    • Short: Other data elements that this mapping also produces
    • Definition: Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConceptMapGroupElementTargetComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConceptMapGroupElementTargetComponent

      ConceptMapGroupElementTargetComponent data model or undefined for ConceptMapGroupElementTargetComponent

      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