This page is part of the Loinc/IVD Mapping FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

This is a pre-release version (Draft for Comment) of Loinc/IVD Mapping (LIVD) R1 (STU). There is no current official version.
For a full list of available versions, see the Directory of published versions .

StructureDefinition: LIVD ValueSet

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from ValueSet

Summary

Mandatory: 1 element (8 nested mandatory elements)
Prohibited: 1 element

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..*LIVD ValueSet
... url 1..1uri
... identifier 0..0
... version 0..1string
... name 0..1string
... title 0..1string
... status 1..1code
... experimental 0..1boolean
... date 0..1dateTime
... publisher 0..1string
... contact 0..*ContactDetail
... description 0..1markdown
... useContext 0..*UsageContext
... jurisdiction 0..*CodeableConcept
... immutable 0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdown
... copyright 0..1markdown
... compose 0..1BackboneElementDefinition of the content of the value set
.... lockedDate 0..1dateFixed date for version-less references (transitive)
.... inactive 0..1booleanWhether inactive codes are in the value set
.... include 1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... system 0..1uriThe system the codes come from
..... version 0..1stringSpecific version of the code system referred to
..... concept 0..*BackboneElementA concept defined in the system
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation 0..*BackboneElementAdditional representations for this concept
....... language 0..1codeHuman language of the designation
....... use 0..1CodingDetails how this designation would be used
....... value 1..1stringThe text value for this designation
..... filter 0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... property 1..1codeA property defined by the code system
...... op 1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value 1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet 0..*canonical(ValueSet)Select the contents included in this value set
.... exclude 0..*Explicitly exclude codes from a code system or other value sets
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... identifier 0..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... name 1..1stringName as assigned by the server
..... value[x] 0..1string, boolean, integer, decimal, uri, code, dateTimeValue of the named parameter
.... contains 0..*BackboneElementCodes in the value set
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code 0..1codeCode - if blank, this is not a selectable code
..... display 0..1stringUser display for the concept
..... designation 0..*Additional representations for this item
..... contains 0..*Codes contained under this entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*LIVD ValueSet
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... 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
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the value set
... name ΣI0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... compose I0..1BackboneElementDefinition of the content of the value set
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... lockedDate Σ0..1dateFixed date for version-less references (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system ΣI0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
....... language 0..1codeHuman language of the designation
Binding: Common Languages (preferred)
....... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible)
....... value 1..1stringThe text value for this designation
..... filter ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... property Σ1..1codeA property defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value Σ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude I0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
... expansion I0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... identifier 0..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... name 1..1stringName as assigned by the server
..... value[x] 0..1string, boolean, integer, decimal, uri, code, dateTimeValue of the named parameter
.... contains I0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation 0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... contains 0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

doco Documentation for this format

This structure is derived from ValueSet

Summary

Mandatory: 1 element (8 nested mandatory elements)
Prohibited: 1 element

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..*LIVD ValueSet
... url 1..1uri
... identifier 0..0
... version 0..1string
... name 0..1string
... title 0..1string
... status 1..1code
... experimental 0..1boolean
... date 0..1dateTime
... publisher 0..1string
... contact 0..*ContactDetail
... description 0..1markdown
... useContext 0..*UsageContext
... jurisdiction 0..*CodeableConcept
... immutable 0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdown
... copyright 0..1markdown
... compose 0..1BackboneElementDefinition of the content of the value set
.... lockedDate 0..1dateFixed date for version-less references (transitive)
.... inactive 0..1booleanWhether inactive codes are in the value set
.... include 1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... system 0..1uriThe system the codes come from
..... version 0..1stringSpecific version of the code system referred to
..... concept 0..*BackboneElementA concept defined in the system
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation 0..*BackboneElementAdditional representations for this concept
....... language 0..1codeHuman language of the designation
....... use 0..1CodingDetails how this designation would be used
....... value 1..1stringThe text value for this designation
..... filter 0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... property 1..1codeA property defined by the code system
...... op 1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value 1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet 0..*canonical(ValueSet)Select the contents included in this value set
.... exclude 0..*Explicitly exclude codes from a code system or other value sets
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... identifier 0..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... name 1..1stringName as assigned by the server
..... value[x] 0..1string, boolean, integer, decimal, uri, code, dateTimeValue of the named parameter
.... contains 0..*BackboneElementCodes in the value set
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code 0..1codeCode - if blank, this is not a selectable code
..... display 0..1stringUser display for the concept
..... designation 0..*Additional representations for this item
..... contains 0..*Codes contained under this entry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*LIVD ValueSet
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... 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
... url Σ1..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the value set
... name ΣI0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... compose I0..1BackboneElementDefinition of the content of the value set
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... lockedDate Σ0..1dateFixed date for version-less references (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system ΣI0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
....... language 0..1codeHuman language of the designation
Binding: Common Languages (preferred)
....... use 0..1CodingDetails how this designation would be used
Binding: DesignationUse (extensible)
....... value 1..1stringThe text value for this designation
..... filter ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... property Σ1..1codeA property defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value Σ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude I0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
... expansion I0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... identifier 0..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... name 1..1stringName as assigned by the server
..... value[x] 0..1string, boolean, integer, decimal, uri, code, dateTimeValue of the named parameter
.... contains I0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... designation 0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... contains 0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
ValueSet.languageLanguagepreferredCommon Languages
ValueSet.statusPublicationStatusrequiredPublicationStatus
ValueSet.jurisdictionJurisdictionextensibleJurisdiction ValueSet
ValueSet.compose.include.concept.designation.languageLanguagepreferredCommon Languages
ValueSet.compose.include.concept.designation.useDesignation UseextensibleDesignationUse
ValueSet.compose.include.filter.opFilterOperatorrequiredFilterOperator

Constraints

IdPathDetailsRequirements
dom-2ValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ValueSetIf 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-3ValueSetIf 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-6ValueSetA resource should have narrative for robust management
: text.div.exists()
dom-5ValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
vsd-11ValueSetStatus must = 'active' if expansion is present and compose is absent
: status='active' or compose.exists() or expansion.empty()
vsd-0ValueSetName 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}')
ele-1ValueSet.composeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.compose.includeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-2ValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3ValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-1ValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
ele-1ValueSet.compose.include.conceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.compose.include.concept.designationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.compose.include.filterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.expansionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.expansion.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.expansion.containsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-6ValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9ValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10ValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()