LOINC – IVD Test Code (LIVD) Mapping
1.0.0-ballot - ballot International flag

This page is part of the Loinc/IVD Mapping FHIR IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: LIVD DeviceDefinition

Official URL: http://hl7.org/fhir/uv/livd/StructureDefinition/devicedefinition-uv-livd Version: 1.0.0-ballot
Active as of 2018-08-14 Computable Name: LIVDDeviceDefinition

Profile on the DeviceDefinition resource for representing the devices included in the LIVD catalog for which mappings are defined.

Description

The LIVD DeviceDefinition is a profile on the DeviceDefinition resource for representing the devices included in the LIVD catalog for which mappings are defined.

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 0..*DeviceDefinitionLIVDDeviceDefinition
... identifier 0..0
... udiDeviceIdentifier S0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... deviceIdentifier S1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer S1..1uriUDI Issuing Organization
.... jurisdiction S1..1uriRegional UDI authority
... manufacturer[x] S1..1stringName of device manufacturer
... modelNumber S1..1stringModel id assigned by the manufacturer
... type S0..1CodeableConceptWhat kind of device or device system this is
Binding: IVD device types for LIVD device definitions (extensible): IVD device types for LIVD device definitions (extensible).

... specialization 0..0
... version 0..0
... safety 0..0
... shelfLifeStorage 0..0
... physicalCharacteristics 0..0
... languageCode 0..0
... capability S1..*BackboneElementDevice capabilities
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... DeviceDefinitionExtensionAnalyte S1..*Reference(LIVDObservationDefinition)LIVD Test Analyte
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
.... type S1..1CodeableConceptType of capability
.... description 0..0
... property 0..0
... owner 0..0
... contact 0..0
... url 0..0
... onlineInformation 0..0
... note 0..0
... quantity 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DeviceDefinition.typeextensibleLivdDeviceTypeVS (a valid code from IVD device types for LIVD device definitions)
NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionLIVDDeviceDefinition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... udiDeviceIdentifier S0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier S1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer S1..1uriUDI Issuing Organization
.... jurisdiction S1..1uriRegional UDI authority
... modelNumber S1..1stringModel id assigned by the manufacturer
... type S0..1CodeableConceptWhat kind of device or device system this is
Binding: IVD device types for LIVD device definitions (extensible): IVD device types for LIVD device definitions (extensible).

... capability S1..*BackboneElementDevice capabilities
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... DeviceDefinitionExtensionAnalyte S1..*Reference(LIVDObservationDefinition)LIVD Test Analyte
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptType of capability

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.typeextensibleLivdDeviceTypeVS (a valid code from IVD device types for LIVD device definitions)

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..*DeviceDefinitionLIVDDeviceDefinition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... udiDeviceIdentifier S0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier S1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer S1..1uriUDI Issuing Organization
.... jurisdiction S1..1uriRegional UDI authority
... manufacturer[x] S1..1stringName of device manufacturer
... modelNumber S1..1stringModel id assigned by the manufacturer
... type S0..1CodeableConceptWhat kind of device or device system this is
Binding: IVD device types for LIVD device definitions (extensible): IVD device types for LIVD device definitions (extensible).

... capability S1..*BackboneElementDevice capabilities
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... DeviceDefinitionExtensionAnalyte S1..*Reference(LIVDObservationDefinition)LIVD Test Analyte
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptType of capability
... parentDevice Σ0..1Reference(DeviceDefinition)The parent device it can be part of
... material 0..*BackboneElementA substance used to create the material(s) of which the device is made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance 1..1CodeableConceptThe substance
.... alternate 0..1booleanIndicates an alternative material of the device
.... allergenicIndicator 0..1booleanWhether the substance is a known or suspected allergen

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.typeextensibleLivdDeviceTypeVS (a valid code from IVD device types for LIVD device definitions)

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: 10 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from DeviceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionLIVDDeviceDefinition
... identifier 0..0
... udiDeviceIdentifier S0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... deviceIdentifier S1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer S1..1uriUDI Issuing Organization
.... jurisdiction S1..1uriRegional UDI authority
... manufacturer[x] S1..1stringName of device manufacturer
... modelNumber S1..1stringModel id assigned by the manufacturer
... type S0..1CodeableConceptWhat kind of device or device system this is
Binding: IVD device types for LIVD device definitions (extensible): IVD device types for LIVD device definitions (extensible).

... specialization 0..0
... version 0..0
... safety 0..0
... shelfLifeStorage 0..0
... physicalCharacteristics 0..0
... languageCode 0..0
... capability S1..*BackboneElementDevice capabilities
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... DeviceDefinitionExtensionAnalyte S1..*Reference(LIVDObservationDefinition)LIVD Test Analyte
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
.... type S1..1CodeableConceptType of capability
.... description 0..0
... property 0..0
... owner 0..0
... contact 0..0
... url 0..0
... onlineInformation 0..0
... note 0..0
... quantity 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DeviceDefinition.typeextensibleLivdDeviceTypeVS (a valid code from IVD device types for LIVD device definitions)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DeviceDefinition 0..*DeviceDefinitionLIVDDeviceDefinition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... udiDeviceIdentifier S0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier S1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer S1..1uriUDI Issuing Organization
.... jurisdiction S1..1uriRegional UDI authority
... modelNumber S1..1stringModel id assigned by the manufacturer
... type S0..1CodeableConceptWhat kind of device or device system this is
Binding: IVD device types for LIVD device definitions (extensible): IVD device types for LIVD device definitions (extensible).

... capability S1..*BackboneElementDevice capabilities
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... DeviceDefinitionExtensionAnalyte S1..*Reference(LIVDObservationDefinition)LIVD Test Analyte
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptType of capability

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.typeextensibleLivdDeviceTypeVS (a valid code from IVD device types for LIVD device definitions)

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..*DeviceDefinitionLIVDDeviceDefinition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... udiDeviceIdentifier S0..1BackboneElementUnique Device Identifier (UDI) Barcode string
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... deviceIdentifier S1..1stringThe identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
.... issuer S1..1uriUDI Issuing Organization
.... jurisdiction S1..1uriRegional UDI authority
... manufacturer[x] S1..1stringName of device manufacturer
... modelNumber S1..1stringModel id assigned by the manufacturer
... type S0..1CodeableConceptWhat kind of device or device system this is
Binding: IVD device types for LIVD device definitions (extensible): IVD device types for LIVD device definitions (extensible).

... capability S1..*BackboneElementDevice capabilities
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... DeviceDefinitionExtensionAnalyte S1..*Reference(LIVDObservationDefinition)LIVD Test Analyte
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type S1..1CodeableConceptType of capability
... parentDevice Σ0..1Reference(DeviceDefinition)The parent device it can be part of
... material 0..*BackboneElementA substance used to create the material(s) of which the device is made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substance 1..1CodeableConceptThe substance
.... alternate 0..1booleanIndicates an alternative material of the device
.... allergenicIndicator 0..1booleanWhether the substance is a known or suspected allergen

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DeviceDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
DeviceDefinition.deviceName.typerequiredDeviceNameType
DeviceDefinition.typeextensibleLivdDeviceTypeVS (a valid code from IVD device types for LIVD device definitions)

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: 10 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron