This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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: Not linked to any 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. |
Cardinality | 0..* |
Type | DomainResource |
Requirements | Allows institutions to track their devices. |
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 |
Comments | The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. |
Device.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 |
Device.definition | |
Element Id | Device.definition |
Definition | The reference to the definition for the device. |
Cardinality | 0..1 |
Type | Reference(DeviceDefinition) |
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 | 0..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 |
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/fda-udi. |
Cardinality | 0..1 |
Type | uri |
Requirements | Allows a recipient of a UDI to know which database will contain the UDI-associated metadata. |
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. |
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 |
Device.distinctIdentifier | |
Element Id | Device.distinctIdentifier |
Definition | The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. |
Cardinality | 0..1 |
Type | string |
Alternate Names | Distinct Identification Code (DIC) |
Comments | 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 |
Device.manufactureDate | |
Element Id | Device.manufactureDate |
Definition | The date and time when the device was manufactured. |
Cardinality | 0..1 |
Type | dateTime |
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 |
Device.lotNumber | |
Element Id | Device.lotNumber |
Definition | Lot number assigned by the manufacturer. |
Cardinality | 0..1 |
Type | string |
Device.serialNumber | |
Element Id | Device.serialNumber |
Definition | The serial number assigned by the organization when the device was manufactured. |
Cardinality | 0..1 |
Type | string |
Comments | Alphanumeric Maximum 20. |
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..* |
Device.deviceName.name | |
Element Id | Device.deviceName.name |
Definition | The name that identifies the device. |
Cardinality | 1..1 |
Type | string |
Alternate Names | Σ |
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. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. |
Cardinality | 1..1 |
Terminology Binding | DeviceNameType (Required) |
Type | code |
Device.modelNumber | |
Element Id | Device.modelNumber |
Definition | The manufacturer's model number for the device. |
Cardinality | 0..1 |
Type | string |
Device.partNumber | |
Element Id | Device.partNumber |
Definition | The part number or catalog number of the device. |
Cardinality | 0..1 |
Type | string |
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 |
Device.specialization | |
Element Id | Device.specialization |
Definition | The device function, including in some cases whether or not the functionality conforms to some standard. For example, a PHD blood pressure specialization indicates that the device conforms to the IEEE 11073-10407 Blood Pressure Specialization. This is NOT an alternate name or an additional descriptive name given by the manufacturer. That would be found in the deviceName element. In the PHD case, there are 11073 10101 nomenclature codes that define the specialization standards and that will be used, for example, in the PHD case for the specialization.systemType element. The specialization.version would be the version of the standard if the systemType referred to a standard. |
Cardinality | 0..* |
Device.specialization.systemType | |
Element Id | Device.specialization.systemType |
Definition | The standard that is used to operate and communicate. |
Cardinality | 1..1 |
Type | CodeableConcept |
Alternate Names | Σ |
Device.specialization.version | |
Element Id | Device.specialization.version |
Definition | The version of the standard that is used to operate and communicate. |
Note | This is a business versionId, not a resource version id (see discussion) |
Cardinality | 0..1 |
Type | string |
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..* |
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 | Σ |
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 |
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 |
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..* |
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 |
Device.property.valueQuantity | |
Element Id | Device.property.valueQuantity |
Definition | Property value as a quantity. |
Cardinality | 0..* |
Type | Quantity |
Device.property.valueCode | |
Element Id | Device.property.valueCode |
Definition | Property value as a code, e.g., NTP4 (synced to NTP). |
Cardinality | 0..* |
Type | CodeableConcept |
Device.patient | |
Element Id | Device.patient |
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) |
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. |
Device.operationalStatus | |
Element Id | Device.operationalStatus |
Definition | The status of the device itself - whether it is switched on, or activated, etc. |
Cardinality | 0..1 |
Device.operationalStatus.value | |
Element Id | Device.operationalStatus.value |
Definition | on |off | standby. |
Cardinality | 0..1 |
Type | CodeableConcept |
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 |
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 |
Device.associationStatus.value | |
Element Id | Device.associationStatus.value |
Definition | implanted|explanted|attached. |
Cardinality | 0..1 |
Type | CodeableConcept |
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 |
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) |
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 |
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. |
Device.url | |
Element Id | Device.url |
Definition | A network address on which the device may be contacted directly. |
Cardinality | 0..1 |
Type | uri |
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.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 |
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) |