Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU 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

8.15 Resource DeviceDefinition - Content

Orders and Observations icon Work Group Maturity Level : 0 1   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

The characteristics, operational status and capabilities of a medical-related component of a medical 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 subdivded as follows:

Implantable device

Patient-use device

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

Device vs deviceDefinition: 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.

8.15.3.1
This resource is referenced by

Structure

Name Flags Card. Type Description & Constraints doco
. . DeviceDefinition TU DomainResource An instance of a medical-related component of a medical device

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . identifier . description 0..* 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 jurisdication porvided 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
. . manufacturer[x] . regulatoryIdentifier 0..1 0..* BackboneElement Name of Regulatory identifier(s) associated with this device manufacturer

. . . . manufacturerString type 1..1 code basic | master | license
DeviceDefinitionRegulatoryIdentifierType ( Required )
.... deviceIdentifier 1..1 string The identifier itself
.... issuer 1..1 uri The organization that issued this identifier
. . . manufacturerReference . 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 A The name given to or names of the device to identify it as given by the manufacturer

. . . . name 1..1 string The A name of that is used to refer to the device
. . . . type 1..1 code udi-label-name registered-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
DeviceNameType ( Required )
. . . modelNumber 0..1 string The catalog or model number for the device for example as defined by the manufacturer
. . type . classification 0..1 0..* CodeableConcept BackboneElement What kind of device or device system this is
FHIR
. . . . type 1..1 CodeableConcept A classification or risk class of the device model
Device Types Type ( Example )
. . . . justification 0..* RelatedArtifact Further information qualifying this classification of the device model

... specialization 0..* BackboneElement RelatedArtifact The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication

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

. . . . reference 1..1 Reference ( DeviceDefinition ) Reference to the part
... . systemType count 1..1 0..1 string integer The standard that Number of occurrences of the part
... packaging 0..* BackboneElement Information about the packaging of the device, i.e. how the device is used to operate and communicate packaged

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

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

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

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

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

.... type 0..1 CodeableConcept Safety characteristics The type of the device version, e.g. manufacturer, approved, internal
Safety
. . . . component ( Example ) 0..1 Identifier The hardware or software module of the device to which the version applies
. . . . value 1..1 string The version text
. . . shelfLifeStorage safety Σ 0..* ProductShelfLife CodeableConcept Shelf Life and storage information Safety characteristics of the device
DeviceSafety ( Example )

. . . physicalCharacteristics shelfLifeStorage 0..1 0..* ProdCharacteristic ProductShelfLife Dimensions, color etc. Shelf Life and storage information

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

. . . capability property 0..* BackboneElement Device capabilities The potential, valid configuration settings of a device, e.g., regulation status, time properties

. . . . type 1..1 CodeableConcept Type of capability Code that specifies the property
. . . description . value[x] 0..* 1..1 CodeableConcept Description of capability Property value - as a code or quantity
. . property . . . valueQuantity 0..* BackboneElement Quantity The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
. . . . . type valueCodeableConcept 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
. . . . valueQuantity . valueString string
. . . . . valueBoolean boolean
. . . . . valueInteger 0..* Quantity integer Property value as a quantity
. . . valueCode . . valueRange 0..* CodeableConcept Range Property value as a code, e.g., NTP4 (synced to NTP)
. . . . . valueAttachment Attachment
. . . owner 0..1 Reference ( Organization ) Organization responsible for device
. . . contact 0..* ContactPoint Details for human/organization for support

. . . link 0..* BackboneElement An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device

.. . url . relation 0..1 1..1 uri Coding Network address The type indicates the relationship of the related device to contact the device instance
DeviceDefinitionRelationType ( Extensible )
. . onlineInformation . . relatedDevice 0..1 1..1 uri CodeableReference ( DeviceDefinition ) Access A reference to on-line information the linked device
. . . note 0..* Annotation Device notes and comments

. . quantity . parentDevice Σ 0..1 Quantity Reference ( DeviceDefinition ) The quantity parent device it can be part of
... material 0..* BackboneElement A substance used to create the material(s) of which the device present in the packaging (e.g. is made

.... substance 1..1 CodeableConcept A relevant substance that the number device contains, may contain, or is made of devices present in
. . . . alternate 0..1 boolean Indicates an alternative material of the device
.... allergenicIndicator 0..1 boolean Whether the substance is a pack, known or suspected allergen
... productionIdentifierInUDI 0..* code lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
DeviceProductionIdentifierInUDI ( Required )

... guideline 0..1 BackboneElement Information aimed at providing directions for the number usage of devices in this model of device
.... useContext 0..* UsageContext The circumstances that form the same package 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..* CodeableReference ( ClinicalUseDefinition ) A clinical condition for which the medicinal product) device was designed to be used

. . . . parentDevice contraindication Σ 0..* CodeableReference ( ClinicalUseDefinition ) A specific situation when a device should not be used because it may cause harm

.... warning 0..* CodeableReference ( ClinicalUseDefinition ) Specific hazard alert information that a user needs to know before using the device

.... intendedUse 0..1 Reference 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
DeviceCorrectiveActionScope ( DeviceDefinition Required )
. . . . period The parent device it can be part 1..1 Period Start and end dates of the corrective action
. . . material chargeItem 0..* BackboneElement A substance used to create the material(s) of which Billing code or reference associated with the device is made

. . . substance . chargeItemCode 1..1 CodeableConcept CodeableReference ( ChargeItemDefinition ) The substance code or reference for the charge item
. . . alternate . count 0..1 1..1 boolean Quantity Indicates an alternative material of Coefficient applicable to the device billing code
. . . allergenicIndicator . effectivePeriod 0..1 boolean Period Whether the substance is a known or suspected allergen 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

See the Extensions for this resource

UML Diagram ( Legend )

DeviceDefinition ( DomainResource ) Additional information to describe the device description : markdown [0..1] Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID 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 identifier : Identifier [0..*] The part number or catalog number of the device partNumber : string [0..1] 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 manufacturer[x] manufacturer : Element Reference [0..1] « string | Reference ( Organization ) » The model number for the device for example as defined by the manufacturer or labeler, or other agency modelNumber : string [0..1] What kind of device or device system this is type : CodeableConcept [0..1] « null (Strength=Example) FHIRDeviceTypes ?? » The available versions of the capabilities supported on a device, e.g., software versions the standards to which the device conforms for a particular purpose, and used for the communication version specialization : string RelatedArtifact [0..*] Safety characteristics of the device safety : CodeableConcept [0..*] « null (Strength=Example) Safety DeviceSafety ?? » Shelf Life and storage information shelfLifeStorage : ProductShelfLife [0..*] Dimensions, color etc physicalCharacteristics : ProdCharacteristic [0..1] Language code for the human-readable text strings produced by the device (all supported) languageCode : CodeableConcept [0..*] An organization that is responsible for the provision and ongoing maintenance of the device owner : Reference [0..1] « Organization » Contact details for an organization or a particular human that is responsible for the device contact : ContactPoint [0..*] A network address on which the device may be contacted directly url : uri [0..1] Access to on-line information about the device onlineInformation : uri [0..1] Descriptive information, usage information or implantation information that is not captured in an existing element note : Annotation [0..*] The quantity of the parent device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package it can be part of the medicinal product) quantity parentDevice : Quantity Reference [0..1] « DeviceDefinition » The parent Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device it can be part of label parentDevice productionIdentifierInUDI : Reference code [0..1] [0..*] « DeviceDefinition null (Strength=Required) DeviceProductionIdentifierInU... ! » UdiDeviceIdentifier 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 deviceIdentifier : string [1..1] The organization that assigns the identifier algorithm issuer : uri [1..1] The jurisdiction to which the deviceIdentifier applies jurisdiction : uri [1..1] DeviceName MarketDistribution Begin and end dates for the commercial distribution of the device marketPeriod : Period [1..1] National state or territory to which the marketDistribution recers, typically where the device is commercialized subJurisdiction : uri [1..1] RegulatoryIdentifier The name type of identifier itself type : code [1..1] « null (Strength=Required) DeviceDefinitionRegulatoryIde... ! » The identifier itself deviceIdentifier : string [1..1] The organization that issued this identifier issuer : uri [1..1] The jurisdiction to which the deviceIdentifier applies jurisdiction : uri [1..1] DeviceName 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 name : string [1..1] The type of deviceName. UDILabelName RegisteredName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName type : code [1..1] « null (Strength=Required) DeviceNameType ! » Specialization Classification The standard A classification or risk class of the device model type : CodeableConcept [1..1] « null (Strength=Example) DeviceType ?? » Further information qualifying this classification of the device model justification : RelatedArtifact [0..*] HasPart Reference to the device that is used to operate and communicate part of the current device systemType reference : string Reference [1..1] « DeviceDefinition » Number of instances of the component device in the current device count : integer [0..1] Packaging The version business identifier of the standard packaged medication identifier : Identifier [0..1] A code that is used to operate and communicate defines the specific type of packaging version type : CodeableConcept [0..1] The number of items contained in the package (devices or sub-packages) count : integer [0..1] Distributor Distributor's human-readable name name : string [0..1] Distributor as an Organization resource organizationReference : Reference [0..*] « Organization » Capability Version Type The type of capability the device version, e.g. manufacturer, approved, internal type : CodeableConcept [1..1] [0..1] Description The hardware or software module of capability the device to which the version applies description component : CodeableConcept Identifier [0..*] [0..1] The version text value : string [1..1] Property Code that specifies the property DeviceDefinitionPropetyCode (Extensible) type : CodeableConcept [1..1] Property value as a quantity - the data type depends on the property type valueQuantity value[x] : DataType [1..1] « Quantity [0..*] | CodeableConcept | string | boolean | integer | Range | Attachment » Link Property value as a code, e.g., NTP4 (synced The type indicates the relationship of the related device to NTP) the device instance valueCode relation : CodeableConcept Coding [0..*] [1..1] « null (Strength=Extensible) DeviceDefinitionRelationType + » A reference to the linked device relatedDevice : CodeableReference [1..1] « DeviceDefinition » Material The 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 substance : CodeableConcept [1..1] Indicates an alternative material of the device alternate : boolean [0..1] Whether the substance is a known or suspected allergen allergenicIndicator : boolean [0..1] Guideline The circumstances that form the setting for using the device useContext : UsageContext [0..*] Detailed written and visual directions for the user on how to use the device usageInstruction : markdown [0..1] A source of information or reference for this guideline relatedArtifact : RelatedArtifact [0..*] A clinical condition for which the device was designed to be used indication : CodeableReference [0..*] « ClinicalUseDefinition » A specific situation when a device should not be used because it may cause harm contraindication : CodeableReference [0..*] « ClinicalUseDefinition » Specific hazard alert information that a user needs to know before using the device warning : CodeableReference [0..*] « ClinicalUseDefinition » A description of the general purpose or medical use of the device or its function intendedUse : string [0..1] CorrectiveAction Whether the last corrective action known for this device was a recall recall : boolean [1..1] The scope of the 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 scope : code [0..1] « null (Strength=Required) DeviceCorrectiveActionScope ! » Start and end dates of the corrective action period : Period [1..1] ChargeItem The code or reference for the charge item chargeItemCode : CodeableReference [1..1] « ChargeItemDefinition » Coefficient applicable to the billing code count : Quantity [1..1] A specific time period in which this charge item applies effectivePeriod : Period [0..1] The context to which this charge item applies useContext : UsageContext [0..*] Indicates where and when the device is available on the market marketDistribution [0..*] 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 udiDeviceIdentifier [0..*] A name given to Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device to identify it models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe deviceName regulatoryIdentifier [0..*] The capabilities supported on a device, name or names of the standards to which device as given by the manufacturer deviceName [0..*] What kind of device conforms for or device system this is classification [0..*] A device that is part (for example a particular purpose, and used for component) of the communication present device specialization hasPart [0..*] An organization that distributes the packaged device distributor [0..*] Unique Device capabilities Identifier (UDI) Barcode string on the packaging capability udiDeviceIdentifier [0..*] Allows packages within packages packaging [0..*] Information about the packaging of the device, i.e. how the device is packaged packaging [0..*] The actual version of the device or software version [0..*] The potential, valid configuration settings of a device as it actually operates, device, e.g., regulation status, time properties property [0..*] An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device link [0..*] A substance used to create the material(s) of which the device is made material [0..*] Information aimed at providing directions for the usage of this model of device guideline [0..1] Tracking of latest field safety corrective action correctiveAction [0..1] Billing code or reference associated with the device chargeItem [0..*]

XML Template

<DeviceDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>

 <description value="[markdown]"/><!-- 0..1 Additional information to describe the device -->
 <identifier><!-- 0..* Identifier Instance identifier --></identifier>

 <udiDeviceIdentifier>  <!-- 0..* Unique Device Identifier (UDI) Barcode string -->
  <

  <deviceIdentifier value="[string]"/><!-- 1..1 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 value="[uri]"/><!-- 1..1 The organization that assigns the identifier algorithm -->
  <jurisdiction value="[uri]"/><!-- 1..1 The jurisdiction to which the deviceIdentifier applies -->
  <marketDistribution>  <!-- 0..* 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 --></marketPeriod>
   <subJurisdiction value="[uri]"/><!-- 1..1 National state or territory where the device is commercialized -->
  </marketDistribution>

 </udiDeviceIdentifier>
 <</manufacturer[x]>
 <
  <

 <regulatoryIdentifier>  <!-- 0..* Regulatory identifier(s) associated with this device -->
  <type value="[code]"/><!-- 1..1 basic | master | license -->
  <deviceIdentifier value="[string]"/><!-- 1..1 The identifier itself -->
  <issuer value="[uri]"/><!-- 1..1 The organization that issued this identifier -->
  <jurisdiction value="[uri]"/><!-- 1..1 The jurisdiction to which the deviceIdentifier applies -->
 </regulatoryIdentifier>
 <partNumber value="[string]"/><!-- 0..1 The part number or catalog number of the device -->
 <manufacturer><!-- 0..1 Reference(Organization) Name of device manufacturer --></manufacturer>
 <deviceName>  <!-- 0..* The name or names of the device as given by the manufacturer -->
  <name value="[string]"/><!-- 1..1 A name that is used to refer to the device -->

  <UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." class="dict">

RegisteredName | UserFriendlyName | PatientReportedName." class="dict">type value="[code]"/><!-- 1..1 registered-name | user-friendly-name | patient-reported-name -->

 </deviceName>
 <
 <</type>
 <
  <
  <
 </specialization>
 <
 <</safety>

 <modelNumber value="[string]"/><!-- 0..1 The catalog or model number for the device for example as defined by the manufacturer -->
 <classification>  <!-- 0..* What kind of device or device system this is -->
  <type><!-- 1..1 CodeableConcept A classification or risk class of the device model --></type>
  <justification><!-- 0..* RelatedArtifact Further information qualifying this classification of the device model --></justification>
 </classification>
 <specialization><!-- 0..* RelatedArtifact The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication --></specialization>
 <hasPart>  <!-- 0..* A device, part of the current one -->
  <reference><!-- 1..1 Reference(DeviceDefinition) Reference to the part --></reference>
  <count value="[integer]"/><!-- 0..1 Number of occurrences of the part -->
 </hasPart>
 <packaging>  <!-- 0..* Information about the packaging of the device, i.e. how the device is packaged -->
  <identifier><!-- 0..1 Identifier Business identifier of the packaged medication --></identifier>
  <type><!-- 0..1 CodeableConcept A code that defines the specific type of packaging --></type>
  <count value="[integer]"/><!-- 0..1 The number of items contained in the package (devices or sub-packages) -->
  <distributor>  <!-- 0..* An organization that distributes the packaged device -->
   <name value="[string]"/><!-- 0..1 Distributor's human-readable name -->
   <organizationReference><!-- 0..* Reference(Organization) Distributor as an Organization resource --></organizationReference>
  </distributor>
  <udiDeviceIdentifier><!-- 0..* Content as for DeviceDefinition.udiDeviceIdentifier Unique Device Identifier (UDI) Barcode string on the packaging --></udiDeviceIdentifier>
  <packaging><!-- 0..* Content as for DeviceDefinition.packaging Allows packages within packages --></packaging>
 </packaging>
 <version>  <!-- 0..* The version of the device or software -->
  <type><!-- 0..1 CodeableConcept The type of the device version, e.g. manufacturer, approved, internal --></type>
  <component><!-- 0..1 Identifier The hardware or software module of the device to which the version applies --></component>
  <value value="[string]"/><!-- 1..1 The version text -->
 </version>
 <safety><!-- 0..* CodeableConcept Safety characteristics of the device --></safety>

 <shelfLifeStorage><!-- 0..* ProductShelfLife Shelf Life and storage information --></shelfLifeStorage>
 <</physicalCharacteristics>

 <languageCode><!-- 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported) --></languageCode>
 <
  <</type>
  <</description>
 </capability>
 <
  <</type>
  <</valueQuantity>
  <</valueCode>

 <property>  <!-- 0..* The potential, valid configuration settings of a device, e.g., regulation status, time properties -->
  <type><!-- 1..1 CodeableConcept Code that specifies the property --></type>
  <value[x]><!-- 1..1 Quantity|CodeableConcept|string|boolean|integer|Range|
    Attachment Property value - as a code or quantity --></value[x]>
 </property>
 <owner><!-- 0..1 Reference(Organization) Organization responsible for device --></owner>
 <contact><!-- 0..* ContactPoint Details for human/organization for support --></contact>
 <
 <

 <link>  <!-- 0..* 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 --></relation>
  <relatedDevice><!-- 1..1 CodeableReference(DeviceDefinition) A reference to the linked device --></relatedDevice>
 </link>

 <note><!-- 0..* Annotation Device notes and comments --></note>
 <</quantity>

 <parentDevice><!-- 0..1 Reference(DeviceDefinition) The parent device it can be part of --></parentDevice>
 <material>  <!-- 0..* A substance used to create the material(s) of which the device is made -->
  <</substance>

  <substance><!-- 1..1 CodeableConcept A relevant substance that the device contains, may contain, or is made of --></substance>

  <alternate value="[boolean]"/><!-- 0..1 Indicates an alternative material of the device -->
  <allergenicIndicator value="[boolean]"/><!-- 0..1 Whether the substance is a known or suspected allergen -->
 </material>
 <productionIdentifierInUDI value="[code]"/><!-- 0..* lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version -->
 <guideline>  <!-- 0..1 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 --></useContext>
  <usageInstruction value="[markdown]"/><!-- 0..1 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 --></relatedArtifact>
  <indication><!-- 0..* CodeableReference(ClinicalUseDefinition) A clinical condition for which the device was designed to be used --></indication>
  <contraindication><!-- 0..* CodeableReference(ClinicalUseDefinition) A specific situation when a device should not be used because it may cause harm --></contraindication>
  <warning><!-- 0..* CodeableReference(ClinicalUseDefinition) Specific hazard alert information that a user needs to know before using the device --></warning>
  <intendedUse value="[string]"/><!-- 0..1 A description of the general purpose or medical use of the device or its function -->
 </guideline>
 <correctiveAction>  <!-- 0..1 Tracking of latest field safety corrective action -->
  <recall value="[boolean]"/><!-- 1..1 Whether the corrective action was a recall -->
  <scope value="[code]"/><!-- 0..1 model | lot-numbers | serial-numbers -->
  <period><!-- 1..1 Period Start and end dates of the  corrective action --></period>
 </correctiveAction>
 <chargeItem>  <!-- 0..* Billing code or reference associated with the device -->
  <chargeItemCode><!-- 1..1 CodeableReference(ChargeItemDefinition) The code or reference for the charge item --></chargeItemCode>
  <count><!-- 1..1 Quantity Coefficient applicable to the billing code --></count>
  <effectivePeriod><!-- 0..1 Period A specific time period in which this charge item applies --></effectivePeriod>
  <useContext><!-- 0..* UsageContext The context to which this charge item applies --></useContext>
 </chargeItem>

</DeviceDefinition>

JSON Template

{doco
  "resourceType" : "DeviceDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "description" : "<markdown>", // Additional information to describe the device
  "identifier" : [{ Identifier }], // Instance identifier

  "udiDeviceIdentifier" : [{ // Unique Device Identifier (UDI) Barcode string
    "

    "deviceIdentifier" : "<string>", // R!  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" : "<uri>", // R!  The organization that assigns the identifier algorithm
    "

    "jurisdiction" : "<uri>", // R!  The jurisdiction to which the deviceIdentifier applies
    "marketDistribution" : [{ // Indicates whether and when the device is available on the market
      "marketPeriod" : { Period }, // R!  Begin and end dates for the commercial distribution of the device
      "subJurisdiction" : "<uri>" // R!  National state or territory where the device is commercialized
    }]

  }],
  
  ">",
  " },
  "
    "

  "regulatoryIdentifier" : [{ // Regulatory identifier(s) associated with this device
    "type" : "<code>", // R!  basic | master | license
    "deviceIdentifier" : "<string>", // R!  The identifier itself
    "issuer" : "<uri>", // R!  The organization that issued this identifier
    "jurisdiction" : "<uri>" // R!  The jurisdiction to which the deviceIdentifier applies
  }],
  "partNumber" : "<string>", // The part number or catalog number of the device
  "manufacturer" : { Reference(Organization) }, // Name of device manufacturer
  "deviceName" : [{ // The name or names of the device as given by the manufacturer
    "name" : "<string>", // R!  A name that is used to refer to the device

    "UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." class="dict">type

RegisteredName | UserFriendlyName | PatientReportedName." class="dict">type" : "<code>" // R!  registered-name | user-friendly-name | patient-reported-name

  }],
  "
  "
  "
    "
    "

  "modelNumber" : "<string>", // The catalog or model number for the device for example as defined by the manufacturer
  "classification" : [{ // What kind of device or device system this is
    "type" : { CodeableConcept }, // R!  A classification or risk class of the device model
    "justification" : [{ RelatedArtifact }] // Further information qualifying this classification of the device model

  }],
  "
  "

  "specialization" : [{ RelatedArtifact }], // The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication
  "hasPart" : [{ // A device, part of the current one
    "reference" : { Reference(DeviceDefinition) }, // R!  Reference to the part
    "count" : <integer> // Number of occurrences of the part
  }],
  "packaging" : [{ // Information about the packaging of the device, i.e. how the device is packaged
    "identifier" : { Identifier }, // Business identifier of the packaged medication
    "type" : { CodeableConcept }, // A code that defines the specific type of packaging
    "count" : <integer>, // The number of items contained in the package (devices or sub-packages)
    "distributor" : [{ // An organization that distributes the packaged device
      "name" : "<string>", // Distributor's human-readable name
      "organizationReference" : [{ Reference(Organization) }] // Distributor as an Organization resource
    }],
    "udiDeviceIdentifier" : [{ Content as for DeviceDefinition.udiDeviceIdentifier }], // Unique Device Identifier (UDI) Barcode string on the packaging
    "packaging" : [{ Content as for DeviceDefinition.packaging }] // Allows packages within packages
  }],
  "version" : [{ // The version of the device or software
    "type" : { CodeableConcept }, // The type of the device version, e.g. manufacturer, approved, internal
    "component" : { Identifier }, // The hardware or software module of the device to which the version applies
    "value" : "<string>" // R!  The version text
  }],
  "safety" : [{ CodeableConcept }], // Safety characteristics of the device

  "shelfLifeStorage" : [{ ProductShelfLife }], // Shelf Life and storage information
  "

  "languageCode" : [{ CodeableConcept }], // Language code for the human-readable text strings produced by the device (all supported)
  "
    "
    "
  }],
  "
    "
    "
    "

  "property" : [{ // The potential, valid configuration settings of a device, e.g., regulation status, time properties
    "type" : { CodeableConcept }, // R!  Code that specifies the property
    // value[x]: Property value - as a code or quantity. One of these 7:

    "valueQuantity" : { Quantity },
    "valueCodeableConcept" : { CodeableConcept },
    "valueString" : "<string>",
    "valueBoolean" : <boolean>,
    "valueInteger" : <integer>,
    "valueRange" : { Range },
    "valueAttachment" : { Attachment }

  }],
  "owner" : { Reference(Organization) }, // Organization responsible for device
  "contact" : [{ ContactPoint }], // Details for human/organization for support
  "
  "

  "link" : [{ // An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device
    "relation" : { Coding }, // R!  The type indicates the relationship of the related device to the device instance
    "relatedDevice" : { CodeableReference(DeviceDefinition) } // R!  A reference to the linked device
  }],

  "note" : [{ Annotation }], // Device notes and comments
  "

  "parentDevice" : { Reference(DeviceDefinition) }, // The parent device it can be part of
  "material" : [{ // A substance used to create the material(s) of which the device is made
    "

    "substance" : { CodeableConcept }, // R!  A relevant substance that the device contains, may contain, or is made of

    "alternate" : <boolean>, // Indicates an alternative material of the device
    "allergenicIndicator" : <boolean> // Whether the substance is a known or suspected allergen
  }],
  "productionIdentifierInUDI" : ["<code>"], // lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
  "guideline" : { // Information aimed at providing directions for the usage of this model of device
    "useContext" : [{ UsageContext }], // The circumstances that form the setting for using the device
    "usageInstruction" : "<markdown>", // Detailed written and visual directions for the user on how to use the device
    "relatedArtifact" : [{ RelatedArtifact }], // A source of information or reference for this guideline
    "indication" : [{ CodeableReference(ClinicalUseDefinition) }], // A clinical condition for which the device was designed to be used
    "contraindication" : [{ CodeableReference(ClinicalUseDefinition) }], // A specific situation when a device should not be used because it may cause harm
    "warning" : [{ CodeableReference(ClinicalUseDefinition) }], // Specific hazard alert information that a user needs to know before using the device
    "intendedUse" : "<string>" // A description of the general purpose or medical use of the device or its function
  },
  "correctiveAction" : { // Tracking of latest field safety corrective action
    "recall" : <boolean>, // R!  Whether the corrective action was a recall
    "scope" : "<code>", // model | lot-numbers | serial-numbers
    "period" : { Period } // R!  Start and end dates of the  corrective action
  },
  "chargeItem" : [{ // Billing code or reference associated with the device
    "chargeItemCode" : { CodeableReference(ChargeItemDefinition) }, // R!  The code or reference for the charge item
    "count" : { Quantity }, // R!  Coefficient applicable to the billing code
    "effectivePeriod" : { Period }, // A specific time period in which this charge item applies
    "useContext" : [{ UsageContext }] // The context to which this charge item applies

  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DeviceDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:

  fhir:DeviceDefinition.description [ markdown ]; # 0..1 Additional information to describe the device
  fhir:DeviceDefinition.identifier [ Identifier ], ... ; # 0..* Instance identifier

  fhir:DeviceDefinition.udiDeviceIdentifier [ # 0..* Unique Device Identifier (UDI) Barcode string
    fhir:

    fhir:DeviceDefinition.udiDeviceIdentifier.deviceIdentifier [ string ]; # 1..1 The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier

    fhir:DeviceDefinition.udiDeviceIdentifier.issuer [ uri ]; # 1..1 The organization that assigns the identifier algorithm
    fhir:DeviceDefinition.udiDeviceIdentifier.jurisdiction [ uri ]; # 1..1 The jurisdiction to which the deviceIdentifier applies
    fhir:DeviceDefinition.udiDeviceIdentifier.marketDistribution [ # 0..* Indicates whether and when the device is available on the market
      fhir:DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod [ Period ]; # 1..1 Begin and end dates for the commercial distribution of the device
      fhir:DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction [ uri ]; # 1..1 National state or territory where the device is commercialized
    ], ...;

  ], ...;
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
    fhir:

  fhir:DeviceDefinition.regulatoryIdentifier [ # 0..* Regulatory identifier(s) associated with this device
    fhir:DeviceDefinition.regulatoryIdentifier.type [ code ]; # 1..1 basic | master | license
    fhir:DeviceDefinition.regulatoryIdentifier.deviceIdentifier [ string ]; # 1..1 The identifier itself
    fhir:DeviceDefinition.regulatoryIdentifier.issuer [ uri ]; # 1..1 The organization that issued this identifier
    fhir:DeviceDefinition.regulatoryIdentifier.jurisdiction [ uri ]; # 1..1 The jurisdiction to which the deviceIdentifier applies
  ], ...;
  fhir:DeviceDefinition.partNumber [ string ]; # 0..1 The part number or catalog number of the device
  fhir:DeviceDefinition.manufacturer [ Reference(Organization) ]; # 0..1 Name of device manufacturer
  fhir:DeviceDefinition.deviceName [ # 0..* The name or names of the device as given by the manufacturer
    fhir:DeviceDefinition.deviceName.name [ string ]; # 1..1 A name that is used to refer to the device

    fhir:UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." class="dict">DeviceDefinition.deviceName.type

RegisteredName | UserFriendlyName | PatientReportedName." class="dict">DeviceDefinition.deviceName.type [ code ]; # 1..1 registered-name | user-friendly-name | patient-reported-name

  ], ...;
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:

  fhir:DeviceDefinition.modelNumber [ string ]; # 0..1 The catalog or model number for the device for example as defined by the manufacturer
  fhir:DeviceDefinition.classification [ # 0..* What kind of device or device system this is
    fhir:DeviceDefinition.classification.type [ CodeableConcept ]; # 1..1 A classification or risk class of the device model
    fhir:DeviceDefinition.classification.justification [ RelatedArtifact ], ... ; # 0..* Further information qualifying this classification of the device model
  ], ...;
  fhir:DeviceDefinition.specialization [ RelatedArtifact ], ... ; # 0..* The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication
  fhir:DeviceDefinition.hasPart [ # 0..* A device, part of the current one
    fhir:DeviceDefinition.hasPart.reference [ Reference(DeviceDefinition) ]; # 1..1 Reference to the part
    fhir:DeviceDefinition.hasPart.count [ integer ]; # 0..1 Number of occurrences of the part
  ], ...;
  fhir:DeviceDefinition.packaging [ # 0..* Information about the packaging of the device, i.e. how the device is packaged
    fhir:DeviceDefinition.packaging.identifier [ Identifier ]; # 0..1 Business identifier of the packaged medication
    fhir:DeviceDefinition.packaging.type [ CodeableConcept ]; # 0..1 A code that defines the specific type of packaging
    fhir:DeviceDefinition.packaging.count [ integer ]; # 0..1 The number of items contained in the package (devices or sub-packages)
    fhir:DeviceDefinition.packaging.distributor [ # 0..* An organization that distributes the packaged device
      fhir:DeviceDefinition.packaging.distributor.name [ string ]; # 0..1 Distributor's human-readable name
      fhir:DeviceDefinition.packaging.distributor.organizationReference [ Reference(Organization) ], ... ; # 0..* Distributor as an Organization resource
    ], ...;
    fhir:DeviceDefinition.packaging.udiDeviceIdentifier [ See DeviceDefinition.udiDeviceIdentifier ], ... ; # 0..* Unique Device Identifier (UDI) Barcode string on the packaging
    fhir:DeviceDefinition.packaging.packaging [ See DeviceDefinition.packaging ], ... ; # 0..* Allows packages within packages
  ], ...;
  fhir:DeviceDefinition.version [ # 0..* The version of the device or software
    fhir:DeviceDefinition.version.type [ CodeableConcept ]; # 0..1 The type of the device version, e.g. manufacturer, approved, internal
    fhir:DeviceDefinition.version.component [ Identifier ]; # 0..1 The hardware or software module of the device to which the version applies
    fhir:DeviceDefinition.version.value [ string ]; # 1..1 The version text

  ], ...;
  fhir:

  fhir:DeviceDefinition.safety [ CodeableConcept ], ... ; # 0..* Safety characteristics of the device
  fhir:DeviceDefinition.shelfLifeStorage [ ProductShelfLife ], ... ; # 0..* Shelf Life and storage information
  fhir:

  fhir:DeviceDefinition.languageCode [ CodeableConcept ], ... ; # 0..* Language code for the human-readable text strings produced by the device (all supported)
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:

  fhir:DeviceDefinition.property [ # 0..* The potential, valid configuration settings of a device, e.g., regulation status, time properties
    fhir:DeviceDefinition.property.type [ CodeableConcept ]; # 1..1 Code that specifies the property
    # DeviceDefinition.property.value[x] : 1..1 Property value - as a code or quantity. One of these 7
      fhir:DeviceDefinition.property.valueQuantity [ Quantity ]
      fhir:DeviceDefinition.property.valueCodeableConcept [ CodeableConcept ]
      fhir:DeviceDefinition.property.valueString [ string ]
      fhir:DeviceDefinition.property.valueBoolean [ boolean ]
      fhir:DeviceDefinition.property.valueInteger [ integer ]
      fhir:DeviceDefinition.property.valueRange [ Range ]
      fhir:DeviceDefinition.property.valueAttachment [ Attachment ]

  ], ...;
  fhir:DeviceDefinition.owner [ Reference(Organization) ]; # 0..1 Organization responsible for device
  fhir:DeviceDefinition.contact [ ContactPoint ], ... ; # 0..* Details for human/organization for support
  fhir:
  fhir:

  fhir:DeviceDefinition.link [ # 0..* An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device
    fhir:DeviceDefinition.link.relation [ Coding ]; # 1..1 The type indicates the relationship of the related device to the device instance
    fhir:DeviceDefinition.link.relatedDevice [ CodeableReference(DeviceDefinition) ]; # 1..1 A reference to the linked device
  ], ...;

  fhir:DeviceDefinition.note [ Annotation ], ... ; # 0..* Device notes and comments
  fhir:

  fhir:DeviceDefinition.parentDevice [ Reference(DeviceDefinition) ]; # 0..1 The parent device it can be part of
  fhir:DeviceDefinition.material [ # 0..* A substance used to create the material(s) of which the device is made
    fhir:

    fhir:DeviceDefinition.material.substance [ CodeableConcept ]; # 1..1 A relevant substance that the device contains, may contain, or is made of

    fhir:DeviceDefinition.material.alternate [ boolean ]; # 0..1 Indicates an alternative material of the device
    fhir:DeviceDefinition.material.allergenicIndicator [ boolean ]; # 0..1 Whether the substance is a known or suspected allergen
  ], ...;
  fhir:DeviceDefinition.productionIdentifierInUDI [ code ], ... ; # 0..* lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
  fhir:DeviceDefinition.guideline [ # 0..1 Information aimed at providing directions for the usage of this model of device
    fhir:DeviceDefinition.guideline.useContext [ UsageContext ], ... ; # 0..* The circumstances that form the setting for using the device
    fhir:DeviceDefinition.guideline.usageInstruction [ markdown ]; # 0..1 Detailed written and visual directions for the user on how to use the device
    fhir:DeviceDefinition.guideline.relatedArtifact [ RelatedArtifact ], ... ; # 0..* A source of information or reference for this guideline
    fhir:DeviceDefinition.guideline.indication [ CodeableReference(ClinicalUseDefinition) ], ... ; # 0..* A clinical condition for which the device was designed to be used
    fhir:DeviceDefinition.guideline.contraindication [ CodeableReference(ClinicalUseDefinition) ], ... ; # 0..* A specific situation when a device should not be used because it may cause harm
    fhir:DeviceDefinition.guideline.warning [ CodeableReference(ClinicalUseDefinition) ], ... ; # 0..* Specific hazard alert information that a user needs to know before using the device
    fhir:DeviceDefinition.guideline.intendedUse [ string ]; # 0..1 A description of the general purpose or medical use of the device or its function
  ];
  fhir:DeviceDefinition.correctiveAction [ # 0..1 Tracking of latest field safety corrective action
    fhir:DeviceDefinition.correctiveAction.recall [ boolean ]; # 1..1 Whether the corrective action was a recall
    fhir:DeviceDefinition.correctiveAction.scope [ code ]; # 0..1 model | lot-numbers | serial-numbers
    fhir:DeviceDefinition.correctiveAction.period [ Period ]; # 1..1 Start and end dates of the  corrective action
  ];
  fhir:DeviceDefinition.chargeItem [ # 0..* Billing code or reference associated with the device
    fhir:DeviceDefinition.chargeItem.chargeItemCode [ CodeableReference(ChargeItemDefinition) ]; # 1..1 The code or reference for the charge item
    fhir:DeviceDefinition.chargeItem.count [ Quantity ]; # 1..1 Coefficient applicable to the billing code
    fhir:DeviceDefinition.chargeItem.effectivePeriod [ Period ]; # 0..1 A specific time period in which this charge item applies
    fhir:DeviceDefinition.chargeItem.useContext [ UsageContext ], ... ; # 0..* The context to which this charge item applies
  ], ...;

]

Changes since R4

DeviceDefinition
DeviceDefinition.description
  • No Changes Added Element
DeviceDefinition.udiDeviceIdentifier.marketDistribution
  • Added Element
DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod
  • Added Mandatory Element
DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier
  • Added Element
DeviceDefinition.regulatoryIdentifier.type
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier.deviceIdentifier
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier.issuer
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier.jurisdiction
  • Added Mandatory Element
DeviceDefinition.partNumber
  • Added Element
DeviceDefinition.manufacturer
  • Added Element
DeviceDefinition.classification
  • Added Element
DeviceDefinition.classification.type
  • Added Mandatory Element
DeviceDefinition.classification.justification
  • Added Element
DeviceDefinition.specialization
  • Type changed from BackboneElement to RelatedArtifact
  • Type changed from BackboneElement to RelatedArtifact
DeviceDefinition.hasPart
  • Added Element
DeviceDefinition.hasPart.reference
  • Added Mandatory Element
DeviceDefinition.hasPart.count
  • Added Element
DeviceDefinition.packaging
  • Added Element
DeviceDefinition.packaging.identifier
  • Added Element
DeviceDefinition.packaging.type
  • Added Element
DeviceDefinition.packaging.count
  • Added Element
DeviceDefinition.packaging.distributor
  • Added Element
DeviceDefinition.packaging.distributor.name
  • Added Element
DeviceDefinition.packaging.distributor.organizationReference
  • Added Element
DeviceDefinition.packaging.udiDeviceIdentifier
  • Added Element
DeviceDefinition.packaging.packaging
  • Added Element
DeviceDefinition.version
  • Type changed from string to BackboneElement
  • Type changed from string to BackboneElement
DeviceDefinition.version.type
  • Added Element
DeviceDefinition.version.component
  • Added Element
DeviceDefinition.version.value
  • Added Mandatory Element
DeviceDefinition.property.value[x]
  • Added Mandatory Element
DeviceDefinition.link
  • Added Element
DeviceDefinition.link.relation
  • Added Mandatory Element
DeviceDefinition.link.relatedDevice
  • Added Mandatory Element
DeviceDefinition.productionIdentifierInUDI
  • Added Element
DeviceDefinition.guideline
  • Added Element
DeviceDefinition.guideline.useContext
  • Added Element
DeviceDefinition.guideline.usageInstruction
  • Added Element
DeviceDefinition.guideline.relatedArtifact
  • Added Element
DeviceDefinition.guideline.indication
  • Added Element
DeviceDefinition.guideline.contraindication
  • Added Element
DeviceDefinition.guideline.warning
  • Added Element
DeviceDefinition.guideline.intendedUse
  • Added Element
DeviceDefinition.correctiveAction
  • Added Element
DeviceDefinition.correctiveAction.recall
  • Added Mandatory Element
DeviceDefinition.correctiveAction.scope
  • Added Element
DeviceDefinition.correctiveAction.period
  • Added Mandatory Element
DeviceDefinition.chargeItem
  • Added Element
DeviceDefinition.chargeItem.chargeItemCode
  • Added Mandatory Element
DeviceDefinition.chargeItem.count
  • Added Mandatory Element
DeviceDefinition.chargeItem.effectivePeriod
  • Added Element
DeviceDefinition.chargeItem.useContext
  • Added Element
DeviceDefinition.manufacturer[x]
  • deleted
DeviceDefinition.type
  • deleted
DeviceDefinition.specialization.systemType
  • deleted
DeviceDefinition.specialization.version
  • deleted
DeviceDefinition.physicalCharacteristics
  • deleted
DeviceDefinition.capability
  • deleted
DeviceDefinition.property.valueQuantity
  • deleted
DeviceDefinition.property.valueCode
  • deleted
DeviceDefinition.url
  • deleted
DeviceDefinition.onlineInformation
  • deleted
DeviceDefinition.quantity
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

Structure

Name Flags Card. Type Description & Constraints doco
. . DeviceDefinition TU DomainResource An instance of a medical-related component of a medical device

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . identifier . description 0..* 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 jurisdication porvided 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
. . manufacturer[x] . regulatoryIdentifier 0..1 0..* BackboneElement Name of Regulatory identifier(s) associated with this device manufacturer

. . . . manufacturerString type 1..1 code basic | master | license
DeviceDefinitionRegulatoryIdentifierType ( Required )
.... deviceIdentifier 1..1 string The identifier itself
.... issuer 1..1 uri The organization that issued this identifier
. . . manufacturerReference . 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 A The name given to or names of the device to identify it as given by the manufacturer

. . . . name 1..1 string The A name of that is used to refer to the device
. . . . type 1..1 code udi-label-name registered-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
DeviceNameType ( Required )
. . . modelNumber 0..1 string The catalog or model number for the device for example as defined by the manufacturer
. . type . classification 0..1 0..* CodeableConcept BackboneElement What kind of device or device system this is
FHIR
. . . . type 1..1 CodeableConcept A classification or risk class of the device model
Device Types Type ( Example )
. . . . justification 0..* RelatedArtifact Further information qualifying this classification of the device model

... specialization 0..* BackboneElement RelatedArtifact The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication

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

. . . . reference 1..1 Reference ( DeviceDefinition ) Reference to the part
... . systemType count 1..1 0..1 string integer The standard that Number of occurrences of the part
... packaging 0..* BackboneElement Information about the packaging of the device, i.e. how the device is used to operate and communicate packaged

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

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

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

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

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

.... type 0..1 CodeableConcept Safety characteristics The type of the device version, e.g. manufacturer, approved, internal
Safety
. . . . component ( Example ) 0..1 Identifier The hardware or software module of the device to which the version applies
. . . . value 1..1 string The version text
. . . shelfLifeStorage safety Σ 0..* ProductShelfLife CodeableConcept Shelf Life and storage information Safety characteristics of the device
DeviceSafety ( Example )

. . . physicalCharacteristics shelfLifeStorage 0..1 0..* ProdCharacteristic ProductShelfLife Dimensions, color etc. Shelf Life and storage information

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

. . . capability property 0..* BackboneElement Device capabilities The potential, valid configuration settings of a device, e.g., regulation status, time properties

. . . . type 1..1 CodeableConcept Type of capability Code that specifies the property
. . . description . value[x] 0..* 1..1 CodeableConcept Description of capability Property value - as a code or quantity
. . property . . . valueQuantity 0..* BackboneElement Quantity The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
. . . . . type valueCodeableConcept 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
. . . . valueQuantity . valueString string
. . . . . valueBoolean boolean
. . . . . valueInteger 0..* Quantity integer Property value as a quantity
. . . valueCode . . valueRange 0..* CodeableConcept Range Property value as a code, e.g., NTP4 (synced to NTP)
. . . . . valueAttachment Attachment
. . . owner 0..1 Reference ( Organization ) Organization responsible for device
. . . contact 0..* ContactPoint Details for human/organization for support

. . . link 0..* BackboneElement An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device

.. . url . relation 0..1 1..1 uri Coding Network address The type indicates the relationship of the related device to contact the device instance
DeviceDefinitionRelationType ( Extensible )
. . onlineInformation . . relatedDevice 0..1 1..1 uri CodeableReference ( DeviceDefinition ) Access A reference to on-line information the linked device
. . . note 0..* Annotation Device notes and comments

. . quantity . parentDevice Σ 0..1 Quantity Reference ( DeviceDefinition ) The quantity parent device it can be part of
. . . material 0..* BackboneElement A substance used to create the device present in material(s) of which the packaging (e.g. device is made

.... substance 1..1 CodeableConcept A relevant substance that the number device contains, may contain, or is made of devices present in
. . . . alternate 0..1 boolean Indicates an alternative material of the device
.... allergenicIndicator 0..1 boolean Whether the substance is a pack, known or suspected allergen
... productionIdentifierInUDI 0..* code lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
DeviceProductionIdentifierInUDI ( Required )

... guideline 0..1 BackboneElement Information aimed at providing directions for the number usage of devices in this model of device
.... useContext 0..* UsageContext The circumstances that form the same package 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..* CodeableReference ( ClinicalUseDefinition ) A clinical condition for which the medicinal product) device was designed to be used

. . . . parentDevice contraindication Σ 0..* CodeableReference ( ClinicalUseDefinition ) A specific situation when a device should not be used because it may cause harm

.... warning 0..* CodeableReference ( ClinicalUseDefinition ) Specific hazard alert information that a user needs to know before using the device

.... intendedUse 0..1 Reference 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
DeviceCorrectiveActionScope ( DeviceDefinition Required )
. . . . period The parent device it can be part 1..1 Period Start and end dates of the corrective action
. . . material chargeItem 0..* BackboneElement A substance used to create the material(s) of which Billing code or reference associated with the device is made

. . . substance . chargeItemCode 1..1 CodeableConcept CodeableReference ( ChargeItemDefinition ) The substance code or reference for the charge item
. . . alternate . count 0..1 1..1 boolean Quantity Indicates an alternative material of Coefficient applicable to the device billing code
. . . allergenicIndicator . effectivePeriod 0..1 boolean Period Whether the substance is a known or suspected allergen 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

See the Extensions for this resource

UML Diagram ( Legend )

DeviceDefinition ( DomainResource ) Additional information to describe the device description : markdown [0..1] Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID 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 identifier : Identifier [0..*] The part number or catalog number of the device partNumber : string [0..1] 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 manufacturer[x] manufacturer : Element Reference [0..1] « string | Reference ( Organization ) » The model number for the device for example as defined by the manufacturer or labeler, or other agency modelNumber : string [0..1] What kind of device or device system this is type : CodeableConcept [0..1] « null (Strength=Example) FHIRDeviceTypes ?? » The available versions of the capabilities supported on a device, e.g., software versions the standards to which the device conforms for a particular purpose, and used for the communication version specialization : string RelatedArtifact [0..*] Safety characteristics of the device safety : CodeableConcept [0..*] « null (Strength=Example) Safety DeviceSafety ?? » Shelf Life and storage information shelfLifeStorage : ProductShelfLife [0..*] Dimensions, color etc physicalCharacteristics : ProdCharacteristic [0..1] Language code for the human-readable text strings produced by the device (all supported) languageCode : CodeableConcept [0..*] An organization that is responsible for the provision and ongoing maintenance of the device owner : Reference [0..1] « Organization » Contact details for an organization or a particular human that is responsible for the device contact : ContactPoint [0..*] A network address on which the device may be contacted directly url : uri [0..1] Access to on-line information about the device onlineInformation : uri [0..1] Descriptive information, usage information or implantation information that is not captured in an existing element note : Annotation [0..*] The quantity of the parent device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package it can be part of the medicinal product) quantity parentDevice : Quantity Reference [0..1] « DeviceDefinition » The parent Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device it can be part of label parentDevice productionIdentifierInUDI : Reference code [0..1] [0..*] « DeviceDefinition null (Strength=Required) DeviceProductionIdentifierInU... ! » UdiDeviceIdentifier 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 deviceIdentifier : string [1..1] The organization that assigns the identifier algorithm issuer : uri [1..1] The jurisdiction to which the deviceIdentifier applies jurisdiction : uri [1..1] DeviceName MarketDistribution Begin and end dates for the commercial distribution of the device marketPeriod : Period [1..1] National state or territory to which the marketDistribution recers, typically where the device is commercialized subJurisdiction : uri [1..1] RegulatoryIdentifier The name type of identifier itself type : code [1..1] « null (Strength=Required) DeviceDefinitionRegulatoryIde... ! » The identifier itself deviceIdentifier : string [1..1] The organization that issued this identifier issuer : uri [1..1] The jurisdiction to which the deviceIdentifier applies jurisdiction : uri [1..1] DeviceName 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 name : string [1..1] The type of deviceName. UDILabelName RegisteredName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName type : code [1..1] « null (Strength=Required) DeviceNameType ! » Specialization Classification The standard A classification or risk class of the device model type : CodeableConcept [1..1] « null (Strength=Example) DeviceType ?? » Further information qualifying this classification of the device model justification : RelatedArtifact [0..*] HasPart Reference to the device that is used to operate and communicate part of the current device systemType reference : string Reference [1..1] « DeviceDefinition » Number of instances of the component device in the current device count : integer [0..1] Packaging The version business identifier of the standard packaged medication identifier : Identifier [0..1] A code that is used to operate and communicate defines the specific type of packaging version type : CodeableConcept [0..1] The number of items contained in the package (devices or sub-packages) count : integer [0..1] Distributor Distributor's human-readable name name : string [0..1] Distributor as an Organization resource organizationReference : Reference [0..*] « Organization » Capability Version Type The type of capability the device version, e.g. manufacturer, approved, internal type : CodeableConcept [1..1] [0..1] Description The hardware or software module of capability the device to which the version applies description component : CodeableConcept Identifier [0..*] [0..1] The version text value : string [1..1] Property Code that specifies the property DeviceDefinitionPropetyCode (Extensible) type : CodeableConcept [1..1] Property value as a quantity - the data type depends on the property type valueQuantity value[x] : DataType [1..1] « Quantity [0..*] | CodeableConcept | string | boolean | integer | Range | Attachment » Link Property value as a code, e.g., NTP4 (synced The type indicates the relationship of the related device to NTP) the device instance valueCode relation : CodeableConcept Coding [0..*] [1..1] « null (Strength=Extensible) DeviceDefinitionRelationType + » A reference to the linked device relatedDevice : CodeableReference [1..1] « DeviceDefinition » Material The 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 substance : CodeableConcept [1..1] Indicates an alternative material of the device alternate : boolean [0..1] Whether the substance is a known or suspected allergen allergenicIndicator : boolean [0..1] Guideline The circumstances that form the setting for using the device useContext : UsageContext [0..*] Detailed written and visual directions for the user on how to use the device usageInstruction : markdown [0..1] A source of information or reference for this guideline relatedArtifact : RelatedArtifact [0..*] A clinical condition for which the device was designed to be used indication : CodeableReference [0..*] « ClinicalUseDefinition » A specific situation when a device should not be used because it may cause harm contraindication : CodeableReference [0..*] « ClinicalUseDefinition » Specific hazard alert information that a user needs to know before using the device warning : CodeableReference [0..*] « ClinicalUseDefinition » A description of the general purpose or medical use of the device or its function intendedUse : string [0..1] CorrectiveAction Whether the last corrective action known for this device was a recall recall : boolean [1..1] The scope of the 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 scope : code [0..1] « null (Strength=Required) DeviceCorrectiveActionScope ! » Start and end dates of the corrective action period : Period [1..1] ChargeItem The code or reference for the charge item chargeItemCode : CodeableReference [1..1] « ChargeItemDefinition » Coefficient applicable to the billing code count : Quantity [1..1] A specific time period in which this charge item applies effectivePeriod : Period [0..1] The context to which this charge item applies useContext : UsageContext [0..*] Indicates where and when the device is available on the market marketDistribution [0..*] 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 udiDeviceIdentifier [0..*] A name given to Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device to identify it models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe deviceName regulatoryIdentifier [0..*] The capabilities supported on a device, name or names of the standards to which device as given by the manufacturer deviceName [0..*] What kind of device conforms for or device system this is classification [0..*] A device that is part (for example a particular purpose, and used for component) of the communication present device specialization hasPart [0..*] An organization that distributes the packaged device distributor [0..*] Unique Device capabilities Identifier (UDI) Barcode string on the packaging capability udiDeviceIdentifier [0..*] Allows packages within packages packaging [0..*] Information about the packaging of the device, i.e. how the device is packaged packaging [0..*] The actual version of the device or software version [0..*] The potential, valid configuration settings of a device as it actually operates, device, e.g., regulation status, time properties property [0..*] An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device link [0..*] A substance used to create the material(s) of which the device is made material [0..*] Information aimed at providing directions for the usage of this model of device guideline [0..1] Tracking of latest field safety corrective action correctiveAction [0..1] Billing code or reference associated with the device chargeItem [0..*]

XML Template

<DeviceDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</identifier>

 <description value="[markdown]"/><!-- 0..1 Additional information to describe the device -->
 <identifier><!-- 0..* Identifier Instance identifier --></identifier>

 <udiDeviceIdentifier>  <!-- 0..* Unique Device Identifier (UDI) Barcode string -->
  <

  <deviceIdentifier value="[string]"/><!-- 1..1 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 value="[uri]"/><!-- 1..1 The organization that assigns the identifier algorithm -->
  <jurisdiction value="[uri]"/><!-- 1..1 The jurisdiction to which the deviceIdentifier applies -->
  <marketDistribution>  <!-- 0..* 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 --></marketPeriod>
   <subJurisdiction value="[uri]"/><!-- 1..1 National state or territory where the device is commercialized -->
  </marketDistribution>

 </udiDeviceIdentifier>
 <</manufacturer[x]>
 <
  <

 <regulatoryIdentifier>  <!-- 0..* Regulatory identifier(s) associated with this device -->
  <type value="[code]"/><!-- 1..1 basic | master | license -->
  <deviceIdentifier value="[string]"/><!-- 1..1 The identifier itself -->
  <issuer value="[uri]"/><!-- 1..1 The organization that issued this identifier -->
  <jurisdiction value="[uri]"/><!-- 1..1 The jurisdiction to which the deviceIdentifier applies -->
 </regulatoryIdentifier>
 <partNumber value="[string]"/><!-- 0..1 The part number or catalog number of the device -->
 <manufacturer><!-- 0..1 Reference(Organization) Name of device manufacturer --></manufacturer>
 <deviceName>  <!-- 0..* The name or names of the device as given by the manufacturer -->
  <name value="[string]"/><!-- 1..1 A name that is used to refer to the device -->

  <UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." class="dict">

RegisteredName | UserFriendlyName | PatientReportedName." class="dict">type value="[code]"/><!-- 1..1 registered-name | user-friendly-name | patient-reported-name -->

 </deviceName>
 <
 <</type>
 <
  <
  <
 </specialization>
 <
 <</safety>

 <modelNumber value="[string]"/><!-- 0..1 The catalog or model number for the device for example as defined by the manufacturer -->
 <classification>  <!-- 0..* What kind of device or device system this is -->
  <type><!-- 1..1 CodeableConcept A classification or risk class of the device model --></type>
  <justification><!-- 0..* RelatedArtifact Further information qualifying this classification of the device model --></justification>
 </classification>
 <specialization><!-- 0..* RelatedArtifact The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication --></specialization>
 <hasPart>  <!-- 0..* A device, part of the current one -->
  <reference><!-- 1..1 Reference(DeviceDefinition) Reference to the part --></reference>
  <count value="[integer]"/><!-- 0..1 Number of occurrences of the part -->
 </hasPart>
 <packaging>  <!-- 0..* Information about the packaging of the device, i.e. how the device is packaged -->
  <identifier><!-- 0..1 Identifier Business identifier of the packaged medication --></identifier>
  <type><!-- 0..1 CodeableConcept A code that defines the specific type of packaging --></type>
  <count value="[integer]"/><!-- 0..1 The number of items contained in the package (devices or sub-packages) -->
  <distributor>  <!-- 0..* An organization that distributes the packaged device -->
   <name value="[string]"/><!-- 0..1 Distributor's human-readable name -->
   <organizationReference><!-- 0..* Reference(Organization) Distributor as an Organization resource --></organizationReference>
  </distributor>
  <udiDeviceIdentifier><!-- 0..* Content as for DeviceDefinition.udiDeviceIdentifier Unique Device Identifier (UDI) Barcode string on the packaging --></udiDeviceIdentifier>
  <packaging><!-- 0..* Content as for DeviceDefinition.packaging Allows packages within packages --></packaging>
 </packaging>
 <version>  <!-- 0..* The version of the device or software -->
  <type><!-- 0..1 CodeableConcept The type of the device version, e.g. manufacturer, approved, internal --></type>
  <component><!-- 0..1 Identifier The hardware or software module of the device to which the version applies --></component>
  <value value="[string]"/><!-- 1..1 The version text -->
 </version>
 <safety><!-- 0..* CodeableConcept Safety characteristics of the device --></safety>

 <shelfLifeStorage><!-- 0..* ProductShelfLife Shelf Life and storage information --></shelfLifeStorage>
 <</physicalCharacteristics>

 <languageCode><!-- 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported) --></languageCode>
 <
  <</type>
  <</description>
 </capability>
 <
  <</type>
  <</valueQuantity>
  <</valueCode>

 <property>  <!-- 0..* The potential, valid configuration settings of a device, e.g., regulation status, time properties -->
  <type><!-- 1..1 CodeableConcept Code that specifies the property --></type>
  <value[x]><!-- 1..1 Quantity|CodeableConcept|string|boolean|integer|Range|
    Attachment Property value - as a code or quantity --></value[x]>
 </property>
 <owner><!-- 0..1 Reference(Organization) Organization responsible for device --></owner>
 <contact><!-- 0..* ContactPoint Details for human/organization for support --></contact>
 <
 <

 <link>  <!-- 0..* 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 --></relation>
  <relatedDevice><!-- 1..1 CodeableReference(DeviceDefinition) A reference to the linked device --></relatedDevice>
 </link>

 <note><!-- 0..* Annotation Device notes and comments --></note>
 <</quantity>

 <parentDevice><!-- 0..1 Reference(DeviceDefinition) The parent device it can be part of --></parentDevice>
 <material>  <!-- 0..* A substance used to create the material(s) of which the device is made -->
  <</substance>

  <substance><!-- 1..1 CodeableConcept A relevant substance that the device contains, may contain, or is made of --></substance>

  <alternate value="[boolean]"/><!-- 0..1 Indicates an alternative material of the device -->
  <allergenicIndicator value="[boolean]"/><!-- 0..1 Whether the substance is a known or suspected allergen -->
 </material>
 <productionIdentifierInUDI value="[code]"/><!-- 0..* lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version -->
 <guideline>  <!-- 0..1 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 --></useContext>
  <usageInstruction value="[markdown]"/><!-- 0..1 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 --></relatedArtifact>
  <indication><!-- 0..* CodeableReference(ClinicalUseDefinition) A clinical condition for which the device was designed to be used --></indication>
  <contraindication><!-- 0..* CodeableReference(ClinicalUseDefinition) A specific situation when a device should not be used because it may cause harm --></contraindication>
  <warning><!-- 0..* CodeableReference(ClinicalUseDefinition) Specific hazard alert information that a user needs to know before using the device --></warning>
  <intendedUse value="[string]"/><!-- 0..1 A description of the general purpose or medical use of the device or its function -->
 </guideline>
 <correctiveAction>  <!-- 0..1 Tracking of latest field safety corrective action -->
  <recall value="[boolean]"/><!-- 1..1 Whether the corrective action was a recall -->
  <scope value="[code]"/><!-- 0..1 model | lot-numbers | serial-numbers -->
  <period><!-- 1..1 Period Start and end dates of the  corrective action --></period>
 </correctiveAction>
 <chargeItem>  <!-- 0..* Billing code or reference associated with the device -->
  <chargeItemCode><!-- 1..1 CodeableReference(ChargeItemDefinition) The code or reference for the charge item --></chargeItemCode>
  <count><!-- 1..1 Quantity Coefficient applicable to the billing code --></count>
  <effectivePeriod><!-- 0..1 Period A specific time period in which this charge item applies --></effectivePeriod>
  <useContext><!-- 0..* UsageContext The context to which this charge item applies --></useContext>
 </chargeItem>

</DeviceDefinition>

JSON Template

{doco
  "resourceType" : "DeviceDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "description" : "<markdown>", // Additional information to describe the device
  "identifier" : [{ Identifier }], // Instance identifier

  "udiDeviceIdentifier" : [{ // Unique Device Identifier (UDI) Barcode string
    "

    "deviceIdentifier" : "<string>", // R!  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" : "<uri>", // R!  The organization that assigns the identifier algorithm
    "

    "jurisdiction" : "<uri>", // R!  The jurisdiction to which the deviceIdentifier applies
    "marketDistribution" : [{ // Indicates whether and when the device is available on the market
      "marketPeriod" : { Period }, // R!  Begin and end dates for the commercial distribution of the device
      "subJurisdiction" : "<uri>" // R!  National state or territory where the device is commercialized
    }]

  }],
  
  ">",
  " },
  "
    "

  "regulatoryIdentifier" : [{ // Regulatory identifier(s) associated with this device
    "type" : "<code>", // R!  basic | master | license
    "deviceIdentifier" : "<string>", // R!  The identifier itself
    "issuer" : "<uri>", // R!  The organization that issued this identifier
    "jurisdiction" : "<uri>" // R!  The jurisdiction to which the deviceIdentifier applies
  }],
  "partNumber" : "<string>", // The part number or catalog number of the device
  "manufacturer" : { Reference(Organization) }, // Name of device manufacturer
  "deviceName" : [{ // The name or names of the device as given by the manufacturer
    "name" : "<string>", // R!  A name that is used to refer to the device

    "UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." class="dict">type

RegisteredName | UserFriendlyName | PatientReportedName." class="dict">type" : "<code>" // R!  registered-name | user-friendly-name | patient-reported-name

  }],
  "
  "
  "
    "
    "

  "modelNumber" : "<string>", // The catalog or model number for the device for example as defined by the manufacturer
  "classification" : [{ // What kind of device or device system this is
    "type" : { CodeableConcept }, // R!  A classification or risk class of the device model
    "justification" : [{ RelatedArtifact }] // Further information qualifying this classification of the device model

  }],
  "
  "

  "specialization" : [{ RelatedArtifact }], // The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication
  "hasPart" : [{ // A device, part of the current one
    "reference" : { Reference(DeviceDefinition) }, // R!  Reference to the part
    "count" : <integer> // Number of occurrences of the part
  }],
  "packaging" : [{ // Information about the packaging of the device, i.e. how the device is packaged
    "identifier" : { Identifier }, // Business identifier of the packaged medication
    "type" : { CodeableConcept }, // A code that defines the specific type of packaging
    "count" : <integer>, // The number of items contained in the package (devices or sub-packages)
    "distributor" : [{ // An organization that distributes the packaged device
      "name" : "<string>", // Distributor's human-readable name
      "organizationReference" : [{ Reference(Organization) }] // Distributor as an Organization resource
    }],
    "udiDeviceIdentifier" : [{ Content as for DeviceDefinition.udiDeviceIdentifier }], // Unique Device Identifier (UDI) Barcode string on the packaging
    "packaging" : [{ Content as for DeviceDefinition.packaging }] // Allows packages within packages
  }],
  "version" : [{ // The version of the device or software
    "type" : { CodeableConcept }, // The type of the device version, e.g. manufacturer, approved, internal
    "component" : { Identifier }, // The hardware or software module of the device to which the version applies
    "value" : "<string>" // R!  The version text
  }],
  "safety" : [{ CodeableConcept }], // Safety characteristics of the device

  "shelfLifeStorage" : [{ ProductShelfLife }], // Shelf Life and storage information
  "

  "languageCode" : [{ CodeableConcept }], // Language code for the human-readable text strings produced by the device (all supported)
  "
    "
    "
  }],
  "
    "
    "
    "

  "property" : [{ // The potential, valid configuration settings of a device, e.g., regulation status, time properties
    "type" : { CodeableConcept }, // R!  Code that specifies the property
    // value[x]: Property value - as a code or quantity. One of these 7:

    "valueQuantity" : { Quantity },
    "valueCodeableConcept" : { CodeableConcept },
    "valueString" : "<string>",
    "valueBoolean" : <boolean>,
    "valueInteger" : <integer>,
    "valueRange" : { Range },
    "valueAttachment" : { Attachment }

  }],
  "owner" : { Reference(Organization) }, // Organization responsible for device
  "contact" : [{ ContactPoint }], // Details for human/organization for support
  "
  "

  "link" : [{ // An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device
    "relation" : { Coding }, // R!  The type indicates the relationship of the related device to the device instance
    "relatedDevice" : { CodeableReference(DeviceDefinition) } // R!  A reference to the linked device
  }],

  "note" : [{ Annotation }], // Device notes and comments
  "

  "parentDevice" : { Reference(DeviceDefinition) }, // The parent device it can be part of
  "material" : [{ // A substance used to create the material(s) of which the device is made
    "

    "substance" : { CodeableConcept }, // R!  A relevant substance that the device contains, may contain, or is made of

    "alternate" : <boolean>, // Indicates an alternative material of the device
    "allergenicIndicator" : <boolean> // Whether the substance is a known or suspected allergen
  }],
  "productionIdentifierInUDI" : ["<code>"], // lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
  "guideline" : { // Information aimed at providing directions for the usage of this model of device
    "useContext" : [{ UsageContext }], // The circumstances that form the setting for using the device
    "usageInstruction" : "<markdown>", // Detailed written and visual directions for the user on how to use the device
    "relatedArtifact" : [{ RelatedArtifact }], // A source of information or reference for this guideline
    "indication" : [{ CodeableReference(ClinicalUseDefinition) }], // A clinical condition for which the device was designed to be used
    "contraindication" : [{ CodeableReference(ClinicalUseDefinition) }], // A specific situation when a device should not be used because it may cause harm
    "warning" : [{ CodeableReference(ClinicalUseDefinition) }], // Specific hazard alert information that a user needs to know before using the device
    "intendedUse" : "<string>" // A description of the general purpose or medical use of the device or its function
  },
  "correctiveAction" : { // Tracking of latest field safety corrective action
    "recall" : <boolean>, // R!  Whether the corrective action was a recall
    "scope" : "<code>", // model | lot-numbers | serial-numbers
    "period" : { Period } // R!  Start and end dates of the  corrective action
  },
  "chargeItem" : [{ // Billing code or reference associated with the device
    "chargeItemCode" : { CodeableReference(ChargeItemDefinition) }, // R!  The code or reference for the charge item
    "count" : { Quantity }, // R!  Coefficient applicable to the billing code
    "effectivePeriod" : { Period }, // A specific time period in which this charge item applies
    "useContext" : [{ UsageContext }] // The context to which this charge item applies

  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:DeviceDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:

  fhir:DeviceDefinition.description [ markdown ]; # 0..1 Additional information to describe the device
  fhir:DeviceDefinition.identifier [ Identifier ], ... ; # 0..* Instance identifier

  fhir:DeviceDefinition.udiDeviceIdentifier [ # 0..* Unique Device Identifier (UDI) Barcode string
    fhir:

    fhir:DeviceDefinition.udiDeviceIdentifier.deviceIdentifier [ string ]; # 1..1 The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier

    fhir:DeviceDefinition.udiDeviceIdentifier.issuer [ uri ]; # 1..1 The organization that assigns the identifier algorithm
    fhir:DeviceDefinition.udiDeviceIdentifier.jurisdiction [ uri ]; # 1..1 The jurisdiction to which the deviceIdentifier applies
    fhir:DeviceDefinition.udiDeviceIdentifier.marketDistribution [ # 0..* Indicates whether and when the device is available on the market
      fhir:DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod [ Period ]; # 1..1 Begin and end dates for the commercial distribution of the device
      fhir:DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction [ uri ]; # 1..1 National state or territory where the device is commercialized
    ], ...;

  ], ...;
  # . One of these 2
    fhir: ]
    fhir:) ]
  fhir:
    fhir:

  fhir:DeviceDefinition.regulatoryIdentifier [ # 0..* Regulatory identifier(s) associated with this device
    fhir:DeviceDefinition.regulatoryIdentifier.type [ code ]; # 1..1 basic | master | license
    fhir:DeviceDefinition.regulatoryIdentifier.deviceIdentifier [ string ]; # 1..1 The identifier itself
    fhir:DeviceDefinition.regulatoryIdentifier.issuer [ uri ]; # 1..1 The organization that issued this identifier
    fhir:DeviceDefinition.regulatoryIdentifier.jurisdiction [ uri ]; # 1..1 The jurisdiction to which the deviceIdentifier applies
  ], ...;
  fhir:DeviceDefinition.partNumber [ string ]; # 0..1 The part number or catalog number of the device
  fhir:DeviceDefinition.manufacturer [ Reference(Organization) ]; # 0..1 Name of device manufacturer
  fhir:DeviceDefinition.deviceName [ # 0..* The name or names of the device as given by the manufacturer
    fhir:DeviceDefinition.deviceName.name [ string ]; # 1..1 A name that is used to refer to the device

    fhir:UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." class="dict">DeviceDefinition.deviceName.type

RegisteredName | UserFriendlyName | PatientReportedName." class="dict">DeviceDefinition.deviceName.type [ code ]; # 1..1 registered-name | user-friendly-name | patient-reported-name

  ], ...;
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:

  fhir:DeviceDefinition.modelNumber [ string ]; # 0..1 The catalog or model number for the device for example as defined by the manufacturer
  fhir:DeviceDefinition.classification [ # 0..* What kind of device or device system this is
    fhir:DeviceDefinition.classification.type [ CodeableConcept ]; # 1..1 A classification or risk class of the device model
    fhir:DeviceDefinition.classification.justification [ RelatedArtifact ], ... ; # 0..* Further information qualifying this classification of the device model
  ], ...;
  fhir:DeviceDefinition.specialization [ RelatedArtifact ], ... ; # 0..* The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication
  fhir:DeviceDefinition.hasPart [ # 0..* A device, part of the current one
    fhir:DeviceDefinition.hasPart.reference [ Reference(DeviceDefinition) ]; # 1..1 Reference to the part
    fhir:DeviceDefinition.hasPart.count [ integer ]; # 0..1 Number of occurrences of the part
  ], ...;
  fhir:DeviceDefinition.packaging [ # 0..* Information about the packaging of the device, i.e. how the device is packaged
    fhir:DeviceDefinition.packaging.identifier [ Identifier ]; # 0..1 Business identifier of the packaged medication
    fhir:DeviceDefinition.packaging.type [ CodeableConcept ]; # 0..1 A code that defines the specific type of packaging
    fhir:DeviceDefinition.packaging.count [ integer ]; # 0..1 The number of items contained in the package (devices or sub-packages)
    fhir:DeviceDefinition.packaging.distributor [ # 0..* An organization that distributes the packaged device
      fhir:DeviceDefinition.packaging.distributor.name [ string ]; # 0..1 Distributor's human-readable name
      fhir:DeviceDefinition.packaging.distributor.organizationReference [ Reference(Organization) ], ... ; # 0..* Distributor as an Organization resource
    ], ...;
    fhir:DeviceDefinition.packaging.udiDeviceIdentifier [ See DeviceDefinition.udiDeviceIdentifier ], ... ; # 0..* Unique Device Identifier (UDI) Barcode string on the packaging
    fhir:DeviceDefinition.packaging.packaging [ See DeviceDefinition.packaging ], ... ; # 0..* Allows packages within packages
  ], ...;
  fhir:DeviceDefinition.version [ # 0..* The version of the device or software
    fhir:DeviceDefinition.version.type [ CodeableConcept ]; # 0..1 The type of the device version, e.g. manufacturer, approved, internal
    fhir:DeviceDefinition.version.component [ Identifier ]; # 0..1 The hardware or software module of the device to which the version applies
    fhir:DeviceDefinition.version.value [ string ]; # 1..1 The version text

  ], ...;
  fhir:

  fhir:DeviceDefinition.safety [ CodeableConcept ], ... ; # 0..* Safety characteristics of the device
  fhir:DeviceDefinition.shelfLifeStorage [ ProductShelfLife ], ... ; # 0..* Shelf Life and storage information
  fhir:

  fhir:DeviceDefinition.languageCode [ CodeableConcept ], ... ; # 0..* Language code for the human-readable text strings produced by the device (all supported)
  fhir:
    fhir:
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:

  fhir:DeviceDefinition.property [ # 0..* The potential, valid configuration settings of a device, e.g., regulation status, time properties
    fhir:DeviceDefinition.property.type [ CodeableConcept ]; # 1..1 Code that specifies the property
    # DeviceDefinition.property.value[x] : 1..1 Property value - as a code or quantity. One of these 7
      fhir:DeviceDefinition.property.valueQuantity [ Quantity ]
      fhir:DeviceDefinition.property.valueCodeableConcept [ CodeableConcept ]
      fhir:DeviceDefinition.property.valueString [ string ]
      fhir:DeviceDefinition.property.valueBoolean [ boolean ]
      fhir:DeviceDefinition.property.valueInteger [ integer ]
      fhir:DeviceDefinition.property.valueRange [ Range ]
      fhir:DeviceDefinition.property.valueAttachment [ Attachment ]

  ], ...;
  fhir:DeviceDefinition.owner [ Reference(Organization) ]; # 0..1 Organization responsible for device
  fhir:DeviceDefinition.contact [ ContactPoint ], ... ; # 0..* Details for human/organization for support
  fhir:
  fhir:

  fhir:DeviceDefinition.link [ # 0..* An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device
    fhir:DeviceDefinition.link.relation [ Coding ]; # 1..1 The type indicates the relationship of the related device to the device instance
    fhir:DeviceDefinition.link.relatedDevice [ CodeableReference(DeviceDefinition) ]; # 1..1 A reference to the linked device
  ], ...;

  fhir:DeviceDefinition.note [ Annotation ], ... ; # 0..* Device notes and comments
  fhir:

  fhir:DeviceDefinition.parentDevice [ Reference(DeviceDefinition) ]; # 0..1 The parent device it can be part of
  fhir:DeviceDefinition.material [ # 0..* A substance used to create the material(s) of which the device is made
    fhir:

    fhir:DeviceDefinition.material.substance [ CodeableConcept ]; # 1..1 A relevant substance that the device contains, may contain, or is made of

    fhir:DeviceDefinition.material.alternate [ boolean ]; # 0..1 Indicates an alternative material of the device
    fhir:DeviceDefinition.material.allergenicIndicator [ boolean ]; # 0..1 Whether the substance is a known or suspected allergen
  ], ...;
  fhir:DeviceDefinition.productionIdentifierInUDI [ code ], ... ; # 0..* lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version
  fhir:DeviceDefinition.guideline [ # 0..1 Information aimed at providing directions for the usage of this model of device
    fhir:DeviceDefinition.guideline.useContext [ UsageContext ], ... ; # 0..* The circumstances that form the setting for using the device
    fhir:DeviceDefinition.guideline.usageInstruction [ markdown ]; # 0..1 Detailed written and visual directions for the user on how to use the device
    fhir:DeviceDefinition.guideline.relatedArtifact [ RelatedArtifact ], ... ; # 0..* A source of information or reference for this guideline
    fhir:DeviceDefinition.guideline.indication [ CodeableReference(ClinicalUseDefinition) ], ... ; # 0..* A clinical condition for which the device was designed to be used
    fhir:DeviceDefinition.guideline.contraindication [ CodeableReference(ClinicalUseDefinition) ], ... ; # 0..* A specific situation when a device should not be used because it may cause harm
    fhir:DeviceDefinition.guideline.warning [ CodeableReference(ClinicalUseDefinition) ], ... ; # 0..* Specific hazard alert information that a user needs to know before using the device
    fhir:DeviceDefinition.guideline.intendedUse [ string ]; # 0..1 A description of the general purpose or medical use of the device or its function
  ];
  fhir:DeviceDefinition.correctiveAction [ # 0..1 Tracking of latest field safety corrective action
    fhir:DeviceDefinition.correctiveAction.recall [ boolean ]; # 1..1 Whether the corrective action was a recall
    fhir:DeviceDefinition.correctiveAction.scope [ code ]; # 0..1 model | lot-numbers | serial-numbers
    fhir:DeviceDefinition.correctiveAction.period [ Period ]; # 1..1 Start and end dates of the  corrective action
  ];
  fhir:DeviceDefinition.chargeItem [ # 0..* Billing code or reference associated with the device
    fhir:DeviceDefinition.chargeItem.chargeItemCode [ CodeableReference(ChargeItemDefinition) ]; # 1..1 The code or reference for the charge item
    fhir:DeviceDefinition.chargeItem.count [ Quantity ]; # 1..1 Coefficient applicable to the billing code
    fhir:DeviceDefinition.chargeItem.effectivePeriod [ Period ]; # 0..1 A specific time period in which this charge item applies
    fhir:DeviceDefinition.chargeItem.useContext [ UsageContext ], ... ; # 0..* The context to which this charge item applies
  ], ...;

]

Changes since Release 4

DeviceDefinition
DeviceDefinition.description
  • No Changes Added Element
DeviceDefinition.udiDeviceIdentifier.marketDistribution
  • Added Element
DeviceDefinition.udiDeviceIdentifier.marketDistribution.marketPeriod
  • Added Mandatory Element
DeviceDefinition.udiDeviceIdentifier.marketDistribution.subJurisdiction
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier
  • Added Element
DeviceDefinition.regulatoryIdentifier.type
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier.deviceIdentifier
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier.issuer
  • Added Mandatory Element
DeviceDefinition.regulatoryIdentifier.jurisdiction
  • Added Mandatory Element
DeviceDefinition.partNumber
  • Added Element
DeviceDefinition.manufacturer
  • Added Element
DeviceDefinition.classification
  • Added Element
DeviceDefinition.classification.type
  • Added Mandatory Element
DeviceDefinition.classification.justification
  • Added Element
DeviceDefinition.specialization
  • Type changed from BackboneElement to RelatedArtifact
  • Type changed from BackboneElement to RelatedArtifact
DeviceDefinition.hasPart
  • Added Element
DeviceDefinition.hasPart.reference
  • Added Mandatory Element
DeviceDefinition.hasPart.count
  • Added Element
DeviceDefinition.packaging
  • Added Element
DeviceDefinition.packaging.identifier
  • Added Element
DeviceDefinition.packaging.type
  • Added Element
DeviceDefinition.packaging.count
  • Added Element
DeviceDefinition.packaging.distributor
  • Added Element
DeviceDefinition.packaging.distributor.name
  • Added Element
DeviceDefinition.packaging.distributor.organizationReference
  • Added Element
DeviceDefinition.packaging.udiDeviceIdentifier
  • Added Element
DeviceDefinition.packaging.packaging
  • Added Element
DeviceDefinition.version
  • Type changed from string to BackboneElement
  • Type changed from string to BackboneElement
DeviceDefinition.version.type
  • Added Element
DeviceDefinition.version.component
  • Added Element
DeviceDefinition.version.value
  • Added Mandatory Element
DeviceDefinition.property.value[x]
  • Added Mandatory Element
DeviceDefinition.link
  • Added Element
DeviceDefinition.link.relation
  • Added Mandatory Element
DeviceDefinition.link.relatedDevice
  • Added Mandatory Element
DeviceDefinition.productionIdentifierInUDI
  • Added Element
DeviceDefinition.guideline
  • Added Element
DeviceDefinition.guideline.useContext
  • Added Element
DeviceDefinition.guideline.usageInstruction
  • Added Element
DeviceDefinition.guideline.relatedArtifact
  • Added Element
DeviceDefinition.guideline.indication
  • Added Element
DeviceDefinition.guideline.contraindication
  • Added Element
DeviceDefinition.guideline.warning
  • Added Element
DeviceDefinition.guideline.intendedUse
  • Added Element
DeviceDefinition.correctiveAction
  • Added Element
DeviceDefinition.correctiveAction.recall
  • Added Mandatory Element
DeviceDefinition.correctiveAction.scope
  • Added Element
DeviceDefinition.correctiveAction.period
  • Added Mandatory Element
DeviceDefinition.chargeItem
  • Added Element
DeviceDefinition.chargeItem.chargeItemCode
  • Added Mandatory Element
DeviceDefinition.chargeItem.count
  • Added Mandatory Element
DeviceDefinition.chargeItem.effectivePeriod
  • Added Element
DeviceDefinition.chargeItem.useContext
  • Added Element
DeviceDefinition.manufacturer[x]
  • deleted
DeviceDefinition.type
  • deleted
DeviceDefinition.specialization.systemType
  • deleted
DeviceDefinition.specialization.version
  • deleted
DeviceDefinition.physicalCharacteristics
  • deleted
DeviceDefinition.capability
  • deleted
DeviceDefinition.property.valueQuantity
  • deleted
DeviceDefinition.property.valueCode
  • deleted
DeviceDefinition.url
  • deleted
DeviceDefinition.onlineInformation
  • deleted
DeviceDefinition.quantity
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

DeviceDefinition.type
Path Definition Type Reference
DeviceDefinition.regulatoryIdentifier.type

Regulatory Identifier type

Required DeviceDefinitionRegulatoryIdentifierType
DeviceDefinition.deviceName.type

The type of name the device is referred by.

Required DeviceNameType
DeviceDefinition.classification.type

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.

Example FHIRDeviceTypes DeviceType
DeviceDefinition.safety

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.

Example http://hl7.org/fhir/ValueSet/device-safety DeviceSafety
DeviceDefinition.link.relation

Description Needed Here

Extensible DeviceDefinitionRelationType
DeviceDefinition.productionIdentifierInUDI

Device Production Identifier in UDI

Required DeviceProductionIdentifierInUDI
DeviceDefinition.correctiveAction.scope

Device - Corrective action scope

Required DeviceCorrectiveActionScope

Search parameters for 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
identifier token The identifier of the component DeviceDefinition.identifier
parent reference The parent DeviceDefinition resource DeviceDefinition.parentDevice
( DeviceDefinition )
type token The device component type DeviceDefinition.type DeviceDefinition.classification.type