Data Model Libraries
    Preparing search index...

    InventoryItemNameComponent Class

    FHIR Specification

    • Short: The item name(s) - the brand name, or common name, functional name, generic name or others
    • Definition: The item name(s) - the brand name, or common name, functional name, generic name.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    nameType: null | Coding

    InventoryItem.name.nameType Element

    FHIR Specification

    • Short: The type of name e.g. 'brand-name', 'functional-name', 'common-name'
    • Definition: The type of name e.g. 'brand-name', 'functional-name', 'common-name'.
    • FHIR Type: Coding
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    language: null | CodeType

    InventoryItem.name.language Element

    FHIR Specification

    • Short: The language used to express the item name
    • Definition: The language that the item name is expressed in.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    name: null | StringType

    FHIR Specification

    • Short: The name or designation of the item
    • Definition: The name or designation that the item is given.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR InventoryItemNameComponent

      • OptionaloptSourceField: string

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

      Returns undefined | InventoryItemNameComponent

      InventoryItemNameComponent data model or undefined for InventoryItemNameComponent

      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