Data Model Libraries
    Preparing search index...

    Class StructureDefinitionMappingComponent

    StructureDefinitionMappingComponent Class

    FHIR Specification

    • Short: External specification that the content is mapped to
    • Definition: An external specification that the content is mapped to.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    identity: null | IdType

    StructureDefinition.mapping.identity Element

    FHIR Specification

    • Short: Internal id when this mapping is used
    • Definition: An Internal id that is used to identify this mapping set when specific mappings are made.
    • Comment: The specification is described once, with general comments, and then specific mappings are made that reference this declaration.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    uri?: UriType

    StructureDefinition.mapping.uri Element

    FHIR Specification

    • Short: Identifies what this mapping refers to
    • Definition: An absolute URI that identifies the specification that this mapping is expressed to.
    • Comment: A formal identity for the specification being mapped to helps with identifying maps consistently.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    name?: StringType

    FHIR Specification

    • Short: Names what this mapping refers to
    • Definition: A name for the specification that is being mapped to.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    comment?: StringType

    StructureDefinition.mapping.comment Element

    FHIR Specification

    • Short: Versions, Issues, Scope limitations etc.
    • Definition: Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR StructureDefinitionMappingComponent

      • OptionaloptSourceField: string

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

      Returns undefined | StructureDefinitionMappingComponent

      StructureDefinitionMappingComponent data model or undefined for StructureDefinitionMappingComponent

      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