This page is part of the FHIR Specification (v5.0.0-snapshot1: R5 Snapshot #1). 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. |
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. |
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. |
Cardinality | 0..1 |
Type | string |
Summary | false |
Device.definition | |
Element Id | Device.definition |
Definition | 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. |
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. |
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:
|
Cardinality | 0..1 |
Type | uri |
Alternate Names | Barcode System |
Summary | false |
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. |
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. |
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. |
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. |
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 | Status of the Device record. This is not the status of the device like availability. |
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.statusReason | |
Element Id | Device.statusReason |
Definition | Reason for the status of the Device record. For example, why is the record not active. |
Cardinality | 0..* |
Terminology Binding | FHIRDeviceStatusReason (Extensible) |
Type | CodeableConcept |
Summary | false |
Device.biologicalSource | |
Element Id | Device.biologicalSource |
Definition | An identifier that supports traceability to the biological entity that is the source of biological material in the product. |
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. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. For example, this applies to devices in the United States regulated under Code of Federal Regulation 21CFR§1271.290(c). |
Device.manufacturer | |
Element Id | Device.manufacturer |
Definition | A name of the manufacturer or entity legally responsible for the device. |
Cardinality | 0..1 |
Type | string |
Summary | false |
Device.manufactureDate | |
Element Id | Device.manufactureDate |
Definition | The date and time when the device was manufactured. |
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). |
Cardinality | 0..1 |
Type | dateTime |
Summary | false |
Device.lotNumber | |
Element Id | Device.lotNumber |
Definition | Lot number assigned by the manufacturer. |
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. |
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. |
Cardinality | 0..* |
Summary | false |
Device.deviceName.name | |
Element Id | Device.deviceName.name |
Definition | 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. |
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. |
Cardinality | 0..1 |
Type | string |
Summary | false |
Device.partNumber | |
Element Id | Device.partNumber |
Definition | The part number or catalog number of the device. |
Cardinality | 0..1 |
Type | string |
Summary | false |
Comments | Alphanumeric Maximum 20. |
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. |
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. |
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. |
Cardinality | 0..1 |
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. |
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.value | |
Element Id | Device.version.value |
Definition | The version text. |
Cardinality | 1..1 |
Type | string |
Summary | false |
Device.property | |
Element Id | Device.property |
Definition | 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://build.fhir.org/mdc.html. |
Cardinality | 1..1 |
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. |
Cardinality | 0..1 |
Type | Quantity|CodeableConcept|string|boolean|integer|Range|Attachment |
[x] Note | See Choice of Data Types 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.subject | |
Element Id | Device.subject |
Definition | Patient information, if the device is affixed to, or associated to a patient for their specific use, irrespective of the procedure, use, observation, or other activity that the device is involved in. |
Cardinality | 0..1 |
Type | Reference(Patient | Practitioner | Person) |
Patterns | Reference(Patient,Practitioner,Person): No common pattern |
Requirements | If the device is implanted, or otherwise in use by the patient (e.g., wheelchair, oxygen tank), without further describing its specific use, then the device needs to be associated to the patient. |
Summary | false |
Device.operationalStatus | |
Element Id | Device.operationalStatus |
Definition | The status of the device itself - whether it is switched on, or activated, etc. |
Cardinality | 0..1 |
Summary | false |
Device.operationalStatus.value | |
Element Id | Device.operationalStatus.value |
Definition | on |off | standby. |
Cardinality | 1..1 |
Terminology Binding | FHIRDeviceOperationalStatus (Example) |
Type | CodeableConcept |
Summary | false |
Device.operationalStatus.reason | |
Element Id | Device.operationalStatus.reason |
Definition | The reasons given for the current operational status - i.e. why is the device switched on etc. |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
Device.associationStatus | |
Element Id | Device.associationStatus |
Definition | The state of the usage or application of the device - whether the device is implanted, or explanted, or attached to the patient. |
Cardinality | 0..1 |
Summary | false |
Device.associationStatus.value | |
Element Id | Device.associationStatus.value |
Definition | implanted|explanted|attached. |
Cardinality | 1..1 |
Terminology Binding | FHIRDeviceAssociationStatus (Example) |
Type | CodeableConcept |
Summary | false |
Device.associationStatus.reason | |
Element Id | Device.associationStatus.reason |
Definition | The reasons given for the current association status - i.e. why is the device explanted, or attached to the patient, etc. |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
Device.owner | |
Element Id | Device.owner |
Definition | An organization that is responsible for the provision and ongoing maintenance of the 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. |
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. |
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. |
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. |
Cardinality | 0..* |
Type | Reference(Endpoint) |
Summary | false |
Device.link | |
Element Id | Device.link |
Definition | An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device. |
Cardinality | 0..* |
Summary | false |
Device.link.relation | |
Element Id | Device.link.relation |
Definition | The type indicates the relationship of the related device to the device instance. |
Cardinality | 1..1 |
Terminology Binding | DeviceRelationType (Extensible) |
Type | Coding |
Summary | false |
Device.link.relatedDevice | |
Element Id | Device.link.relatedDevice |
Definition | A reference to the linked device. |
Cardinality | 1..1 |
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. |
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. |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | true |
Device.parent | |
Element Id | Device.parent |
Definition | The device that this device is attached to or is part of. |
Cardinality | 0..1 |
Type | Reference(Device) |
Summary | false |