Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: R5 Snapshot #1). 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 : 0 1   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the DeviceDefinition resource.

Alternate Names uri
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.description
Element Id DeviceDefinition.description
Definition

Additional information to describe the device.

Cardinality 0..1
Type markdown
Summary false
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. The identifier is typically valued if the udiDeviceIdentifier, partNumber or modelNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

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 jurisdiction provided 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.udiDeviceIdentifier.marketDistribution
Element Id DeviceDefinition.udiDeviceIdentifier.marketDistribution
Definition

The organization that assigns the identifier algorithm.

Cardinality 0..*
Summary false
DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod
Element Id DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod
Definition

Begin and end dates for the commercial distribution of the device.

Cardinality 1..1
Type Period
Summary false
DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction
Element Id DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction
Definition

National state or territory to which the marketDistribution recers, typically where the device is commercialized.

Cardinality 1..1
Type uri
Summary false
DeviceDefinition.partNumber
Element Id DeviceDefinition.partNumber
Definition

The part number or catalog number of the device.

Cardinality 0..1
Type string
Summary false
Comments

Alphanumeric Maximum 20.

DeviceDefinition.manufacturer[x]
Element Id DeviceDefinition.manufacturer[x]
Definition

A name of the manufacturer. 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

A The name given to or names of the device to identify it. as given by the manufacturer.

Cardinality 0..*
Summary false
DeviceDefinition.deviceName.name
Element Id DeviceDefinition.deviceName.name
Definition

The A human-friendly name of that is used to refer to the device. 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 RegisteredName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. PatientReportedName.

Cardinality 1..1
Terminology Binding DeviceNameType ( Required )
Type code
Summary false
DeviceDefinition.modelNumber
Element Id DeviceDefinition.modelNumber
Definition

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

Cardinality 0..1
Type string
Summary false
DeviceDefinition.type DeviceDefinition.classification
Element Id DeviceDefinition.type DeviceDefinition.classification
Definition

What kind of device or device system this is.

Cardinality 0..1 0..*
Summary false
Comments

In this element various classifications can be used, such as GMDN, EMDN, SNOMED CT, risk classes, national product codes.

DeviceDefinition.classification.type
Element Id DeviceDefinition.classification.type
Definition

A classification or risk class of the device model.

Cardinality 1..1
Terminology Binding FHIR Device Types Type ( Example )
Type CodeableConcept
Summary false
DeviceDefinition.classification.justification
Element Id DeviceDefinition.classification.justification
Definition

Further information qualifying this classification of the device model.

Cardinality 0..*
Type RelatedArtifact
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..*
Type RelatedArtifact
Summary false
DeviceDefinition.specialization.systemType DeviceDefinition.hasPart
Element Id DeviceDefinition.specialization.systemType DeviceDefinition.hasPart
Definition

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

Cardinality 0..*
Summary false
DeviceDefinition.hasPart.reference
Element Id DeviceDefinition.hasPart.reference
Definition

Reference to operate and communicate. the device that is part of the current device.

Cardinality 1..1
Type string 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.specialization.version DeviceDefinition.packaging
Element Id DeviceDefinition.specialization.version DeviceDefinition.packaging
Definition

The version Information about the packaging of the standard that device, i.e. how the device is used to operate and communicate. 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 versionId, identifier, not a resource version id identifier (see discussion )
Cardinality 0..1
Type string Identifier
Summary false
DeviceDefinition.version DeviceDefinition.packaging.type
Element Id DeviceDefinition.version 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 available versions number of items contained in the device, e.g., software versions. package (devices or sub-packages).

Note Cardinality This is a business versionId, not a resource version id (see discussion 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.safety DeviceDefinition.packaging.distributor.organizationReference
Element Id DeviceDefinition.safety DeviceDefinition.packaging.distributor.organizationReference
Definition

Safety characteristics of the device. Distributor as an Organization resource.

Cardinality 0..*
Terminology Binding Type Reference
Summary false
DeviceDefinition.packaging.udiDeviceIdentifier
Element Id DeviceDefinition.packaging.udiDeviceIdentifier
Definition

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

Cardinality ( Example 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 CodeableConcept string
Summary true false
DeviceDefinition.shelfLifeStorage DeviceDefinition.packaging.udiDeviceIdentifier.issuer
Element Id DeviceDefinition.shelfLifeStorage DeviceDefinition.packaging.udiDeviceIdentifier.issuer
Definition

Shelf Life and storage information. The organization that assigns the identifier algorithm.

Cardinality 0..* 1..1
Type ProductShelfLife uri
Summary false
DeviceDefinition.physicalCharacteristics DeviceDefinition.packaging.udiDeviceIdentifier.jurisdiction
Element Id DeviceDefinition.physicalCharacteristics DeviceDefinition.packaging.udiDeviceIdentifier.jurisdiction
Definition

Dimensions, color etc. The jurisdiction to which the deviceIdentifier applies.

Cardinality 0..1 1..1
Type ProdCharacteristic uri
Summary false
DeviceDefinition.languageCode DeviceDefinition.packaging.udiDeviceIdentifier.marketDistribution
Element Id DeviceDefinition.languageCode DeviceDefinition.packaging.udiDeviceIdentifier.marketDistribution
Definition

Language code The organization that assigns the identifier algorithm.

Cardinality 0..1
Summary false
DeviceDefinition.packaging.udiDeviceIdentifier.marketDistribution.marketPeriod
Element Id DeviceDefinition.packaging.udiDeviceIdentifier.marketDistribution.marketPeriod
Definition

Begin and end dates for the human-readable text strings produced by commercial distribution of the device.

Cardinality 0..1
Type Period
Summary false
DeviceDefinition.packaging.udiDeviceIdentifier.marketDistribution.subJurisdiction
Element Id DeviceDefinition.packaging.udiDeviceIdentifier.marketDistribution.subJurisdiction
Definition

National state or territory to which the marketDistribution refers, typically where the device (all supported). is commercialized.

Cardinality 0..1
Type uri
Summary false
DeviceDefinition.packaging.packaging
Element Id DeviceDefinition.packaging.packaging
Definition

Allows packages within packages.

Cardinality 0..*
Type CodeableConcept See DeviceDefinition.packaging
Summary false
DeviceDefinition.capability DeviceDefinition.version
Element Id DeviceDefinition.capability DeviceDefinition.version
Definition

Device capabilities. 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.capability.type DeviceDefinition.version.type
Element Id DeviceDefinition.capability.type DeviceDefinition.version.type
Definition

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

Cardinality 1..1 0..1
Type CodeableConcept
Alternate Names Σ
Summary false
DeviceDefinition.capability.description DeviceDefinition.version.component
Element Id DeviceDefinition.capability.description DeviceDefinition.version.component
Definition

Description The hardware or software module of capability. 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.property DeviceDefinition.shelfLifeStorage
Element Id DeviceDefinition.property DeviceDefinition.shelfLifeStorage
Definition

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties. Shelf Life and storage information.

Cardinality 0..*
Type ProductShelfLife
Summary false
DeviceDefinition.property.type DeviceDefinition.languageCode
Element Id DeviceDefinition.property.type DeviceDefinition.languageCode
Definition

Code that specifies Language code for the property DeviceDefinitionPropetyCode (Extensible). human-readable text strings produced by the device (all supported).

Cardinality 1..1 0..*
Type CodeableConcept
Summary false
DeviceDefinition.property.valueQuantity DeviceDefinition.property
Element Id DeviceDefinition.property.valueQuantity DeviceDefinition.property
Definition

Property value as The potential, valid configuration settings of a quantity. device, e.g., regulation status, time properties.

Cardinality 0..*
Summary false
DeviceDefinition.property.type
Element Id DeviceDefinition.property.type
Definition

Code that specifies the property.

Cardinality 1..1
Type Quantity CodeableConcept
Summary false
DeviceDefinition.property.valueCode DeviceDefinition.property.value[x]
Element Id DeviceDefinition.property.valueCode DeviceDefinition.property.value[x]
Definition

Property value as a code, e.g., NTP4 (synced to NTP). - the data type depends on the property type.

Cardinality 0..* 0..1
Type Quantity | CodeableConcept | string | boolean | integer | Range | Attachment
[x] Note See Choice of Data Types for further information about how to use [x]
Summary false
Comments

The usage of CodeableConcept is for concepts that are normally coded but for which a code is not available - for example a device implant size that is not standardized. The property string is for text characteristics, e.g. long descriptions, warnings, etc.

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.url DeviceDefinition.link
Element Id DeviceDefinition.url DeviceDefinition.link
Definition

A network address on which the An associated device, attached to, used with, communicating with or linking a previous or new device may be contacted directly. model to the focal device.

Cardinality 0..1 0..*
Type Summary false
DeviceDefinition.link.relation
Comments Element Id DeviceDefinition.link.relation
Definition

If The type indicates the device is running a FHIR server, relationship of the network address should be related device to the Base URL from which a conformance statement may be retrieved. device instance.

Cardinality 1..1
Terminology Binding DeviceDefinitionRelationType ( Extensible )
Type Coding
Summary false
DeviceDefinition.onlineInformation DeviceDefinition.link.relatedDevice
Element Id DeviceDefinition.onlineInformation DeviceDefinition.link.relatedDevice
Definition

Access A reference to on-line information about the linked device.

Cardinality 0..1 1..1
Type uri CodeableReference ( DeviceDefinition )
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.quantity DeviceDefinition.parentDevice
Element Id DeviceDefinition.quantity DeviceDefinition.parentDevice
Definition

The quantity 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 present in is made.

Cardinality 0..*
Summary false
DeviceDefinition.material.substance
Element Id DeviceDefinition.material.substance
Definition

A substance that the packaging (e.g. 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 number composition of devices present in 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 pack, known or suspected allergen.

Cardinality 0..1
Type boolean
Summary false
DeviceDefinition.productionIdentifierInUDI
Element Id DeviceDefinition.productionIdentifierInUDI
Definition

Indicates the number of devices production identifier(s) that are expected to appear in the same package UDI carrier on the device label.

Cardinality 0..*
Terminology Binding DeviceProductionIdentifierInUDI ( Required )
Type code
Summary false
DeviceDefinition.guideline
Element Id DeviceDefinition.guideline
Definition

Information aimed at providing directions for the usage of this model of device.

Cardinality 0..1
Summary false
DeviceDefinition.guideline.useContext
Element Id DeviceDefinition.guideline.useContext
Definition

The circumstances that form the medicinal product). setting for using the device.

Cardinality 0..*
Type UsageContext
Summary false
DeviceDefinition.guideline.usageInstruction
Element Id DeviceDefinition.guideline.usageInstruction
Definition

Detailed written and visual directions for the user on how to use the device.

Cardinality 0..1
Type Quantity markdown
Summary false
DeviceDefinition.parentDevice DeviceDefinition.guideline.relatedArtifact
Element Id DeviceDefinition.parentDevice DeviceDefinition.guideline.relatedArtifact
Definition

The parent A source of information or reference for this guideline.

Cardinality 0..*
Type RelatedArtifact
Summary false
DeviceDefinition.guideline.indication
Element Id DeviceDefinition.guideline.indication
Definition

A clinical condition for which the device it can was designed to be part of. used.

Cardinality 0..1 0..*
Type Reference CodeableReference ( DeviceDefinition ClinicalUseDefinition )
Summary true false
DeviceDefinition.material DeviceDefinition.guideline.contraindication
Element Id DeviceDefinition.material DeviceDefinition.guideline.contraindication
Definition

A substance specific situation when a device should not be used because it may cause harm.

Cardinality 0..*
Type CodeableReference ( ClinicalUseDefinition )
Summary false
DeviceDefinition.guideline.warning
Element Id DeviceDefinition.guideline.warning
Definition

Specific hazard alert information that a user needs to create know before using the material(s) device.

Cardinality 0..*
Type CodeableReference ( ClinicalUseDefinition )
Summary false
DeviceDefinition.guideline.intendedUse
Element Id DeviceDefinition.guideline.intendedUse
Definition

A description of the general purpose or medical use of which the device is made. or its function.

Cardinality 0..* 0..1
Type string
Summary false
DeviceDefinition.material.substance DeviceDefinition.correctiveAction
Element Id DeviceDefinition.material.substance DeviceDefinition.correctiveAction
Definition

The substance. Tracking of latest field safety corrective action.

Cardinality 0..1
Summary false
DeviceDefinition.correctiveAction.recall
Element Id DeviceDefinition.correctiveAction.recall
Definition

Whether the last corrective action known for this device was a recall.

Cardinality 1..1
Type CodeableConcept boolean
Summary false
Comments

When a field safety action has been initiated but not yet resulted in a recall, this element will be set to 'false'.

DeviceDefinition.material.alternate DeviceDefinition.correctiveAction.scope
Element Id DeviceDefinition.material.alternate DeviceDefinition.correctiveAction.scope
Definition

Indicates an alternative material The scope of the device. corrective action - whether the action targeted all units of a given device model, or only a specific set of batches identified by lot numbers, or individually identified devices identified by the serial name.

Cardinality 0..1
Terminology Binding DeviceCorrectiveActionScope ( Required )
Type boolean code
Summary false
DeviceDefinition.material.allergenicIndicator DeviceDefinition.correctiveAction.period
Element Id DeviceDefinition.material.allergenicIndicator DeviceDefinition.correctiveAction.period
Definition

Whether Start and end dates of the substance is a known corrective action.

Cardinality 1..1
Type Period
Summary false
DeviceDefinition.chargeItem
Element Id DeviceDefinition.chargeItem
Definition

Billing code or suspected allergen. reference associated with the device.

Cardinality 0..*
Summary false
DeviceDefinition.chargeItem.chargeItemCode
Element Id DeviceDefinition.chargeItem.chargeItemCode
Definition

The code or reference for the charge item.

Cardinality 1..1
Type CodeableReference ( ChargeItemDefinition )
Summary false
DeviceDefinition.chargeItem.count
Element Id DeviceDefinition.chargeItem.count
Definition

Coefficient applicable to the billing code.

Cardinality 1..1
Type Quantity
Summary false
DeviceDefinition.chargeItem.effectivePeriod
Element Id DeviceDefinition.chargeItem.effectivePeriod
Definition

A specific time period in which this charge item applies.

Cardinality 0..1
Type boolean Period
Summary false
DeviceDefinition.chargeItem.useContext
Element Id DeviceDefinition.chargeItem.useContext
Definition

The context to which this charge item applies.

Cardinality 0..*
Type UsageContext
Summary false