This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: Device (IPS)

This profile represents the constraints applied to the Device resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A device used by or implanted on the patient is described in the patient summary as an instance of a Device resource constrained by this profile.

This profile constrains the representation of a medical device used by or impanted on the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.

Usage:

• Refer to this Resource Profile:

Formal Views of Profile Content

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

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

This structure is derived from Device

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	Item used in healthcare
type	S	0..1	CodeableConceptIPS	Type of device. Preferably valued by using SNOMED CT. The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: Medical Devices - SNOMED CT + Absent/Unknown - IPS (preferred): The type of device or a code for absent/unknown device Additional Bindings Purpose Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Absent or Unknown Devices - IPS Candidate Validation Binding
patient	S	1..1	Reference(Patient (IPS))	Patient to whom Device is affixed
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Device.type	preferred	MedicalDevicesSnomedAbsentUnknownUvIps Additional Bindings Purpose Documentation Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Codes for medical devices in SNOMED IPS Free Set Absent or Unknown Devices - IPS Candidate Validation Binding Codes for absent or unknown medical devices

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	Item used in healthcare
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
type	S	0..1	CodeableConceptIPS	Type of device. Preferably valued by using SNOMED CT. The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: Medical Devices - SNOMED CT + Absent/Unknown - IPS (preferred): The type of device or a code for absent/unknown device Additional Bindings Purpose Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Absent or Unknown Devices - IPS Candidate Validation Binding
patient	S	1..1	Reference(Patient (IPS))	Patient to whom Device is affixed
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Device.status	required	FHIRDeviceStatus
Device.type	preferred	MedicalDevicesSnomedAbsentUnknownUvIps Additional Bindings Purpose Documentation Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Codes for medical devices in SNOMED IPS Free Set Absent or Unknown Devices - IPS Candidate Validation Binding Codes for absent or unknown medical devices

Constraints

Id	Grade	Path(s)	Details	Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	Item used in healthcare
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
definition		0..1	Reference(DeviceDefinition)	The reference to the definition for the device
udiCarrier	Σ	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string
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	Σ	0..1	string	Mandatory fixed portion of UDI
issuer		0..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 + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason		0..*	CodeableConcept	online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier		0..1	string	The distinct identification string
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
deviceName		0..*	BackboneElement	The name of the device as given by the manufacturer
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
name		1..1	string	The name of the device
type		1..1	code	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
modelNumber		0..1	string	The model number for the device
partNumber		0..1	string	The part number of the device
type	S	0..1	CodeableConceptIPS	Type of device. Preferably valued by using SNOMED CT. The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: Medical Devices - SNOMED CT + Absent/Unknown - IPS (preferred): The type of device or a code for absent/unknown device Additional Bindings Purpose Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Absent or Unknown Devices - IPS Candidate Validation Binding
specialization		0..*	BackboneElement	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
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
systemType		1..1	CodeableConcept	The standard that is used to operate and communicate
version		0..1	string	The version of the standard that is used to operate and communicate
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
component		0..1	Identifier	A single component of the device version
value		1..1	string	The version text
property		0..*	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
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 DeviceDefinitionPropetyCode (Extensible)
valueQuantity		0..*	Quantity	Property value as a quantity
valueCode		0..*	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP)
patient	S	1..1	Reference(Patient (IPS))	Patient to whom Device is affixed
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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
note		0..*	Annotation	Device notes and comments
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device
parent		0..1	Reference(Device)	The parent device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Device.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Device.udiCarrier.entryType	required	UDIEntryType
Device.status	required	FHIRDeviceStatus
Device.statusReason	extensible	FHIRDeviceStatusReason
Device.deviceName.type	required	DeviceNameType
Device.type	preferred	MedicalDevicesSnomedAbsentUnknownUvIps Additional Bindings Purpose Documentation Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Codes for medical devices in SNOMED IPS Free Set Absent or Unknown Devices - IPS Candidate Validation Binding Codes for absent or unknown medical devices
Device.patient.type	extensible	ResourceType

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Maturity: 2

Differential View

This structure is derived from Device

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	Item used in healthcare
type	S	0..1	CodeableConceptIPS	Type of device. Preferably valued by using SNOMED CT. The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: Medical Devices - SNOMED CT + Absent/Unknown - IPS (preferred): The type of device or a code for absent/unknown device Additional Bindings Purpose Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Absent or Unknown Devices - IPS Candidate Validation Binding
patient	S	1..1	Reference(Patient (IPS))	Patient to whom Device is affixed
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Device.type	preferred	MedicalDevicesSnomedAbsentUnknownUvIps Additional Bindings Purpose Documentation Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Codes for medical devices in SNOMED IPS Free Set Absent or Unknown Devices - IPS Candidate Validation Binding Codes for absent or unknown medical devices

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	Item used in healthcare
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
type	S	0..1	CodeableConceptIPS	Type of device. Preferably valued by using SNOMED CT. The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: Medical Devices - SNOMED CT + Absent/Unknown - IPS (preferred): The type of device or a code for absent/unknown device Additional Bindings Purpose Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Absent or Unknown Devices - IPS Candidate Validation Binding
patient	S	1..1	Reference(Patient (IPS))	Patient to whom Device is affixed
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Device.status	required	FHIRDeviceStatus
Device.type	preferred	MedicalDevicesSnomedAbsentUnknownUvIps Additional Bindings Purpose Documentation Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Codes for medical devices in SNOMED IPS Free Set Absent or Unknown Devices - IPS Candidate Validation Binding Codes for absent or unknown medical devices

Constraints

Id	Grade	Path(s)	Details	Requirements
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	Item used in healthcare
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
definition		0..1	Reference(DeviceDefinition)	The reference to the definition for the device
udiCarrier	Σ	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string
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	Σ	0..1	string	Mandatory fixed portion of UDI
issuer		0..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 + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason		0..*	CodeableConcept	online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier		0..1	string	The distinct identification string
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
deviceName		0..*	BackboneElement	The name of the device as given by the manufacturer
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
name		1..1	string	The name of the device
type		1..1	code	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
modelNumber		0..1	string	The model number for the device
partNumber		0..1	string	The part number of the device
type	S	0..1	CodeableConceptIPS	Type of device. Preferably valued by using SNOMED CT. The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: Medical Devices - SNOMED CT + Absent/Unknown - IPS (preferred): The type of device or a code for absent/unknown device Additional Bindings Purpose Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Absent or Unknown Devices - IPS Candidate Validation Binding
specialization		0..*	BackboneElement	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
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
systemType		1..1	CodeableConcept	The standard that is used to operate and communicate
version		0..1	string	The version of the standard that is used to operate and communicate
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
component		0..1	Identifier	A single component of the device version
value		1..1	string	The version text
property		0..*	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
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 DeviceDefinitionPropetyCode (Extensible)
valueQuantity		0..*	Quantity	Property value as a quantity
valueCode		0..*	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP)
patient	S	1..1	Reference(Patient (IPS))	Patient to whom Device is affixed
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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
note		0..*	Annotation	Device notes and comments
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device
parent		0..1	Reference(Device)	The parent device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Device.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Device.udiCarrier.entryType	required	UDIEntryType
Device.status	required	FHIRDeviceStatus
Device.statusReason	extensible	FHIRDeviceStatusReason
Device.deviceName.type	required	DeviceNameType
Device.type	preferred	MedicalDevicesSnomedAbsentUnknownUvIps Additional Bindings Purpose Documentation Medical Devices - SNOMED CT IPS Free Set Candidate Validation Binding Codes for medical devices in SNOMED IPS Free Set Absent or Unknown Devices - IPS Candidate Validation Binding Codes for absent or unknown medical devices
Device.patient.type	extensible	ResourceType

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron