FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.18 Resource DeviceDefinition - Content

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

The definition of a kind of device or device component. Typically, this definition corresponds to a device model although it may be a broader category of device.

Devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health, as well as devices such as a machine, cellphone, computer, software, application, etc. The DeviceDefinition resource is used to describe the common characteristics and capabilities of a device of a certain type or kind, e.g., a certain model or class of a device such as a x-ray model or personal wearable device model, whereas a Device resource documents an actual instance of a device such as the actual x-ray machine that is installed or the personal wearable device being worn.

Devices can also be subdivided as follows:

Implantable device

Patient-use device

The DeviceDefinition resource contains the "catalog" definition of a device - whether that definition is authored by the manufacturer or a regulatory entity and allows defining valid hierarchical device configurations (devices as part of other devices).

Device vs deviceDefinition: The Device resource is meant to refer to a physical instance of a device - hence having attributes like lot number, patient, location, operational status which the DeviceDefinition resource does not have.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition TU DomainResource The definition of a kind of device or device component

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... description 0..1 markdown Additional information to describe the device
... identifier Σ 0..* Identifier Instance identifier

... udiDeviceIdentifier 0..* BackboneElement Unique Device Identifier (UDI) Barcode string

.... deviceIdentifier 1..1 string The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier
.... issuer 1..1 uri The organization that assigns the identifier algorithm
.... jurisdiction 1..1 uri The jurisdiction to which the deviceIdentifier applies
.... marketDistribution 0..* BackboneElement Indicates whether and when the device is available on the market

..... marketPeriod 1..1 Period Begin and end dates for the commercial distribution of the device
..... subJurisdiction 1..1 uri National state or territory where the device is commercialized
.... type 1..1 code basic | master | license
Binding: Device Definition Regulatory Identifier Type (Required)
.... deviceIdentifier 1..1 string The identifier itself
.... issuer 1..1 uri The organization that issued this identifier
.... jurisdiction 1..1 uri The jurisdiction to which the deviceIdentifier applies
... partNumber 0..1 string The part number or catalog number of the device
... manufacturer Σ 0..1 Reference(Organization) Name of device manufacturer
... deviceName Σ 0..* BackboneElement The name or names of the device as given by the manufacturer

.... name Σ 1..1 string A name that is used to refer to the device
.... type Σ 1..1 CodeableConcept registered-name | user-friendly-name | patient-reported-name
Binding: Device Name Type (Extensible)
... modelNumber Σ 0..1 string The catalog or model number for the device for example as defined by the manufacturer
... contact Σ 0..* ContactDetail Contact details for the publisher

... publisher Σ 0..1 string The name of the organization responsible for publishing the definition
... classification Σ 0..* BackboneElement What kind of device or device system this is

.... type Σ 1..1 CodeableConcept A classification or risk class of the device model
Binding: Device Type (Example)
.... justification 0..* RelatedArtifact Further information qualifying this classification of the device model

... conformsTo Σ 0..* BackboneElement Identifies the standards, specifications, or formal guidances for the capabilities supported by the device

.... category Σ 0..1 CodeableConcept Describes the common type of the standard, specification, or formal guidance
Binding: Device Specification Category (Example)
.... specification Σ 1..1 CodeableConcept Identifies the standard, specification, or formal guidance that the device adheres to the Device Specification type
Binding: Device Specification Type (Example)
.... version Σ 0..* string The specific form or variant of the standard, specification or formal guidance

.... source 0..* RelatedArtifact Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance

... hasPart Σ 0..* BackboneElement A device, part of the current one

.... reference Σ 1..1 Reference(DeviceDefinition) Reference to the part
.... count 0..1 integer Number of occurrences of the part
... packaging 0..* BackboneElement Information about the packaging of the device, i.e. how the device is packaged

.... identifier 0..1 Identifier Business identifier of the packaged medication
.... type 0..1 CodeableConcept A code that defines the specific type of packaging
.... count 0..1 integer The number of items contained in the package (devices or sub-packages)
.... distributor 0..* BackboneElement An organization that distributes the packaged device

..... name 0..1 string Distributor's human-readable name
..... organizationReference 0..* Reference(Organization) Distributor as an Organization resource

.... udiDeviceIdentifier 0..* see udiDeviceIdentifier Unique Device Identifier (UDI) Barcode string on the packaging

.... packaging 0..* see packaging Allows packages within packages

... deviceVersion 0..* BackboneElement The version of the device or software

.... type 0..1 CodeableConcept The type of the device version, e.g. manufacturer, approved, internal
.... component 0..1 Identifier The hardware or software module of the device to which the version applies
.... value 1..1 string The version text
... safety Σ 0..* CodeableConcept Safety characteristics of the device
Binding: Device Safety (Example)

... shelfLifeStorage 0..* ProductShelfLife Shelf Life and storage information

... outputLanguage 0..* code Language code for the human-readable text strings produced by the device (all supported)
Binding: All Languages (Required)
Additional BindingsPurpose
Common Languages Starter Set


... property 0..* BackboneElement Inherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc

.... type 1..1 CodeableConcept Code that specifies the property being represented
Binding: Device Property Type (Example)
.... value[x] 1..1 Value of the property
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueAttachment Attachment
... link 0..* BackboneElement An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device

.... relation 1..1 Coding The type indicates the relationship of the related device to the device instance
Binding: Device Definition Relation Type (Extensible)
.... relatedDevice 1..1 CodeableReference(DeviceDefinition) A reference to the linked device
... note 0..* Annotation Device notes and comments

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

.... substance 1..1 CodeableConcept A relevant substance that the device contains, may contain, or is made of
Binding: Substance Code (Example)
.... alternate 0..1 boolean Indicates an alternative material of the device
.... allergenicIndicator 0..1 boolean Whether the substance is a known or suspected allergen
... productionIdentifierInUDI 0..* CodeableConcept lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
Binding: Device Production Identifier In UDI (Extensible)

... guideline 0..1 BackboneElement Information aimed at providing directions for the usage of this model of device
.... useContext 0..* UsageContext The circumstances that form the setting for using the device

.... usageInstruction 0..1 markdown Detailed written and visual directions for the user on how to use the device
.... relatedArtifact 0..* RelatedArtifact A source of information or reference for this guideline

.... indication 0..* CodeableConcept A clinical condition for which the device was designed to be used

.... contraindication 0..* CodeableConcept A specific situation when a device should not be used because it may cause harm

.... warning 0..* CodeableConcept Specific hazard alert information that a user needs to know before using the device

.... intendedUse 0..1 string A description of the general purpose or medical use of the device or its function
... correctiveAction 0..1 BackboneElement Tracking of latest field safety corrective action
.... recall 1..1 boolean Whether the corrective action was a recall
.... scope 0..1 code model | lot-numbers | serial-numbers
Binding: Device Corrective Action Scope (Required)
.... period 1..1 Period Start and end dates of the corrective action
... chargeItem 0..* BackboneElement Billing code or reference associated with the device

.... chargeItemCode 1..1 CodeableReference(ChargeItemDefinition) The code or reference for the charge item
.... count 1..1 Quantity Coefficient applicable to the billing code
.... effectivePeriod 0..1 Period A specific time period in which this charge item applies
.... useContext 0..* UsageContext The context to which this charge item applies


doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

Path ValueSet Type Documentation
DeviceDefinition.regulatoryIdentifier.type DeviceDefinitionRegulatoryIdentifierType (a valid code from Device Regulatory Identifier Type) Required

Regulatory Identifier type

DeviceDefinition.deviceName.type DeviceNameType Extensible

The type of name the device is referred by.

DeviceDefinition.classification.type DeviceType Example

Codes used to identify medical devices. Includes concepts from SNOMED CT (http://www.snomed.org/) where concept is-a 49062001 (Device) and is provided as a suggestive example.

DeviceDefinition.conformsTo.category DeviceSpecificationCategory (a valid code from FHIR Device Specialization Category) Example

The kind of standards used by the device.

DeviceDefinition.conformsTo.specification DeviceSpecificationType Example

The type or specification of a standard that devices can adhere to

DeviceDefinition.safety DeviceSafety Example

Codes used to identify medical devices safety characteristics. These codes are taken from the NCI Thesaurus icon and are provided here as a suggestive example.

DeviceDefinition.outputLanguage AllLanguages (a valid code from Tags for the Identification of Languages icon) Required

This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47)

  Common Languages starter
DeviceDefinition.property.type DeviceType Example

Codes used to identify medical devices. Includes concepts from SNOMED CT (http://www.snomed.org/) where concept is-a 49062001 (Device) and is provided as a suggestive example.

DeviceDefinition.link.relation DeviceDefinitionRelationType Extensible

Description Needed Here

DeviceDefinition.material.substance SubstanceCode Example

This value set contains concept codes for specific substances. It includes codes from SNOMED icon where concept is-a 105590001 (Substance (substance))

DeviceDefinition.productionIdentifierInUDI DeviceProductionIdentifierInUDI Extensible

Device Production Identifier in UDI

DeviceDefinition.correctiveAction.scope DeviceCorrectiveActionScope Required

Device - Corrective action scope

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
device-name string A server defined search that may match any of the string fields in DeviceDefinition.name or DeviceDefinition.classification.type - the latter to search for 'generic' devices. DeviceDefinition.deviceName.name | DeviceDefinition.classification.type.coding.display | DeviceDefinition.classification.type.text
has-part reference The manufacturer of the device DeviceDefinition.hasPart.reference
(DeviceDefinition)
identifier token The identifier of the component DeviceDefinition.identifier | DeviceDefinition.udiDeviceIdentifier 35 Resources
manufacturer reference The manufacturer of the device DeviceDefinition.manufacturer
(Organization)
model-number token The model of the device DeviceDefinition.modelNumber
part-number string The part number or catalog number of the device. DeviceDefinition.partNumber
publisher string The contact for the publisher of the device definition DeviceDefinition.contact.name | DeviceDefinition.publisher 31 Resources
specification token The specification that the device conforms to DeviceDefinition.conformsTo.specification
specification-version composite A composite of both specification and version On DeviceDefinition.conformsTo:
  specification: specification
  version: version
type token The device type DeviceDefinition.conformsTo.category
version token The specific version of the device DeviceDefinition.deviceVersion.value 32 Resources
version-type composite Value and type of version On DeviceDefinition.deviceVersion:
  type: type
  value: value