Structured Data Capture
4.0.0-ballot - STU 4 ballot
Structured Data Capture
4.0.0-ballot - STU 4 ballot
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset | Version: 4.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SDCValueSet | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.70 | ||||
Defines how ValueSet is used to reflect code lists found in data element defintions and form definitions to be used within the ONC's Structured Data Capture standard.
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ValueSet |
C | 0..* | ValueSet | A set of codes drawn from one or more code systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management vsd-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 ele-1: All FHIR elements must have a @value or children |
  Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
   modifierExtension:rendering-criticalExtension |
?!S | 0..* | RenderingCriticalExtension | Extension that must be supported ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url |
SΣ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
| description |
S | 0..1 | markdown | Natural language description of the value set ele-1: All FHIR elements must have a @value or children |
| immutable |
SΣ | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur ele-1: All FHIR elements must have a @value or children |
 compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| lockedDate |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) ele-1: All FHIR elements must have a @value or children |
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set ele-1: All FHIR elements must have a @value or children |
| include |
SΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) ele-1: All FHIR elements must have a @value or children 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 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system |
SΣC | 0..1 | uri | The system the codes come from ele-1: All FHIR elements must have a @value or children |
| version |
SΣ | 0..1 | string | Specific version of the code system referred to ele-1: All FHIR elements must have a @value or children |
| concept |
SC | 0..* | BackboneElement | A concept defined in the system ele-1: All FHIR elements must have a @value or children |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 conceptLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
 value[x] |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 code-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| code-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
S | 1..1 | code | Code or expression from system ele-1: All FHIR elements must have a @value or children |
| display |
S | 0..1 | string | Text to display for this code for this value set in this valueset ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| codeDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| codeDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| filter |
SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
SΣ | 1..1 | code | A property/filter defined by the code system ele-1: All FHIR elements must have a @value or children |
| op |
SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. ele-1: All FHIR elements must have a @value or children |
 value |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists ele-1: All FHIR elements must have a @value or children |
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set ele-1: All FHIR elements must have a @value or children |
 exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets ele-1: All FHIR elements must have a @value or children |
| expansion |
S | 0..1 | BackboneElement | Used when the value set is "expanded" ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionSource |
0..1 | uri | ValueSet definition used to generate this expansion (logical URL) URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
S | 0..1 | uri | Identifies the value set expansion (business identifier) ele-1: All FHIR elements must have a @value or children |
| timestamp |
S | 1..1 | dateTime | Time ValueSet expansion happened ele-1: All FHIR elements must have a @value or children |
| contains |
SC | 0..* | BackboneElement | Codes in the value set ele-1: All FHIR elements must have a @value or children vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
| value[x] |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansion-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansion-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| containsProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system |
S | 0..1 | uri | System value for the code ele-1: All FHIR elements must have a @value or children |
| abstract |
S | 0..1 | boolean | If user cannot select this entry ele-1: All FHIR elements must have a @value or children |
| version |
S | 0..1 | string | Version in which this code/display is defined ele-1: All FHIR elements must have a @value or children |
| code |
SC | 0..1 | code | Code - if blank, this is not a selectable code ele-1: All FHIR elements must have a @value or children |
| display |
SC | 0..1 | string | User display for the concept ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| designation |
0..* | BackboneElement | Additional representations for this item ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDesignation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDesignation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value |
1..1 | string | The text value for this designation ele-1: All FHIR elements must have a @value or children | |
| contains |
S | 0..* | See contains (ValueSet) | Codes contained under this entry ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard |
This structure is derived from ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet |
0..* | ValueSet | A set of codes drawn from one or more code systems | |
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| modifierExtension:rendering-criticalExtension |
S | 0..* | RenderingCriticalExtension | Extension that must be supported |
| url |
S | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
S | 0..1 | boolean | For testing purposes, not real usage |
| date |
S | 0..1 | dateTime | Date last changed |
| description |
S | 0..1 | markdown | Natural language description of the value set |
| immutable |
S | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
| lockedDate |
S | 0..1 | date | Fixed date for references with no specified version (transitive) |
| inactive |
S | 0..1 | boolean | Whether inactive codes are in the value set |
| include |
S | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
| system |
S | 0..1 | uri | The system the codes come from |
| version |
S | 0..1 | string | Specific version of the code system referred to |
| concept |
S | 0..* | BackboneElement | A concept defined in the system |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| conceptLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| value[x] |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| code-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| code-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| code |
S | 1..1 | code | Code or expression from system |
| display |
S | 0..1 | string | Text to display for this code for this value set in this valueset |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| codeDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| codeDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| designation |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| designation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| designation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| filter |
S | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| property |
S | 1..1 | code | A property/filter defined by the code system |
| op |
S | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists |
| value |
S | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
| valueSet |
S | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude |
S | 0..* | Explicitly exclude codes from a code system or other value sets | |
| expansion |
S | 0..1 | BackboneElement | Used when the value set is "expanded" |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionSource |
0..1 | uri | ValueSet definition used to generate this expansion (logical URL) URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource | |
| expansionProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property |
| identifier |
S | 0..1 | uri | Identifies the value set expansion (business identifier) |
| timestamp |
S | 1..1 | dateTime | Time ValueSet expansion happened |
| contains |
S | 0..* | BackboneElement | Codes in the value set |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| value[x] |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansion-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| expansion-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| containsProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property |
| system |
S | 0..1 | uri | System value for the code |
| abstract |
S | 0..1 | boolean | If user cannot select this entry |
| version |
S | 0..1 | string | Version in which this code/display is defined |
| code |
S | 0..1 | code | Code - if blank, this is not a selectable code |
| display |
S | 0..1 | string | User display for the concept |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| expansionDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| designation |
0..* | BackboneElement | Additional representations for this item | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionDesignation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| expansionDesignation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| contains |
S | 0..* | Codes contained under this entry | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet |
C | 0..* | ValueSet | A set of codes drawn from one or more code systems vsd-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: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:rendering-criticalExtension |
?!S | 0..* | RenderingCriticalExtension | Extension that must be supported | ||||
| url |
SΣ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
| version |
Σ | 0..1 | string | Business version of the value set | ||||
| name |
ΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this value set (human friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
SΣ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 0..1 | markdown | Natural language description of the value set | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| immutable |
SΣ | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
| purpose |
0..1 | markdown | Why this value set is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| lockedDate |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
| include |
SΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) 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 |
SΣC | 0..1 | uri | The system the codes come from | ||||
| version |
SΣ | 0..1 | string | Specific version of the code system referred to | ||||
| concept |
SC | 0..* | BackboneElement | A concept defined in the system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| conceptLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| code-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| code-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Code or expression from system | ||||
| display |
S | 0..1 | string | Text to display for this code for this value set in this valueset | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| codeDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| codeDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| designation |
0..* | BackboneElement | Additional representations for this concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| designation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| use |
0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value |
1..1 | string | The text value for this designation | |||||
| filter |
SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
SΣ | 1..1 | code | A property/filter defined by the code system | ||||
| op |
SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
| value |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
| exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
| expansion |
S | 0..1 | BackboneElement | Used when the value set is "expanded" | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionSource |
0..1 | uri | ValueSet definition used to generate this expansion (logical URL) URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource | |||||
| expansionProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
S | 0..1 | uri | Identifies the value set expansion (business identifier) | ||||
| timestamp |
S | 1..1 | dateTime | Time ValueSet expansion happened | ||||
| total |
0..1 | integer | Total number of codes in the expansion | |||||
| offset |
0..1 | integer | Offset at which this resource starts | |||||
| parameter |
0..* | BackboneElement | Parameter that controlled the expansion process | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
1..1 | string | Name as assigned by the client or server | |||||
 value[x] |
0..1 | Value of the named parameter | ||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueDecimal |
decimal | |||||||
| valueUri |
uri | |||||||
| valueCode |
code | |||||||
| valueDateTime |
dateTime | |||||||
| contains |
SC | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansion-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| expansion-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder | ||||
| containsProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| system |
S | 0..1 | uri | System value for the code | ||||
| abstract |
S | 0..1 | boolean | If user cannot select this entry | ||||
| inactive |
0..1 | boolean | If concept is inactive in the code system | |||||
| version |
S | 0..1 | string | Version in which this code/display is defined | ||||
| code |
SC | 0..1 | code | Code - if blank, this is not a selectable code | ||||
| display |
SC | 0..1 | string | User display for the concept | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| expansionDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| designation |
0..* | BackboneElement | Additional representations for this item | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionDesignation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| expansionDesignation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| use |
0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value |
1..1 | string | The text value for this designation | |||||
| contains |
S | 0..* | See contains (ValueSet) | Codes contained under this entry | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ValueSet.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ValueSet.compose.include.concept.designation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard | ||||
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard | ||||
| ValueSet.expansion.contains.designation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ValueSet.expansion.contains.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard |
This structure is derived from ValueSet
Summary
Mandatory: 1 element
Must-Support: 38 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet |
C | 0..* | ValueSet | A set of codes drawn from one or more code systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management vsd-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 ele-1: All FHIR elements must have a @value or children |
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension:rendering-criticalExtension |
?!S | 0..* | RenderingCriticalExtension | Extension that must be supported ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| url |
SΣ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
| description |
S | 0..1 | markdown | Natural language description of the value set ele-1: All FHIR elements must have a @value or children |
| immutable |
SΣ | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur ele-1: All FHIR elements must have a @value or children |
| compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| lockedDate |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) ele-1: All FHIR elements must have a @value or children |
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set ele-1: All FHIR elements must have a @value or children |
| include |
SΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) ele-1: All FHIR elements must have a @value or children 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 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system |
SΣC | 0..1 | uri | The system the codes come from ele-1: All FHIR elements must have a @value or children |
| version |
SΣ | 0..1 | string | Specific version of the code system referred to ele-1: All FHIR elements must have a @value or children |
| concept |
SC | 0..* | BackboneElement | A concept defined in the system ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| conceptLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
| value[x] |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| code-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| code-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| code |
S | 1..1 | code | Code or expression from system ele-1: All FHIR elements must have a @value or children |
| display |
S | 0..1 | string | Text to display for this code for this value set in this valueset ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| codeDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| codeDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| filter |
SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| property |
SΣ | 1..1 | code | A property/filter defined by the code system ele-1: All FHIR elements must have a @value or children |
| op |
SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. ele-1: All FHIR elements must have a @value or children |
| value |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists ele-1: All FHIR elements must have a @value or children |
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set ele-1: All FHIR elements must have a @value or children |
| exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets ele-1: All FHIR elements must have a @value or children |
| expansion |
S | 0..1 | BackboneElement | Used when the value set is "expanded" ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionSource |
0..1 | uri | ValueSet definition used to generate this expansion (logical URL) URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
S | 0..1 | uri | Identifies the value set expansion (business identifier) ele-1: All FHIR elements must have a @value or children |
| timestamp |
S | 1..1 | dateTime | Time ValueSet expansion happened ele-1: All FHIR elements must have a @value or children |
| contains |
SC | 0..* | BackboneElement | Codes in the value set ele-1: All FHIR elements must have a @value or children vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
| value[x] |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansion-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansion-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| containsProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| system |
S | 0..1 | uri | System value for the code ele-1: All FHIR elements must have a @value or children |
| abstract |
S | 0..1 | boolean | If user cannot select this entry ele-1: All FHIR elements must have a @value or children |
| version |
S | 0..1 | string | Version in which this code/display is defined ele-1: All FHIR elements must have a @value or children |
| code |
SC | 0..1 | code | Code - if blank, this is not a selectable code ele-1: All FHIR elements must have a @value or children |
| display |
SC | 0..1 | string | User display for the concept ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| designation |
0..* | BackboneElement | Additional representations for this item ele-1: All FHIR elements must have a @value or children | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDesignation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| expansionDesignation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value |
1..1 | string | The text value for this designation ele-1: All FHIR elements must have a @value or children | |
| contains |
S | 0..* | See contains (ValueSet) | Codes contained under this entry ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard |
Differential View
This structure is derived from ValueSet
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet |
0..* | ValueSet | A set of codes drawn from one or more code systems | |
| Slices for modifierExtension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| modifierExtension:rendering-criticalExtension |
S | 0..* | RenderingCriticalExtension | Extension that must be supported |
| url |
S | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) |
| status |
S | 1..1 | code | draft | active | retired | unknown |
| experimental |
S | 0..1 | boolean | For testing purposes, not real usage |
| date |
S | 0..1 | dateTime | Date last changed |
| description |
S | 0..1 | markdown | Natural language description of the value set |
| immutable |
S | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
| lockedDate |
S | 0..1 | date | Fixed date for references with no specified version (transitive) |
| inactive |
S | 0..1 | boolean | Whether inactive codes are in the value set |
| include |
S | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
| system |
S | 0..1 | uri | The system the codes come from |
| version |
S | 0..1 | string | Specific version of the code system referred to |
| concept |
S | 0..* | BackboneElement | A concept defined in the system |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| conceptLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| value[x] |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| code-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| code-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| code |
S | 1..1 | code | Code or expression from system |
| display |
S | 0..1 | string | Text to display for this code for this value set in this valueset |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| codeDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| codeDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| designation |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| designation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| designation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| filter |
S | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| property |
S | 1..1 | code | A property/filter defined by the code system |
| op |
S | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists |
| value |
S | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
| valueSet |
S | 0..* | canonical(ValueSet) | Select the contents included in this value set |
| exclude |
S | 0..* | Explicitly exclude codes from a code system or other value sets | |
| expansion |
S | 0..1 | BackboneElement | Used when the value set is "expanded" |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionSource |
0..1 | uri | ValueSet definition used to generate this expansion (logical URL) URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource | |
| expansionProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property |
| identifier |
S | 0..1 | uri | Identifies the value set expansion (business identifier) |
| timestamp |
S | 1..1 | dateTime | Time ValueSet expansion happened |
| contains |
S | 0..* | BackboneElement | Codes in the value set |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
| value[x] |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansion-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| expansion-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder |
| containsProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property |
| system |
S | 0..1 | uri | System value for the code |
| abstract |
S | 0..1 | boolean | If user cannot select this entry |
| version |
S | 0..1 | string | Version in which this code/display is defined |
| code |
S | 0..1 | code | Code - if blank, this is not a selectable code |
| display |
S | 0..1 | string | User display for the concept |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| expansionDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| designation |
0..* | BackboneElement | Additional representations for this item | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expansionDesignation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |
| expansionDesignation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |
| contains |
S | 0..* | Codes contained under this entry | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ValueSet |
C | 0..* | ValueSet | A set of codes drawn from one or more code systems vsd-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: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:rendering-criticalExtension |
?!S | 0..* | RenderingCriticalExtension | Extension that must be supported | ||||
| url |
SΣ | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
| version |
Σ | 0..1 | string | Business version of the value set | ||||
| name |
ΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this value set (human friendly) | ||||
| status |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
SΣ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
SΣ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
S | 0..1 | markdown | Natural language description of the value set | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| immutable |
SΣ | 1..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
| purpose |
0..1 | markdown | Why this value set is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| compose |
S | 0..1 | BackboneElement | Content logical definition of the value set (CLD) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| lockedDate |
SΣ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
| inactive |
SΣ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
| include |
SΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) 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 |
SΣC | 0..1 | uri | The system the codes come from | ||||
| version |
SΣ | 0..1 | string | Specific version of the code system referred to | ||||
| concept |
SC | 0..* | BackboneElement | A concept defined in the system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| conceptLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| code-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| code-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | code | Code or expression from system | ||||
| display |
S | 0..1 | string | Text to display for this code for this value set in this valueset | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| codeDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| codeDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| designation |
0..* | BackboneElement | Additional representations for this concept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| designation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| designation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| use |
0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value |
1..1 | string | The text value for this designation | |||||
| filter |
SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| property |
SΣ | 1..1 | code | A property/filter defined by the code system | ||||
| op |
SΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
| value |
SΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
| valueSet |
SΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
| exclude |
SC | 0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | ||||
| expansion |
S | 0..1 | BackboneElement | Used when the value set is "expanded" | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionSource |
0..1 | uri | ValueSet definition used to generate this expansion (logical URL) URL: http://hl7.org/fhir/StructureDefinition/valueset-expansionSource | |||||
| expansionProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.property | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
S | 0..1 | uri | Identifies the value set expansion (business identifier) | ||||
| timestamp |
S | 1..1 | dateTime | Time ValueSet expansion happened | ||||
| total |
0..1 | integer | Total number of codes in the expansion | |||||
| offset |
0..1 | integer | Offset at which this resource starts | |||||
| parameter |
0..* | BackboneElement | Parameter that controlled the expansion process | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
1..1 | string | Name as assigned by the client or server | |||||
| value[x] |
0..1 | Value of the named parameter | ||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueDecimal |
decimal | |||||||
| valueUri |
uri | |||||||
| valueCode |
code | |||||||
| valueDateTime |
dateTime | |||||||
| contains |
SC | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: Must have a code if not abstract vsd-10: Must have a system if a code is present | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionLabel |
S | 0..1 | (Complex) | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |||||
| value[x] |
1..1 | string | Value of extension | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansion-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| expansion-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| conceptConceptOrder |
S | 0..1 | integer | Appearance order for user selection URL: http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder | ||||
| containsProperty |
S | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ValueSet.expansion.contains.property | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| system |
S | 0..1 | uri | System value for the code | ||||
| abstract |
S | 0..1 | boolean | If user cannot select this entry | ||||
| inactive |
0..1 | boolean | If concept is inactive in the code system | |||||
| version |
S | 0..1 | string | Version in which this code/display is defined | ||||
| code |
SC | 0..1 | code | Code - if blank, this is not a selectable code | ||||
| display |
SC | 0..1 | string | User display for the concept | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionDisplay-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| expansionDisplay-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| designation |
0..* | BackboneElement | Additional representations for this item | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| expansionDesignation-renderingStyle |
0..1 | string | Html style value URL: http://hl7.org/fhir/StructureDefinition/rendering-style | |||||
| expansionDesignation-xhtml |
0..1 | string | String equivalent with html markup URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
| |||||
| use |
0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | |||||
| value |
1..1 | string | The text value for this designation | |||||
| contains |
S | 0..* | See contains (ValueSet) | Codes contained under this entry | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ValueSet.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ValueSet.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ValueSet.compose.include.concept.designation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard | ||||
| ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|4.0.1from the FHIR Standard | ||||
| ValueSet.expansion.contains.designation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ValueSet.expansion.contains.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-usefrom the FHIR Standard |
This structure is derived from ValueSet
Summary
Mandatory: 1 element
Must-Support: 38 elements
Extensions
This structure refers to these extensions:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#4.0.0-ballot based on FHIR 4.0.1. Generated 2024-12-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change