Current Build

8.15 Resource DeviceDefinition - Content

Orders and Observations Work GroupMaturity Level: 0 Trial Use Compartments: Not linked to any defined compartments

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

The DeviceDefinition resource is used to describe the characteristics and capabilities of a medical device.

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

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

This resource is referenced by device

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition TUDomainResourceAn instance of a medical-related component of a medical device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierInstance identifier
... udiDeviceIdentifier 0..*BackboneElementThe UDI device identification for the device
.... deviceIdentifier 1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer 1..1uriThe organizaiton that issued that deviceIdentifier
.... jurisdiction 1..1uriThe juridication to which the deviceIdentifier applies
... manufacturer 0..1stringName of device manufacturer
... deviceName 0..*BackboneElementThe name of the device as given by the manufacturer
.... name 1..1stringThe name of the device
.... type 1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
DeviceNameType (Required)
... modelNumber 0..1stringThe model number for the device
... type 0..1CodeableConcepttype1 | type2 | type3 | other
DeviceType (Required)
... specialization 0..*BackboneElementThe name of the device as given by the manufacturer
.... systemType 1..1stringThe name of the device
.... version 0..1stringThe standard that is used to operate and communicate
... version 0..*stringThe actual design of the device or software version running on the device
... safety Σ0..*CodeableConceptSafety characteristics of the device
... languageCode 0..*CodeableConceptLanguage code for the human-readable text strings produced by the device (all supported)
... capability 0..*BackboneElementDevice capabilities
.... type 1..1CodeableConceptType of capability
.... description 0..*CodeableConceptDescription of capability
... property 0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... type 1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuanity 0..*QuantityProperty value as a quantity
.... valueCode 0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP)
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... url 0..1uriNetwork address to contact device
... onlineInformation 0..1uriAccess to on-line information
... note 0..*AnnotationDevice notes and comments
... partOf 0..*BackboneElementThe device that this component can be part of
... parentDevice Σ0..1Reference(DeviceDefinition)The parent device it can be part of

doco Documentation for this format

UML Diagram (Legend)

DeviceDefinition (DomainResource)Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle IDidentifier : Identifier [0..*]A name of the manufacturermanufacturer : string [0..1]The model number for the devicemodelNumber : string [0..1]What kind of device or device system this istype : CodeableConcept [0..1] « Type of device e.g. according to official classification. (Strength=Required)DeviceType! »The actual design of the device or software version running on the deviceversion : string [0..*]Safety characteristics of the devicesafety : CodeableConcept [0..*]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 deviceowner : Reference [0..1] « Organization »Contact details for an organization or a particular human that is responsible for the devicecontact : ContactPoint [0..*]A network address on which the device may be contacted directlyurl : uri [0..1]Access to on-line information about the deviceonlineInformation : uri [0..1]Descriptive information, usage information or implantation information that is not captured in an existing elementnote : Annotation [0..*]The device that this component can be part of - a parent devicepartOf : BackboneElement [0..*]The parent device it can be part ofparentDevice : Reference [0..1] « DeviceDefinition »UdiDeviceIdentifierThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifierdeviceIdentifier : string [1..1]The organizaiton that issued that deviceIdentifierissuer : uri [1..1]The juridication to which the deviceIdentifier appliesjurisdiction : uri [1..1]DeviceNameThe name of the devicename : string [1..1]The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelNametype : code [1..1] « The type of name the device is referred by. (Strength=Required)DeviceNameType! »SpecializationThe name of the devicesystemType : string [1..1]The standard that is used to operate and communicate. Example vocabulary: 11073 MDCversion : string [0..1]CapabilityType of capabilitytype : CodeableConcept [1..1]Description of capabilitydescription : CodeableConcept [0..*]PropertyCode that specifies the property DeviceDefinitionPropetyCode (Extensible)type : CodeableConcept [1..1]Property value as a quantityvalueQuanity : Quantity [0..*]Property value as a code, e.g., NTP4 (synced to NTP)valueCode : CodeableConcept [0..*]The UDI device identification for the deviceudiDeviceIdentifier[0..*]This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinitiondeviceName[0..*]This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinitionspecialization[0..*]Device capabilitiescapability[0..*]The actual configuration settings of a device as it actually operates, e.g., regulation status, time propertiesproperty[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><!-- 0..* Identifier Instance identifier --></identifier>
 <udiDeviceIdentifier>  <!-- 0..* The UDI device identification for the device -->
  <deviceIdentifier value="[string]"/><!-- 1..1 The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier -->
  <issuer value="[uri]"/><!-- 1..1 The organizaiton that issued that deviceIdentifier -->
  <jurisdiction value="[uri]"/><!-- 1..1 The juridication to which the deviceIdentifier applies -->
 </udiDeviceIdentifier>
 <manufacturer value="[string]"/><!-- 0..1 Name of device manufacturer -->
 <deviceName>  <!-- 0..* The name of the device as given by the manufacturer -->
  <name value="[string]"/><!-- 1..1 The name of the device -->
  <type value="[code]"/><!-- 1..1 udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other -->
 </deviceName>
 <modelNumber value="[string]"/><!-- 0..1 The model number for the device -->
 <type><!-- 0..1 CodeableConcept type1 | type2 | type3 | other --></type>
 <specialization>  <!-- 0..* The name of the device as given by the manufacturer -->
  <systemType value="[string]"/><!-- 1..1 The name of the device -->
  <version value="[string]"/><!-- 0..1 The standard that is used to operate and communicate -->
 </specialization>
 <version value="[string]"/><!-- 0..* The actual design of the device or software version running on the device -->
 <safety><!-- 0..* CodeableConcept Safety characteristics of the device --></safety>
 <languageCode><!-- 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported) --></languageCode>
 <capability>  <!-- 0..* Device capabilities -->
  <type><!-- 1..1 CodeableConcept Type of capability --></type>
  <description><!-- 0..* CodeableConcept Description of capability --></description>
 </capability>
 <property>  <!-- 0..* The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties -->
  <type><!-- 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible) --></type>
  <valueQuanity><!-- 0..* Quantity Property value as a quantity --></valueQuanity>
  <valueCode><!-- 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP) --></valueCode>
 </property>
 <owner><!-- 0..1 Reference(Organization) Organization responsible for device --></owner>
 <contact><!-- 0..* ContactPoint Details for human/organization for support --></contact>
 <url value="[uri]"/><!-- 0..1 Network address to contact device -->
 <onlineInformation value="[uri]"/><!-- 0..1 Access to on-line information -->
 <note><!-- 0..* Annotation Device notes and comments --></note>
 <partOf><!-- 0..* BackboneElement The device that this component can be part of --></partOf>
 <parentDevice><!-- 0..1 Reference(DeviceDefinition) The parent device it can be part of --></parentDevice>
</DeviceDefinition>

JSON Template

{doco
  "resourceType" : "DeviceDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Instance identifier
  "udiDeviceIdentifier" : [{ // The UDI device identification for the device
    "deviceIdentifier" : "<string>", // R!  The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
    "issuer" : "<uri>", // R!  The organizaiton that issued that deviceIdentifier
    "jurisdiction" : "<uri>" // R!  The juridication to which the deviceIdentifier applies
  }],
  "manufacturer" : "<string>", // Name of device manufacturer
  "deviceName" : [{ // The name of the device as given by the manufacturer
    "name" : "<string>", // R!  The name of the device
    "type" : "<code>" // R!  udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
  }],
  "modelNumber" : "<string>", // The model number for the device
  "type" : { CodeableConcept }, // type1 | type2 | type3 | other
  "specialization" : [{ // The name of the device as given by the manufacturer
    "systemType" : "<string>", // R!  The name of the device
    "version" : "<string>" // The standard that is used to operate and communicate
  }],
  "version" : ["<string>"], // The actual design of the device or software version running on the device
  "safety" : [{ CodeableConcept }], // Safety characteristics of the device
  "languageCode" : [{ CodeableConcept }], // Language code for the human-readable text strings produced by the device (all supported)
  "capability" : [{ // Device capabilities
    "type" : { CodeableConcept }, // R!  Type of capability
    "description" : [{ CodeableConcept }] // Description of capability
  }],
  "property" : [{ // The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
    "type" : { CodeableConcept }, // R!  Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
    "valueQuanity" : [{ Quantity }], // Property value as a quantity
    "valueCode" : [{ CodeableConcept }] // Property value as a code, e.g., NTP4 (synced to NTP)
  }],
  "owner" : { Reference(Organization) }, // Organization responsible for device
  "contact" : [{ ContactPoint }], // Details for human/organization for support
  "url" : "<uri>", // Network address to contact device
  "onlineInformation" : "<uri>", // Access to on-line information
  "note" : [{ Annotation }], // Device notes and comments
  "partOf" : [{ BackboneElement }], // The device that this component can be part of
  "parentDevice" : { Reference(DeviceDefinition) } // The parent device it can be part of
}

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:DeviceDefinition.identifier [ Identifier ], ... ; # 0..* Instance identifier
  fhir:DeviceDefinition.udiDeviceIdentifier [ # 0..* The UDI device identification for the device
    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 jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
    fhir:DeviceDefinition.udiDeviceIdentifier.issuer [ uri ]; # 1..1 The organizaiton that issued that deviceIdentifier
    fhir:DeviceDefinition.udiDeviceIdentifier.jurisdiction [ uri ]; # 1..1 The juridication to which the deviceIdentifier applies
  ], ...;
  fhir:DeviceDefinition.manufacturer [ string ]; # 0..1 Name of device manufacturer
  fhir:DeviceDefinition.deviceName [ # 0..* The name of the device as given by the manufacturer
    fhir:DeviceDefinition.deviceName.name [ string ]; # 1..1 The name of the device
    fhir:DeviceDefinition.deviceName.type [ code ]; # 1..1 udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
  ], ...;
  fhir:DeviceDefinition.modelNumber [ string ]; # 0..1 The model number for the device
  fhir:DeviceDefinition.type [ CodeableConcept ]; # 0..1 type1 | type2 | type3 | other
  fhir:DeviceDefinition.specialization [ # 0..* The name of the device as given by the manufacturer
    fhir:DeviceDefinition.specialization.systemType [ string ]; # 1..1 The name of the device
    fhir:DeviceDefinition.specialization.version [ string ]; # 0..1 The standard that is used to operate and communicate
  ], ...;
  fhir:DeviceDefinition.version [ string ], ... ; # 0..* The actual design of the device or software version running on the device
  fhir:DeviceDefinition.safety [ CodeableConcept ], ... ; # 0..* Safety characteristics of the device
  fhir:DeviceDefinition.languageCode [ CodeableConcept ], ... ; # 0..* Language code for the human-readable text strings produced by the device (all supported)
  fhir:DeviceDefinition.capability [ # 0..* Device capabilities
    fhir:DeviceDefinition.capability.type [ CodeableConcept ]; # 1..1 Type of capability
    fhir:DeviceDefinition.capability.description [ CodeableConcept ], ... ; # 0..* Description of capability
  ], ...;
  fhir:DeviceDefinition.property [ # 0..* The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
    fhir:DeviceDefinition.property.type [ CodeableConcept ]; # 1..1 Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
    fhir:DeviceDefinition.property.valueQuanity [ Quantity ], ... ; # 0..* Property value as a quantity
    fhir:DeviceDefinition.property.valueCode [ CodeableConcept ], ... ; # 0..* Property value as a code, e.g., NTP4 (synced to NTP)
  ], ...;
  fhir:DeviceDefinition.owner [ Reference(Organization) ]; # 0..1 Organization responsible for device
  fhir:DeviceDefinition.contact [ ContactPoint ], ... ; # 0..* Details for human/organization for support
  fhir:DeviceDefinition.url [ uri ]; # 0..1 Network address to contact device
  fhir:DeviceDefinition.onlineInformation [ uri ]; # 0..1 Access to on-line information
  fhir:DeviceDefinition.note [ Annotation ], ... ; # 0..* Device notes and comments
  fhir:DeviceDefinition.partOf [ BackboneElement ], ... ; # 0..* The device that this component can be part of
  fhir:DeviceDefinition.parentDevice [ Reference(DeviceDefinition) ]; # 0..1 The parent device it can be part of
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition TUDomainResourceAn instance of a medical-related component of a medical device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierInstance identifier
... udiDeviceIdentifier 0..*BackboneElementThe UDI device identification for the device
.... deviceIdentifier 1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer 1..1uriThe organizaiton that issued that deviceIdentifier
.... jurisdiction 1..1uriThe juridication to which the deviceIdentifier applies
... manufacturer 0..1stringName of device manufacturer
... deviceName 0..*BackboneElementThe name of the device as given by the manufacturer
.... name 1..1stringThe name of the device
.... type 1..1codeudi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
DeviceNameType (Required)
... modelNumber 0..1stringThe model number for the device
... type 0..1CodeableConcepttype1 | type2 | type3 | other
DeviceType (Required)
... specialization 0..*BackboneElementThe name of the device as given by the manufacturer
.... systemType 1..1stringThe name of the device
.... version 0..1stringThe standard that is used to operate and communicate
... version 0..*stringThe actual design of the device or software version running on the device
... safety Σ0..*CodeableConceptSafety characteristics of the device
... languageCode 0..*CodeableConceptLanguage code for the human-readable text strings produced by the device (all supported)
... capability 0..*BackboneElementDevice capabilities
.... type 1..1CodeableConceptType of capability
.... description 0..*CodeableConceptDescription of capability
... property 0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
.... type 1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... valueQuanity 0..*QuantityProperty value as a quantity
.... valueCode 0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP)
... owner 0..1Reference(Organization)Organization responsible for device
... contact 0..*ContactPointDetails for human/organization for support
... url 0..1uriNetwork address to contact device
... onlineInformation 0..1uriAccess to on-line information
... note 0..*AnnotationDevice notes and comments
... partOf 0..*BackboneElementThe device that this component can be part of
... parentDevice Σ0..1Reference(DeviceDefinition)The parent device it can be part of

doco Documentation for this format

UML Diagram (Legend)

DeviceDefinition (DomainResource)Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle IDidentifier : Identifier [0..*]A name of the manufacturermanufacturer : string [0..1]The model number for the devicemodelNumber : string [0..1]What kind of device or device system this istype : CodeableConcept [0..1] « Type of device e.g. according to official classification. (Strength=Required)DeviceType! »The actual design of the device or software version running on the deviceversion : string [0..*]Safety characteristics of the devicesafety : CodeableConcept [0..*]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 deviceowner : Reference [0..1] « Organization »Contact details for an organization or a particular human that is responsible for the devicecontact : ContactPoint [0..*]A network address on which the device may be contacted directlyurl : uri [0..1]Access to on-line information about the deviceonlineInformation : uri [0..1]Descriptive information, usage information or implantation information that is not captured in an existing elementnote : Annotation [0..*]The device that this component can be part of - a parent devicepartOf : BackboneElement [0..*]The parent device it can be part ofparentDevice : Reference [0..1] « DeviceDefinition »UdiDeviceIdentifierThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifierdeviceIdentifier : string [1..1]The organizaiton that issued that deviceIdentifierissuer : uri [1..1]The juridication to which the deviceIdentifier appliesjurisdiction : uri [1..1]DeviceNameThe name of the devicename : string [1..1]The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelNametype : code [1..1] « The type of name the device is referred by. (Strength=Required)DeviceNameType! »SpecializationThe name of the devicesystemType : string [1..1]The standard that is used to operate and communicate. Example vocabulary: 11073 MDCversion : string [0..1]CapabilityType of capabilitytype : CodeableConcept [1..1]Description of capabilitydescription : CodeableConcept [0..*]PropertyCode that specifies the property DeviceDefinitionPropetyCode (Extensible)type : CodeableConcept [1..1]Property value as a quantityvalueQuanity : Quantity [0..*]Property value as a code, e.g., NTP4 (synced to NTP)valueCode : CodeableConcept [0..*]The UDI device identification for the deviceudiDeviceIdentifier[0..*]This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinitiondeviceName[0..*]This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinitionspecialization[0..*]Device capabilitiescapability[0..*]The actual configuration settings of a device as it actually operates, e.g., regulation status, time propertiesproperty[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><!-- 0..* Identifier Instance identifier --></identifier>
 <udiDeviceIdentifier>  <!-- 0..* The UDI device identification for the device -->
  <deviceIdentifier value="[string]"/><!-- 1..1 The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier -->
  <issuer value="[uri]"/><!-- 1..1 The organizaiton that issued that deviceIdentifier -->
  <jurisdiction value="[uri]"/><!-- 1..1 The juridication to which the deviceIdentifier applies -->
 </udiDeviceIdentifier>
 <manufacturer value="[string]"/><!-- 0..1 Name of device manufacturer -->
 <deviceName>  <!-- 0..* The name of the device as given by the manufacturer -->
  <name value="[string]"/><!-- 1..1 The name of the device -->
  <type value="[code]"/><!-- 1..1 udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other -->
 </deviceName>
 <modelNumber value="[string]"/><!-- 0..1 The model number for the device -->
 <type><!-- 0..1 CodeableConcept type1 | type2 | type3 | other --></type>
 <specialization>  <!-- 0..* The name of the device as given by the manufacturer -->
  <systemType value="[string]"/><!-- 1..1 The name of the device -->
  <version value="[string]"/><!-- 0..1 The standard that is used to operate and communicate -->
 </specialization>
 <version value="[string]"/><!-- 0..* The actual design of the device or software version running on the device -->
 <safety><!-- 0..* CodeableConcept Safety characteristics of the device --></safety>
 <languageCode><!-- 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported) --></languageCode>
 <capability>  <!-- 0..* Device capabilities -->
  <type><!-- 1..1 CodeableConcept Type of capability --></type>
  <description><!-- 0..* CodeableConcept Description of capability --></description>
 </capability>
 <property>  <!-- 0..* The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties -->
  <type><!-- 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible) --></type>
  <valueQuanity><!-- 0..* Quantity Property value as a quantity --></valueQuanity>
  <valueCode><!-- 0..* CodeableConcept Property value as a code, e.g., NTP4 (synced to NTP) --></valueCode>
 </property>
 <owner><!-- 0..1 Reference(Organization) Organization responsible for device --></owner>
 <contact><!-- 0..* ContactPoint Details for human/organization for support --></contact>
 <url value="[uri]"/><!-- 0..1 Network address to contact device -->
 <onlineInformation value="[uri]"/><!-- 0..1 Access to on-line information -->
 <note><!-- 0..* Annotation Device notes and comments --></note>
 <partOf><!-- 0..* BackboneElement The device that this component can be part of --></partOf>
 <parentDevice><!-- 0..1 Reference(DeviceDefinition) The parent device it can be part of --></parentDevice>
</DeviceDefinition>

JSON Template

{doco
  "resourceType" : "DeviceDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Instance identifier
  "udiDeviceIdentifier" : [{ // The UDI device identification for the device
    "deviceIdentifier" : "<string>", // R!  The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
    "issuer" : "<uri>", // R!  The organizaiton that issued that deviceIdentifier
    "jurisdiction" : "<uri>" // R!  The juridication to which the deviceIdentifier applies
  }],
  "manufacturer" : "<string>", // Name of device manufacturer
  "deviceName" : [{ // The name of the device as given by the manufacturer
    "name" : "<string>", // R!  The name of the device
    "type" : "<code>" // R!  udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
  }],
  "modelNumber" : "<string>", // The model number for the device
  "type" : { CodeableConcept }, // type1 | type2 | type3 | other
  "specialization" : [{ // The name of the device as given by the manufacturer
    "systemType" : "<string>", // R!  The name of the device
    "version" : "<string>" // The standard that is used to operate and communicate
  }],
  "version" : ["<string>"], // The actual design of the device or software version running on the device
  "safety" : [{ CodeableConcept }], // Safety characteristics of the device
  "languageCode" : [{ CodeableConcept }], // Language code for the human-readable text strings produced by the device (all supported)
  "capability" : [{ // Device capabilities
    "type" : { CodeableConcept }, // R!  Type of capability
    "description" : [{ CodeableConcept }] // Description of capability
  }],
  "property" : [{ // The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
    "type" : { CodeableConcept }, // R!  Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
    "valueQuanity" : [{ Quantity }], // Property value as a quantity
    "valueCode" : [{ CodeableConcept }] // Property value as a code, e.g., NTP4 (synced to NTP)
  }],
  "owner" : { Reference(Organization) }, // Organization responsible for device
  "contact" : [{ ContactPoint }], // Details for human/organization for support
  "url" : "<uri>", // Network address to contact device
  "onlineInformation" : "<uri>", // Access to on-line information
  "note" : [{ Annotation }], // Device notes and comments
  "partOf" : [{ BackboneElement }], // The device that this component can be part of
  "parentDevice" : { Reference(DeviceDefinition) } // The parent device it can be part of
}

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:DeviceDefinition.identifier [ Identifier ], ... ; # 0..* Instance identifier
  fhir:DeviceDefinition.udiDeviceIdentifier [ # 0..* The UDI device identification for the device
    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 jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
    fhir:DeviceDefinition.udiDeviceIdentifier.issuer [ uri ]; # 1..1 The organizaiton that issued that deviceIdentifier
    fhir:DeviceDefinition.udiDeviceIdentifier.jurisdiction [ uri ]; # 1..1 The juridication to which the deviceIdentifier applies
  ], ...;
  fhir:DeviceDefinition.manufacturer [ string ]; # 0..1 Name of device manufacturer
  fhir:DeviceDefinition.deviceName [ # 0..* The name of the device as given by the manufacturer
    fhir:DeviceDefinition.deviceName.name [ string ]; # 1..1 The name of the device
    fhir:DeviceDefinition.deviceName.type [ code ]; # 1..1 udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
  ], ...;
  fhir:DeviceDefinition.modelNumber [ string ]; # 0..1 The model number for the device
  fhir:DeviceDefinition.type [ CodeableConcept ]; # 0..1 type1 | type2 | type3 | other
  fhir:DeviceDefinition.specialization [ # 0..* The name of the device as given by the manufacturer
    fhir:DeviceDefinition.specialization.systemType [ string ]; # 1..1 The name of the device
    fhir:DeviceDefinition.specialization.version [ string ]; # 0..1 The standard that is used to operate and communicate
  ], ...;
  fhir:DeviceDefinition.version [ string ], ... ; # 0..* The actual design of the device or software version running on the device
  fhir:DeviceDefinition.safety [ CodeableConcept ], ... ; # 0..* Safety characteristics of the device
  fhir:DeviceDefinition.languageCode [ CodeableConcept ], ... ; # 0..* Language code for the human-readable text strings produced by the device (all supported)
  fhir:DeviceDefinition.capability [ # 0..* Device capabilities
    fhir:DeviceDefinition.capability.type [ CodeableConcept ]; # 1..1 Type of capability
    fhir:DeviceDefinition.capability.description [ CodeableConcept ], ... ; # 0..* Description of capability
  ], ...;
  fhir:DeviceDefinition.property [ # 0..* The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
    fhir:DeviceDefinition.property.type [ CodeableConcept ]; # 1..1 Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
    fhir:DeviceDefinition.property.valueQuanity [ Quantity ], ... ; # 0..* Property value as a quantity
    fhir:DeviceDefinition.property.valueCode [ CodeableConcept ], ... ; # 0..* Property value as a code, e.g., NTP4 (synced to NTP)
  ], ...;
  fhir:DeviceDefinition.owner [ Reference(Organization) ]; # 0..1 Organization responsible for device
  fhir:DeviceDefinition.contact [ ContactPoint ], ... ; # 0..* Details for human/organization for support
  fhir:DeviceDefinition.url [ uri ]; # 0..1 Network address to contact device
  fhir:DeviceDefinition.onlineInformation [ uri ]; # 0..1 Access to on-line information
  fhir:DeviceDefinition.note [ Annotation ], ... ; # 0..* Device notes and comments
  fhir:DeviceDefinition.partOf [ BackboneElement ], ... ; # 0..* The device that this component can be part of
  fhir:DeviceDefinition.parentDevice [ Reference(DeviceDefinition) ]; # 0..1 The parent device it can be part of
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

PathDefinitionTypeReference
DeviceDefinition.deviceName.type The type of name the device is referred by.RequiredDeviceNameType
DeviceDefinition.type Type of device e.g. according to official classification.RequiredDeviceType

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
identifiertokenThe identifier of the componentDeviceDefinition.identifier
parentreferenceThe parent DeviceDefinition resourceDeviceDefinition.parentDevice
(DeviceDefinition)
typetokenThe device component typeDeviceDefinition.type