This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Responsible
Owner:
Orders
and
Observations
Work
Group
|
Normative
|
|
Compartments : Device |
Detailed Descriptions for the elements in the Device resource.
| Device | |||||||||
|
| Device | ||||||||
| Definition |
|
||||||||
| Short Display |
Item
used
|
||||||||
|
|
0..* | ||||||||
|
| DomainResource | ||||||||
| Requirements |
Allows institutions to track their devices. |
||||||||
| Summary | false | ||||||||
| Constraints |
| ||||||||
| Device.identifier | |||||||||
|
| Device.identifier | ||||||||
| Definition |
Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
||||||||
|
| Instance identifier | ||||||||
| Note |
This
is
a
business
|
||||||||
|
|
0..* | ||||||||
| Type | Identifier | ||||||||
| Summary |
|
||||||||
| Comments |
Certain
attributes,
like
serial
number
and
UDI
Carrier
(the
HRF
or
AIDC
barcode
string)
are
not
device
instance
identifiers
as
they
are
not
consistently
able
to
uniquely
identify
the
instance
of
a
device,
thus
are
not
appropriate
to
be
used
to
value
Device.identifier.
The
barcode
string
from
a
barcode
present
on
a
device
label
or
package
may
identify
the
instance,
include
names
given
to
the
device
in
local
usage,
or
may
identify
the
type
of
device.
If
the
identifier
identifies
the
type
of
device,
Device.type
element
should
be
used.
|
||||||||
|
|
|||||||||
|
| Device.definition | ||||||||
| Definition |
The reference to the definition for the device. |
||||||||
| Short Display |
The
reference
to
the
definition
for
the
device
|
||||||||
|
Cardinality
|
0..1 | ||||||||
| Type | canonical ( DeviceDefinition ) | ||||||||
| Summary | false | ||||||||
| Device.udiCarrier | |||||||||
| Element Id | Device.udiCarrier | ||||||||
| Definition | Unique Device Identifier (UDI) placed on a device label or package. Note that the Device may include multiple UDIs if it is sold in multiple jurisdictions. |
||||||||
| Short Display | Unique Device Identifier (UDI) value | ||||||||
|
|
|
||||||||
| Summary | true | ||||||||
| Comments |
UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device. |
||||||||
|
|
|||||||||
|
| Device.udiCarrier.deviceIdentifier | ||||||||
| Definition |
The
device
identifier
|
||||||||
| Short Display | Mandatory fixed portion of UDI | ||||||||
| Cardinality |
|
||||||||
| Type | string | ||||||||
| Alternate Names | DI | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
|
|
Device.udiCarrier.deviceIdentifierSystem | ||||||||
| Definition |
|
||||||||
| Short Display | The namespace for the device identifier value | ||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
| Summary |
|
||||||||
|
Device.udiCarrier.issuer
|
|||||||||
|
| Device.udiCarrier.issuer | ||||||||
|
|
| ||||||||
| Short Display | UDI Issuing Organization | ||||||||
|
Cardinality
|
1..1 | ||||||||
| Type | uri | ||||||||
| Alternate Names | Barcode System | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
|
| Device.udiCarrier.jurisdiction | ||||||||
| Definition |
The
identity
of
the
authoritative
source
for
UDI
generation
within
a
jurisdiction.
All
UDIs
are
globally
unique
within
a
single
|
||||||||
| Short Display | Regional UDI authority | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | uri | ||||||||
| Requirements |
Allows a recipient of a UDI to know which database will contain the UDI-associated metadata. |
||||||||
|
|
|
||||||||
|
|
|||||||||
|
|
|
||||||||
| Definition |
The
full
UDI
carrier
of
the
Automatic
Identification
and
Data
Capture
(AIDC)
technology
representation
|
||||||||
| Short Display | UDI Machine Readable value | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | base64Binary | ||||||||
| Alternate Names | Automatic Identification and Data Capture | ||||||||
| Summary | true | ||||||||
| Comments |
The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label. |
||||||||
|
|
|||||||||
|
| Device.udiCarrier.carrierHRF | ||||||||
| Definition |
|
||||||||
| Short Display | UDI Human Readable value | ||||||||
| Cardinality | 0..1 | ||||||||
| Type |
|
||||||||
| Alternate Names | Human Readable Form | ||||||||
|
| true | ||||||||
| Comments |
If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label. | ||||||||
|
|
|||||||||
|
|
Device.udiCarrier.entryType | ||||||||
| Definition |
A coded entry to indicate how the data was entered. |
||||||||
| Short Display | barcode | rfid | manual | card | self-reported | electronic-transmission | unknown | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | code | ||||||||
| Requirements |
Supports a way to distinguish hand entered from machine read data. |
||||||||
| Summary | false | ||||||||
| Device.status | |||||||||
|
| Device.status | ||||||||
| Definition |
|
||||||||
| Short Display | active | inactive | entered-in-error | unknown | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | Device.availabilityStatus | ||||||||
| Definition |
|
||||||||
| Short Display | lost | damaged | destroyed | available | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
FHIR
Device
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
|
|
Device.biologicalSourceEvent | ||||||||
| Definition |
|
||||||||
| Short Display | A production identifier of the donation, collection, or pooling event from which biological material in this device was derived | ||||||||
|
|
0..1 | ||||||||
| Type | Identifier | ||||||||
| Alternate Names | Distinct Identification Code (DIC) | ||||||||
| Summary | false | ||||||||
| Comments | Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier. | ||||||||
| Device.manufacturer | |||||||||
|
| Device.manufacturer | ||||||||
| Definition |
A
name
of
the
|
||||||||
| Short Display | Name of device manufacturer | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Device.manufactureDate | |||||||||
|
| Device.manufactureDate | ||||||||
| Definition |
The date and time when the device was manufactured. |
||||||||
| Short Display | A production identifier that indicates the date when the device was made | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | false | ||||||||
| Device.expirationDate | |||||||||
|
|
Device.expirationDate | ||||||||
| Definition |
The date and time beyond which this device is no longer valid or should not be used (if applicable). |
||||||||
| Short Display | A production identifier that indicates the date and time of expiry of this device (if applicable) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id | Device.lotNumber | ||||||||
| Definition |
Lot number assigned by the manufacturer. | ||||||||
| Short Display | A production identifier that indicates the Lot number of manufacture | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Device.serialNumber | |||||||||
| Element Id | Device.serialNumber | ||||||||
| Definition |
The
| ||||||||
| Short Display | A production identifier that indicates the Serial number assigned by the manufacturer | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Comments |
Alphanumeric
Maximum
20.
While
a
serial
number
is
a
type
of
identifier,
in
the
context
of
devices
for
which
a
UDI
is
required,
thus
a
serial
number
may
be
part
of
the
production
identifier,
it
is
more
informative
to
| ||||||||
| Device.name | |||||||||
| Element Id | Device.name | ||||||||
| Definition |
This
represents
the
|
||||||||
| Short Display | The name or names of the device as known to the manufacturer and/or patient | ||||||||
|
| 0..* | ||||||||
| Summary | false | ||||||||
|
|
| ||||||||
| Device.name.value | |||||||||
| Element Id | Device.name.value | ||||||||
| Definition | The actual name that identifies the device. | ||||||||
| Short Display | The term that names the device | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | string | ||||||||
| Alternate Names | Σ | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | Device.name.type | ||||||||
| Definition |
Indicates the kind of name. RegisteredName | UserFriendlyName | PatientReportedName. | ||||||||
| Short Display | registered-name | user-friendly-name | patient-reported-name | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Device Name Type ( Extensible ) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments |
The
| ||||||||
| Device.name.display | |||||||||
| Element Id | Device.name.display | ||||||||
| Definition |
Indicates
the
default
or
|
||||||||
|
| The preferred device name | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Is Modifier |
true
(Reason:
This
element
is
labelled
as
a
| ||||||||
|
Summary
|
true | ||||||||
| Constraints |
| ||||||||
| Device.modelNumber | |||||||||
| Element Id | Device.modelNumber | ||||||||
| Definition | The manufacturer's model number for the device. | ||||||||
| Short Display | The manufacturer's model number for the device | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
| Element Id | Device.partNumber | ||||||||
| Definition |
The part number or catalog number of the device. | ||||||||
| Short Display | The part number or catalog number of the device | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Comments |
| ||||||||
| Device.category | |||||||||
| Element Id | Device.category | ||||||||
| Definition | Devices may be associated with one or more categories. | ||||||||
| Short Display |
Indicates
a
high-level
grouping
of
the
device
|
||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | FHIR Device Category ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| Device.type | |||||||||
| Element Id | Device.type | ||||||||
| Definition |
The
kind
or
type
of
device.
A
device
instance
may
have
more
than
one
type
-
in
which
case
those
are
the
types
that
apply
to
|
||||||||
| Short Display | The kind or type of device | ||||||||
| Cardinality | 0..* | ||||||||
|
| Device Type ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
|
| false | ||||||||
| Comments | Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor. Device.type relates DeviceDefinition.classification.type using the same binding enabling referencing. | ||||||||
| Device.deviceVersion | |||||||||
| Element Id | Device.deviceVersion | ||||||||
| Definition | The actual design of the device or software version running on the device. | ||||||||
| Short Display | The actual design of the device or software version running on the device | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| Comments | The combination of type and component SHOULD be unique across all repetitions of version. | ||||||||
| Device.deviceVersion.type | |||||||||
| Element Id | Device.deviceVersion.type | ||||||||
| Definition | The type of the device version, e.g. manufacturer, approved, internal. | ||||||||
| Short Display | The type of the device version, e.g. manufacturer, approved, internal | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding |
Device
Version
Type
(
|
||||||||
|
|
CodeableConcept | ||||||||
| Alternate Names | Σ | ||||||||
| Summary | false | ||||||||
| Device.deviceVersion.component | |||||||||
| Element Id | Device.deviceVersion.component | ||||||||
| Definition |
| ||||||||
| Short Display |
The
hardware
or
software
module
of
the
device
to
which
the
| ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Identifier | ||||||||
| Summary | false | ||||||||
| Comments | Note that the module of the device would not need to be tracked as a separate device, e.g., using different UDI, thus would typically involve one or more software modules. For example, a device may involve two software modules each on a different version. |
||||||||
|
|
|||||||||
| Element Id | Device.deviceVersion.installDate | ||||||||
| Definition |
The date the version was installed on the device. | ||||||||
| Short Display | The date the version was installed on the device | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | false | ||||||||
| Device.deviceVersion.value | |||||||||
| Element Id | Device.deviceVersion.value | ||||||||
| Definition |
| ||||||||
| Short Display | The version text | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Device.conformsTo | |||||||||
| Element Id | Device.conformsTo | ||||||||
| Definition |
Identifies
the
standards,
specifications,
or
formal
guidances
for
the
|
||||||||
| Short Display | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | ||||||||
|
|
0..* | ||||||||
| Summary | false | ||||||||
| Device.conformsTo.category | |||||||||
| Element Id | Device.conformsTo.category | ||||||||
| Definition | Describes the type of the standard, specification, or formal guidance. | ||||||||
| Short Display | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Device Specification Category ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
|
| false | ||||||||
| Device.conformsTo.specification | |||||||||
| Element Id | Device.conformsTo.specification | ||||||||
| Definition | Code that identifies the specific standard, specification, protocol, formal guidance, regulation, legislation, or certification scheme to which the device adheres. | ||||||||
| Short Display | Identifies the standard, specification, or formal guidance that the device adheres to | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding |
Device
Specification
Type
(
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
|
|
Device.conformsTo.version | ||||||||
| Definition |
| ||||||||
| Short Display | Specific form or variant of the standard | ||||||||
| Note |
This
is
| ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Device.property | |||||||||
| Element Id | Device.property | ||||||||
| Definition | Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes. | ||||||||
| Short Display | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| Comments | Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition. |
||||||||
| Device.property.type | |||||||||
| Element Id | Device.property.type | ||||||||
| Definition | Code that specifies the property, such as resolution, color, size, being represented. | ||||||||
| Short Display | Code that specifies the property being represented | ||||||||
| Cardinality | 1..1 | ||||||||
|
| Device Property Type (Example only) ( Example ) | ||||||||
| Type | CodeableConcept | ||||||||
|
| false | ||||||||
| Device.property.value[x] | |||||||||
|
| Device.property.value[x] | ||||||||
| Definition |
The value of the property specified by the associated property.type code. | ||||||||
| Short Display | Value of the property | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Quantity | CodeableConcept | string | boolean | integer | Range | Attachment | ||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
| Summary | false | ||||||||
| Comments |
The
text
element
in
CodeableConcept.text
is
used
for
|
||||||||
|
|
|||||||||
|
| Device.additive | ||||||||
| Definition |
Material
added
to
a
container
device
(typically
used
in
specimen
collection
or
initial
processing).
The
| ||||||||
| Short Display | Material added to a container device | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| Comments |
A
Procedure
can
be
|
||||||||
| Device.additive.type | |||||||||
| Element Id | Device.additive.type | ||||||||
| Definition | The type of the substance added to the container. This is represented as a concept from a code system or described in a Substance resource. | ||||||||
| Short Display | The additive substance | ||||||||
| Cardinality | 1..1 | ||||||||
|
| Substance Code ( Example ) | ||||||||
| Type |
|
||||||||
|
|
false | ||||||||
| Device.additive.quantity | |||||||||
| Element Id | Device.additive.quantity | ||||||||
| Definition |
|
||||||||
| Short Display | Quantity of additive substance within container | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | SimpleQuantity | ||||||||
| Summary | false | ||||||||
|
|
|||||||||
|
| Device.contact | ||||||||
| Definition |
|
||||||||
| Short Display | Details for human/organization for support | ||||||||
| Cardinality |
|
||||||||
| Type | ContactPoint | ||||||||
|
|
false | ||||||||
| Comments |
used for troubleshooting etc. | ||||||||
| Device.location | |||||||||
| Element Id | Device.location | ||||||||
| Definition |
| ||||||||
| Short Display |
Where
the
| ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference ( Location ) | ||||||||
| Requirements |
Device.location
can
be
|
||||||||
| Summary | false | ||||||||
| Device.note | |||||||||
|
| Device.note | ||||||||
| Definition |
Descriptive information, usage information or implantation information that is not captured in an existing element. |
||||||||
| Short Display | Device notes and comments | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Annotation | ||||||||
| Summary | false | ||||||||
| Device.safety | |||||||||
|
| Device.safety | ||||||||
| Definition |
Provides additional safety characteristics about a medical device. For example devices containing latex. |
||||||||
| Short Display | Safety Characteristics of Device | ||||||||
|
|
0..* | ||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Device.parent | |||||||||
| Element Id | Device.parent | ||||||||
| Definition | The higher level or encompassing device that this device is a logical part of. | ||||||||
| Short Display | The higher level or encompassing device that this device is a logical part of | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference ( Device ) | ||||||||
| Hierarchy | This reference is part of a strict Hierarchy | ||||||||
| Summary | false | ||||||||
| Comments | For example a vital signs monitor (parent) where three separate modules can be plugged into such as interchangeable blood pressure, oximeter, temperature modules. These modules are represented as devices with the .parent valued to the vital signs monitor when plugged in. | ||||||||