CommonProduct
Class Device

Identifies a class of devices characterized by their manufacturer, model name/number, software version, etc. This class differs from the Device Instance class in that this class represents all instances of a kind of device whereas the Device Instance class represents one individual. For example, the Device class might describe a Color LaserJet Model CMJ1312 made by Hewlett Packard. The DeviceInstance class might describe the individual Color LaserJet Model CMJ1312 that has serial number 1234.

"A contrivance or an invention serving a particular purpose, especially a machine used to perform one or more relatively simple tasks." (The American Heritage Stedman's Medical Dictionary).
"A ManufacturedMaterial used in an activity without being substantially changed through that activity." - HL7 V3

Attributes
«CS» Code cataloglId cataloglId

Identifies the kind of the product, as assigned by a distributor or other organization responsible for ordering and supplying of equipment.

String commonDeviceName commonDeviceName

A generic name for the device, as opposed to a brand name specific to a particular manufacturer's product.

DeviceInstance deviceInstance deviceInstance

Identifies an individual device belonging to the class of devices represented by the Device class on the other end of the association. For example, the Device class might describe a Color LaserJet Model CMJ1312 made by Hewlett Packard. The DeviceInstance class might describe the machine that has serial number 1234. Other information about the device instance, such as the cost, date placed into service, date last serviced, etc. may be added to the DeviceInstance class in the future. For now, we are just interested in the serial number (the Id property).

«CS» Code modelId modelId

Identifies the kind of the product, as assigned by the manufacturer.

String modelName modelName

"The human designated moniker for a device, assigned by the manufacturer" - HL7 V3
"The model is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type." - HL7 FHIR, Device.model

String name name

“The name of the product kind described. If this is a specific manufactured (brand) product, this would be the proprietary name. For general product class descriptions this would be a non-proprietary name. This attribute may sometimes be used instead of a code and descriptive data elements when no suitable coding system is available. The data type for the name allows for suffixes and also other name parts, which might hold proprietary dose form (e.g., "capsil", "discus", "injection system") or other name parts which may be required for recognition of the product among health professionals. Note that these name parts are never to be used instead of proper descriptive data elements (formCode, ingredients and their quantities, etc.).” - HL7 Version 3 (ManufacturedMaterial.name).

String version version

"The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware." - HL7 FHIR, Device.version

Attributes inherited from FHIM::CommonProduct::Product FHIM::CommonProduct::Product
brandName brandName, description description, equivalentTo equivalentTo, fdaProductCode fdaProductCode, formCode formCode, handlingCode handlingCode, kind kind, manufacturer manufacturer, riskCode riskCode, shelfLife shelfLife, specializationOf specializationOf, status status

Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameDevice
Name Expression
NamespaceCommonProduct
Owned Template Signature
OwnerCommonProduct
Owning Template Parameter
PackageCommonProduct
Qualified NameFHIM::CommonProduct::Device
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 cataloglId
Public «CS» Code cataloglId

Identifies the kind of the product, as assigned by a distributor or other organization responsible for ordering and supplying of equipment.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDevice
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywordsdeprecated
Lower0
Lower Value(0)
Multiplicity0..1
NamecataloglId
Name Expression
NamespaceDevice
Opposite
OwnerDevice
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Device::cataloglId
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 commonDeviceName
Public String commonDeviceName

A generic name for the device, as opposed to a brand name specific to a particular manufacturer's product.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDevice
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamecommonDeviceName
Name Expression
NamespaceDevice
Opposite
OwnerDevice
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Device::commonDeviceName
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 deviceInstance
Public DeviceInstance deviceInstance

Identifies an individual device belonging to the class of devices represented by the Device class on the other end of the association. For example, the Device class might describe a Color LaserJet Model CMJ1312 made by Hewlett Packard. The DeviceInstance class might describe the machine that has serial number 1234. Other information about the device instance, such as the cost, date placed into service, date last serviced, etc. may be added to the DeviceInstance class in the future. For now, we are just interested in the serial number (the Id property).

Constraints:
Properties:

AggregationNone
Alias
Associationdevice_deviceInstance
Association End
ClassDevice
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedeviceInstance
Name Expression
NamespaceDevice
Oppositedevice
OwnerDevice
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Device::deviceInstance
Stereotype
Template Parameter
TypeDeviceInstance
Upper*
Upper Value(*)
VisibilityPublic


 modelId
Public «CS» Code modelId

Identifies the kind of the product, as assigned by the manufacturer.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDevice
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywordsdeprecated
Lower0
Lower Value(0)
Multiplicity0..1
NamemodelId
Name Expression
NamespaceDevice
Opposite
OwnerDevice
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Device::modelId
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 modelName
Public String modelName

"The human designated moniker for a device, assigned by the manufacturer" - HL7 V3
"The model is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type." - HL7 FHIR, Device.model

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDevice
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamemodelName
Name Expression
NamespaceDevice
Opposite
OwnerDevice
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Device::modelName
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 name
Public String name

“The name of the product kind described. If this is a specific manufactured (brand) product, this would be the proprietary name. For general product class descriptions this would be a non-proprietary name. This attribute may sometimes be used instead of a code and descriptive data elements when no suitable coding system is available. The data type for the name allows for suffixes and also other name parts, which might hold proprietary dose form (e.g., "capsil", "discus", "injection system") or other name parts which may be required for recognition of the product among health professionals. Note that these name parts are never to be used instead of proper descriptive data elements (formCode, ingredients and their quantities, etc.).” - HL7 Version 3 (ManufacturedMaterial.name).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDevice
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namename
Name Expression
NamespaceDevice
Opposite
OwnerDevice
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Device::name
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 version
Public String version

"The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware." - HL7 FHIR, Device.version

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDevice
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameversion
Name Expression
NamespaceDevice
Opposite
OwnerDevice
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::Device::version
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic