Data Model Libraries
    Preparing search index...

    DeviceNameComponent Class

    FHIR Specification

    • Short: The name or names of the device as known to the manufacturer and/or patient
    • Definition: This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    value: null | StringType

    Device.name.value Element

    FHIR Specification

    • Short: The term that names the device
    • Definition: The actual name that identifies the device.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    deviceNametypeEnum: DeviceNametypeEnum

    FHIR CodeSystem: DeviceNametype

    type_: null | EnumCodeType

    Device.name.type Element

    FHIR Specification

    • Short: registered-name | user-friendly-name | patient-reported-name
    • Definition: Indicates the kind of name. RegisteredName | UserFriendlyName | PatientReportedName.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: DeviceNametypeEnum

    display?: BooleanType

    Device.name.display Element

    FHIR Specification

    • Short: The preferred device name
    • Definition: Indicates the default or preferred name to be displayed.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that that a name is preferred.
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceNameComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DeviceNameComponent

      DeviceNameComponent data model or undefined for DeviceNameComponent

      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