Data Model Libraries
    Preparing search index...

    Class DeviceDefinitionDeviceNameComponent

    DeviceDefinitionDeviceNameComponent Class

    FHIR Specification

    • Short: The name or names of the device as given by the manufacturer
    • Definition: The name or names of the device as given by the manufacturer.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    name: null | StringType

    FHIR Specification

    • Short: A name that is used to refer to the device
    • Definition: A human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    deviceNametypeEnum: DeviceNametypeEnum

    FHIR CodeSystem: DeviceNametype

    type_: null | EnumCodeType

    DeviceDefinition.deviceName.type Element

    FHIR Specification

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

    CodeSystem Enumeration: DeviceNametypeEnum

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceDefinitionDeviceNameComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DeviceDefinitionDeviceNameComponent

      DeviceDefinitionDeviceNameComponent data model or undefined for DeviceDefinitionDeviceNameComponent

      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