Data Model Libraries
    Preparing search index...

    Class ConceptMapAdditionalAttributeComponent

    ConceptMapAdditionalAttributeComponent Class

    FHIR Specification

    • Short: Definition of an additional attribute to act as a data source or target
    • Definition: An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).
    • Comment: Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(https://hl7.org/fhir/conceptmap-example-specimen-type.html)

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeType

    ConceptMap.additionalAttribute.code Element

    FHIR Specification

    • Short: Identifies this additional attribute through this resource
    • Definition: A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    uri?: UriType

    ConceptMap.additionalAttribute.uri Element

    FHIR Specification

    • Short: Formal identifier for the data element referred to in this attribte
    • Definition: Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    ConceptMap.additionalAttribute.description Element

    FHIR Specification

    • Short: Why the additional attribute is defined, and/or what the data element it refers to is
    • Definition: A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    conceptmapAttributeTypeEnum: ConceptmapAttributeTypeEnum

    FHIR CodeSystem: ConceptmapAttributeType

    type_: null | EnumCodeType

    ConceptMap.additionalAttribute.type Element

    FHIR Specification

    • Short: code | Coding | string | boolean | Quantity
    • Definition: The type of the source data contained in this concept map for this data element.
    • Comment: When the source or target is not content defined by FHIR, some additional application logic might be required to map from the FHIR Datatype to the externally defined content
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ConceptmapAttributeTypeEnum

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ConceptMapAdditionalAttributeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ConceptMapAdditionalAttributeComponent

      ConceptMapAdditionalAttributeComponent data model or undefined for ConceptMapAdditionalAttributeComponent

      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