Data Model Libraries
    Preparing search index...

    StructureMapStructureComponent Class

    FHIR Specification

    • Short: Structure Definition used by this map
    • Definition: A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
    • Comment: It is not necessary for a structure map to identify any dependent structures, though not listing them may restrict its usefulness.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    url: null | CanonicalType

    StructureMap.structure.url Element

    FHIR Specification

    mapModelModeEnum: MapModelModeEnum

    FHIR CodeSystem: MapModelMode

    mode: null | EnumCodeType

    StructureMap.structure.mode Element

    FHIR Specification

    • Short: source | queried | target | produced
    • Definition: How the referenced structure is used in this mapping.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MapModelModeEnum

    alias?: StringType

    StructureMap.structure.alias Element

    FHIR Specification

    • Short: Name for type in this map
    • Definition: The name used for this type in the map.
    • Comment: This is needed if both types have the same name (e.g. version conversion).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    documentation?: StringType

    StructureMap.structure.documentation Element

    FHIR Specification

    • Short: Documentation on use of structure
    • Definition: Documentation that describes how the structure is used in the mapping.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR StructureMapStructureComponent

      • OptionaloptSourceField: string

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

      Returns undefined | StructureMapStructureComponent

      StructureMapStructureComponent data model or undefined for StructureMapStructureComponent

      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