Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 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: 3.0.0 | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: SDCValueSet |
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.
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 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
styleSensitive | S | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive |
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 | string | 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 | |
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 | string | 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 |
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 |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
styleSensitive | S | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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 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 |
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) |
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) |
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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
conceptLabel | S | 0..1 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
value[x] | 1..1 | string | Value of extension | |
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 |
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 |
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 | |
filter | SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
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" |
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 | |
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 |
contains | SC | 0..* | BackboneElement | Codes in the value set |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expansionLabel | S | 0..1 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
value[x] | 1..1 | string | Value of extension | |
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 |
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 |
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 |
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 | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 |
ValueSet.status | required | PublicationStatus |
ValueSet.compose.include.filter.op | required | FilterOperator |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
styleSensitive | S | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
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) | ||||
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 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
id | 0..1 | string | 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 | |||||
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 | ||||
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 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
id | 0..1 | string | 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 | ||||
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 | ||||
ValueSet.language | preferred | CommonLanguages
| ||||
ValueSet.status | required | PublicationStatus | ||||
ValueSet.jurisdiction | extensible | Jurisdiction ValueSet | ||||
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
| ||||
ValueSet.compose.include.concept.designation.use | extensible | DesignationUse | ||||
ValueSet.compose.include.filter.op | required | FilterOperator | ||||
ValueSet.expansion.contains.designation.language | preferred | CommonLanguages
| ||||
ValueSet.expansion.contains.designation.use | extensible | DesignationUse |
This structure is derived from ValueSet
Summary
Mandatory: 1 element
Must-Support: 36 elements
Extensions
This structure refers to these extensions:
Maturity: 3
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 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
styleSensitive | S | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive |
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 | string | 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 | |
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 | string | 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 |
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 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
styleSensitive | S | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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 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 |
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) |
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) |
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 |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
conceptLabel | S | 0..1 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
value[x] | 1..1 | string | Value of extension | |
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 |
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 |
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 | |
filter | SΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
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" |
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 | |
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 |
contains | SC | 0..* | BackboneElement | Codes in the value set |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
expansionLabel | S | 0..1 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-label" | |
value[x] | 1..1 | string | Value of extension | |
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 |
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 |
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 |
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 | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
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 |
ValueSet.status | required | PublicationStatus |
ValueSet.compose.include.filter.op | required | FilterOperator |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ValueSet | C | 0..* | ValueSet | A set of codes drawn from one or more code systems | ||||
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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
styleSensitive | S | 0..1 | boolean | Are styles important for processing? URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
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) | ||||
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 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
id | 0..1 | string | 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 | |||||
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 | ||||
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 | string | E.g. "(a)", "1.", etc. URL: http://hl7.org/fhir/StructureDefinition/valueset-label | ||||
id | 0..1 | string | 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 | ||||
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 | ||||
ValueSet.language | preferred | CommonLanguages
| ||||
ValueSet.status | required | PublicationStatus | ||||
ValueSet.jurisdiction | extensible | Jurisdiction ValueSet | ||||
ValueSet.compose.include.concept.designation.language | preferred | CommonLanguages
| ||||
ValueSet.compose.include.concept.designation.use | extensible | DesignationUse | ||||
ValueSet.compose.include.filter.op | required | FilterOperator | ||||
ValueSet.expansion.contains.designation.language | preferred | CommonLanguages
| ||||
ValueSet.expansion.contains.designation.use | extensible | DesignationUse |
This structure is derived from ValueSet
Summary
Mandatory: 1 element
Must-Support: 36 elements
Extensions
This structure refers to these extensions:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron