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 Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the DeviceDefinition resource.
DeviceDefinition | |
Element Id | DeviceDefinition |
Definition | The characteristics, operational status and capabilities of a medical-related component of a medical device. |
Cardinality | 0..* |
Type | DomainResource |
Summary | false |
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 Id | DeviceDefinition.identifier |
Definition | Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | false |
DeviceDefinition.udiDeviceIdentifier | |
Element Id | DeviceDefinition.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. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.udiDeviceIdentifier.deviceIdentifier | |
Element Id | DeviceDefinition.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. |
Cardinality | 1..1 |
Type | string |
Summary | false |
DeviceDefinition.udiDeviceIdentifier.issuer | |
Element Id | DeviceDefinition.udiDeviceIdentifier.issuer |
Definition | The organization that assigns the identifier algorithm. |
Cardinality | 1..1 |
Type | uri |
Summary | false |
DeviceDefinition.udiDeviceIdentifier.jurisdiction | |
Element Id | DeviceDefinition.udiDeviceIdentifier.jurisdiction |
Definition | The jurisdiction to which the deviceIdentifier applies. |
Cardinality | 1..1 |
Type | uri |
Summary | false |
DeviceDefinition.manufacturer[x] | |
Element Id | DeviceDefinition.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. |
Cardinality | 0..1 |
Type | string|Reference(Organization) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | false |
DeviceDefinition.deviceName | |
Element Id | DeviceDefinition.deviceName |
Definition | The name or names of the device as given by the manufacturer. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.deviceName.name | |
Element Id | DeviceDefinition.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. |
Cardinality | 1..1 |
Type | string |
Alternate Names | Σ |
Summary | false |
DeviceDefinition.deviceName.type | |
Element Id | DeviceDefinition.deviceName.type |
Definition | The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. |
Cardinality | 1..1 |
Terminology Binding | DeviceNameType (Required) |
Type | code |
Summary | false |
DeviceDefinition.modelNumber | |
Element Id | DeviceDefinition.modelNumber |
Definition | The model number for the device for example as defined by the manufacturer or labeler, or other agency. |
Cardinality | 0..1 |
Type | string |
Summary | false |
DeviceDefinition.type | |
Element Id | DeviceDefinition.type |
Definition | What kind of device or device system this is. |
Cardinality | 0..* |
Terminology Binding | Device Type (Example) |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.specialization | |
Element Id | DeviceDefinition.specialization |
Definition | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.specialization.systemType | |
Element Id | DeviceDefinition.specialization.systemType |
Definition | The standard that is used to operate and communicate. |
Cardinality | 1..1 |
Type | string |
Alternate Names | Σ |
Summary | false |
DeviceDefinition.specialization.version | |
Element Id | DeviceDefinition.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 |
Summary | false |
DeviceDefinition.hasPart | |
Element Id | DeviceDefinition.hasPart |
Definition | A device that is part (for example a component) of the present device. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.hasPart.reference | |
Element Id | DeviceDefinition.hasPart.reference |
Definition | Reference to the device that is part of the current device. |
Cardinality | 1..1 |
Type | Reference(DeviceDefinition) |
Summary | false |
DeviceDefinition.hasPart.count | |
Element Id | DeviceDefinition.hasPart.count |
Definition | Number of instances of the component device in the current device. |
Cardinality | 0..1 |
Type | integer |
Summary | false |
DeviceDefinition.packaging | |
Element Id | DeviceDefinition.packaging |
Definition | Information about the packaging of the device, i.e. how the device is packaged. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.packaging.identifier | |
Element Id | DeviceDefinition.packaging.identifier |
Definition | The business identifier of the packaged medication. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..1 |
Type | Identifier |
Summary | false |
DeviceDefinition.packaging.type | |
Element Id | DeviceDefinition.packaging.type |
Definition | A code that defines the specific type of packaging. |
Cardinality | 0..1 |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.packaging.count | |
Element Id | DeviceDefinition.packaging.count |
Definition | The number of items contained in the package (devices or sub-packages). |
Cardinality | 0..1 |
Type | integer |
Summary | false |
DeviceDefinition.packaging.distributor | |
Element Id | DeviceDefinition.packaging.distributor |
Definition | An organization that distributes the packaged device. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.packaging.distributor.name | |
Element Id | DeviceDefinition.packaging.distributor.name |
Definition | Distributor's human-readable name. |
Cardinality | 0..1 |
Type | string |
Summary | false |
DeviceDefinition.packaging.distributor.organizationReference | |
Element Id | DeviceDefinition.packaging.distributor.organizationReference |
Definition | Distributor as an Organization resource. |
Cardinality | 0..* |
Type | Reference |
Summary | false |
DeviceDefinition.packaging.udiDeviceIdentifier | |
Element Id | DeviceDefinition.packaging.udiDeviceIdentifier |
Definition | Unique Device Identifier (UDI) Barcode string on the packaging. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.packaging.udiDeviceIdentifier.deviceIdentifier | |
Element Id | DeviceDefinition.packaging.udiDeviceIdentifier.deviceIdentifier |
Definition | Identifier to be associated with every instance for issuer and jurisdiction. |
Cardinality | 1..1 |
Type | string |
Summary | false |
DeviceDefinition.packaging.udiDeviceIdentifier.issuer | |
Element Id | DeviceDefinition.packaging.udiDeviceIdentifier.issuer |
Definition | The organization that assigns the identifier algorithm. |
Cardinality | 1..1 |
Type | uri |
Summary | false |
DeviceDefinition.packaging.udiDeviceIdentifier.jurisdiction | |
Element Id | DeviceDefinition.packaging.udiDeviceIdentifier.jurisdiction |
Definition | The jurisdiction to which the deviceIdentifier applies. |
Cardinality | 1..1 |
Type | uri |
Summary | false |
DeviceDefinition.packaging.packaging | |
Element Id | DeviceDefinition.packaging.packaging |
Definition | Allows packages within packages. |
Cardinality | 0..* |
Type | See DeviceDefinition.packaging |
Summary | false |
DeviceDefinition.version | |
Element Id | DeviceDefinition.version |
Definition | The version of the device or software. |
Note | This is a business versionId, not a resource version id (see discussion) |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.version.type | |
Element Id | DeviceDefinition.version.type |
Definition | The type of the device version, e.g. manufacturer, approved, internal. |
Cardinality | 0..1 |
Type | CodeableConcept |
Alternate Names | Σ |
Summary | false |
DeviceDefinition.version.component | |
Element Id | DeviceDefinition.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. |
DeviceDefinition.version.value | |
Element Id | DeviceDefinition.version.value |
Definition | The version text. |
Cardinality | 1..1 |
Type | string |
Summary | false |
DeviceDefinition.safety | |
Element Id | DeviceDefinition.safety |
Definition | Safety characteristics of the device. |
Cardinality | 0..* |
Terminology Binding | Safety : |
Type | CodeableConcept |
Summary | true |
DeviceDefinition.shelfLifeStorage | |
Element Id | DeviceDefinition.shelfLifeStorage |
Definition | Shelf Life and storage information. |
Cardinality | 0..* |
Type | ProductShelfLife |
Summary | false |
DeviceDefinition.physicalCharacteristics | |
Element Id | DeviceDefinition.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. |
Cardinality | 0..1 |
Type | ProdCharacteristic |
Summary | false |
DeviceDefinition.languageCode | |
Element Id | DeviceDefinition.languageCode |
Definition | Language code for the human-readable text strings produced by the device (all supported). |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.capability | |
Element Id | DeviceDefinition.capability |
Definition | Additional capabilities that the device is defined or required to have e.g. "water resistant", "long life". |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.capability.type | |
Element Id | DeviceDefinition.capability.type |
Definition | The type of capability - whether it is a physical attribute, a customization needed. For exampl e "water ingress protection". |
Cardinality | 1..1 |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.capability.description | |
Element Id | DeviceDefinition.capability.description |
Definition | The actual capability of the device e.g. IP67. |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.property | |
Element Id | DeviceDefinition.property |
Definition | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.property.type | |
Element Id | DeviceDefinition.property.type |
Definition | Code that specifies the property DeviceDefinitionPropetyCode (Extensible). |
Cardinality | 1..1 |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.property.valueQuantity | |
Element Id | DeviceDefinition.property.valueQuantity |
Definition | Property value as a quantity. |
Cardinality | 0..* |
Type | Quantity |
Summary | false |
DeviceDefinition.property.valueCode | |
Element Id | DeviceDefinition.property.valueCode |
Definition | Property value as a code, e.g., NTP4 (synced to NTP). |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.owner | |
Element Id | DeviceDefinition.owner |
Definition | An organization that is responsible for the provision and ongoing maintenance of the device. |
Cardinality | 0..1 |
Type | Reference(Organization) |
Summary | false |
DeviceDefinition.contact | |
Element Id | DeviceDefinition.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. |
DeviceDefinition.onlineInformation | |
Element Id | DeviceDefinition.onlineInformation |
Definition | Access to on-line information about the device. |
Cardinality | 0..1 |
Type | uri |
Summary | false |
DeviceDefinition.note | |
Element Id | DeviceDefinition.note |
Definition | Descriptive information, usage information or implantation information that is not captured in an existing element. |
Cardinality | 0..* |
Type | Annotation |
Summary | false |
DeviceDefinition.parentDevice | |
Element Id | DeviceDefinition.parentDevice |
Definition | The parent device it can be part of. |
Cardinality | 0..1 |
Type | Reference(DeviceDefinition) |
Summary | true |
DeviceDefinition.material | |
Element Id | DeviceDefinition.material |
Definition | A substance used to create the material(s) of which the device is made. |
Cardinality | 0..* |
Summary | false |
DeviceDefinition.material.substance | |
Element Id | DeviceDefinition.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. |
Cardinality | 1..1 |
Type | CodeableConcept |
Summary | false |
DeviceDefinition.material.alternate | |
Element Id | DeviceDefinition.material.alternate |
Definition | Indicates an alternative material of the device. |
Cardinality | 0..1 |
Type | boolean |
Summary | false |
DeviceDefinition.material.allergenicIndicator | |
Element Id | DeviceDefinition.material.allergenicIndicator |
Definition | Whether the substance is a known or suspected allergen. |
Cardinality | 0..1 |
Type | boolean |
Summary | false |