DK EHMI Endpoint Register (EER)
0.5.0 - ci-build Denmark flag

DK EHMI Endpoint Register (EER), published by . This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-ehmi-eer/ and changes regularly. See the Directory of published versions

Resource Profile: EER DeviceDefinition for General Devices

Official URL: http://medcomehmi.dk/ig/dk-ehmi-eer/StructureDefinition/EER.DeviceDefinition Version: 0.5.0
Draft as of 2024-08-15 Computable Name: EerDeviceDefinition

An EHMI profile of the EerDeviceDefinition resource.

Usage:

Formal Views of Profile Content

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

This structure is derived from DeviceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition DeviceDefinition
... identifier S 1..1 Identifier Instance identifier
... udiDeviceIdentifier 0..0
... Slices for manufacturer[x] 1..1 string Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturer[x]:manufacturerString S 1..1 string Name of device manufacturer
.... name S 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
Fixed Value: manufacturer-name
... type S 1..1 CodeableConcept What kind of device or device system this is
Binding: EER SOR Organization Identier Type Valueset (required)
... specialization
.... systemType S 1..1 string The standard that is used to operate and communicate
... safety 0..0
... shelfLifeStorage 0..0
... physicalCharacteristics 0..0
... material 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DeviceDefinition.typerequiredEerDeviceTypeVS (a valid code from EER-Device-Type CodeSystem)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-device-type-valueset
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..* DeviceDefinition An instance of a medical-related component of a medical device
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..1 Identifier Instance identifier
.... manufacturer[x]:manufacturerString S 1..1 string Name of device manufacturer
... deviceName 1..1 BackboneElement A name given to the device to identify it
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 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: manufacturer-name
... type S 1..1 CodeableConcept What kind of device or device system this is
Binding: EER SOR Organization Identier Type Valueset (required)
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... systemType S 1..1 string The standard that is used to operate and communicate

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DeviceDefinition.deviceName.typerequiredFixed Value: manufacturer-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
DeviceDefinition.typerequiredEerDeviceTypeVS (a valid code from EER-Device-Type CodeSystem)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-device-type-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..* DeviceDefinition An instance of a medical-related component of a medical device
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..1 Identifier Instance identifier
... Slices for manufacturer[x] 1..1 string Name of device manufacturer
Slice: Unordered, Closed by type:$this
.... manufacturer[x]:manufacturerString S 1..1 string Name of device manufacturer
... deviceName 1..1 BackboneElement A name given to the device to identify it
.... 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 S 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: manufacturer-name
... modelNumber 0..1 string The model number for the device
... type S 1..1 CodeableConcept What kind of device or device system this is
Binding: EER SOR Organization Identier Type Valueset (required)
... 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 S 1..1 string 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..* string Available versions
... languageCode 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported)
... capability 0..* BackboneElement Device capabilities
.... 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 Type of capability
.... description 0..* CodeableConcept Description of capability
... 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)
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... url 0..1 uri Network address to contact device
... onlineInformation 0..1 uri Access to on-line information
... note 0..* Annotation Device notes and comments
... quantity 0..1 Quantity The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
... parentDevice Σ 0..1 Reference(DeviceDefinition) The parent device it can be part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DeviceDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DeviceDefinition.deviceName.typerequiredFixed Value: manufacturer-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
DeviceDefinition.typerequiredEerDeviceTypeVS (a valid code from EER-Device-Type CodeSystem)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-device-type-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA 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()

This structure is derived from DeviceDefinition

Summary

Mandatory: 5 elements
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DeviceDefinition.manufacturer[x]

Differential View

This structure is derived from DeviceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition DeviceDefinition
... identifier S 1..1 Identifier Instance identifier
... udiDeviceIdentifier 0..0
... Slices for manufacturer[x] 1..1 string Name of device manufacturer
Slice: Unordered, Open by type:$this
.... manufacturer[x]:manufacturerString S 1..1 string Name of device manufacturer
.... name S 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
Fixed Value: manufacturer-name
... type S 1..1 CodeableConcept What kind of device or device system this is
Binding: EER SOR Organization Identier Type Valueset (required)
... specialization
.... systemType S 1..1 string The standard that is used to operate and communicate
... safety 0..0
... shelfLifeStorage 0..0
... physicalCharacteristics 0..0
... material 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
DeviceDefinition.typerequiredEerDeviceTypeVS (a valid code from EER-Device-Type CodeSystem)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-device-type-valueset
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..* DeviceDefinition An instance of a medical-related component of a medical device
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..1 Identifier Instance identifier
.... manufacturer[x]:manufacturerString S 1..1 string Name of device manufacturer
... deviceName 1..1 BackboneElement A name given to the device to identify it
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 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: manufacturer-name
... type S 1..1 CodeableConcept What kind of device or device system this is
Binding: EER SOR Organization Identier Type Valueset (required)
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... systemType S 1..1 string The standard that is used to operate and communicate

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DeviceDefinition.deviceName.typerequiredFixed Value: manufacturer-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
DeviceDefinition.typerequiredEerDeviceTypeVS (a valid code from EER-Device-Type CodeSystem)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-device-type-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..* DeviceDefinition An instance of a medical-related component of a medical device
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 1..1 Identifier Instance identifier
... Slices for manufacturer[x] 1..1 string Name of device manufacturer
Slice: Unordered, Closed by type:$this
.... manufacturer[x]:manufacturerString S 1..1 string Name of device manufacturer
... deviceName 1..1 BackboneElement A name given to the device to identify it
.... 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 S 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: manufacturer-name
... modelNumber 0..1 string The model number for the device
... type S 1..1 CodeableConcept What kind of device or device system this is
Binding: EER SOR Organization Identier Type Valueset (required)
... 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 S 1..1 string 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..* string Available versions
... languageCode 0..* CodeableConcept Language code for the human-readable text strings produced by the device (all supported)
... capability 0..* BackboneElement Device capabilities
.... 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 Type of capability
.... description 0..* CodeableConcept Description of capability
... 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)
... owner 0..1 Reference(Organization) Organization responsible for device
... contact 0..* ContactPoint Details for human/organization for support
... url 0..1 uri Network address to contact device
... onlineInformation 0..1 uri Access to on-line information
... note 0..* Annotation Device notes and comments
... quantity 0..1 Quantity The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
... parentDevice Σ 0..1 Reference(DeviceDefinition) The parent device it can be part of

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DeviceDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DeviceDefinition.deviceName.typerequiredFixed Value: manufacturer-name
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
DeviceDefinition.typerequiredEerDeviceTypeVS (a valid code from EER-Device-Type CodeSystem)
http://medcomehmi.dk/ig/dk-ehmi-eer/ValueSet/eer-device-type-valueset
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceDefinitionIf 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-4errorDeviceDefinitionIf 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-5errorDeviceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceDefinitionA 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()

This structure is derived from DeviceDefinition

Summary

Mandatory: 5 elements
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DeviceDefinition.manufacturer[x]

 

Other representations of profile: CSV, Excel, Schematron