Data Model Libraries
    Preparing search index...

    Class StructureMapGroupRuleSourceComponent

    StructureMapGroupRuleSourceComponent Class

    FHIR Specification

    • Short: Source inputs to the mapping
    • Definition: Source inputs to the mapping.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    context: null | IdType

    StructureMap.group.rule.source.context Element

    FHIR Specification

    • Short: Type or variable this rule applies to
    • Definition: Type or variable this rule applies to.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    StructureMap.group.rule.source.min Element

    FHIR Specification

    • Short: Specified minimum cardinality
    • Definition: Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    StructureMap.group.rule.source.max Element

    FHIR Specification

    • Short: Specified maximum cardinality (number or *)
    • Definition: Specified maximum cardinality for the element - a number or a "". This is optional; if present, it acts an implicit check on the input content ( just serves as documentation; it's the default value).
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    type_?: StringType

    StructureMap.group.rule.source.type Element

    FHIR Specification

    • Short: Rule only applies if source has this type
    • Definition: Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    defaultValue?: StringType

    StructureMap.group.rule.source.defaultValue Element

    FHIR Specification

    • Short: Default value if no value exists
    • Definition: A value to use if there is no existing value in the source object.
    • Comment: If there's a default value on an item that can repeat, it will only be used once.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    element?: StringType

    StructureMap.group.rule.source.element Element

    FHIR Specification

    • Short: Optional field for this source
    • Definition: Optional field for this source.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    mapSourceListModeEnum: MapSourceListModeEnum

    FHIR CodeSystem: MapSourceListMode

    listMode?: EnumCodeType

    StructureMap.group.rule.source.listMode Element

    FHIR Specification

    • Short: first | not_first | last | not_last | only_one
    • Definition: How to handle the list mode for this element.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MapSourceListModeEnum

    variable?: IdType

    StructureMap.group.rule.source.variable Element

    FHIR Specification

    • Short: Named context for field, if a field is specified
    • Definition: Named context for field, if a field is specified.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    condition?: StringType

    StructureMap.group.rule.source.condition Element

    FHIR Specification

    • Short: FHIRPath expression - must be true or the rule does not apply
    • Definition: FHIRPath expression - must be true or the rule does not apply.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    check?: StringType

    StructureMap.group.rule.source.check Element

    FHIR Specification

    • Short: FHIRPath expression - must be true or the mapping engine throws an error instead of completing
    • Definition: FHIRPath expression - must be true or the mapping engine throws an error instead of completing.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    logMessage?: StringType

    StructureMap.group.rule.source.logMessage Element

    FHIR Specification

    • Short: Message to put in log if source exists (FHIRPath)
    • Definition: A FHIRPath expression which specifies a message to put in the transform log when content matching the source rule is found.
    • Comment: This is typically used for recording that something Is not transformed to the target for some reason.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR StructureMapGroupRuleSourceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | StructureMapGroupRuleSourceComponent

      StructureMapGroupRuleSourceComponent data model or undefined for StructureMapGroupRuleSourceComponent

      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