This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Orders and Observations Work Group | Maturity Level: 2 | Trial Use | Security Category: Business | Compartments: Patient |
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 |
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.displayName | |
Element Id | Device.displayName |
Definition | The name used to display by default when the device is referenced. Based on intent of use by the resource creator, this may reflect one of the names in Device.deviceName, or may be another simple name. |
Short Display | The name used to display by default when the device is referenced |
Cardinality | 0..1 |
Type | string |
Summary | false |
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 | CodeableReference(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.issuer | |
Element Id | Device.udiCarrier.issuer |
Definition | Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include:
|
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 | UDIEntryType (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 | FHIRDeviceStatus (Required) |
Type | code |
Is Modifier | true (Reason: This element is labelled 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 |
Comments | This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid. |
Device.availabilityStatus | |
Element Id | Device.availabilityStatus |
Definition | The availability of the device. |
Short Display | lost | damaged | destroyed | available |
Cardinality | 0..1 |
Terminology Binding | FHIRDeviceAvailabilityStatus (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.deviceName | |
Element Id | Device.deviceName |
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 |
Device.deviceName.name | |
Element Id | Device.deviceName.name |
Definition | The name that identifies the device. |
Short Display | The name that identifies the device |
Cardinality | 1..1 |
Type | string |
Alternate Names | Σ |
Summary | false |
Device.deviceName.type | |
Element Id | Device.deviceName.type |
Definition | The type of deviceName. Note that ManufactureDeviceName means that the name is the name as given by the manufacturer, not the name of the manufacturer. RegisteredName | UserFriendlyName | PatientReportedName. |
Short Display | registered-name | user-friendly-name | patient-reported-name |
Cardinality | 1..1 |
Terminology Binding | DeviceNameType (Required) |
Type | code |
Summary | false |
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 | FHIRDeviceCategory (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.version | |
Element Id | Device.version |
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 |
Note | This is a business versionId, not a resource version id (see discussion) |
Cardinality | 0..* |
Summary | false |
Device.version.type | |
Element Id | Device.version.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.version.component | |
Element Id | Device.version.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.version.installDate | |
Element Id | Device.version.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.version.value | |
Element Id | Device.version.value |
Definition | The version text. |
Short Display | The version text |
Cardinality | 1..1 |
Type | string |
Summary | false |
Device.specialization | |
Element Id | Device.specialization |
Definition | The standards to which the device adheres and may be certified to in support of its capabilities, e.g., communication, performance, process, or measurement standards. |
Short Display | The standard(s) the device supports |
Cardinality | 0..* |
Summary | false |
Device.specialization.systemType | |
Element Id | Device.specialization.systemType |
Definition | Code that specifies the system that identifies the specific standard that the device adheres to. |
Short Display | Code of the system that identifies the standard that the device adheres to |
Cardinality | 1..1 |
Terminology Binding | Device Specialization System Type (Example) |
Type | CodeableConcept |
Summary | false |
Device.specialization.version | |
Element Id | Device.specialization.version |
Definition | The version of the standard that is used to operate and communicate. |
Short Display | Standard version used |
Note | This is a business versionId, not a resource version id (see discussion) |
Cardinality | 0..1 |
Type | string |
Summary | false |
Device.specialization.category | |
Element Id | Device.specialization.category |
Definition | Kind of standards that the device adheres to, e.g., communication, performance or communication. |
Short Display | communication | performance | measurement |
Cardinality | 0..1 |
Terminology Binding | FHIRDeviceSpecializationCategory (Example) |
Type | Coding |
Summary | false |
Device.property | |
Element Id | Device.property |
Definition | Characteristics or features of the device that are otherwise not captured in available attributes, e.g., actual configuration settings, time or timing attributes, resolution, accuracy, and physical attributes. The focus is on properties of the device actually in use while DeviceDefinition focuses on properties that are available to be used. |
Short Display | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
Cardinality | 0..* |
Summary | false |
Device.property.type | |
Element Id | Device.property.type |
Definition | Code that specifies the property being represented. No codes are specified but the MDC codes are an example: https://terminology.hl7.org/MDC.html. |
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 | Property value - can be a code, quantity, boolean, string or attachment. |
Short Display | Property value - as a code, quantity, boolean, string or attachment |
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 string is used for properties that are intrinsically text, such as warning text, or assemlby instructions. CodeableConcept.text also supports unencoded text but should be used where the characteristic is a concept that might be coded but there is no assigned code for the present value. For example, a security class can be a code like 'Class 1' but in some cases may contain a string like 'Depending on the settings' - in this case the property is normally coded but this is an exception |
Device.operation | |
Element Id | Device.operation |
Definition | The status of the device itself - whether it is switched on, or activated, etc. |
Short Display | The details about the device when it is in use to describe the actions, conditions and status |
Cardinality | 0..* |
Summary | false |
Device.operation.status | |
Element Id | Device.operation.status |
Definition | The state or condition of the device's operation. |
Short Display | Device operational condition |
Cardinality | 1..1 |
Terminology Binding | FHIRDeviceOperationStatus (Example) |
Type | CodeableConcept |
Summary | false |
Device.operation.statusReason | |
Element Id | Device.operation.statusReason |
Definition | The reasons given for the current operational status - i.e. why is the device switched on etc. |
Short Display | The rationale given for the current operational status |
Cardinality | 0..* |
Terminology Binding | FHIRDeviceOperatonStatusReason (Example) |
Type | CodeableConcept |
Summary | false |
Device.operation.operator | |
Element Id | Device.operation.operator |
Definition | The individual performing the action enabled by the device. |
Short Display | The individual performing the action enabled by the device |
Cardinality | 0..* |
Type | Reference(Patient | Practitioner | RelatedPerson) |
Summary | false |
Device.operation.mode | |
Element Id | Device.operation.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 | FHIRDeviceOperationMode (Example) |
Type | CodeableConcept |
Summary | false |
Device.operation.cycle | |
Element Id | Device.operation.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.operation.duration | |
Element Id | Device.operation.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.association | |
Element Id | Device.association |
Definition | The details about the device when it is affixed or inside of a patient. |
Short Display | Current association of the device |
Cardinality | 0..* |
Summary | true |
Device.association.status | |
Element Id | Device.association.status |
Definition | The state of the usage or application of the device. |
Short Display | Device useage state |
Cardinality | 1..1 |
Terminology Binding | FHIRDeviceAssociationStatus (Example) |
Type | CodeableConcept |
Summary | true |
Device.association.statusReason | |
Element Id | Device.association.statusReason |
Definition | The reasons given for the current association status - i.e. why is the device explanted, or attached to the patient, etc. |
Short Display | The reasons given for the current association status |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
Device.association.humanSubject | |
Element Id | Device.association.humanSubject |
Definition | The individual to whom the device is affixed or inserted in their body. |
Short Display | The individual associated with the device |
Cardinality | 0..1 |
Type | Reference(Patient) |
Summary | false |
Device.association.bodyStructure | |
Element Id | Device.association.bodyStructure |
Definition | The current anatomical location of the device in/on the humanSubject where it is attached or placed. |
Short Display | Current anatomical location of device in/on humanSubject |
Cardinality | 0..1 |
Type | CodeableReference(BodyStructure) |
Summary | true |
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/data collector, translator or controller 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 |
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 | DeviceSafety (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) |
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. |