FHIR Release 3 (STU) CI-Build

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 icon . Page versions: R5 R4B R4 R3 R2

Responsible Owner: Orders and Observations icon Work Group   Normative Maturity Level : 2   Trial Use Security Category : Business Compartments : Device

Detailed Descriptions for the elements in the Device resource.

Alternate Names Unique Control Alternate Names Control Device.udi.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. Type true Control Control Control Control Comments Control string Control Control Control Control Control Control Control Control
Definition Element Id Device
Definition

This resource identifies an instance or a type of a 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. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment

Short Display Item used for diagnostic, treatment, and research for in healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
Control Cardinality 0..*
1..1 Type DomainResource
Requirements

Allows institutions to track their devices.

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

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

Note Short Display Instance identifier
Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Summary Serial Number 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. For UDI , this element corresponds to the variable portion of the UDI that identifies The identifier is typically valued if the serial number of a specific device. See UDI mappings for serialNumber or lotNumber is not valued and represents a complete mapping different type of UDI parts identifier. However, it is permissible to Device. still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

Definition Element Id Device.definition
Definition

The reference to the definition for the device.

Short Display The reference to the definition for the device identifier (UDI)
Cardinality assigned to 0..1
Type canonical ( DeviceDefinition )
Summary false
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
Control Cardinality 0..1 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.

Definition Element Id Device.udiCarrier.deviceIdentifier
Definition

The device identifier (DI) (UDI-DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. The UDI-DI portion is placed on a device label or package. Note that the DeviceDefinition may include multiple UDI-DIs if it is sold in multiple jurisdictions.

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

Name of device as Establishes the namespace for the issuing agency's system (e.g, GS1's GTIN, ICCBBA's ISBT-128) used in labeling or catalog. to create the device identifier.

Short Display The namespace for the device identifier value
Control Cardinality 0..1
Type string uri
Summary Brand Name false
true Element Id Device.udiCarrier.issuer
Comments Definition

Use the Device.type Organization that is charged with issuing UDIs for a generic type or kind of device name. Note devices. For example, the GUDID 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 lists the name as the 'Brand Name'. 1..1
Type uri
Alternate Names Barcode System
Summary true
Definition 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. 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/fda-udi. 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.

Control Summary 0..1 false
Comments Element Id 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.udi.carrierAIDC 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 e.g., a barcode , 2D Matrix, or RFID. Because of limitations on character sets in XML Some AIDC representations contain non-printable characters and the need to round-trip JSON data through XML, cannot be represented in a string format. For this reason, AIDC Formats format SHALL be base64 base64Binary encoded.

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.

Definition Element Id Device.udiCarrier.carrierHRF
Definition

Organization that is charged with issuing UDIs for devices. For example, The full UDI carrier as the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 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. human readable form (HRF) representation as printed on the packaging of the device.

Short Display UDI Human Readable value
Cardinality 0..1
Type uri string
Alternate Names Human Readable Form
Barcode System 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.

Definition 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 UDIEntryType UDI Entry Type ( Required )
Type code
Requirements

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

Summary false
Definition Element Id Device.status
Definition

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

Short Display active | inactive | entered-in-error | unknown
Cardinality 0..1
Terminology Binding FHIRDeviceStatus 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
Element Id Device.availabilityStatus
Definition

Code or identifier to identify a kind The availability of the device.

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

Lot number assigned by A production identifier of the manufacturer. donation, collection, or pooling event from which biological material in this device was derived.

Short Display A production identifier of the donation, collection, or pooling event from which biological material in this device was derived
Control 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.

Definition Element Id Device.manufacturer
Definition

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

Short Display Name of device manufacturer
Cardinality 0..1
Type string
Summary false
Definition Element Id 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
Definition 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 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
Element Id Device.serialNumber
Definition

The "model" is an serial number assigned by the organization when the device was manufactured.

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 identify have the product by 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. This Systems that do not realize an identifier is a serial number may place it in Device.identifier or if the identifier.system is shared by known for the all devices sold serial number, it may also be populated in the Device.identifier as a globally unique id_.

Element Id Device.name
Definition

This represents the same type. 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
Control Cardinality 0..*
Summary false
0..1 Constraints
Affect this element
dev-1 Rule only one Device.name.display SHALL be true when there is more than one Device.name name.where(display=true).count() <= 1
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 version of the device, if implementation or jurisdiction must clarify which name is to be used as the registered-name. As a result a device has definition may have multiple releases under names that are the same model, or if same, but then used for different purposes per the device is software name type and jurisdictional guidance.

Element Id Device.name.display
Definition

Indicates the default or carries firmware. preferred name to be displayed.

Note Short Display The preferred device name
Cardinality 0..1
Type boolean
Is Modifier true (Reason: This element is labelled as a business versionId, not modifier because it is a resource version id (see discussion status element that can indicate that that a name is preferred.)
Summary ) true
Constraints Control
Affect this element
dev-1 Rule only one Device.name.display SHALL be true when there is more than one Device.name name.where(display=true).count() <= 1
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

Patient information, If Alphanumeric Maximum 20.

Element Id Device.category
Definition

Devices may be associated with one or more categories.

Short Display Indicates a high-level grouping of the device is affixed
Cardinality 0..*
Terminology Binding FHIR Device Category ( Example )
Type CodeableConcept
Summary false
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 a person. the specific instance of the device.

Short Display The kind or type of device
Cardinality 0..*
0..1 Terminology Binding Device Type ( Example )
Type CodeableConcept
Reference 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.

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.

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 ( Patient Example )
Requirements Type CodeableConcept
Alternate Names Σ
Summary false
Element Id Device.deviceVersion.component
Definition

If The hardware or software module of the device is implanted in a patient, then need to associate which the version applies.

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

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
Element Id Device.deviceVersion.value
Definition

An organization that is responsible The version text.

Short Display The version text
Cardinality 1..1
Type string
Summary false
Element Id Device.conformsTo
Definition

Identifies the standards, specifications, or formal guidances for the provision and ongoing maintenance of 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
Control Cardinality 0..*
Summary false
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
Reference Summary false
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 ( Organization Example )
Type CodeableConcept
Summary false
Definition Element Id Device.conformsTo.version
Definition

Contact details for an organization Identifies the specific form or variant of the standard, specification, or formal guidance. This may be a particular human that 'version number', release, document edition, publication year, or other label.

Short Display Specific form or variant of the standard
Note This is responsible a business versionId, not a resource version id (see discussion )
Cardinality 0..1
Type string
Summary false
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.

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
0..* Terminology Binding Device Property Type (Example only) ( Example )
Type CodeableConcept
ContactPoint Summary false
Comments 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 troubleshooting etc. 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.

Definition Element Id Device.additive
Definition

Material added to a container device (typically used in specimen collection or initial processing). The place where material may be added by the device manufacturer or by a different party subsequent to manufacturing.

Short Display Material added to a container device
Cardinality 0..*
Summary false
Comments

A Procedure can be found. used to document details of the addition of a substance to the device.

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
0..1 Terminology Binding Substance Code ( Example )
Type Reference CodeableReference ( Location SubstanceDefinition )
Requirements Summary false
Element Id Device.additive.quantity
Definition

Device.location can The quantity of the additive substance in the container; may be used to track device location. volume, dimensions, or other appropriate measurements, depending on the container and additive substance type.

Short Display Quantity of additive substance within container
Cardinality 0..1
Type SimpleQuantity
Summary false
Definition Element Id Device.contact
Definition

A network address on which Contact details for an organization or a particular human that is responsible for the device may be contacted directly. device.

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

used for troubleshooting etc.

Element Id Device.location
Definition

If The place where the device is running a FHIR server, the network address should can be found.

Short Display Where the Base URL from which a conformance statement may device is found
Cardinality 0..1
Type Reference ( Location )
Requirements

Device.location can be retrieved. used to track device location.

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

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

Short Display Safety Characteristics of Device
Control Cardinality 0..*
Terminology Binding DeviceSafety Device Safety ( Example )
Type CodeableConcept
Summary true
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.