DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 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 R3 R2

Orders and Observations Work Group Maturity Level : 2   Trial Use Compartments : Device

Detailed Descriptions for the elements in the Device resource.

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 includes 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
Definition

Unique instance identifiers assigned to a device by organizations like manufacturers other organizations or owners. If the identifier identifies the type of device, Device.type should be used.

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Alternate Names Serial Number
Comments

Often fixed to the device as The barcode string from a barcode and present on a device label or package may identify the instance, include names given to the device in local usage. Note that some usage, or may identify the type of device. If the barcodes affixed to identifier identifies the device identify its type, not its instance. type of device, Device.type element should be used. For UDI , this element corresponds to the FDA mandated Unique Device Identifier (UDI) use variable portion of the Device.udi element. UDI that identifies the serial number of a specific device. See UDI mappings for a complete mapping of UDI parts to Device.

Device.type Device.udi
Definition

Code or 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
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
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
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.

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
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 1..1 0..1
Binding Type DeviceKind string : Preferred : Global Medical Device Nomenclature (GMDN®).
Alternate Names Human Readable Form
Summary (Defines true
Comments

If separate barcodes for DI and PI are present, concatenate the nature string with DI first and in order of human readable expression on label.

Device.udi.carrierAIDC
Definition

The full UDI carrier of the device Automatic Identification and Data Capture (AIDC) technology representation of the kind barcode string as printed on the packaging of functionality/services/behavior that may 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 expected from it.) base64 encoded.

Control 0..1
Type CodeableConcept base64Binary
Alternate Names Automatic Identification and Data Capture
Summary true
Comments

For The AIDC form of UDIs should be scanned or otherwise used for the FDA mandated Unique Device Identifier (UDI) use identification of the Device.udi element. 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.note Device.udi.issuer
Definition

Descriptive information, usage information or implantation information Organization that is not captured in an existing element. charged with issuing UDIs for devices. For example, 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.

Control 0..* 0..1
Type Annotation uri
Alternate Names Barcode System
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
Definition

Status of the Device availability.

Control 0..1
Terminology Binding DeviceStatus: The availability status of the device. FHIRDeviceStatus ( Required )
Type code
Is Modifier true
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.manufacturer Device.type
Definition

A name Code or identifier to identify a kind of the manufacturer. device.

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

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

Control 0..1
Type string
Device.version Device.manufacturer
Definition

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

Note This is a business versionId, not a resource identifier (see discussion ) Control 0..1
Type string
Device.manufactureDate
Definition

The date and time when the device was manufactured.

Control 0..1
Type dateTime
Device.expiry 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.udi Device.model
Definition

United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use The "model" is an identifier assigned by the human readable information (the content that manufacturer to identify the user sees, which product by its type. This number is sometimes different to shared by the exact syntax represented in all devices sold as the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm. same type.

Control 0..1
Type string
Device.version
Comments Definition

The unique identifier may identify an instance of a device uniquely, or it may only identify the type of the device. A portion version of the UDI - device, if the DI part - can be extracted from device has multiple releases under the UDI when required, and used to look up information about same model, or if the device through the GUDID. is software or carries firmware.

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

Lot number assigned by Patient information, If the manufacturer. device is affixed to a person.

Control 0..1
Type string Reference ( Patient )
Comments Requirements

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

Device.owner
Definition

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

Control 0..1
Type Reference ( Organization )
Device.location Device.contact
Definition

The place where Contact details for an organization or a particular human that is responsible for the device can be found. device.

Control 0..1 0..*
Type Reference ( Location ContactPoint )
Comments

used for troubleshooting etc.

Device.patient Device.location
Definition

Patient information, if The place where the resource is affixed to a person. device can be found.

Control 0..1
Type Reference ( Patient Location )
Requirements

Device.location can be used to track device location.

Device.contact Device.url
Definition

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

Control 0..* 0..1
Type ContactPoint uri
Comments

used for troubleshooting etc. 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.url Device.note
Definition

A network address on which the device may be contacted directly. Descriptive information, usage information or implantation information that is not captured in an existing element.

Control 0..1 0..*
Type uri Annotation
Device.safety
Comments Definition

If the device is running a FHIR server, the network address should be the root URL from which Provides additional safety characteristics about a conformance statement may be retrieved. medical device. For example devices containing latex.

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