CommonProduct
Class DeviceInstance

This class identifies an individual device. The Id property is commonly known as a serial number.
"Identifies the Equipment Instance (e.g., Analyzer, Analyzer module, group of Analyzers, etc.) responsible for the production of the observation...." - HL7 Version 2.8, OBX-18.

Attributes
«CS» Code alertLevel alertLevel

"The current functional status of an automated device." - HL7 V3. Possible values include: Normal, Warning, Critical, etc.

«TEL» ContactPoint contact contact

"Contact details for an organization or a particular human that is responsible for the device." - HL7 FHIR, Device.contact

«TS» PointInTime dateAcquired dateAcquired

"Date and time equipment was installed or affixed" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

«TS» PointInTime dateDisposed dateDisposed

"Date and time equipment was removed or uninstalled" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

«TS» PointInTime dateLastCalibrated dateLastCalibrated

"The date and time the device was last calibrated." - HL7 V3

«TS» PointInTime dateManufactured dateManufactured

"The date and time when the device was manufactured." - HL7 FHIR, Device.manufactureDate

Device device device

Identifies a class of devices characterized by their manufacturer, model name/number, software version, etc. This class differs from the Device Instance class on the other end of the association 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 machine that has serial number 1234.

DeviceComponent deviceComponent deviceComponent

Pointer to the characteristics, operational status and capabilities of a medical-related component of a medical device.

«II» Id identifier identifier

Identifies the individual device. This may be a Serial Number assigned by the manufacturer, or some other unique identifer assigned by the owning organization (e.g., an asset control number).
"A unique identifier for this instance. If the product instance represents a single individual product (quantity = 1) then this id is also called the serial number. If the product instance represents a product lot, the id is also called the lot number." - HL7 V3
"Unique instance identifiers assigned to a device by manufacturers other organizations or owners." - HL7 FHIR, Device.identifier

«CS» Code localRemoteControlState localRemoteControlState

"The state of control of the device. A device can either work autonomously or it can be controlled by another system. The control status of a device must be communicated between devices prior to remote commands being transmitted. If the device is not in "Remote" status, external commands will be ignored." - HL7 V3

ServiceDeliveryLocation location location

"The place where the device can be found." - HL7 FHIR, Device.location

ManufacturingLot manufacturingLot manufacturingLot

Pointer to the batch or lot in which the device was manufactured.

String note note

"Descriptive information, usage information or implantation information that is not captured in an existing element." - HL7 FHIR, Device.note
Note that FHIR models this as an Annotation, whereas FHIM currently models this as a string.

Organization owner owner

"An organization that is responsible for the provision and ongoing maintenance of the device." - HL7 FHIR, Device.owner

Patient patient patient

If the device was implanted in a Patient, this property is a pointer to that Patient.
"Patient information, If the device is affixed to a person.", HL7 FHIR, Device.patient

Reprocessor reprocessor reprocessor

Pointer to an organization that performs additional processing and manufacturing upon a existing device that has previously been used on a patient such that it can be used again on another (or the same) patient.

«CS» Code safety safety

"Provides additional safety characteristics about a medical device. For example devices containing latex." - HL7 FHIR, Device.safety
Note that safety information is also an optional property of the Unique Device Identifier, so it is possible that this information may be duplicated both here and within the UDI.

«CS» Code softwareName softwareName

"The moniker, version and release of the software that operates the device as assigned by the software manufacturer or developer." - HL7 V3

«CS» Code status status

Identifies whether or not the Device Instance is available. This property is included for compatibility with FHIR. FHIR specifies three possible values for this property: Available, Not Available, and Entered in Error (which is meant to convey that the device instance doesn't exist as the record concerning its existence is invalid). It is anticipated that there may be other values that would be appropriate.
"Status of the Device availability." - HL7 FHIR, Device.status

UniqueDeviceIdentifier udi udi

Pointer to the device's Unique Device Identifier, which is used to identify and track devices through distribution and use.

String url url

"A network address on which the device may be contacted directly." - HL7 FHIR, Device.url


Properties:

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

Attribute Details

 alertLevel
Public «CS» Code alertLevel

"The current functional status of an automated device." - HL7 V3. Possible values include: Normal, Warning, Critical, etc.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
NamealertLevel
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::alertLevel
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 contact
Public «TEL» ContactPoint contact

"Contact details for an organization or a particular human that is responsible for the device." - HL7 FHIR, Device.contact

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
Namecontact
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::contact
Stereotype
Template Parameter
Type«TEL» ContactPoint
Upper1
Upper Value(1)
VisibilityPublic


 dateAcquired
Public «TS» PointInTime dateAcquired

"Date and time equipment was installed or affixed" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
NamedateAcquired
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::dateAcquired
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateDisposed
Public «TS» PointInTime dateDisposed

"Date and time equipment was removed or uninstalled" - ONC S&I Clinical Element Data Dictionary (CEDD), March 2012.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
NamedateDisposed
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::dateDisposed
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateLastCalibrated
Public «TS» PointInTime dateLastCalibrated

"The date and time the device was last calibrated." - HL7 V3

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
NamedateLastCalibrated
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::dateLastCalibrated
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 dateManufactured
Public «TS» PointInTime dateManufactured

"The date and time when the device was manufactured." - HL7 FHIR, Device.manufactureDate

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
NamedateManufactured
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::dateManufactured
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 device
Public Device device

Identifies a class of devices characterized by their manufacturer, model name/number, software version, etc. This class differs from the Device Instance class on the other end of the association 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 machine that has serial number 1234.

Constraints:
Properties:

AggregationNone
Alias
Associationdevice_deviceInstance
Association End
ClassDeviceInstance
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namedevice
Name Expression
NamespaceDeviceInstance
OppositedeviceInstance
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::device
Stereotype
Template Parameter
TypeDevice
Upper1
Upper Value(1)
VisibilityPublic


 deviceComponent
Public DeviceComponent deviceComponent

Pointer to the characteristics, operational status and capabilities of a medical-related component of a medical device.

Constraints:
Properties:

AggregationComposite
Alias
AssociationdeviceInstance_deviceComponent
Association End
ClassDeviceInstance
Datatype
Default
Default Value
Is Compositetrue
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedeviceComponent
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::deviceComponent
Stereotype
Template Parameter
TypeDeviceComponent
Upper*
Upper Value(*)
VisibilityPublic


 identifier
Public «II» Id identifier

Identifies the individual device. This may be a Serial Number assigned by the manufacturer, or some other unique identifer assigned by the owning organization (e.g., an asset control number).
"A unique identifier for this instance. If the product instance represents a single individual product (quantity = 1) then this id is also called the serial number. If the product instance represents a product lot, the id is also called the lot number." - HL7 V3
"Unique instance identifiers assigned to a device by manufacturers other organizations or owners." - HL7 FHIR, Device.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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*
Nameidentifier
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 localRemoteControlState
Public «CS» Code localRemoteControlState

"The state of control of the device. A device can either work autonomously or it can be controlled by another system. The control status of a device must be communicated between devices prior to remote commands being transmitted. If the device is not in "Remote" status, external commands will be ignored." - HL7 V3

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
NamelocalRemoteControlState
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::localRemoteControlState
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 location
Public ServiceDeliveryLocation location

"The place where the device can be found." - HL7 FHIR, Device.location

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceInstance_location
Association End
ClassDeviceInstance
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
Namelocation
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::location
Stereotype
Template Parameter
TypeServiceDeliveryLocation
Upper1
Upper Value(1)
VisibilityPublic


 manufacturingLot
Public ManufacturingLot manufacturingLot

Pointer to the batch or lot in which the device was manufactured.

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceInstance_manufacturingLot
Association End
ClassDeviceInstance
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
NamemanufacturingLot
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::manufacturingLot
Stereotype
Template Parameter
TypeManufacturingLot
Upper1
Upper Value(1)
VisibilityPublic


 note
Public String note

"Descriptive information, usage information or implantation information that is not captured in an existing element." - HL7 FHIR, Device.note
Note that FHIR models this as an Annotation, whereas FHIM currently models this as a string.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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*
Namenote
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::note
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 owner
Public Organization owner

"An organization that is responsible for the provision and ongoing maintenance of the device." - HL7 FHIR, Device.owner

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceInstance_owner
Association End
ClassDeviceInstance
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
Nameowner
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::owner
Stereotype
Template Parameter
TypeOrganization
Upper1
Upper Value(1)
VisibilityPublic


 patient
Public Patient patient

If the device was implanted in a Patient, this property is a pointer to that Patient.
"Patient information, If the device is affixed to a person.", HL7 FHIR, Device.patient

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceInstance_patient
Association End
ClassDeviceInstance
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
Namepatient
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::patient
Stereotype
Template Parameter
TypePatient
Upper1
Upper Value(1)
VisibilityPublic


 reprocessor
Public Reprocessor reprocessor

Pointer to an organization that performs additional processing and manufacturing upon a existing device that has previously been used on a patient such that it can be used again on another (or the same) patient.

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceInstance_reprocessor
Association End
ClassDeviceInstance
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
Namereprocessor
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::reprocessor
Stereotype
Template Parameter
TypeReprocessor
Upper1
Upper Value(1)
VisibilityPublic


 safety
Public «CS» Code safety

"Provides additional safety characteristics about a medical device. For example devices containing latex." - HL7 FHIR, Device.safety
Note that safety information is also an optional property of the Unique Device Identifier, so it is possible that this information may be duplicated both here and within the UDI.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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*
Namesafety
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::safety
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 softwareName
Public «CS» Code softwareName

"The moniker, version and release of the software that operates the device as assigned by the software manufacturer or developer." - HL7 V3

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
NamesoftwareName
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::softwareName
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

Identifies whether or not the Device Instance is available. This property is included for compatibility with FHIR. FHIR specifies three possible values for this property: Available, Not Available, and Entered in Error (which is meant to convey that the device instance doesn't exist as the record concerning its existence is invalid). It is anticipated that there may be other values that would be appropriate.
"Status of the Device availability." - HL7 FHIR, Device.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
Namestatus
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 udi
Public UniqueDeviceIdentifier udi

Pointer to the device's Unique Device Identifier, which is used to identify and track devices through distribution and use.

Constraints:
Properties:

AggregationNone
Alias
AssociationdeviceInstance_udi
Association End
ClassDeviceInstance
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
Nameudi
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::udi
Stereotype
Template Parameter
TypeUniqueDeviceIdentifier
Upper1
Upper Value(1)
VisibilityPublic


 url
Public String url

"A network address on which the device may be contacted directly." - HL7 FHIR, Device.url

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDeviceInstance
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
Nameurl
Name Expression
NamespaceDeviceInstance
Opposite
OwnerDeviceInstance
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DeviceInstance::url
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic

Comments