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

Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.15.0) 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.15.0
Draft as of 2023-02-07 Realm: Netherlands flag 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
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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
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 .
.... 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 C 0..1 Reference(KT2_Organization) Organization responsible for device
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
From the FHIR Standard
Device.deviceName.typerequiredFixed Value: user-friendly-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorDevice.ownerSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device Device
... Slices for extension Content/Rules for all slices
.... 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
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... 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 Additional content defined by implementations
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
Slice: Unordered, Open by value:url
... 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 ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
.... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
... 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
Slice: Unordered, Open by value:url
.... 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 C 0..1 Reference(KT2_Organization) Organization responsible for device
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Device.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1
From the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
From the FHIR Standard
Device.deviceName.typerequiredFixed Value: user-friendly-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
From the FHIR Standard
Device.typeexampleDeviceType
http://hl7.org/fhir/ValueSet/device-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorDevice.identifier.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3errorDevice.property.valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorDevice.identifier.assigner, Device.ownerSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... 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
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 .
.... 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 C 0..1 Reference(KT2_Organization) Organization responsible for device
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
From the FHIR Standard
Device.deviceName.typerequiredFixed Value: user-friendly-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorDevice.ownerSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from Device

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device Device
... Slices for extension Content/Rules for all slices
.... 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
... 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 0..* Device Item used in healthcare
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... 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 Additional content defined by implementations
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
Slice: Unordered, Open by value:url
... 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 ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
.... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
... 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
Slice: Unordered, Open by value:url
.... 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 C 0..1 Reference(KT2_Organization) Organization responsible for device
Constraints: ref-1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Device.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Device.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Device.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1
From the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
From the FHIR Standard
Device.deviceName.typerequiredFixed Value: user-friendly-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
From the FHIR Standard
Device.typeexampleDeviceType
http://hl7.org/fhir/ValueSet/device-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorDevice.identifier.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
qty-3errorDevice.property.valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorDevice.identifier.assigner, Device.ownerSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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