HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: Imaging Device

This profile on Device represents the imaging device.

Usage:

• Refer to this Resource Profile: Imaging Composition, ImagingStudy, Key images represented as an ImagingSelection and Imaging Procedure

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Device	C	0..*	Device	Item used in healthcare dev-1: only one Device.name.display SHALL be true when there is more than one Device.name dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
udiCarrier	SOΣ	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deviceIdentifier	SOΣ	1..1	string	Mandatory fixed portion of UDI ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
issuer	Σ	1..1	uri	UDI Issuing Organization ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | inactive | entered-in-error Binding: FHIRDeviceStatus (required): The record status of the device. ele-1: All FHIR elements must have a @value or children
name	SOC	0..1	BackboneElement	The name or names of the device as known to the manufacturer and/or patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
value	Σ	1..1	string	The term that names the device ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. ele-1: All FHIR elements must have a @value or children
display	?!ΣC	0..1	boolean	The preferred device name ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Device.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|5.0.0 from the FHIR Standard
Device.name.type	required	DeviceNameType http://hl7.org/fhir/ValueSet/device-nametype|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dev-1	error	Device	only one Device.name.display SHALL be true when there is more than one Device.name : name.where(display=true).count() <= 1
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Device	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Device	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Device	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Device

Name	Flags	Card.	Type	Description & Constraints
Device			Device
meta
security	S	0..*	Coding	Security Labels applied to this resource
language	S	0..1	code	Language of the resource content
udiCarrier	SO	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string Obligations Actor SHALL:populate-if-known IM Producer
deviceIdentifier	SO	1..1	string	Mandatory fixed portion of UDI Obligations Actor SHALL:populate-if-known IM Producer
status	S	1..1	code	active | inactive | entered-in-error
name	SO	0..1	BackboneElement	The name or names of the device as known to the manufacturer and/or patient Obligations Actor SHALL:populate-if-known IM Producer
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Device	C	0..*	Device	Item used in healthcare dev-1: only one Device.name.display SHALL be true when there is more than one Device.name
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Instance identifier
displayName		0..1	string	The name used to display by default when the device is referenced
definition		0..1	CodeableReference(DeviceDefinition)	The reference to the definition for the device
udiCarrier	SOΣ	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
deviceIdentifier	SOΣ	1..1	string	Mandatory fixed portion of UDI Obligations Actor SHALL:populate-if-known IM Producer
issuer	Σ	1..1	uri	UDI Issuing Organization
jurisdiction		0..1	uri	Regional UDI authority
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
carrierHRF	Σ	0..1	string	UDI Human Readable Barcode String
entryType		0..1	code	barcode | rfid | manual | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status	?!SΣ	1..1	code	active | inactive | entered-in-error Binding: FHIRDeviceStatus (required): The record status of the device.
availabilityStatus		0..1	CodeableConcept	lost | damaged | destroyed | available Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device.
biologicalSourceEvent		0..1	Identifier	An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
manufacturer		0..1	string	Name of device manufacturer
manufactureDate		0..1	dateTime	Date when the device was made
expirationDate		0..1	dateTime	Date and time of expiry of this device (if applicable)
lotNumber		0..1	string	Lot number of manufacture
serialNumber		0..1	string	Serial number assigned by the manufacturer
name	SOC	0..1	BackboneElement	The name or names of the device as known to the manufacturer and/or patient Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value	Σ	1..1	string	The term that names the device
type	Σ	1..1	code	registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by.
display	?!ΣC	0..1	boolean	The preferred device name
modelNumber		0..1	string	The manufacturer's model number for the device
partNumber		0..1	string	The part number or catalog number of the device
category		0..*	CodeableConcept	Indicates a high-level grouping of the device Binding: FHIRDeviceCategory (example): Categories of medical devices.
type		0..*	CodeableConcept	The kind or type of device Binding: DeviceType (example): Codes to identify medical devices.
version		0..*	BackboneElement	The actual design of the device or software version running on the device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device.
component		0..1	Identifier	The hardware or software module of the device to which the version applies
installDate		0..1	dateTime	The date the version was installed on the device
value		1..1	string	The version text
conformsTo		0..*	BackboneElement	Identifies the standards, specifications, or formal guidances for the capabilities supported by the device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
category		0..1	CodeableConcept	Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device.
specification		1..1	CodeableConcept	Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device.
version		0..1	string	Specific form or variant of the standard
property		0..*	BackboneElement	Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	Code that specifies the property being represented Binding: DeviceType (example): Device property type.
value[x]		1..1		Value of the property
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueAttachment			Attachment
mode		0..1	CodeableConcept	The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device.
cycle		0..1	Count	The series of occurrences that repeats during the operation of the device
duration		0..1	Duration	A measurement of time during the device's operation (e.g., days, hours, mins, etc.)
owner		0..1	Reference(Organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(Location)	Where the device is found
url		0..1	uri	Network address to contact device
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to electronic services provided by the device
gateway		0..*	CodeableReference(Device)	Linked device acting as a communication/data collector, translator or controller
note		0..*	Annotation	Device notes and comments
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device Binding: DeviceSafety (example)
parent		0..1	Reference(Device)	The higher level or encompassing device that this device is a logical part of
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Device.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Device.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Device.udiCarrier.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type|5.0.0 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|5.0.0 from the FHIR Standard
Device.availabilityStatus	extensible	FHIRDeviceAvailabilityStatus http://hl7.org/fhir/ValueSet/device-availability-status from the FHIR Standard
Device.name.type	required	DeviceNameType http://hl7.org/fhir/ValueSet/device-nametype|5.0.0 from the FHIR Standard
Device.category	example	FHIRDeviceCategory http://hl7.org/fhir/ValueSet/device-category from the FHIR Standard
Device.type	example	DeviceType http://hl7.org/fhir/ValueSet/device-type from the FHIR Standard
Device.version.type	example	DeviceVersionType http://hl7.org/fhir/ValueSet/device-versiontype from the FHIR Standard
Device.conformsTo.category	example	DeviceSpecificationCategory http://hl7.org/fhir/ValueSet/device-specification-category from the FHIR Standard
Device.conformsTo.specification	example	DeviceSpecificationType http://hl7.org/fhir/ValueSet/device-specification-type from the FHIR Standard
Device.property.type	example	DeviceType http://hl7.org/fhir/ValueSet/device-property-type from the FHIR Standard
Device.mode	example	FHIRDeviceOperationMode http://hl7.org/fhir/ValueSet/device-operation-mode from the FHIR Standard
Device.safety	example	DeviceSafety http://hl7.org/fhir/ValueSet/device-safety from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dev-1	error	Device	only one Device.name.display SHALL be true when there is more than one Device.name : name.where(display=true).count() <= 1
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Device	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Device	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Device	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 1 element
Must-Support: 6 elements

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Device	C	0..*	Device	Item used in healthcare dev-1: only one Device.name.display SHALL be true when there is more than one Device.name dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
udiCarrier	SOΣ	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deviceIdentifier	SOΣ	1..1	string	Mandatory fixed portion of UDI ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
issuer	Σ	1..1	uri	UDI Issuing Organization ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | inactive | entered-in-error Binding: FHIRDeviceStatus (required): The record status of the device. ele-1: All FHIR elements must have a @value or children
name	SOC	0..1	BackboneElement	The name or names of the device as known to the manufacturer and/or patient ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:populate-if-known IM Producer
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
value	Σ	1..1	string	The term that names the device ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. ele-1: All FHIR elements must have a @value or children
display	?!ΣC	0..1	boolean	The preferred device name ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Device.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|5.0.0 from the FHIR Standard
Device.name.type	required	DeviceNameType http://hl7.org/fhir/ValueSet/device-nametype|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dev-1	error	Device	only one Device.name.display SHALL be true when there is more than one Device.name : name.where(display=true).count() <= 1
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Device	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Device	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Device	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Device

Name	Flags	Card.	Type	Description & Constraints
Device			Device
meta
security	S	0..*	Coding	Security Labels applied to this resource
language	S	0..1	code	Language of the resource content
udiCarrier	SO	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string Obligations Actor SHALL:populate-if-known IM Producer
deviceIdentifier	SO	1..1	string	Mandatory fixed portion of UDI Obligations Actor SHALL:populate-if-known IM Producer
status	S	1..1	code	active | inactive | entered-in-error
name	SO	0..1	BackboneElement	The name or names of the device as known to the manufacturer and/or patient Obligations Actor SHALL:populate-if-known IM Producer
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Device	C	0..*	Device	Item used in healthcare dev-1: only one Device.name.display SHALL be true when there is more than one Device.name
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	SΣ	0..*	Coding	Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language	S	0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Instance identifier
displayName		0..1	string	The name used to display by default when the device is referenced
definition		0..1	CodeableReference(DeviceDefinition)	The reference to the definition for the device
udiCarrier	SOΣ	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
deviceIdentifier	SOΣ	1..1	string	Mandatory fixed portion of UDI Obligations Actor SHALL:populate-if-known IM Producer
issuer	Σ	1..1	uri	UDI Issuing Organization
jurisdiction		0..1	uri	Regional UDI authority
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
carrierHRF	Σ	0..1	string	UDI Human Readable Barcode String
entryType		0..1	code	barcode | rfid | manual | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status	?!SΣ	1..1	code	active | inactive | entered-in-error Binding: FHIRDeviceStatus (required): The record status of the device.
availabilityStatus		0..1	CodeableConcept	lost | damaged | destroyed | available Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device.
biologicalSourceEvent		0..1	Identifier	An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
manufacturer		0..1	string	Name of device manufacturer
manufactureDate		0..1	dateTime	Date when the device was made
expirationDate		0..1	dateTime	Date and time of expiry of this device (if applicable)
lotNumber		0..1	string	Lot number of manufacture
serialNumber		0..1	string	Serial number assigned by the manufacturer
name	SOC	0..1	BackboneElement	The name or names of the device as known to the manufacturer and/or patient Obligations Actor SHALL:populate-if-known IM Producer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
value	Σ	1..1	string	The term that names the device
type	Σ	1..1	code	registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by.
display	?!ΣC	0..1	boolean	The preferred device name
modelNumber		0..1	string	The manufacturer's model number for the device
partNumber		0..1	string	The part number or catalog number of the device
category		0..*	CodeableConcept	Indicates a high-level grouping of the device Binding: FHIRDeviceCategory (example): Categories of medical devices.
type		0..*	CodeableConcept	The kind or type of device Binding: DeviceType (example): Codes to identify medical devices.
version		0..*	BackboneElement	The actual design of the device or software version running on the device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device.
component		0..1	Identifier	The hardware or software module of the device to which the version applies
installDate		0..1	dateTime	The date the version was installed on the device
value		1..1	string	The version text
conformsTo		0..*	BackboneElement	Identifies the standards, specifications, or formal guidances for the capabilities supported by the device
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
category		0..1	CodeableConcept	Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device.
specification		1..1	CodeableConcept	Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device.
version		0..1	string	Specific form or variant of the standard
property		0..*	BackboneElement	Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	Code that specifies the property being represented Binding: DeviceType (example): Device property type.
value[x]		1..1		Value of the property
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueAttachment			Attachment
mode		0..1	CodeableConcept	The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device.
cycle		0..1	Count	The series of occurrences that repeats during the operation of the device
duration		0..1	Duration	A measurement of time during the device's operation (e.g., days, hours, mins, etc.)
owner		0..1	Reference(Organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(Location)	Where the device is found
url		0..1	uri	Network address to contact device
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to electronic services provided by the device
gateway		0..*	CodeableReference(Device)	Linked device acting as a communication/data collector, translator or controller
note		0..*	Annotation	Device notes and comments
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device Binding: DeviceSafety (example)
parent		0..1	Reference(Device)	The higher level or encompassing device that this device is a logical part of
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.meta.security	extensible	AllSecurityLabels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Device.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Device.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Device.udiCarrier.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type|5.0.0 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|5.0.0 from the FHIR Standard
Device.availabilityStatus	extensible	FHIRDeviceAvailabilityStatus http://hl7.org/fhir/ValueSet/device-availability-status from the FHIR Standard
Device.name.type	required	DeviceNameType http://hl7.org/fhir/ValueSet/device-nametype|5.0.0 from the FHIR Standard
Device.category	example	FHIRDeviceCategory http://hl7.org/fhir/ValueSet/device-category from the FHIR Standard
Device.type	example	DeviceType http://hl7.org/fhir/ValueSet/device-type from the FHIR Standard
Device.version.type	example	DeviceVersionType http://hl7.org/fhir/ValueSet/device-versiontype from the FHIR Standard
Device.conformsTo.category	example	DeviceSpecificationCategory http://hl7.org/fhir/ValueSet/device-specification-category from the FHIR Standard
Device.conformsTo.specification	example	DeviceSpecificationType http://hl7.org/fhir/ValueSet/device-specification-type from the FHIR Standard
Device.property.type	example	DeviceType http://hl7.org/fhir/ValueSet/device-property-type from the FHIR Standard
Device.mode	example	FHIRDeviceOperationMode http://hl7.org/fhir/ValueSet/device-operation-mode from the FHIR Standard
Device.safety	example	DeviceSafety http://hl7.org/fhir/ValueSet/device-safety from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dev-1	error	Device	only one Device.name.display SHALL be true when there is more than one Device.name : name.where(display=true).count() <= 1
dom-2	error	Device	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Device	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Device	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Device	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Device	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Device

Summary

Mandatory: 1 element
Must-Support: 6 elements

Maturity: 1

Other representations of profile: CSV, Excel, Schematron