Data Model Libraries
    Preparing search index...

    StructureMapGroupComponent Class

    FHIR Specification

    • Short: Named sections for reader convenience
    • Definition: Organizes the mapping into manageable chunks for human review/ease of maintenance.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    name: null | IdType

    FHIR Specification

    • Short: Human-readable label
    • Definition: A unique name for the group for the convenience of human readers.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    extends_?: IdType

    StructureMap.group.extends Element

    FHIR Specification

    • Short: Another group that this group adds rules to
    • Definition: Another group that this group adds rules to.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    mapGroupTypeModeEnum: MapGroupTypeModeEnum

    FHIR CodeSystem: MapGroupTypeMode

    typeMode: null | EnumCodeType

    StructureMap.group.typeMode Element

    FHIR Specification

    • Short: none | types | type-and-types
    • Definition: If this is the default rule set to apply for the source type or this combination of types.
    • Comment: Not applicable if the underlying model is untyped. There can only be one default mapping for any particular type combination.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MapGroupTypeModeEnum

    documentation?: StringType

    StructureMap.group.documentation Element

    FHIR Specification

    • Short: Additional description/explanation for group
    • Definition: Additional supporting documentation that explains the purpose of the group and the types of mappings within it.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    StructureMap.group.input Element

    FHIR Specification

    • Short: Named instance provided when invoking the map
    • Definition: A name assigned to an instance of data. The instance must be provided when the mapping is invoked.
    • Comment: If no inputs are named, then the entry mappings are type based.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    StructureMap.group.rule Element

    FHIR Specification

    • Short: Transform Rule from source to target
    • Definition: Transform Rule from source to target.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR StructureMapGroupComponent

      • OptionaloptSourceField: string

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

      Returns undefined | StructureMapGroupComponent

      StructureMapGroupComponent data model or undefined for StructureMapGroupComponent

      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