FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.3.0: R4 Ballot 2). 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 Compartments : Device

Detailed Descriptions for the elements in the Device resource.

Device
Element Id Device
Definition

This resource identifies an instance or 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. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

Control 1..1
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 identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Alternate Names Serial Number
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. For UDI , this element corresponds to the variable portion of the UDI that identifies the serial number of a specific device. See UDI mappings for a complete mapping of UDI parts to Device.

Device.udi
Element Id Device.udi
Definition

Unique device identifier (UDI) assigned to device label or package.

Control 0..1
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.udi.deviceIdentifier
Element Id Device.udi.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.

Control 0..1
Type string
Alternate Names DI
Summary true
Device.udi.name
Element Id Device.udi.name
Definition

Name of device as used in labeling or catalog.

Control 0..1
Type string
Alternate Names Brand Name
Summary true
Comments

Use the Device.type for a generic type or kind of device name. Note the GUDID lists the name as the 'Brand Name'.

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

Control 0..1
Type uri
Requirements

Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.

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

Control 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.udi.carrierAIDC
Element Id Device.udi.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 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.

Control 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.udi.issuer
Element Id Device.udi.issuer
Definition

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

  1. GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2)
  2. HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3)
  3. ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4)
  4. ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
Control 0..1
Type uri
Alternate Names Barcode System
Device.udi.entryType
Element Id Device.udi.entryType
Definition

A coded entry to indicate how the data was entered.

Control 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 availability.

Control 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.type
Element Id Device.type
Definition

Code or identifier to identify a kind of device.

Control 0..1
Terminology Binding FHIR Device Types ( Example )
Type CodeableConcept
Device.lotNumber
Element Id Device.lotNumber
Definition

Lot number assigned by the manufacturer.

Control 0..1
Type string
Device.manufacturer
Element Id Device.manufacturer
Definition

A name of the manufacturer.

Control 0..1
Type string
Device.manufactureDate
Element Id Device.manufactureDate
Definition

The date and time when the device was manufactured.

Control 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).

Control 0..1
Type dateTime
Device.model
Element Id Device.model
Definition

The "model" "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.

Control 0..1
Type string
Device.version
Element Id Device.version
Definition

The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.

Note This is a business versionId, not a resource version id (see discussion )
Control 0..1
Type string
Device.patient
Element Id Device.patient
Definition

Patient information, If the device is affixed to a person.

Control 0..1
Type Reference ( Patient )
Requirements

If the device is implanted in a patient, then need to associate the device to the patient.

Device.owner
Element Id Device.owner
Definition

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

Control 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.

Control 0..*
Type ContactPoint
Comments

used for troubleshooting etc.

Device.location
Element Id Device.location
Definition

The place where the device can be found.

Control 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.

Control 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.

Control 0..*
Type Annotation
Device.safety
Element Id Device.safety
Definition

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

Control 0..*
Terminology Binding DeviceSafety ( Example )
Type CodeableConcept
Summary true