Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.16.2 - ci-build NL

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

Resource Profile: KT2_Device

Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2Device Version: 0.16.2
Draft as of 2023-02-07 Computable Name: KT2_Device

Copyright/Legal: VZVZ

The Device resource represents a software application or system that is used in the provision of healthcare services. Within the Koppeltaal context, this typically includes modules, portals, or eHealth applications that facilitate patient care and data exchange between healthcare systems.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri The namespace for the identifier value
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.
... deviceName 1..* BackboneElement The name of the device as given by the manufacturer
.... 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
... owner 0..1 Reference(KT2_Organization) Organization responsible for device

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 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 The reference to the definition for the device
... status 1..1 code active | inactive | entered-in-error | unknown
... statusReason 0..0 online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
... distinctIdentifier 0..0 The distinct identification string
... manufacturer 0..0 Name of device manufacturer
... manufactureDate 0..0 Date when the device was made
... expirationDate 0..0 Date and time of expiry of this device (if applicable)
... lotNumber 0..0 Lot number of manufacture
... serialNumber 0..0 Serial number assigned by the manufacturer
... 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 The model number for the device
... partNumber 0..0 The part number of the device
... specialization 0..0 The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
... version 0..0 The actual design of the device or software version running on the device
... property 0..0 The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
... patient 0..0 Patient to whom Device is affixed
... owner 0..1 Reference(KT2_Organization) Organization responsible for device
... contact 0..0 Details for human/organization for support
... location 0..0 Where the device is found
... url 0..0 Network address to contact device
... note 0..0 Device notes and comments
... safety 0..0 Safety Characteristics of Device
... parent 0..0 The parent device

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Device.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Device.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Device.udiCarrier.entryType Base required UDIEntryType 📍4.0.1 FHIR Std.
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 Reference(KT2_Device) Extension
URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri The namespace for the identifier value
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.
... deviceName 1..* BackboneElement The name of the device as given by the manufacturer
.... 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
... owner 0..1 Reference(KT2_Organization) Organization responsible for device

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 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 The reference to the definition for the device
... status 1..1 code active | inactive | entered-in-error | unknown
... statusReason 0..0 online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
... distinctIdentifier 0..0 The distinct identification string
... manufacturer 0..0 Name of device manufacturer
... manufactureDate 0..0 Date when the device was made
... expirationDate 0..0 Date and time of expiry of this device (if applicable)
... lotNumber 0..0 Lot number of manufacture
... serialNumber 0..0 Serial number assigned by the manufacturer
... 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 The model number for the device
... partNumber 0..0 The part number of the device
... specialization 0..0 The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
... version 0..0 The actual design of the device or software version running on the device
... property 0..0 The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
... patient 0..0 Patient to whom Device is affixed
... owner 0..1 Reference(KT2_Organization) Organization responsible for device
... contact 0..0 Details for human/organization for support
... location 0..0 Where the device is found
... url 0..0 Network address to contact device
... note 0..0 Device notes and comments
... safety 0..0 Safety Characteristics of Device
... parent 0..0 The parent device

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:resource-origin 0..1 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Device.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Device.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Device.udiCarrier.entryType Base required UDIEntryType 📍4.0.1 FHIR Std.
Device.status Base required FHIRDeviceStatus 📍4.0.1 FHIR Std.
Device.deviceName.type Base required DeviceNameType 📍4.0.1 FHIR Std.
Device.type Base example Device Type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Identifier

The identifier element is mandatory and must use the Koppeltaal client ID naming system.

Example:

{
  "identifier": [{
    "system": "http://vzvz.nl/fhir/NamingSystem/koppeltaal-client-id",
    "value": "example-client-123"
  }]
}

Status

The status element is required. The default value should be set to 'active' for devices that are currently in use.

Valid status values:

  • active - Device is available for use (default)
  • inactive - Device is no longer available for use
  • entered-in-error - Device record entered in error

Device Name

The deviceName element is mandatory and must have the type set to user-friendly-name. This provides a human-readable name for the device that can be displayed in user interfaces.

Example:

{
  "deviceName": [{
    "name": "My eHealth Application",
    "type": "user-friendly-name"
  }]
}

Owner

When specified, the owner element must reference a KT2_Organization resource. This indicates which organization owns or is responsible for the device.

Example:

{
  "owner": {
    "reference": "Organization/example-org"
  }
}

Usage Notes

  • The Device resource in Koppeltaal is primarily used to represent software applications rather than physical medical devices
  • Each application instance should have a unique client ID in the identifier
  • The device name should be meaningful to end users who will see it in the system