Vaccination CDS Implementation Guide
0.1.0 - ci-build

Vaccination CDS Implementation Guide, published by Euvabeco. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/EUVABECO/VCDS/ and changes regularly. See the Directory of published versions

Resource Profile: ValueSet

Official URL: https://euvabeco.net/vcds-ig/StructureDefinition/ValueSet Version: 0.1.0
Draft as of 2024-10-25 Computable Name: ValueSet

A value set possibly complemented with specific helper text.

Usage:

Formal Views of Profile Content

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

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... compose
.... include
..... concept
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... help 0..1 string Help message in value sets
URL: https://euvabeco.net/vcds-ig/StructureDefinition/ValueHelper

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this value set (computer friendly)
... title Σ 0..1 string Name for this value set (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... immutable Σ 0..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
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the ValueSet was approved by publisher
... lastReviewDate 0..1 date When the ValueSet was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ValueSet is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..* ContactDetail Who authored the ValueSet
... editor 0..* ContactDetail Who edited the ValueSet
... reviewer 0..* ContactDetail Who reviewed the ValueSet
... endorser 0..* ContactDetail Who endorsed the ValueSet
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... compose 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 Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... 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 ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 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
....... help 0..1 string Help message in value sets
URL: https://euvabeco.net/vcds-ig/StructureDefinition/ValueHelper
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation C 0..* BackboneElement Additional representations for this concept
vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present
....... 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
....... language 0..1 code Human language of the designation
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
....... use C 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... additionalUse C 0..* Coding Additional ways how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.


....... value 1..1 string The text value for this designation
..... filter Σ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 Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
..... copyright 0..1 string A copyright statement for the specific code system included in the value set
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
.... property 0..* string Property to return if client doesn't override
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... 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
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... next 0..1 uri Opaque urls for paging through expansion results
.... timestamp 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
.... property 0..* BackboneElement Additional information supplied about each concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Identifies the property on the concepts, and when referred to in operations
..... uri 0..1 uri Formal identifier for the property
.... contains C 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display
vsd-9: SHALL have a code if not abstract
vsd-10: SHALL have a system if a code is present
..... 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 C 0..1 uri System value for the code
..... abstract C 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... property 0..* BackboneElement Property value for the concept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Reference to ValueSet.expansion.property.code
...... value[x] 1..1 Value of the property for this concept
....... valueCode code
....... valueCoding Coding
....... valueString string
....... valueInteger integer
....... valueBoolean boolean
....... valueDateTime dateTime
....... valueDecimal decimal
...... subProperty 0..* BackboneElement SubProperty value for the concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... code 1..1 code Reference to ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
... scope 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... 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
.... inclusionCriteria 0..1 string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1 string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ValueSet.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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-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.containsSHALL have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsSHALL have a system if a code is present
: code.empty() or system.exists()
vsd-11errorValueSet.compose.include.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.exists()

This structure is derived from ValueSet

Summary

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... compose
.... include
..... concept
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... help 0..1 string Help message in value sets
URL: https://euvabeco.net/vcds-ig/StructureDefinition/ValueHelper

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this value set (computer friendly)
... title Σ 0..1 string Name for this value set (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 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: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... immutable Σ 0..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
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the ValueSet was approved by publisher
... lastReviewDate 0..1 date When the ValueSet was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the ValueSet is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author 0..* ContactDetail Who authored the ValueSet
... editor 0..* ContactDetail Who edited the ValueSet
... reviewer 0..* ContactDetail Who reviewed the ValueSet
... endorser 0..* ContactDetail Who endorsed the ValueSet
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... compose 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 Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... 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 ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 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
....... help 0..1 string Help message in value sets
URL: https://euvabeco.net/vcds-ig/StructureDefinition/ValueHelper
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation C 0..* BackboneElement Additional representations for this concept
vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present
....... 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
....... language 0..1 code Human language of the designation
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
....... use C 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... additionalUse C 0..* Coding Additional ways how this designation would be used
Binding: DesignationUse (extensible): Details of how a designation would be used.


....... value 1..1 string The text value for this designation
..... filter Σ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 Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
..... copyright 0..1 string A copyright statement for the specific code system included in the value set
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
.... property 0..* string Property to return if client doesn't override
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... 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
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... next 0..1 uri Opaque urls for paging through expansion results
.... timestamp 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
.... property 0..* BackboneElement Additional information supplied about each concept
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code Identifies the property on the concepts, and when referred to in operations
..... uri 0..1 uri Formal identifier for the property
.... contains C 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display
vsd-9: SHALL have a code if not abstract
vsd-10: SHALL have a system if a code is present
..... 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 C 0..1 uri System value for the code
..... abstract C 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... property 0..* BackboneElement Property value for the concept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Reference to ValueSet.expansion.property.code
...... value[x] 1..1 Value of the property for this concept
....... valueCode code
....... valueCoding Coding
....... valueString string
....... valueInteger integer
....... valueBoolean boolean
....... valueDateTime dateTime
....... valueDecimal decimal
...... subProperty 0..* BackboneElement SubProperty value for the concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... code 1..1 code Reference to ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry
... scope 0..1 BackboneElement Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... 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
.... inclusionCriteria 0..1 string Criteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1 string Criteria describing which concepts or codes should be excluded and why

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ValueSet.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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-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.containsSHALL have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsSHALL have a system if a code is present
: code.empty() or system.exists()
vsd-11errorValueSet.compose.include.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.exists()

This structure is derived from ValueSet

Summary

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron