Structured Data Capture
2.8.0 - CI Build

Structured Data Capture, published by HL7 International - FHIR Infrastructure Work Group. This is not an authorized publication; it is the continuous build for version 2.8.0). This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Resource Profile: SDC Value Set

Defining URL:http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset
Version:2.8.0
Name:SDCValueSet
Title:SDC ValueSet
Status:Draft as of 2021-10-22T22:55:41+00:00
Definition:

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

Publisher:HL7 International - FHIR Infrastructure Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

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

Scope and Usage

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

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

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..*ValueSetA set of codes drawn from one or more code systems
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... url S0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... status S1..1codedraft | active | retired | unknown
... date S0..1dateTimeDate last changed
... description S0..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)
... immutable S1..1booleanIndicates whether or not any change to the content logical definition may occur
... compose S0..1BackboneElementContent logical definition of the value set (CLD)
.... lockedDate S0..1dateFixed date for references with no specified version (transitive)
.... inactive S0..1booleanWhether inactive codes are in the value set
.... include S1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... system S0..1uriThe system the codes come from
..... version S0..1stringSpecific version of the code system referred to
..... concept S0..*BackboneElementA concept defined in the system
...... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... valueString 1..1stringValue of extension
........ 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..1codeCode or expression from system
...... display S0..1stringText to display for this code for this value set in this valueset
....... 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..*BackboneElementAdditional representations for this concept
....... 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..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... property S1..1codeA property/filter defined by the code system
...... op S1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value S1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet S0..*canonical(ValueSet)Select the contents included in this value set
.... exclude S0..*Explicitly exclude codes from a code system or other value sets
... expansion S0..1BackboneElementUsed when the value set is "expanded"
.... valueset-expansionSource 0..1uriValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
.... identifier S0..1uriIdentifies the value set expansion (business identifier)
.... timestamp S1..1dateTimeTime ValueSet expansion happened
.... contains S0..*BackboneElementCodes in the value set
..... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... valueString 1..1stringValue of extension
....... 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..1uriSystem value for the code
..... abstract S0..1booleanIf user cannot select this entry
..... version S0..1stringVersion in which this code/display is defined
..... code S0..1codeCode - if blank, this is not a selectable code
..... display S0..1stringUser display for the concept
...... 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..*BackboneElementAdditional representations for this item
...... value 1..1stringThe text value for this designation
....... 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
..... contains S0..*Codes contained under this entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*ValueSetA set of codes drawn from one or more code systems
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rendering-styleSensitive S0..1booleanAre styles important for processing?
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 ΣI0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... 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 S0..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): Countries and regions within which this artifact is targeted for use.


... 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 S0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..0
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
....... Slices for value[x] 1..1stringValue of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueString 1..1stringValue of extension
......... id 0..1stringxml:id (or equivalent in JSON)
......... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
......... 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
......... value 0..1stringPrimitive value for string
Max Length: 1048576
...... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... 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
....... value 0..1stringPrimitive value for string
Max Length: 1048576
...... designation 0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... 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
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

....... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... value 1..1stringThe text value for this designation
..... filter SΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property SΣ1..1codeA property/filter 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): The kind of operation to perform as a part of a property based filter.

...... 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..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion S0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... valueset-expansionSource 0..1uriValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... contains SI0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
...... Slices for value[x] 1..1stringValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueString 1..1stringValue of extension
........ id 0..1stringxml:id (or equivalent in JSON)
........ Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ 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
........ value 0..1stringPrimitive value for string
Max Length: 1048576
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... 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
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... designation 0..*BackboneElementAdditional representations for this item
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

...... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

...... value 1..1stringThe text value for this designation
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... 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
....... value 0..1stringPrimitive value for string
Max Length: 1048576
..... contains S0..*See contains (ValueSet)Codes contained under this entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*ValueSetA set of codes drawn from one or more code systems
... rendering-styleSensitive 0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... url Σ0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date Σ0..1dateTimeDate last changed
... description 0..1markdownNatural language description of the value set
... immutable Σ1..1booleanIndicates whether or not any change to the content logical definition may occur
... compose 0..1BackboneElementContent logical definition of the value set (CLD)
.... lockedDate Σ0..1dateFixed date for references with no specified version (transitive)
.... inactive Σ0..1booleanWhether inactive codes are in the value set
.... include ΣI1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... system ΣI0..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... valueset-label 0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... valueset-conceptOrder 0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... code 1..1codeCode or expression from system
...... display 0..1stringText to display for this code for this value set in this valueset
..... filter ΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... property Σ1..1codeA property/filter defined by the code system
...... op Σ1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet ΣI0..*canonical(ValueSet)Select the contents included in this value set
.... exclude I0..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion 0..1BackboneElementUsed when the value set is "expanded"
.... identifier 0..1uriIdentifies the value set expansion (business identifier)
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... contains I0..*BackboneElementCodes in the value set
..... valueset-label 0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
..... valueset-conceptOrder 0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... contains 0..*See contains (ValueSet)Codes contained under this entry

doco Documentation for this format

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..*ValueSetA set of codes drawn from one or more code systems
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... url S0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... status S1..1codedraft | active | retired | unknown
... date S0..1dateTimeDate last changed
... description S0..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)
... immutable S1..1booleanIndicates whether or not any change to the content logical definition may occur
... compose S0..1BackboneElementContent logical definition of the value set (CLD)
.... lockedDate S0..1dateFixed date for references with no specified version (transitive)
.... inactive S0..1booleanWhether inactive codes are in the value set
.... include S1..*BackboneElementInclude one or more codes from a code system or other value set(s)
..... system S0..1uriThe system the codes come from
..... version S0..1stringSpecific version of the code system referred to
..... concept S0..*BackboneElementA concept defined in the system
...... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... valueString 1..1stringValue of extension
........ 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..1codeCode or expression from system
...... display S0..1stringText to display for this code for this value set in this valueset
....... 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..*BackboneElementAdditional representations for this concept
....... 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..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... property S1..1codeA property/filter defined by the code system
...... op S1..1code= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value S1..1stringCode from the system, or regex criteria, or boolean value for exists
..... valueSet S0..*canonical(ValueSet)Select the contents included in this value set
.... exclude S0..*Explicitly exclude codes from a code system or other value sets
... expansion S0..1BackboneElementUsed when the value set is "expanded"
.... valueset-expansionSource 0..1uriValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
.... identifier S0..1uriIdentifies the value set expansion (business identifier)
.... timestamp S1..1dateTimeTime ValueSet expansion happened
.... contains S0..*BackboneElementCodes in the value set
..... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... valueString 1..1stringValue of extension
....... 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..1uriSystem value for the code
..... abstract S0..1booleanIf user cannot select this entry
..... version S0..1stringVersion in which this code/display is defined
..... code S0..1codeCode - if blank, this is not a selectable code
..... display S0..1stringUser display for the concept
...... 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..*BackboneElementAdditional representations for this item
...... value 1..1stringThe text value for this designation
....... 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
..... contains S0..*Codes contained under this entry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet I0..*ValueSetA set of codes drawn from one or more code systems
... id Σ0..1stringLogical 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: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rendering-styleSensitive S0..1booleanAre styles important for processing?
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 ΣI0..1stringName for this value set (computer friendly)
... title Σ0..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... 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 S0..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): Countries and regions within which this artifact is targeted for use.


... 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 S0..1BackboneElementContent logical definition of the value set (CLD)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..0
....... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
....... Slices for value[x] 1..1stringValue of extension
Slice: Unordered, Closed by type:$this
........ value[x]:valueString 1..1stringValue of extension
......... id 0..1stringxml:id (or equivalent in JSON)
......... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
......... 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
......... value 0..1stringPrimitive value for string
Max Length: 1048576
...... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... 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
....... value 0..1stringPrimitive value for string
Max Length: 1048576
...... designation 0..*BackboneElementAdditional representations for this concept
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... 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
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

....... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... value 1..1stringThe text value for this designation
..... filter SΣI0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... property SΣ1..1codeA property/filter 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): The kind of operation to perform as a part of a property based filter.

...... 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..*See include (ValueSet)Explicitly exclude codes from a code system or other value sets
... expansion S0..1BackboneElementUsed when the value set is "expanded"
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... valueset-expansionSource 0..1uriValueSet definition used to generate this expansion (logical URL)
URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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 0..*BackboneElementParameter that controlled the expansion process
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1stringName as assigned by the client or server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
...... valueDateTimedateTime
.... contains SI0..*BackboneElementCodes in the value set
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... valueset-label S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/valueset-label
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-label"
...... Slices for value[x] 1..1stringValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueString 1..1stringValue of extension
........ id 0..1stringxml:id (or equivalent in JSON)
........ Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ 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
........ value 0..1stringPrimitive value for string
Max Length: 1048576
..... valueset-conceptOrder S0..1integerAppearance order for user selection
URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... 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
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... designation 0..*BackboneElementAdditional representations for this item
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... language 0..1codeHuman language of the designation
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

...... use 0..1CodingTypes of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

...... value 1..1stringThe text value for this designation
....... id 0..1stringxml:id (or equivalent in JSON)
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... 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
....... value 0..1stringPrimitive value for string
Max Length: 1048576
..... contains S0..*See contains (ValueSet)Codes contained under this entry

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
ValueSet.languagepreferredCommonLanguages
Max Binding: AllLanguages
ValueSet.statusrequiredPublicationStatus
ValueSet.jurisdictionextensibleJurisdiction ValueSet
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
ValueSet.compose.include.filter.oprequiredFilterOperator
ValueSet.expansion.contains.designation.languagepreferredCommonLanguages
Max Binding: AllLanguages