Structured Data Capture
4.0.0-ballot - STU 4 ballot International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Resource Profile: SDC Value Set

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset Version: 4.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: SDCValueSet
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.70

Defines how ValueSet is used to reflect code lists found in data element defintions and form definitions to be used within the ONC's Structured Data Capture standard.

Scope and Usage

Value Sets are used to define possible answer choices in a re-useable cross-questionnaire (and other data structure) manner. They reference codes from one or more Code Systems which might be locally-defined or might be standard international terminologies like LOINC or SNOMED CT or regional code systems for drugs, billing codes, etc. The use of standardized codes is useful when data needs to be populated into the questionnaire or extracted from the questionnaire for other uses. It is also helpful when the set of possibilities is highly dynamic - for example drug codes where the set of available codes might change daily or weekly.

This profile sets expectations for use of the ValueSet resource when used as a source for answers to questions in a Questionnaire. It identifies which core elements and extensions must be supported and highlights other elements that, while not required, may be relevant to the Questionnaire use-case.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the value set
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
... compose S 0..1 BackboneElement Content logical definition of the value set (CLD)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate SΣ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive SΣ 0..1 boolean Whether inactive codes are in the value set
.... include SΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system SΣC 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to
..... concept SC 0..* BackboneElement A concept defined in the system
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
........ value[x] 1..1 string Value of extension
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.......... extension:code-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.......... extension:code-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code S 1..1 code Code or expression from system
...... display S 0..1 string Text to display for this code for this value set in this valueset
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:codeDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:codeDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... filter SΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property SΣ 1..1 code A property/filter defined by the code system
...... op SΣ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value SΣ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet SΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude SC 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion S 0..1 BackboneElement Used when the value set is "expanded"
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expansionSource 0..1 uri ValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
..... extension:expansionProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains SC 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expansionLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
....... value[x] 1..1 string Value of extension
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:expansion-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:expansion-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... extension:containsProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 0..1 uri System value for the code
..... abstract S 0..1 boolean If user cannot select this entry
..... version S 0..1 string Version in which this code/display is defined
..... code SC 0..1 code Code - if blank, this is not a selectable code
..... display SC 0..1 string User display for the concept
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... designation 0..* BackboneElement Additional representations for this item
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDesignation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDesignation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value 1..1 string The text value for this designation
..... contains S 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA 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()
vsd-0warningValueSetName 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-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url S 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... status S 1..1 code draft | active | retired | unknown
... date S 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the value set
... immutable S 1..1 boolean Indicates whether or not any change to the content logical definition may occur
... compose S 0..1 BackboneElement Content logical definition of the value set (CLD)
.... lockedDate S 0..1 date Fixed date for references with no specified version (transitive)
.... inactive S 0..1 boolean Whether inactive codes are in the value set
.... include S 1..* BackboneElement Include one or more codes from a code system or other value set(s)
..... system S 0..1 uri The system the codes come from
..... version S 0..1 string Specific version of the code system referred to
..... concept S 0..* BackboneElement A concept defined in the system
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
........ value[x]
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.......... extension:code-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.......... extension:code-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... code S 1..1 code Code or expression from system
...... display S 0..1 string Text to display for this code for this value set in this valueset
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:codeDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:codeDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... designation
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:designation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:designation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... filter S 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... property S 1..1 code A property/filter defined by the code system
...... op S 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value S 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet S 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude S 0..* Explicitly exclude codes from a code system or other value sets
... expansion S 0..1 BackboneElement Used when the value set is "expanded"
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expansionSource 0..1 uri ValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
..... extension:expansionProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property
.... identifier S 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains S 0..* BackboneElement Codes in the value set
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expansionLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... value[x]
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:expansion-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:expansion-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... extension:containsProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property
..... system S 0..1 uri System value for the code
..... abstract S 0..1 boolean If user cannot select this entry
..... version S 0..1 string Version in which this code/display is defined
..... code S 0..1 code Code - if blank, this is not a selectable code
..... display S 0..1 string User display for the concept
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... designation 0..* BackboneElement Additional representations for this item
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDesignation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDesignation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... contains S 0..* Codes contained under this entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... name ΣC 0..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 SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 0..1 markdown Natural language description of the value set
... useContext Σ 0..* UsageContext The context that the content is intended to support
... 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.
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose S 0..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
.... lockedDate SΣ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive SΣ 0..1 boolean Whether inactive codes are in the value set
.... include SΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... 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 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to
..... concept SC 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
........ value[x] 1..1 string Value of extension
......... id 0..1 string xml:id (or equivalent in JSON)
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.......... extension:code-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.......... extension:code-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
......... value 0..1 string Primitive value for string
Max Length:1048576
....... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code S 1..1 code Code or expression from system
...... display S 0..1 string Text to display for this code for this value set in this valueset
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:codeDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:codeDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1 string Primitive value for string
Max Length:1048576
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:designation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:designation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
....... value 1..1 string The text value for this designation
..... filter SΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... 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
...... property SΣ 1..1 code A property/filter defined by the code system
...... op SΣ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value SΣ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet SΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude SC 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion S 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expansionSource 0..1 uri ValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
..... extension:expansionProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... 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
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains SC 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expansionLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
....... value[x] 1..1 string Value of extension
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:expansion-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:expansion-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
........ value 0..1 string Primitive value for string
Max Length:1048576
...... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... extension:containsProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 0..1 uri System value for the code
..... abstract S 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version S 0..1 string Version in which this code/display is defined
..... code SC 0..1 code Code - if blank, this is not a selectable code
..... display SC 0..1 string User display for the concept
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value 0..1 string Primitive value for string
Max Length:1048576
..... designation 0..* BackboneElement Additional representations for this item
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDesignation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDesignation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
...... value 1..1 string The text value for this designation
..... contains S 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard
ValueSet.expansion.contains.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.expansion.contains.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA 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()
vsd-0warningValueSetName 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-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... experimental SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the value set
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
... compose S 0..1 BackboneElement Content logical definition of the value set (CLD)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate SΣ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive SΣ 0..1 boolean Whether inactive codes are in the value set
.... include SΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system SΣC 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to
..... concept SC 0..* BackboneElement A concept defined in the system
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
........ value[x] 1..1 string Value of extension
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.......... extension:code-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.......... extension:code-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code S 1..1 code Code or expression from system
...... display S 0..1 string Text to display for this code for this value set in this valueset
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:codeDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:codeDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... filter SΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property SΣ 1..1 code A property/filter defined by the code system
...... op SΣ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value SΣ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet SΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude SC 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion S 0..1 BackboneElement Used when the value set is "expanded"
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expansionSource 0..1 uri ValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
..... extension:expansionProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains SC 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expansionLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
....... value[x] 1..1 string Value of extension
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:expansion-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:expansion-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... extension:containsProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 0..1 uri System value for the code
..... abstract S 0..1 boolean If user cannot select this entry
..... version S 0..1 string Version in which this code/display is defined
..... code SC 0..1 code Code - if blank, this is not a selectable code
..... display SC 0..1 string User display for the concept
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... designation 0..* BackboneElement Additional representations for this item
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDesignation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDesignation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... value 1..1 string The text value for this designation
..... contains S 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA 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()
vsd-0warningValueSetName 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-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url S 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... status S 1..1 code draft | active | retired | unknown
... date S 0..1 dateTime Date last changed
... description S 0..1 markdown Natural language description of the value set
... immutable S 1..1 boolean Indicates whether or not any change to the content logical definition may occur
... compose S 0..1 BackboneElement Content logical definition of the value set (CLD)
.... lockedDate S 0..1 date Fixed date for references with no specified version (transitive)
.... inactive S 0..1 boolean Whether inactive codes are in the value set
.... include S 1..* BackboneElement Include one or more codes from a code system or other value set(s)
..... system S 0..1 uri The system the codes come from
..... version S 0..1 string Specific version of the code system referred to
..... concept S 0..* BackboneElement A concept defined in the system
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
........ value[x]
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.......... extension:code-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.......... extension:code-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... code S 1..1 code Code or expression from system
...... display S 0..1 string Text to display for this code for this value set in this valueset
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:codeDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:codeDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... designation
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:designation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:designation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... filter S 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... property S 1..1 code A property/filter defined by the code system
...... op S 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value S 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet S 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude S 0..* Explicitly exclude codes from a code system or other value sets
... expansion S 0..1 BackboneElement Used when the value set is "expanded"
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expansionSource 0..1 uri ValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
..... extension:expansionProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property
.... identifier S 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... contains S 0..* BackboneElement Codes in the value set
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expansionLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... value[x]
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:expansion-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:expansion-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... extension:containsProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property
..... system S 0..1 uri System value for the code
..... abstract S 0..1 boolean If user cannot select this entry
..... version S 0..1 string Version in which this code/display is defined
..... code S 0..1 code Code - if blank, this is not a selectable code
..... display S 0..1 string User display for the concept
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... designation 0..* BackboneElement Additional representations for this item
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDesignation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDesignation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... contains S 0..* Codes contained under this entry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:rendering-criticalExtension ?!S 0..* canonical() Extension that must be supported
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-rendering-criticalExtension
... url SΣ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... name ΣC 0..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 SΣ 0..1 boolean For testing purposes, not real usage
... date SΣ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 0..1 markdown Natural language description of the value set
... useContext Σ 0..* UsageContext The context that the content is intended to support
... 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.
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose S 0..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
.... lockedDate SΣ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive SΣ 0..1 boolean Whether inactive codes are in the value set
.... include SΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... 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 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to
..... concept SC 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:conceptLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
........ value[x] 1..1 string Value of extension
......... id 0..1 string xml:id (or equivalent in JSON)
......... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.......... extension:code-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.......... extension:code-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
......... value 0..1 string Primitive value for string
Max Length:1048576
....... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code S 1..1 code Code or expression from system
...... display S 0..1 string Text to display for this code for this value set in this valueset
....... id 0..1 string xml:id (or equivalent in JSON)
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:codeDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:codeDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1 string Primitive value for string
Max Length:1048576
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:designation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ extension:designation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
....... value 1..1 string The text value for this designation
..... filter SΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... 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
...... property SΣ 1..1 code A property/filter defined by the code system
...... op SΣ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
...... value SΣ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet SΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude SC 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion S 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expansionSource 0..1 uri ValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
..... extension:expansionProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... 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
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains SC 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expansionLabel S 0..1 (Complex) E.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-label"
....... value[x] 1..1 string Value of extension
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:expansion-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
......... extension:expansion-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
........ value 0..1 string Primitive value for string
Max Length:1048576
...... extension:conceptConceptOrder S 0..1 integer Appearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... extension:containsProperty S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system S 0..1 uri System value for the code
..... abstract S 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version S 0..1 string Version in which this code/display is defined
..... code SC 0..1 code Code - if blank, this is not a selectable code
..... display SC 0..1 string User display for the concept
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDisplay-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDisplay-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value 0..1 string Primitive value for string
Max Length:1048576
..... designation 0..* BackboneElement Additional representations for this item
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:expansionDesignation-renderingStyle 0..1 string Html style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... extension:expansionDesignation-xhtml 0..1 string String equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
...... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
...... value 1..1 string The text value for this designation
..... contains S 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
From the FHIR Standard
ValueSet.expansion.contains.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.expansion.contains.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf 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-4errorValueSetIf 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-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA 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()
vsd-0warningValueSetName 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-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

 

Other representations of profile: CSV, Excel, Schematron