FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Orders and Observations icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the Device resource.

Device
Element Id Device
Definition

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Short Display Item used in healthcare
Cardinality 0..*
Type DomainResource
Requirements

Allows institutions to track their devices.

Summary false
Invariants
Defined on this element
dev-1Rule only one Device.name.display SHALL be true when there is more than one Device.namename.where(display=true).count() <= 1
Device.identifier
Element Id Device.identifier
Definition

Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

Short Display Instance identifier
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Summary false
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. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

Device.definition
Element Id 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 Reference(DeviceDefinition)
Summary false
Device.udiCarrier
Element Id Device.udiCarrier
Definition

Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

Short Display Unique Device Identifier (UDI) Barcode string
Cardinality 0..*
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
Element Id Device.udiCarrier.deviceIdentifier
Definition

The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

Short Display Mandatory fixed portion of UDI
Cardinality 1..1
Type string
Alternate Names DI
Summary true
Device.udiCarrier.deviceIdentifierSystem
Element Id Device.udiCarrier.deviceIdentifierSystem
Definition

Establishes the namespace for the device identifier value that is an URL, OID, urn or uuid.

Short Display The namespace for the device identifier value
Cardinality 0..1
Type uri
Summary false
Device.udiCarrier.issuer
Element Id Device.udiCarrier.issuer
Definition

Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include:

  1. GS1: http://hl7.org/fhir/NamingSystem/gs1-di,
  2. HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-diI,
  3. ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di,
  4. ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di # Informationsstelle für Arzneispezialitäten (IFA GmbH) (EU only): http://hl7.org/fhir/NamingSystem/ifa-gmbh-di.
Short Display UDI Issuing Organization
Cardinality 1..1
Type uri
Alternate Names Barcode System
Summary true
Device.udiCarrier.jurisdiction
Element Id Device.udiCarrier.jurisdiction
Definition

The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/us-fda-udi or in the European Union by the European Commission http://hl7.org/fhir/NamingSystem/eu-ec-udi.

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.

Summary false
Device.udiCarrier.carrierAIDC
Element Id Device.udiCarrier.carrierAIDC
Definition

The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.

Short Display UDI Machine Readable Barcode String
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
Element Id Device.udiCarrier.carrierHRF
Definition

The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

Short Display UDI Human Readable Barcode String
Cardinality 0..1
Type string
Alternate Names Human Readable Form
Summary 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
Element Id 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 UDI Entry Type (Required)
Type code
Requirements

Supports a way to distinguish hand entered from machine read data.

Summary false
Device.status
Element Id Device.status
Definition

The Device record status. This is not the status of the device like availability.

Short Display active | inactive | entered-in-error
Cardinality 0..1
Terminology Binding FHIR Device Status (Required)
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
Device.availabilityStatus
Element Id Device.availabilityStatus
Definition

The availability of the device.

Short Display lost | damaged | destroyed | available
Cardinality 0..1
Terminology Binding FHIR Device Availability Status (Extensible)
Type CodeableConcept
Summary false
Device.biologicalSourceEvent
Element Id Device.biologicalSourceEvent
Definition

An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.

Short Display An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
Cardinality 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
Element Id Device.manufacturer
Definition

A name of the manufacturer or entity legally responsible for the device.

Short Display Name of device manufacturer
Cardinality 0..1
Type string
Summary false
Device.manufactureDate
Element Id Device.manufactureDate
Definition

The date and time when the device was manufactured.

Short Display Date when the device was made
Cardinality 0..1
Type dateTime
Summary false
Device.expirationDate
Element Id Device.expirationDate
Definition

The date and time beyond which this device is no longer valid or should not be used (if applicable).

Short Display Date and time of expiry of this device (if applicable)
Cardinality 0..1
Type dateTime
Summary false
Device.lotNumber
Element Id Device.lotNumber
Definition

Lot number assigned by the manufacturer.

Short Display Lot number of manufacture
Cardinality 0..1
Type string
Summary false
Device.serialNumber
Element Id Device.serialNumber
Definition

The serial number assigned by the organization when the device was manufactured.

Short Display 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 have the serial number as a dedicated attribute together with the other UDI production identifier. When the device is not subject to including the UDI (e.g., its presence and exchange is not mandated by local regulatory requirements or specific use case at hand), thus the concept of production identifiers is not relevant as a set, it remains helpful for consistency to still use Device.serialNumber rather than using Device.identifier with an appropriate type. Systems that do not realize an identifier is a serial number may place it in Device.identifier or if the identifier.system is known for the serial number, it may also be populated in the Device.identifier as a globally unique id_.

Device.name
Element Id Device.name
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.

Short Display The name or names of the device as known to the manufacturer and/or patient
Cardinality 0..*
Summary false
Invariants
Affect this element
dev-1Rule only one Device.name.display SHALL be true when there is more than one Device.namename.where(display=true).count() <= 1
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
Device.name.type
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 implementation or jurisdiction must clarify which name is to be used as the registered-name. As a result a device definition may have multiple names that are the same, but then used for different purposes per the name type and jurisdictional guidance.

Device.name.display
Element Id Device.name.display
Definition

Indicates the default or preferred name to be displayed.

Short Display The preferred device name
Cardinality 0..1
Type boolean
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that can indicate that that a name is preferred.)
Summary true
Invariants
Affect this element
dev-1Rule only one Device.name.display SHALL be true when there is more than one Device.namename.where(display=true).count() <= 1
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
Device.partNumber
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

Alphanumeric Maximum 20.

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 the specific instance of the device.

Short Display The kind or type of device
Cardinality 0..*
Terminology Binding Device Type (Example)
Type CodeableConcept
Summary 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
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 (Example)
Type CodeableConcept
Alternate Names Σ
Summary false
Device.deviceVersion.component
Element Id Device.deviceVersion.component
Definition

The hardware or software module of the device to which the version applies.

Short Display The hardware or software module of the device to which the version applies
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.

Device.deviceVersion.installDate
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

The version text.

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 capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

Short Display Identifies the standards, specifications, or formal guidances for the capabilities supported by the device
Cardinality 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
Summary 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 (Example)
Type CodeableConcept
Summary false
Device.conformsTo.version
Element Id Device.conformsTo.version
Definition

Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a 'version number', release, document edition, publication year, or other label.

Short Display Specific form or variant of the standard
Note This is a business versionId, not a resource version id (see discussion)
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
Terminology Binding Device Property Type (Example)
Type CodeableConcept
Summary false
Device.property.value[x]
Element Id 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 properties which would usually be coded (such as the size of an implant, or a security classification) but for which there is not currently an appropriate concept in the vocabulary (e.g. a custom implant size, or a security classification which depends on configuration). Otherwise the string choice type is used for descriptive properties, or instructions.

Device.mode
Element Id Device.mode
Definition

The designated condition for performing a task with the device.

Short Display The designated condition for performing a task
Cardinality 0..1
Terminology Binding FHIR Device Operation Mode (Example)
Type CodeableConcept
Summary false
Device.cycle
Element Id Device.cycle
Definition

The series of occurrences that repeats during the operation of the device.

Short Display The series of occurrences that repeats during the operation of the device
Cardinality 0..1
Type Count
Summary false
Device.duration
Element Id Device.duration
Definition

A measurement of time during the device's operation (e.g., days, hours, mins, etc.).

Short Display A measurement of time during the device's operation (e.g., days, hours, mins, etc.)
Cardinality 0..1
Type Duration
Summary false
Device.owner
Element Id Device.owner
Definition

An organization that is responsible for the provision and ongoing maintenance of the device.

Short Display Organization responsible for device
Cardinality 0..1
Type Reference(Organization)
Summary false
Device.contact
Element Id Device.contact
Definition

Contact details for an organization or a particular human that is responsible for the device.

Short Display Details for human/organization for support
Cardinality 0..*
Type ContactPoint
Summary false
Comments

used for troubleshooting etc.

Device.location
Element Id Device.location
Definition

The place where the device can be found.

Short Display Where the device is found
Cardinality 0..1
Type Reference(Location)
Requirements

Device.location can be used to track device location.

Summary false
Device.url
Element Id Device.url
Definition

A network address on which the device may be contacted directly.

Short Display Network address to contact device
Cardinality 0..1
Type uri
Summary false
Comments

If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.

Device.endpoint
Element Id Device.endpoint
Definition

Technical endpoints providing access to services provided by the device defined at this resource.

Short Display Technical endpoints providing access to electronic services provided by the device
Cardinality 0..*
Type Reference(Endpoint)
Summary false
Device.gateway
Element Id Device.gateway
Definition

The linked device acting as a communication controller, data collector, translator, or concentrator for the current device (e.g., mobile phone application that relays a blood pressure device's data).

Short Display Linked device acting as a communication/data collector, translator or controller
Cardinality 0..*
Type CodeableReference(Device)
Summary false
Comments

The Device.gateway may be used when the Device being referenced has a gateway and/or to capture one or more gateways associated with the device. If the Gateway is included in the Observation resource, the Observation.gatewayDevice should be used instead.

Device.note
Element Id 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
Element Id Device.safety
Definition

Provides additional safety characteristics about a medical device. For example devices containing latex.

Short Display Safety Characteristics of Device
Cardinality 0..*
Terminology Binding Device Safety (Example)
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.