Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft 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

Orders and Observations Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the DeviceDefinition resource.

DeviceDefinition
Element IdDeviceDefinition
Definition

The characteristics, operational status and capabilities of a medical-related component of a medical device.

Cardinality0..*
TypeDomainResource
Summaryfalse
Comments

For the initial scope, this DeviceDefinition resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel.

DeviceDefinition.identifier
Element IdDeviceDefinition.identifier
Definition

Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
DeviceDefinition.udiDeviceIdentifier
Element IdDeviceDefinition.udiDeviceIdentifier
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.

Cardinality0..*
Summaryfalse
DeviceDefinition.udiDeviceIdentifier.deviceIdentifier
Element IdDeviceDefinition.udiDeviceIdentifier.deviceIdentifier
Definition

The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier.

Cardinality1..1
Typestring
Summaryfalse
DeviceDefinition.udiDeviceIdentifier.issuer
Element IdDeviceDefinition.udiDeviceIdentifier.issuer
Definition

The organization that assigns the identifier algorithm.

Cardinality1..1
Typeuri
Summaryfalse
DeviceDefinition.udiDeviceIdentifier.jurisdiction
Element IdDeviceDefinition.udiDeviceIdentifier.jurisdiction
Definition

The jurisdiction to which the deviceIdentifier applies.

Cardinality1..1
Typeuri
Summaryfalse
DeviceDefinition.manufacturer[x]
Element IdDeviceDefinition.manufacturer[x]
Definition

A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.

Cardinality0..1
Typestring|Reference(Organization)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
DeviceDefinition.deviceName
Element IdDeviceDefinition.deviceName
Definition

The name or names of the device as given by the manufacturer.

Cardinality0..*
Summaryfalse
DeviceDefinition.deviceName.name
Element IdDeviceDefinition.deviceName.name
Definition

A human-friendly name that is used to refer to the device - depending on the type, it can be the brand name, the common name or alias, or other.

Cardinality1..1
Typestring
Alternate NamesΣ
Summaryfalse
DeviceDefinition.deviceName.type
Element IdDeviceDefinition.deviceName.type
Definition

The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.

Cardinality1..1
Terminology BindingDeviceNameType (Required)
Typecode
Summaryfalse
DeviceDefinition.modelNumber
Element IdDeviceDefinition.modelNumber
Definition

The model number for the device for example as defined by the manufacturer or labeler, or other agency.

Cardinality0..1
Typestring
Summaryfalse
DeviceDefinition.type
Element IdDeviceDefinition.type
Definition

What kind of device or device system this is.

Cardinality0..*
Terminology BindingDevice Type (Example)
TypeCodeableConcept
Summaryfalse
DeviceDefinition.specialization
Element IdDeviceDefinition.specialization
Definition

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

Cardinality0..*
Summaryfalse
DeviceDefinition.specialization.systemType
Element IdDeviceDefinition.specialization.systemType
Definition

The standard that is used to operate and communicate.

Cardinality1..1
Typestring
Alternate NamesΣ
Summaryfalse
DeviceDefinition.specialization.version
Element IdDeviceDefinition.specialization.version
Definition

The version of the standard that is used to operate and communicate.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summaryfalse
DeviceDefinition.hasPart
Element IdDeviceDefinition.hasPart
Definition

A device that is part (for example a component) of the present device.

Cardinality0..*
Summaryfalse
DeviceDefinition.hasPart.reference
Element IdDeviceDefinition.hasPart.reference
Definition

Reference to the device that is part of the current device.

Cardinality1..1
TypeReference(DeviceDefinition)
Summaryfalse
DeviceDefinition.hasPart.count
Element IdDeviceDefinition.hasPart.count
Definition

Number of instances of the component device in the current device.

Cardinality0..1
Typeinteger
Summaryfalse
DeviceDefinition.packaging
Element IdDeviceDefinition.packaging
Definition

Information about the packaging of the device, i.e. how the device is packaged.

Cardinality0..*
Summaryfalse
DeviceDefinition.packaging.identifier
Element IdDeviceDefinition.packaging.identifier
Definition

The business identifier of the packaged medication.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..1
TypeIdentifier
Summaryfalse
DeviceDefinition.packaging.type
Element IdDeviceDefinition.packaging.type
Definition

A code that defines the specific type of packaging.

Cardinality0..1
TypeCodeableConcept
Summaryfalse
DeviceDefinition.packaging.count
Element IdDeviceDefinition.packaging.count
Definition

The number of items contained in the package (devices or sub-packages).

Cardinality0..1
Typeinteger
Summaryfalse
DeviceDefinition.packaging.distributor
Element IdDeviceDefinition.packaging.distributor
Definition

An organization that distributes the packaged device.

Cardinality0..*
Summaryfalse
DeviceDefinition.packaging.distributor.name
Element IdDeviceDefinition.packaging.distributor.name
Definition

Distributor's human-readable name.

Cardinality0..1
Typestring
Summaryfalse
DeviceDefinition.packaging.distributor.organizationReference
Element IdDeviceDefinition.packaging.distributor.organizationReference
Definition

Distributor as an Organization resource.

Cardinality0..*
TypeReference
Summaryfalse
DeviceDefinition.packaging.udiDeviceIdentifier
Element IdDeviceDefinition.packaging.udiDeviceIdentifier
Definition

Unique Device Identifier (UDI) Barcode string on the packaging.

Cardinality0..*
Summaryfalse
DeviceDefinition.packaging.udiDeviceIdentifier.deviceIdentifier
Element IdDeviceDefinition.packaging.udiDeviceIdentifier.deviceIdentifier
Definition

Identifier to be associated with every instance for issuer and jurisdiction.

Cardinality1..1
Typestring
Summaryfalse
DeviceDefinition.packaging.udiDeviceIdentifier.issuer
Element IdDeviceDefinition.packaging.udiDeviceIdentifier.issuer
Definition

The organization that assigns the identifier algorithm.

Cardinality1..1
Typeuri
Summaryfalse
DeviceDefinition.packaging.udiDeviceIdentifier.jurisdiction
Element IdDeviceDefinition.packaging.udiDeviceIdentifier.jurisdiction
Definition

The jurisdiction to which the deviceIdentifier applies.

Cardinality1..1
Typeuri
Summaryfalse
DeviceDefinition.packaging.packaging
Element IdDeviceDefinition.packaging.packaging
Definition

Allows packages within packages.

Cardinality0..*
TypeSee DeviceDefinition.packaging
Summaryfalse
DeviceDefinition.version
Element IdDeviceDefinition.version
Definition

The version of the device or software.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..*
Summaryfalse
DeviceDefinition.version.type
Element IdDeviceDefinition.version.type
Definition

The type of the device version, e.g. manufacturer, approved, internal.

Cardinality0..1
TypeCodeableConcept
Alternate NamesΣ
Summaryfalse
DeviceDefinition.version.component
Element IdDeviceDefinition.version.component
Definition

The hardware or software module of the device to which the version applies.

Cardinality0..1
TypeIdentifier
Summaryfalse
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.

DeviceDefinition.version.value
Element IdDeviceDefinition.version.value
Definition

The version text.

Cardinality1..1
Typestring
Summaryfalse
DeviceDefinition.safety
Element IdDeviceDefinition.safety
Definition

Safety characteristics of the device.

Cardinality0..*
Terminology BindingSafety :
TypeCodeableConcept
Summarytrue
DeviceDefinition.shelfLifeStorage
Element IdDeviceDefinition.shelfLifeStorage
Definition

Shelf Life and storage information.

Cardinality0..*
TypeProductShelfLife
Summaryfalse
DeviceDefinition.physicalCharacteristics
Element IdDeviceDefinition.physicalCharacteristics
Definition

Physical characteristics to define or specify the product - for example dimensions, color etc. These can be defined by the manufacturer or labeler, or can be used to specify characteristics when ordering.

Cardinality0..1
TypeProdCharacteristic
Summaryfalse
DeviceDefinition.languageCode
Element IdDeviceDefinition.languageCode
Definition

Language code for the human-readable text strings produced by the device (all supported).

Cardinality0..*
TypeCodeableConcept
Summaryfalse
DeviceDefinition.capability
Element IdDeviceDefinition.capability
Definition

Additional capabilities that the device is defined or required to have e.g. "water resistant", "long life".

Cardinality0..*
Summaryfalse
DeviceDefinition.capability.type
Element IdDeviceDefinition.capability.type
Definition

The type of capability - whether it is a physical attribute, a customization needed. For exampl e "water ingress protection".

Cardinality1..1
TypeCodeableConcept
Summaryfalse
DeviceDefinition.capability.description
Element IdDeviceDefinition.capability.description
Definition

The actual capability of the device e.g. IP67.

Cardinality0..*
TypeCodeableConcept
Summaryfalse
DeviceDefinition.property
Element IdDeviceDefinition.property
Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Cardinality0..*
Summaryfalse
DeviceDefinition.property.type
Element IdDeviceDefinition.property.type
Definition

Code that specifies the property DeviceDefinitionPropetyCode (Extensible).

Cardinality1..1
TypeCodeableConcept
Summaryfalse
DeviceDefinition.property.valueQuantity
Element IdDeviceDefinition.property.valueQuantity
Definition

Property value as a quantity.

Cardinality0..*
TypeQuantity
Summaryfalse
DeviceDefinition.property.valueCode
Element IdDeviceDefinition.property.valueCode
Definition

Property value as a code, e.g., NTP4 (synced to NTP).

Cardinality0..*
TypeCodeableConcept
Summaryfalse
DeviceDefinition.owner
Element IdDeviceDefinition.owner
Definition

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

Cardinality0..1
TypeReference(Organization)
Summaryfalse
DeviceDefinition.contact
Element IdDeviceDefinition.contact
Definition

Contact details for an organization or a particular human that is responsible for the device.

Cardinality0..*
TypeContactPoint
Summaryfalse
Comments

used for troubleshooting etc.

DeviceDefinition.onlineInformation
Element IdDeviceDefinition.onlineInformation
Definition

Access to on-line information about the device.

Cardinality0..1
Typeuri
Summaryfalse
DeviceDefinition.note
Element IdDeviceDefinition.note
Definition

Descriptive information, usage information or implantation information that is not captured in an existing element.

Cardinality0..*
TypeAnnotation
Summaryfalse
DeviceDefinition.parentDevice
Element IdDeviceDefinition.parentDevice
Definition

The parent device it can be part of.

Cardinality0..1
TypeReference(DeviceDefinition)
Summarytrue
DeviceDefinition.material
Element IdDeviceDefinition.material
Definition

A substance used to create the material(s) of which the device is made.

Cardinality0..*
Summaryfalse
DeviceDefinition.material.substance
Element IdDeviceDefinition.material.substance
Definition

A substance that the device contains, may contain, or is made of - for example latex - to be used to determine patient compatibility. This is not intended to represent the composition of the device, only the clinically relevant materials.

Cardinality1..1
TypeCodeableConcept
Summaryfalse
DeviceDefinition.material.alternate
Element IdDeviceDefinition.material.alternate
Definition

Indicates an alternative material of the device.

Cardinality0..1
Typeboolean
Summaryfalse
DeviceDefinition.material.allergenicIndicator
Element IdDeviceDefinition.material.allergenicIndicator
Definition

Whether the substance is a known or suspected allergen.

Cardinality0..1
Typeboolean
Summaryfalse