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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: LIVD ValueSet

LIVD value set profile.

Usage:

• Examples for this Resource Profile: LivdTestCodeMappingsVS

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ValueSet

Name	Flags	Card.	Type	Description & Constraints
ValueSet		0..*	ValueSet	LIVDValueSet
url	S	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
identifier		0..0
version	S	1..1	string	Business version of the value set
name	S	1..1	string	Name for this value set (computer friendly)
status	S	1..1	code	draft | active | retired | unknown
publisher		0..0
contact		0..0
useContext		0..0
immutable		0..0
purpose		0..0
compose	S	1..1	BackboneElement	Content logical definition of the value set (CLD)
lockedDate		0..0
inactive		0..0
include	S	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
system	S	1..1	uri	The system the codes come from
version	S	0..1	string	Specific version of the code system referred to
concept	S	1..*	BackboneElement	A concept defined in the system
code	S	1..1	code	Code or expression from system
display	S	1..1	string	Text to display for this code for this value set in this valueset
designation		0..0
filter		0..0
valueSet		0..0
exclude		0..0
expansion		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	LIVDValueSet
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the value set
name	SΣC	1..1	string	Name for this value set (computer friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
compose	S	1..1	BackboneElement	Content logical definition of the value set (CLD)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
include	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
system	SΣC	1..1	uri	The system the codes come from
version	SΣ	0..1	string	Specific version of the code system referred to
concept	SC	1..*	BackboneElement	A concept defined in the system
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Code or expression from system
display	S	1..1	string	Text to display for this code for this value set in this valueset
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.status	required	PublicationStatus
ValueSet.compose.include.filter.op	required	FilterOperator

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ValueSet	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ValueSet	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	ValueSet	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	ValueSet	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ValueSet	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()
vsd-0	warning	ValueSet	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1	error	ValueSet.compose.include	A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists()
vsd-2	error	ValueSet.compose.include	A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists()
vsd-3	error	ValueSet.compose.include	Cannot have both concept and filter : concept.empty() or filter.empty()

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	LIVDValueSet
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the value set
name	SΣC	1..1	string	Name for this value set (computer friendly)
title	Σ	0..1	string	Name for this value set (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
description		0..1	markdown	Natural language description of the value set
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
copyright		0..1	markdown	Use and/or publishing restrictions
compose	S	1..1	BackboneElement	Content logical definition of the value set (CLD)
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
include	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
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
system	SΣC	1..1	uri	The system the codes come from
version	SΣ	0..1	string	Specific version of the code system referred to
concept	SC	1..*	BackboneElement	A concept defined in the system
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
code	S	1..1	code	Code or expression from system
display	S	1..1	string	Text to display for this code for this value set in this valueset
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.status	required	PublicationStatus
ValueSet.jurisdiction	extensible	Jurisdiction ValueSet
ValueSet.compose.include.concept.designation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use	extensible	DesignationUse
ValueSet.compose.include.filter.op	required	FilterOperator

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ValueSet	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ValueSet	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	ValueSet	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	ValueSet	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ValueSet	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()
vsd-0	warning	ValueSet	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1	error	ValueSet.compose.include	A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists()
vsd-2	error	ValueSet.compose.include	A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists()
vsd-3	error	ValueSet.compose.include	Cannot have both concept and filter : concept.empty() or filter.empty()
vsd-6	error	ValueSet.expansion.contains	SHALL have a code or a display : code.exists() or display.exists()
vsd-9	error	ValueSet.expansion.contains	Must have a code if not abstract : code.exists() or abstract = true
vsd-10	error	ValueSet.expansion.contains	Must have a system if a code is present : code.empty() or system.exists()

This structure is derived from ValueSet

Summary

Mandatory: 7 elements
Must-Support: 11 elements
Prohibited: 13 elements

Differential View

This structure is derived from ValueSet

Name	Flags	Card.	Type	Description & Constraints
ValueSet		0..*	ValueSet	LIVDValueSet
url	S	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
identifier		0..0
version	S	1..1	string	Business version of the value set
name	S	1..1	string	Name for this value set (computer friendly)
status	S	1..1	code	draft | active | retired | unknown
publisher		0..0
contact		0..0
useContext		0..0
immutable		0..0
purpose		0..0
compose	S	1..1	BackboneElement	Content logical definition of the value set (CLD)
lockedDate		0..0
inactive		0..0
include	S	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
system	S	1..1	uri	The system the codes come from
version	S	0..1	string	Specific version of the code system referred to
concept	S	1..*	BackboneElement	A concept defined in the system
code	S	1..1	code	Code or expression from system
display	S	1..1	string	Text to display for this code for this value set in this valueset
designation		0..0
filter		0..0
valueSet		0..0
exclude		0..0
expansion		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	LIVDValueSet
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the value set
name	SΣC	1..1	string	Name for this value set (computer friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
compose	S	1..1	BackboneElement	Content logical definition of the value set (CLD)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
include	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
system	SΣC	1..1	uri	The system the codes come from
version	SΣ	0..1	string	Specific version of the code system referred to
concept	SC	1..*	BackboneElement	A concept defined in the system
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	code	Code or expression from system
display	S	1..1	string	Text to display for this code for this value set in this valueset
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.status	required	PublicationStatus
ValueSet.compose.include.filter.op	required	FilterOperator

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ValueSet	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ValueSet	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	ValueSet	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	ValueSet	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ValueSet	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()
vsd-0	warning	ValueSet	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1	error	ValueSet.compose.include	A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists()
vsd-2	error	ValueSet.compose.include	A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists()
vsd-3	error	ValueSet.compose.include	Cannot have both concept and filter : concept.empty() or filter.empty()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ValueSet	C	0..*	ValueSet	LIVDValueSet
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
url	SΣ	1..1	uri	Canonical identifier for this value set, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the value set
name	SΣC	1..1	string	Name for this value set (computer friendly)
title	Σ	0..1	string	Name for this value set (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
description		0..1	markdown	Natural language description of the value set
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
copyright		0..1	markdown	Use and/or publishing restrictions
compose	S	1..1	BackboneElement	Content logical definition of the value set (CLD)
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
include	SΣC	1..*	BackboneElement	Include one or more codes from a code system or other value set(s)
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
system	SΣC	1..1	uri	The system the codes come from
version	SΣ	0..1	string	Specific version of the code system referred to
concept	SC	1..*	BackboneElement	A concept defined in the system
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
code	S	1..1	code	Code or expression from system
display	S	1..1	string	Text to display for this code for this value set in this valueset
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
ValueSet.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.status	required	PublicationStatus
ValueSet.jurisdiction	extensible	Jurisdiction ValueSet
ValueSet.compose.include.concept.designation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use	extensible	DesignationUse
ValueSet.compose.include.filter.op	required	FilterOperator

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ValueSet	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ValueSet	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	ValueSet	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	ValueSet	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ValueSet	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()
vsd-0	warning	ValueSet	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1	error	ValueSet.compose.include	A value set include/exclude SHALL have a value set or a system : valueSet.exists() or system.exists()
vsd-2	error	ValueSet.compose.include	A value set with concepts or filters SHALL include a system : (concept.exists() or filter.exists()) implies system.exists()
vsd-3	error	ValueSet.compose.include	Cannot have both concept and filter : concept.empty() or filter.empty()
vsd-6	error	ValueSet.expansion.contains	SHALL have a code or a display : code.exists() or display.exists()
vsd-9	error	ValueSet.expansion.contains	Must have a code if not abstract : code.exists() or abstract = true
vsd-10	error	ValueSet.expansion.contains	Must have a system if a code is present : code.empty() or system.exists()

This structure is derived from ValueSet

Summary

Mandatory: 7 elements
Must-Support: 11 elements
Prohibited: 13 elements

Other representations of profile: CSV, Excel, Schematron