HL7.FHIR.UV.LIVD\LIVD DeviceDefinition

This page is part of the Loinc/IVD Mapping FHIR IG (v0.3.0: STU 1 (FHIR R4) Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: LIVD DeviceDefinition

Defining URL:

http://hl7.org/fhir/uv/livd/StructureDefinition/devicedefinition-uv-livd

Version:

0.3.0

Name:

LIVDDeviceDefinition

Status:

Active as of 2018-08-14

Definition:

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

Publisher:

HL7 International - Orders and Observations Work Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/livd/StructureDefinition/devicedefinition-uv-livd

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.

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from DeviceDefinition

Summary

Mandatory: 5 elements
Must-Support: 10 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte

This structure is derived from DeviceDefinition

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition		0..*	DeviceDefinition	LIVDDeviceDefinition
identifier		0..0
udiDeviceIdentifier	S	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
deviceIdentifier	S	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuer	S	1..1	uri	UDI Issuing Organization
jurisdiction	S	1..1	uri	Regional UDI authority
manufacturer[x]	S	1..1	string	Name of device manufacturer
deviceName		0..0
modelNumber	S	1..1	string	Model id assigned by the manufacturer
type	S	0..1	CodeableConcept	What 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	S	1..*	BackboneElement	Device capabilities
extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ext-analyte	S	1..*	Reference(LIVDObservationDefinition)	Extension URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
type	S	1..1	CodeableConcept	Type 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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition		0..*	DeviceDefinition	LIVDDeviceDefinition
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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
udiDeviceIdentifier	S	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
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
deviceIdentifier	S	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuer	S	1..1	uri	UDI Issuing Organization
jurisdiction	S	1..1	uri	Regional UDI authority
manufacturer[x]	S	1..1	string	Name of device manufacturer
modelNumber	S	1..1	string	Model id assigned by the manufacturer
type	S	0..1	CodeableConcept	What 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	S	1..*	BackboneElement	Device capabilities
id		0..1	string	Unique id for inter-element referencing
extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ext-analyte	S	1..*	Reference(LIVDObservationDefinition)	Optional Extensions Element URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	1..1	CodeableConcept	Type of capability
parentDevice	Σ	0..1	Reference(DeviceDefinition)	The parent device it can be part of
material		0..*	BackboneElement	A substance used to create the material(s) of which the device is made
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
substance		1..1	CodeableConcept	The substance
alternate		0..1	boolean	Indicates an alternative material of the device
allergenicIndicator		0..1	boolean	Whether the substance is a known or suspected allergen
Documentation for this format

Name	Card.	Type	Description & Constraints
DeviceDefinition	0..*	DeviceDefinition	LIVDDeviceDefinition
udiDeviceIdentifier	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
deviceIdentifier	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuer	1..1	uri	UDI Issuing Organization
jurisdiction	1..1	uri	Regional UDI authority
manufacturer[x]	1..1	string	Name of device manufacturer
modelNumber	1..1	string	Model id assigned by the manufacturer
type	0..1	CodeableConcept	What 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	1..*	BackboneElement	Device capabilities
ext-analyte	1..*	Reference(LIVDObservationDefinition)	Optional Extensions Element URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
type	1..1	CodeableConcept	Type of capability
Documentation for this format

This structure is derived from DeviceDefinition

Summary

Mandatory: 5 elements
Must-Support: 10 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte

Differential View

This structure is derived from DeviceDefinition

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition		0..*	DeviceDefinition	LIVDDeviceDefinition
identifier		0..0
udiDeviceIdentifier	S	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
deviceIdentifier	S	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuer	S	1..1	uri	UDI Issuing Organization
jurisdiction	S	1..1	uri	Regional UDI authority
manufacturer[x]	S	1..1	string	Name of device manufacturer
deviceName		0..0
modelNumber	S	1..1	string	Model id assigned by the manufacturer
type	S	0..1	CodeableConcept	What 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	S	1..*	BackboneElement	Device capabilities
extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ext-analyte	S	1..*	Reference(LIVDObservationDefinition)	Extension URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
type	S	1..1	CodeableConcept	Type 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
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DeviceDefinition		0..*	DeviceDefinition	LIVDDeviceDefinition
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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
udiDeviceIdentifier	S	0..1	BackboneElement	Unique Device Identifier (UDI) Barcode string
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
deviceIdentifier	S	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuer	S	1..1	uri	UDI Issuing Organization
jurisdiction	S	1..1	uri	Regional UDI authority
manufacturer[x]	S	1..1	string	Name of device manufacturer
modelNumber	S	1..1	string	Model id assigned by the manufacturer
type	S	0..1	CodeableConcept	What 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	S	1..*	BackboneElement	Device capabilities
id		0..1	string	Unique id for inter-element referencing
extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
ext-analyte	S	1..*	Reference(LIVDObservationDefinition)	Optional Extensions Element URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-analyte
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	1..1	CodeableConcept	Type of capability
parentDevice	Σ	0..1	Reference(DeviceDefinition)	The parent device it can be part of
material		0..*	BackboneElement	A substance used to create the material(s) of which the device is made
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
substance		1..1	CodeableConcept	The substance
alternate		0..1	boolean	Indicates an alternative material of the device
allergenicIndicator		0..1	boolean	Whether the substance is a known or suspected allergen
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
DeviceDefinition.language	preferred	CommonLanguages Max Binding: AllLanguages
DeviceDefinition.deviceName.type	required	DeviceNameType
DeviceDefinition.type	extensible	LivdDeviceTypeVS

Constraints

Id	Path	Details	Requirements
dom-2	DeviceDefinition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	DeviceDefinition	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	DeviceDefinition	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	DeviceDefinition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	DeviceDefinition	A resource should have narrative for robust management : text.`div`.exists()
ele-1	DeviceDefinition.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.udiDeviceIdentifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.udiDeviceIdentifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.udiDeviceIdentifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.udiDeviceIdentifier.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.udiDeviceIdentifier.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.udiDeviceIdentifier.deviceIdentifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.udiDeviceIdentifier.issuer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.udiDeviceIdentifier.jurisdiction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.manufacturer[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.deviceName.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.deviceName.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.deviceName.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.deviceName.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.deviceName.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.deviceName.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.modelNumber	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.specialization.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.specialization.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.specialization.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.specialization.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.specialization.systemType	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.specialization.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.capability	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.capability.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.capability.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.capability.extension:DeviceDefinitionExtensionAnalyte	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.capability.extension:DeviceDefinitionExtensionAnalyte	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.capability.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.capability.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.capability.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.property.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.property.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.property.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.property.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.property.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.property.valueQuantity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.property.valueCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.parentDevice	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.material.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.material.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	DeviceDefinition.material.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	DeviceDefinition.material.substance	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material.alternate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	DeviceDefinition.material.allergenicIndicator	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())