Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.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/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Expanded ValueSet

Official URL: http://hl7.org/fhir/StructureDefinition/expandedvalueset Version: 4.0.2
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: ExpandedValueSet
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.93

Defines an expanded value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an expanded value set, a computable definition of the value set must be obtained to compute the updated expansion. For production (active and not experimental) value sets, additional requirements apply to identify the value set, code system, and manifest versions used to produce the expansion, as well as the expansion identifier and licensing information (see Production Expansions).

​Original Source: hl7.org

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, exc-1, evs-2, evs-3
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:usageWarning This element must be supported. 1..1 (Complex) A warning about how to interpret and/or correctly use the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
ValueSet.Slices for extension.extension:usageWarning.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:usageWarning.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-warning"
ValueSet.Slices for extension.extension:usageWarning.value[x] This element must be supported. 1..1 markdown Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. (no extensions allowed)
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.url This element must be supported. This element is included in summaries. C 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.version This element must be supported. This element is included in summaries. C 0..1 string Business version of the value set
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ValueSet.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ValueSet.expansion This element must be supported. C 1..1 BackboneElement Used when the value set is "expanded"
Constraints: evs-1
ValueSet.expansion.Slices for extension Content/Rules for all slices
ValueSet.expansion.Slices for extension.extension:unclosed This element must be supported. 0..1 boolean The expansion is incomplete (perhaps because of post-coordination)
URL: http://hl7.org/fhir/StructureDefinition/valueset-unclosed
ValueSet.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.identifier This element must be supported. C 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp This element must be supported. 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total This element must be supported. 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset This element must be supported. 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter This element must be supported. C 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.Slices for extension Content/Rules for all slices
ValueSet.expansion.parameter.Slices for extension.extension:parameterSource This element must be supported. 0..1 code Declares the source of the parameter
URL: http://hl7.org/fhir/StructureDefinition/valueset-parameterSource
Binding: ExpansionParameterSource (required): Declares what the source of a parameter is.
ValueSet.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.parameter.name 1..1 string Name as assigned by the client or server
ValueSet.expansion.contains This element must be supported. C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
ValueSet.expansion.contains.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.contains.system This element must be supported. 0..1 uri System value for the code
ValueSet.expansion.contains.abstract This element must be supported. 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive This element must be supported. 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version This element must be supported. C 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code This element must be supported. C 1..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display This element must be supported. C 0..1 string User display for the concept
ValueSet.expansion.contains.contains This element must be supported. 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
evs-1 error ValueSet.expansion For contains, a version SHALL be provided unless the expansion parameters include a "used-codesystem" parameter (system|version) corresponding to the system of the entry. repeat(contains).all(system.empty() or version.exists() or system in %resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
evs-2 warning ValueSet A production (active and not experimental) expanded value set SHOULD specify url, version, publisher, copyright, and an expansion identifier (status = 'active' and experimental.where($this = true).empty()) implies (url.exists() and version.exists() and publisher.exists() and copyright.exists() and expansion.identifier.exists())
evs-3 warning ValueSet A production (active and not experimental) expanded value set SHOULD include a used-codesystem expansion parameter (system|version) for each code system in the expansion (status = 'active' and experimental.where($this = true).empty()) implies expansion.repeat(contains).system.select(toString()).distinct().subsetOf(%resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error ValueSet If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: exc-1, evs-2, evs-3
ValueSet.Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:usageWarning This element must be supported. 1..1 (Complex) A warning about how to interpret and/or correctly use the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
ValueSet.Slices for extension.extension:usageWarning.value[x] This element must be supported. 1..1 markdown Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. (no extensions allowed)
ValueSet.url This element must be supported. C 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.version This element must be supported. C 0..1 string Business version of the value set
ValueSet.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ValueSet.expansion This element must be supported. C 1..1 BackboneElement Used when the value set is "expanded"
Constraints: evs-1
ValueSet.expansion.Slices for extension Content/Rules for all slices
ValueSet.expansion.Slices for extension.extension:unclosed This element must be supported. 0..1 boolean The expansion is incomplete (perhaps because of post-coordination)
URL: http://hl7.org/fhir/StructureDefinition/valueset-unclosed
ValueSet.expansion.identifier This element must be supported. C 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp This element must be supported. 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total This element must be supported. 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset This element must be supported. 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter This element must be supported. C 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.Slices for extension Content/Rules for all slices
ValueSet.expansion.parameter.Slices for extension.extension:parameterSource This element must be supported. 0..1 code Declares the source of the parameter
URL: http://hl7.org/fhir/StructureDefinition/valueset-parameterSource
Binding: ExpansionParameterSource (required): Declares what the source of a parameter is.
ValueSet.expansion.contains This element must be supported. 0..* BackboneElement Codes in the value set
ValueSet.expansion.contains.system This element must be supported. 0..1 uri System value for the code
ValueSet.expansion.contains.abstract This element must be supported. 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive This element must be supported. 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version This element must be supported. C 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code This element must be supported. 1..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display This element must be supported. 0..1 string User display for the concept
ValueSet.expansion.contains.contains This element must be supported. 0..* Codes contained under this entry

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
evs-1 error ValueSet.expansion For contains, a version SHALL be provided unless the expansion parameters include a "used-codesystem" parameter (system|version) corresponding to the system of the entry. repeat(contains).all(system.empty() or version.exists() or system in %resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
evs-2 warning ValueSet A production (active and not experimental) expanded value set SHOULD specify url, version, publisher, copyright, and an expansion identifier (status = 'active' and experimental.where($this = true).empty()) implies (url.exists() and version.exists() and publisher.exists() and copyright.exists() and expansion.identifier.exists())
evs-3 warning ValueSet A production (active and not experimental) expanded value set SHOULD include a used-codesystem expansion parameter (system|version) for each code system in the expansion (status = 'active' and experimental.where($this = true).empty()) implies expansion.repeat(contains).system.select(toString()).distinct().subsetOf(%resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
exc-1 error ValueSet If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, exc-1, evs-2, evs-3
ValueSet.id This element is included in summaries. 0..1 id Logical id of this artifact
ValueSet.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.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
ValueSet.contained 0..* Resource Contained, inline Resources
ValueSet.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:usageWarning This element must be supported. 1..1 (Complex) A warning about how to interpret and/or correctly use the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
ValueSet.Slices for extension.extension:usageWarning.id 0..1 string Unique id for inter-element referencing
ValueSet.Slices for extension.extension:usageWarning.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:usageWarning.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-warning"
ValueSet.Slices for extension.extension:usageWarning.value[x] This element must be supported. 1..1 markdown Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. (no extensions allowed)
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.url This element must be supported. This element is included in summaries. C 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.identifier This element is included in summaries. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.version This element must be supported. This element is included in summaries. C 0..1 string Business version of the value set
ValueSet.name This element is included in summaries. C 0..1 string Name for this value set (computer friendly)
ValueSet.title This element is included in summaries. 0..1 string Name for this value set (human friendly)
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ValueSet.date This element is included in summaries. 0..1 dateTime Date last changed
ValueSet.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ValueSet.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ValueSet.description 0..1 markdown Natural language description of the value set
ValueSet.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ValueSet.immutable This element is included in summaries. 0..1 boolean Indicates whether or not any change to the content logical definition may occur
ValueSet.purpose 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.lockedDate This element is included in summaries. 0..1 date Fixed date for references with no specified version (transitive)
ValueSet.compose.inactive This element is included in summaries. 0..1 boolean Whether inactive codes are in the value set
ValueSet.compose.include This element is included in summaries. C 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
ValueSet.compose.include.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.system This element is included in summaries. C 0..1 uri The system the codes come from
ValueSet.compose.include.version This element is included in summaries. 0..1 string Specific version of the code system referred to
ValueSet.compose.include.concept C 0..* BackboneElement A concept defined in the system
ValueSet.compose.include.concept.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.code 1..1 code Code or expression from system
ValueSet.compose.include.concept.display 0..1 string Text to display for this code for this value set in this valueset
ValueSet.compose.include.concept.designation 0..* BackboneElement Additional representations for this concept
ValueSet.compose.include.concept.designation.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.designation.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.designation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.designation.language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
ValueSet.compose.include.concept.designation.value 1..1 string The text value for this designation
ValueSet.compose.include.filter This element is included in summaries. C 0..* BackboneElement Select codes/concepts by their properties (including relationships)
ValueSet.compose.include.filter.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.filter.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.filter.property This element is included in summaries. 1..1 code A property/filter defined by the code system
ValueSet.compose.include.filter.op This element is included in summaries. 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.
ValueSet.compose.include.filter.value This element is included in summaries. 1..1 string Code from the system, or regex criteria, or boolean value for exists
ValueSet.compose.include.valueSet This element is included in summaries. C 0..* canonical(ValueSet) Select the contents included in this value set
ValueSet.compose.exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
ValueSet.expansion This element must be supported. C 1..1 BackboneElement Used when the value set is "expanded"
Constraints: evs-1
ValueSet.expansion.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.expansion.Slices for extension.extension:unclosed This element must be supported. 0..1 boolean The expansion is incomplete (perhaps because of post-coordination)
URL: http://hl7.org/fhir/StructureDefinition/valueset-unclosed
ValueSet.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.identifier This element must be supported. C 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp This element must be supported. 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total This element must be supported. 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset This element must be supported. 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter This element must be supported. C 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.parameter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.expansion.parameter.Slices for extension.extension:parameterSource This element must be supported. 0..1 code Declares the source of the parameter
URL: http://hl7.org/fhir/StructureDefinition/valueset-parameterSource
Binding: ExpansionParameterSource (required): Declares what the source of a parameter is.
ValueSet.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.parameter.name 1..1 string Name as assigned by the client or server
ValueSet.expansion.parameter.value[x] 0..1 Value of the named parameter
ValueSet.expansion.parameter.value[x].valueString string
ValueSet.expansion.parameter.value[x].valueBoolean boolean
ValueSet.expansion.parameter.value[x].valueInteger integer
ValueSet.expansion.parameter.value[x].valueDecimal decimal
ValueSet.expansion.parameter.value[x].valueUri uri
ValueSet.expansion.parameter.value[x].valueCode code
ValueSet.expansion.parameter.value[x].valueDateTime dateTime
ValueSet.expansion.contains This element must be supported. C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
ValueSet.expansion.contains.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.contains.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.contains.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.contains.system This element must be supported. 0..1 uri System value for the code
ValueSet.expansion.contains.abstract This element must be supported. 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive This element must be supported. 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version This element must be supported. C 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code This element must be supported. C 1..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display This element must be supported. C 0..1 string User display for the concept
ValueSet.expansion.contains.designation 0..* See designation (ValueSet) Additional representations for this item
ValueSet.expansion.contains.contains This element must be supported. 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.
ValueSet.compose.include.​filter.op Base required FilterOperator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
evs-1 error ValueSet.expansion For contains, a version SHALL be provided unless the expansion parameters include a "used-codesystem" parameter (system|version) corresponding to the system of the entry. repeat(contains).all(system.empty() or version.exists() or system in %resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
evs-2 warning ValueSet A production (active and not experimental) expanded value set SHOULD specify url, version, publisher, copyright, and an expansion identifier (status = 'active' and experimental.where($this = true).empty()) implies (url.exists() and version.exists() and publisher.exists() and copyright.exists() and expansion.identifier.exists())
evs-3 warning ValueSet A production (active and not experimental) expanded value set SHOULD include a used-codesystem expansion parameter (system|version) for each code system in the expansion (status = 'active' and experimental.where($this = true).empty()) implies expansion.repeat(contains).system.select(toString()).distinct().subsetOf(%resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error ValueSet If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

This structure is derived from ValueSet

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, exc-1, evs-2, evs-3
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:usageWarning This element must be supported. 1..1 (Complex) A warning about how to interpret and/or correctly use the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
ValueSet.Slices for extension.extension:usageWarning.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:usageWarning.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-warning"
ValueSet.Slices for extension.extension:usageWarning.value[x] This element must be supported. 1..1 markdown Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. (no extensions allowed)
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.url This element must be supported. This element is included in summaries. C 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.version This element must be supported. This element is included in summaries. C 0..1 string Business version of the value set
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ValueSet.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ValueSet.expansion This element must be supported. C 1..1 BackboneElement Used when the value set is "expanded"
Constraints: evs-1
ValueSet.expansion.Slices for extension Content/Rules for all slices
ValueSet.expansion.Slices for extension.extension:unclosed This element must be supported. 0..1 boolean The expansion is incomplete (perhaps because of post-coordination)
URL: http://hl7.org/fhir/StructureDefinition/valueset-unclosed
ValueSet.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.identifier This element must be supported. C 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp This element must be supported. 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total This element must be supported. 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset This element must be supported. 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter This element must be supported. C 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.Slices for extension Content/Rules for all slices
ValueSet.expansion.parameter.Slices for extension.extension:parameterSource This element must be supported. 0..1 code Declares the source of the parameter
URL: http://hl7.org/fhir/StructureDefinition/valueset-parameterSource
Binding: ExpansionParameterSource (required): Declares what the source of a parameter is.
ValueSet.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.parameter.name 1..1 string Name as assigned by the client or server
ValueSet.expansion.contains This element must be supported. C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
ValueSet.expansion.contains.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.contains.system This element must be supported. 0..1 uri System value for the code
ValueSet.expansion.contains.abstract This element must be supported. 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive This element must be supported. 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version This element must be supported. C 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code This element must be supported. C 1..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display This element must be supported. C 0..1 string User display for the concept
ValueSet.expansion.contains.contains This element must be supported. 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
evs-1 error ValueSet.expansion For contains, a version SHALL be provided unless the expansion parameters include a "used-codesystem" parameter (system|version) corresponding to the system of the entry. repeat(contains).all(system.empty() or version.exists() or system in %resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
evs-2 warning ValueSet A production (active and not experimental) expanded value set SHOULD specify url, version, publisher, copyright, and an expansion identifier (status = 'active' and experimental.where($this = true).empty()) implies (url.exists() and version.exists() and publisher.exists() and copyright.exists() and expansion.identifier.exists())
evs-3 warning ValueSet A production (active and not experimental) expanded value set SHOULD include a used-codesystem expansion parameter (system|version) for each code system in the expansion (status = 'active' and experimental.where($this = true).empty()) implies expansion.repeat(contains).system.select(toString()).distinct().subsetOf(%resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error ValueSet If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: exc-1, evs-2, evs-3
ValueSet.Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:usageWarning This element must be supported. 1..1 (Complex) A warning about how to interpret and/or correctly use the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
ValueSet.Slices for extension.extension:usageWarning.value[x] This element must be supported. 1..1 markdown Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. (no extensions allowed)
ValueSet.url This element must be supported. C 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.version This element must be supported. C 0..1 string Business version of the value set
ValueSet.publisher This element must be supported. C 0..1 string Name of the publisher (organization or individual)
ValueSet.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ValueSet.expansion This element must be supported. C 1..1 BackboneElement Used when the value set is "expanded"
Constraints: evs-1
ValueSet.expansion.Slices for extension Content/Rules for all slices
ValueSet.expansion.Slices for extension.extension:unclosed This element must be supported. 0..1 boolean The expansion is incomplete (perhaps because of post-coordination)
URL: http://hl7.org/fhir/StructureDefinition/valueset-unclosed
ValueSet.expansion.identifier This element must be supported. C 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp This element must be supported. 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total This element must be supported. 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset This element must be supported. 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter This element must be supported. C 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.Slices for extension Content/Rules for all slices
ValueSet.expansion.parameter.Slices for extension.extension:parameterSource This element must be supported. 0..1 code Declares the source of the parameter
URL: http://hl7.org/fhir/StructureDefinition/valueset-parameterSource
Binding: ExpansionParameterSource (required): Declares what the source of a parameter is.
ValueSet.expansion.contains This element must be supported. 0..* BackboneElement Codes in the value set
ValueSet.expansion.contains.system This element must be supported. 0..1 uri System value for the code
ValueSet.expansion.contains.abstract This element must be supported. 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive This element must be supported. 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version This element must be supported. C 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code This element must be supported. 1..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display This element must be supported. 0..1 string User display for the concept
ValueSet.expansion.contains.contains This element must be supported. 0..* Codes contained under this entry

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
evs-1 error ValueSet.expansion For contains, a version SHALL be provided unless the expansion parameters include a "used-codesystem" parameter (system|version) corresponding to the system of the entry. repeat(contains).all(system.empty() or version.exists() or system in %resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
evs-2 warning ValueSet A production (active and not experimental) expanded value set SHOULD specify url, version, publisher, copyright, and an expansion identifier (status = 'active' and experimental.where($this = true).empty()) implies (url.exists() and version.exists() and publisher.exists() and copyright.exists() and expansion.identifier.exists())
evs-3 warning ValueSet A production (active and not experimental) expanded value set SHOULD include a used-codesystem expansion parameter (system|version) for each code system in the expansion (status = 'active' and experimental.where($this = true).empty()) implies expansion.repeat(contains).system.select(toString()).distinct().subsetOf(%resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
exc-1 error ValueSet If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, exc-1, evs-2, evs-3
ValueSet.id This element is included in summaries. 0..1 id Logical id of this artifact
ValueSet.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.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
ValueSet.contained 0..* Resource Contained, inline Resources
ValueSet.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:usageWarning This element must be supported. 1..1 (Complex) A warning about how to interpret and/or correctly use the value set
URL: http://hl7.org/fhir/StructureDefinition/valueset-warning
ValueSet.Slices for extension.extension:usageWarning.id 0..1 string Unique id for inter-element referencing
ValueSet.Slices for extension.extension:usageWarning.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:usageWarning.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-warning"
ValueSet.Slices for extension.extension:usageWarning.value[x] This element must be supported. 1..1 markdown Value of extension
Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. (no extensions allowed)
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.url This element must be supported. This element is included in summaries. C 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.identifier This element is included in summaries. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.version This element must be supported. This element is included in summaries. C 0..1 string Business version of the value set
ValueSet.name This element is included in summaries. C 0..1 string Name for this value set (computer friendly)
ValueSet.title This element is included in summaries. 0..1 string Name for this value set (human friendly)
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ValueSet.date This element is included in summaries. 0..1 dateTime Date last changed
ValueSet.publisher This element must be supported. This element is included in summaries. C 0..1 string Name of the publisher (organization or individual)
ValueSet.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ValueSet.description 0..1 markdown Natural language description of the value set
ValueSet.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ValueSet.immutable This element is included in summaries. 0..1 boolean Indicates whether or not any change to the content logical definition may occur
ValueSet.purpose 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. C 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.lockedDate This element is included in summaries. 0..1 date Fixed date for references with no specified version (transitive)
ValueSet.compose.inactive This element is included in summaries. 0..1 boolean Whether inactive codes are in the value set
ValueSet.compose.include This element is included in summaries. C 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
ValueSet.compose.include.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.system This element is included in summaries. C 0..1 uri The system the codes come from
ValueSet.compose.include.version This element is included in summaries. 0..1 string Specific version of the code system referred to
ValueSet.compose.include.concept C 0..* BackboneElement A concept defined in the system
ValueSet.compose.include.concept.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.code 1..1 code Code or expression from system
ValueSet.compose.include.concept.display 0..1 string Text to display for this code for this value set in this valueset
ValueSet.compose.include.concept.designation 0..* BackboneElement Additional representations for this concept
ValueSet.compose.include.concept.designation.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.designation.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.designation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.designation.language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
ValueSet.compose.include.concept.designation.value 1..1 string The text value for this designation
ValueSet.compose.include.filter This element is included in summaries. C 0..* BackboneElement Select codes/concepts by their properties (including relationships)
ValueSet.compose.include.filter.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.filter.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.filter.property This element is included in summaries. 1..1 code A property/filter defined by the code system
ValueSet.compose.include.filter.op This element is included in summaries. 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.
ValueSet.compose.include.filter.value This element is included in summaries. 1..1 string Code from the system, or regex criteria, or boolean value for exists
ValueSet.compose.include.valueSet This element is included in summaries. C 0..* canonical(ValueSet) Select the contents included in this value set
ValueSet.compose.exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
ValueSet.expansion This element must be supported. C 1..1 BackboneElement Used when the value set is "expanded"
Constraints: evs-1
ValueSet.expansion.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.expansion.Slices for extension.extension:unclosed This element must be supported. 0..1 boolean The expansion is incomplete (perhaps because of post-coordination)
URL: http://hl7.org/fhir/StructureDefinition/valueset-unclosed
ValueSet.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.identifier This element must be supported. C 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp This element must be supported. 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total This element must be supported. 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset This element must be supported. 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter This element must be supported. C 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.parameter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.expansion.parameter.Slices for extension.extension:parameterSource This element must be supported. 0..1 code Declares the source of the parameter
URL: http://hl7.org/fhir/StructureDefinition/valueset-parameterSource
Binding: ExpansionParameterSource (required): Declares what the source of a parameter is.
ValueSet.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.parameter.name 1..1 string Name as assigned by the client or server
ValueSet.expansion.parameter.value[x] 0..1 Value of the named parameter
ValueSet.expansion.parameter.value[x].valueString string
ValueSet.expansion.parameter.value[x].valueBoolean boolean
ValueSet.expansion.parameter.value[x].valueInteger integer
ValueSet.expansion.parameter.value[x].valueDecimal decimal
ValueSet.expansion.parameter.value[x].valueUri uri
ValueSet.expansion.parameter.value[x].valueCode code
ValueSet.expansion.parameter.value[x].valueDateTime dateTime
ValueSet.expansion.contains This element must be supported. C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
ValueSet.expansion.contains.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.contains.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.contains.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.contains.system This element must be supported. 0..1 uri System value for the code
ValueSet.expansion.contains.abstract This element must be supported. 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive This element must be supported. 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version This element must be supported. C 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code This element must be supported. C 1..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display This element must be supported. C 0..1 string User display for the concept
ValueSet.expansion.contains.designation 0..* See designation (ValueSet) Additional representations for this item
ValueSet.expansion.contains.contains This element must be supported. 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.
ValueSet.compose.include.​filter.op Base required FilterOperator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ValueSet If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
evs-1 error ValueSet.expansion For contains, a version SHALL be provided unless the expansion parameters include a "used-codesystem" parameter (system|version) corresponding to the system of the entry. repeat(contains).all(system.empty() or version.exists() or system in %resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
evs-2 warning ValueSet A production (active and not experimental) expanded value set SHOULD specify url, version, publisher, copyright, and an expansion identifier (status = 'active' and experimental.where($this = true).empty()) implies (url.exists() and version.exists() and publisher.exists() and copyright.exists() and expansion.identifier.exists())
evs-3 warning ValueSet A production (active and not experimental) expanded value set SHOULD include a used-codesystem expansion parameter (system|version) for each code system in the expansion (status = 'active' and experimental.where($this = true).empty()) implies expansion.repeat(contains).system.select(toString()).distinct().subsetOf(%resource.expansion.parameter.where(name = 'used-codesystem').value.toString().select(substring(0, indexOf('|'))))
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
exc-1 error ValueSet If knowledge capabilities are stated, they SHALL include executable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'executable').exists()
vsd-0 warning ValueSet Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

This structure is derived from ValueSet

 

Other representations of profile: CSV, Excel, Schematron