Termini

CodeSystemsConceptSystemsStructureDefinitionsValueSetsPackagesConflicts
StructureDefinitionsValueSet

http://hl7.org/fhir/StructureDefinition/ValueSet|5.0.0

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).
StructureJSONDependenciesFHIRSchemaOther VersionsDependant (0)ElementsSummary
NameFlagsCardTypeDescription & Constraints
ValueSet
0..*A set of codes drawn from one or more code systems
 
url
Σ
0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
 
identifier
Σ
0..*IdentifierAdditional identifier for the value set (business identifier)
 
version
Σ
0..1stringBusiness version of the value set
 
versionAlgorithm[x]
Σ
0..1How to compare versions http://hl7.org/fhir/ValueSet/version-algorithm (extensible)
 
 
versionAlgorithmString
Σ
0..1string http://hl7.org/fhir/ValueSet/version-algorithm (extensible)
 
 
versionAlgorithmCoding
Σ
0..1Coding http://hl7.org/fhir/ValueSet/version-algorithm (extensible)
 
name
Σ
0..1stringName for this value set (computer friendly)
 
title
Σ
0..1stringName for this value set (human friendly)
 
status *
?!Σ
1..1codedraft | active | retired | unknown PublicationStatus (required)
 
experimental
Σ
0..1booleanFor testing purposes, not real usage
 
date
Σ
0..1dateTimeDate last changed
 
publisher
Σ
0..1stringName of the publisher/steward (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) Jurisdiction (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
 
copyrightLabel
0..1stringCopyright holder and year(s)
 
approvalDate
0..1dateWhen the ValueSet was approved by publisher
 
lastReviewDate
0..1dateWhen the ValueSet was last reviewed by the publisher
 
effectivePeriod
Σ
0..1PeriodWhen the ValueSet is expected to be used
 
topic
0..*CodeableConceptE.g. Education, Treatment, Assessment, etc DefinitionTopic (example)
 
author
0..*ContactDetailWho authored the ValueSet
 
editor
0..*ContactDetailWho edited the ValueSet
 
reviewer
0..*ContactDetailWho reviewed the ValueSet
 
endorser
0..*ContactDetailWho endorsed the ValueSet
 
relatedArtifact
0..*RelatedArtifactAdditional documentation, citations, etc
 
compose
0..1BackboneElementContent logical definition of the value set (CLD)
 
 
lockedDate
Σ
0..1dateFixed date for references with no specified version (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 Language (required)
 
 
 
 
 
use
0..1CodingTypes of uses of designations ConceptDesignationUse (extensible)
 
 
 
 
 
additionalUse
0..*CodingAdditional ways how this designation would be used ConceptDesignationUse (extensible)
 
 
 
 
 
value *
1..1stringThe text value for this designation
 
 
 
filter
Σ
0..*BackboneElementSelect codes/concepts by their properties (including relationships)
 
 
 
 
property *
Σ
1..1codeA property/filter defined by the code system
 
 
 
 
op *
Σ
1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists FilterOperator (required)
 
 
 
 
value *
Σ
1..1stringCode from the system, or regex criteria, or boolean value for exists
 
 
 
valueSet
Σ
0..*canonicalSelect the contents included in this value set
 
 
 
copyright
0..1stringA copyright statement for the specific code system included in the value set
 
 
exclude
0..*Explicitly exclude codes from a code system or other value sets
 
 
property
0..*stringProperty to return if client doesn't override
 
expansion
0..1BackboneElementUsed when the value set is \"expanded\"
 
 
identifier
0..1uriIdentifies the value set expansion (business identifier)
 
 
next
0..1uriOpaque urls for paging through expansion results
 
 
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 client or server
 
 
 
value[x]
0..1Value of the named parameter
 
 
 
 
valueString
0..1string
 
 
 
 
valueBoolean
0..1boolean
 
 
 
 
valueInteger
0..1integer
 
 
 
 
valueDecimal
0..1decimal
 
 
 
 
valueUri
0..1uri
 
 
 
 
valueCode
0..1code
 
 
 
 
valueDateTime
0..1dateTime
 
 
property
0..*BackboneElementAdditional information supplied about each concept
 
 
 
code *
1..1codeIdentifies the property on the concepts, and when referred to in operations
 
 
 
uri
0..1uriFormal identifier for the property
 
 
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
 
 
 
property
0..*BackboneElementProperty value for the concept
 
 
 
 
code *
1..1codeReference to ValueSet.expansion.property.code
 
 
 
 
value[x] *
1..1Value of the property for this concept
 
 
 
 
 
valueCode *
1..1code
 
 
 
 
 
valueCoding *
1..1Coding
 
 
 
 
 
valueString *
1..1string
 
 
 
 
 
valueInteger *
1..1integer
 
 
 
 
 
valueBoolean *
1..1boolean
 
 
 
 
 
valueDateTime *
1..1dateTime
 
 
 
 
 
valueDecimal *
1..1decimal
 
 
 
 
subProperty
0..*BackboneElementSubProperty value for the concept
 
 
 
 
 
code *
1..1codeReference to ValueSet.expansion.property.code
 
 
 
 
 
value[x] *
1..1Value of the subproperty for this concept
 
 
 
 
 
 
valueCode *
1..1code
 
 
 
 
 
 
valueCoding *
1..1Coding
 
 
 
 
 
 
valueString *
1..1string
 
 
 
 
 
 
valueInteger *
1..1integer
 
 
 
 
 
 
valueBoolean *
1..1boolean
 
 
 
 
 
 
valueDateTime *
1..1dateTime
 
 
 
 
 
 
valueDecimal *
1..1decimal
 
 
 
contains
0..*Codes contained under this entry
 
scope
0..1BackboneElementDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
 
 
inclusionCriteria
0..1stringCriteria describing which concepts or codes should be included and why
 
 
exclusionCriteria
0..1stringCriteria describing which concepts or codes should be excluded and why