Data Model Libraries
    Preparing search index...

    LinkageItemComponent Class

    FHIR Specification

    • Short: Item to be linked
    • Definition: Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    linkageTypeEnum: LinkageTypeEnum

    FHIR CodeSystem: LinkageType

    type_: null | EnumCodeType

    Linkage.item.type Element

    FHIR Specification

    • Short: source | alternate | historical
    • Definition: Distinguishes which item is "source of truth" (if any) and which items are no longer considered to be current representations.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: LinkageTypeEnum

    resource: null | Reference

    Linkage.item.resource Element

    FHIR Specification

    • Short: Resource being linked
    • Definition: The resource instance being linked as part of the group.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR LinkageItemComponent

      • OptionaloptSourceField: string

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

      Returns undefined | LinkageItemComponent

      LinkageItemComponent data model or undefined for LinkageItemComponent

      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