Koppeltaal 2.0 Implementation Guide - Local Development build (v0.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: KT2_Device

The (FHIR) Device (resource) is a representation of an application that is used in the provision of healthcare without being substantially changed through that activity. The device may be a module, portal or eHealth app.

Usage:

• Refer to this Resource Profile: KT2_AuditEvent and KT2_ResourceOrigin
• Examples for this Resource Profile: Device/autorisatieserver, Device/ba33314a-795a-4777-bef8-e6611f6be645 and Device/device-volledig

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		0..*	Device	Item used in healthcare 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
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
identifier		1..*	Identifier	Instance identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://vzvz.nl/fhir/NamingSystem/koppeltaal-client-id
status	?!Σ	1..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children
deviceName		1..*	BackboneElement	The name of the device as given by the manufacturer ele-1: All FHIR elements must have a @value or children
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
name		1..1	string	The name of the device ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Fixed Value: user-friendly-name
owner		0..1	Reference(KT2_Organization)	Organization responsible for device ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.deviceName.type	required	Fixed Value: user-friendly-name http://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard

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()

This structure is derived from Device

Name	Flags	Card.	Type	Description & Constraints
Device			Device
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
identifier		1..*	Identifier	Instance identifier
system		0..1	uri	The namespace for the identifier value Fixed Value: http://vzvz.nl/fhir/NamingSystem/koppeltaal-client-id
definition		0..0
udiCarrier		0..0
status		1..1	code	active | inactive | entered-in-error | unknown
statusReason		0..0
distinctIdentifier		0..0
manufacturer		0..0
manufactureDate		0..0
expirationDate		0..0
lotNumber		0..0
serialNumber		0..0
deviceName		1..*	BackboneElement	The name of the device as given by the manufacturer
type		1..1	code	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Fixed Value: user-friendly-name
modelNumber		0..0
partNumber		0..0
specialization		0..0
version		0..0
property		0..0
patient		0..0
owner		0..1	Reference(KT2_Organization)	Organization responsible for device
contact		0..0
location		0..0
url		0..0
note		0..0
safety		0..0
parent		0..0
Documentation for this format

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..*	Identifier	Instance identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Fixed Value: http://vzvz.nl/fhir/NamingSystem/koppeltaal-client-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	1..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
deviceName		1..*	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. Fixed Value: user-friendly-name
type		0..1	CodeableConcept	The kind or type of device Binding: DeviceType (example): Codes to identify medical devices.
owner		0..1	Reference(KT2_Organization)	Organization responsible for device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Device.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Device.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Device.udiCarrier.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.deviceName.type	required	Fixed Value: user-friendly-name http://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard
Device.type	example	DeviceType http://hl7.org/fhir/ValueSet/device-type from the FHIR Standard

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()

This structure is derived from Device

Summary

Mandatory: 3 elements
Fixed: 2 elements
Prohibited: 21 elements

Structures

This structure refers to these other structures:

• KT2_Organization (http://koppeltaal.nl/fhir/StructureDefinition/KT2Organization)

Extensions

This structure refers to these extensions:

• http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	Device	Item used in healthcare 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
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
identifier		1..*	Identifier	Instance identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://vzvz.nl/fhir/NamingSystem/koppeltaal-client-id
status	?!Σ	1..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children
deviceName		1..*	BackboneElement	The name of the device as given by the manufacturer ele-1: All FHIR elements must have a @value or children
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
name		1..1	string	The name of the device ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children Fixed Value: user-friendly-name
owner		0..1	Reference(KT2_Organization)	Organization responsible for device ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.deviceName.type	required	Fixed Value: user-friendly-name http://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard

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()

Differential View

This structure is derived from Device

Name	Flags	Card.	Type	Description & Constraints
Device			Device
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
identifier		1..*	Identifier	Instance identifier
system		0..1	uri	The namespace for the identifier value Fixed Value: http://vzvz.nl/fhir/NamingSystem/koppeltaal-client-id
definition		0..0
udiCarrier		0..0
status		1..1	code	active | inactive | entered-in-error | unknown
statusReason		0..0
distinctIdentifier		0..0
manufacturer		0..0
manufactureDate		0..0
expirationDate		0..0
lotNumber		0..0
serialNumber		0..0
deviceName		1..*	BackboneElement	The name of the device as given by the manufacturer
type		1..1	code	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Fixed Value: user-friendly-name
modelNumber		0..0
partNumber		0..0
specialization		0..0
version		0..0
property		0..0
patient		0..0
owner		0..1	Reference(KT2_Organization)	Organization responsible for device
contact		0..0
location		0..0
url		0..0
note		0..0
safety		0..0
parent		0..0
Documentation for this format

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:resource-origin		0..*	Reference(KT2_Device)	Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		1..*	Identifier	Instance identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Fixed Value: http://vzvz.nl/fhir/NamingSystem/koppeltaal-client-id
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!Σ	1..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
deviceName		1..*	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. Fixed Value: user-friendly-name
type		0..1	CodeableConcept	The kind or type of device Binding: DeviceType (example): Codes to identify medical devices.
owner		0..1	Reference(KT2_Organization)	Organization responsible for device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Device.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Device.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Device.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Device.udiCarrier.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.deviceName.type	required	Fixed Value: user-friendly-name http://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard
Device.type	example	DeviceType http://hl7.org/fhir/ValueSet/device-type from the FHIR Standard

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()

This structure is derived from Device

Summary

Mandatory: 3 elements
Fixed: 2 elements
Prohibited: 21 elements

Structures

This structure refers to these other structures:

• KT2_Organization (http://koppeltaal.nl/fhir/StructureDefinition/KT2Organization)

Extensions

This structure refers to these extensions:

• http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Other representations of profile: CSV, Excel, Schematron