Structured Data Capture 2.5.0 - Edition 3(STU), For Comment 2018Sep Ballot

This page is part of the Structured Data Capture FHIR IG (v2.5.0: STU 3 Ballot 1) based on FHIR v3.5.0. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

10.16 StructureDefinition: Structured Data Capture Value Set

The official URL for this profile is: 

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

10.16.1 Scope and Usage

This profile sets expectations for use of the ValueSet resource within the Structured Data Capture implementation guide. This includes identifying which core elements and extensions must be supported.

For the purposes of this profile, Supported means that clients SHALL be capable of processing the element/extension and use the information to control the display and information capture associated with the ValueSet. It means that servers SHALL be capable of persisting those elements and returning them in response to requests. For systems rendering Questionnaires, these Supported elements and extensions must be supported in the rendering of allowed choices associated with questions.

10.16.2 Boundaries and Relationships

This profile relies on the use of the valueset-extensions profile which defines a number of less common properties for value sets, several of which are mandated for this profile. It also makes use of the r rendering-extensions which defines rendering information for display names and labels of codes.

10.16.2 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..*
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... url S0..1uri
... name S1..1string
... title 0..1string
... status S1..1code
... experimental S0..1boolean
... date S0..1dateTime
... description S1..1markdown
... useContext 0..*UsageContext
... jurisdiction 0..*CodeableConcept
... immutable S1..1boolean
... compose S0..1BackboneElement
.... lockedDate S0..1date
.... inactive S0..1boolean
.... include S1..*BackboneElement
..... system S0..1uri
..... version S0..1string
..... concept S0..*BackboneElement
...... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... valueString 0..1string
........ rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... code S1..1code
...... display S0..1string
....... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... filter S0..*BackboneElement
...... property S1..1code
...... op S1..1code
...... value S1..1string
..... valueSet S0..*canonical(ValueSet)
.... exclude S0..*
... expansion S0..1BackboneElement
.... identifier S0..1uri
.... timestamp S1..1dateTime
.... contains S0..*BackboneElement
..... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... valueString 0..1string
....... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... system S0..1uri
..... abstract S0..1boolean
..... version S0..1string
..... code S0..1code
..... display S0..1string
...... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... designation 0..*
..... contains S0..*

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*A set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rendering-styleSensitive SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the value set (business identifier)
... version Σ0..1stringBusiness version of the value set
... name SΣI1..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!SΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ0..1booleanFor testing purposes, not real usage
... date SΣ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... immutable SΣ1..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... compose SI0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... lockedDate SΣ0..1dateFixed date for references with no specified version (transitive)
.... inactive SΣ0..1booleanWhether inactive codes are in the value set
.... include SΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system SΣI0..1uriThe system the codes come from
..... version SΣ0..1stringSpecific version of the code system referred to
..... concept SI0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... valueset-label SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
....... valueString 0..1stringValue of extension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
........ value 0..1Primitive value for string
Max Length: 1048576
...... valueset-conceptOrder SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... code S1..1codeCode or expression from system
...... display S0..1stringText to display for this code for this value set in this valueset
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1Primitive value for string
Max Length: 1048576
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
....... language 0..1codeHuman language of the designation
Binding: Common Languages (preferred)
....... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible)
....... value 1..1stringThe text value for this designation
..... filter SΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... property SΣ1..1codeA property defined by the code system
...... op SΣ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value SΣ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet SΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude SI0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
... expansion SI0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... identifier S0..1uriIdentifies the value set expansion (business identifier)
.... timestamp S1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1string, boolean, integer, decimal, uri, code, dateTimeValue of the named parameter
.... contains SI0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... valueset-label SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
...... valueString 0..1stringValue of extension
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1Primitive value for string
Max Length: 1048576
..... valueset-conceptOrder SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system S0..1uriSystem value for the code
..... abstract S0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version S0..1stringVersion in which this code/display is defined
..... code SI0..1codeCode - if blank, this is not a selectable code
..... display SI0..1stringUser display for the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value 0..1Primitive value for string
Max Length: 1048576
..... designation 0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... contains S0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

doco Documentation for this format

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..*
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... url S0..1uri
... name S1..1string
... title 0..1string
... status S1..1code
... experimental S0..1boolean
... date S0..1dateTime
... description S1..1markdown
... useContext 0..*UsageContext
... jurisdiction 0..*CodeableConcept
... immutable S1..1boolean
... compose S0..1BackboneElement
.... lockedDate S0..1date
.... inactive S0..1boolean
.... include S1..*BackboneElement
..... system S0..1uri
..... version S0..1string
..... concept S0..*BackboneElement
...... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... valueString 0..1string
........ rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... code S1..1code
...... display S0..1string
....... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... filter S0..*BackboneElement
...... property S1..1code
...... op S1..1code
...... value S1..1string
..... valueSet S0..*canonical(ValueSet)
.... exclude S0..*
... expansion S0..1BackboneElement
.... identifier S0..1uri
.... timestamp S1..1dateTime
.... contains S0..*BackboneElement
..... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... valueString 0..1string
....... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... system S0..1uri
..... abstract S0..1boolean
..... version S0..1string
..... code S0..1code
..... display S0..1string
...... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... designation 0..*
..... contains S0..*

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*A set of codes drawn from one or more code systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rendering-styleSensitive SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the value set (business identifier)
... version Σ0..1stringBusiness version of the value set
... name SΣI1..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!SΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ0..1booleanFor testing purposes, not real usage
... date SΣ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S1..1markdownNatural language description of the value set
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... immutable SΣ1..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... compose SI0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... lockedDate SΣ0..1dateFixed date for references with no specified version (transitive)
.... inactive SΣ0..1booleanWhether inactive codes are in the value set
.... include SΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system SΣI0..1uriThe system the codes come from
..... version SΣ0..1stringSpecific version of the code system referred to
..... concept SI0..*BackboneElementA concept defined in the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... valueset-label SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..0
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
....... valueString 0..1stringValue of extension
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
........ rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
........ value 0..1Primitive value for string
Max Length: 1048576
...... valueset-conceptOrder SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... code S1..1codeCode or expression from system
...... display S0..1stringText to display for this code for this value set in this valueset
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1Primitive value for string
Max Length: 1048576
...... designation I0..*BackboneElementAdditional representations for this concept
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
....... language 0..1codeHuman language of the designation
Binding: Common Languages (preferred)
....... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible)
....... value 1..1stringThe text value for this designation
..... filter SΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
...... property SΣ1..1codeA property defined by the code system
...... op SΣ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required)
...... value SΣ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet SΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude SI0..*Unknown reference to #ValueSet.compose.include
Explicitly exclude codes from a code system or other value sets
... expansion SI0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... identifier S0..1uriIdentifies the value set expansion (business identifier)
.... timestamp S1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter I0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1string, boolean, integer, decimal, uri, code, dateTimeValue of the named parameter
.... contains SI0..*BackboneElementCodes in the value set
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... valueset-label SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
...... valueString 0..1stringValue of extension
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
....... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
....... value 0..1Primitive value for string
Max Length: 1048576
..... valueset-conceptOrder SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... system S0..1uriSystem value for the code
..... abstract S0..1booleanIf user cannot select this entry
..... inactive 0..1booleanIf concept is inactive in the code system
..... version S0..1stringVersion in which this code/display is defined
..... code SI0..1codeCode - if blank, this is not a selectable code
..... display SI0..1stringUser display for the concept
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
...... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
...... value 0..1Primitive value for string
Max Length: 1048576
..... designation 0..*Unknown reference to #ValueSet.compose.include.concept.designation
Additional representations for this item
..... contains S0..*Unknown reference to #ValueSet.expansion.contains
Codes contained under this entry

doco Documentation for this format

 

Other representations of profile: Schematron

10.16.3 Terminology Bindings

Terminology Bindings

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

10.16.4 Constraints

Constraints

IdPathDetailsRequirements
dom-2ValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ValueSetIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3ValueSetIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6ValueSetA resource should have narrative for robust management
: text.div.exists()
dom-5ValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
vsd-11ValueSetStatus must = 'active' if expansion is present and compose is absent
: status='active' or compose.exists() or expansion.empty()
vsd-0ValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1ValueSet.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.composeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.compose.includeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-2ValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3ValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-1ValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
ele-1ValueSet.compose.include.conceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.compose.include.concept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.extension.valueString.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.extension.valueString.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.extension.valueString.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.extension.valueString.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.extension.valueString.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.extension.valueString.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.display.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.display.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.display.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.display.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.display.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.compose.include.concept.display.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.compose.include.concept.designationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.compose.include.filterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.expansionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.expansion.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ValueSet.expansion.containsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-6ValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9ValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10ValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()
ele-1ValueSet.expansion.contains.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.extension.valueString.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.extension.valueString.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.extension.valueString.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.extension.valueString.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.extension.valueString.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.extension.valueString.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.display.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.display.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.display.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.display.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ValueSet.expansion.contains.display.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ValueSet.expansion.contains.display.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()