ValueSet
activeFoundationA ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| ValueSet | 0..* | — | A set of codes drawn from one or more code systems |
| .idΣ | 0..1 | String | 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 Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 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Σ | 0..1 | string | Name for this value set (computer friendly) |
| .titleΣ | 0..1 | string | Name for this value set (human friendly) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .dateΣ | 0..1 | dateTime | Date last changed |
| .publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
| .contactΣ | 0..* | ContactDetail | Contact details for the publisher |
| .description | 0..1 | markdown | Natural language description of the value set |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Bindingjurisdiction(extensible) |
| .immutableΣ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur |
| .purpose | 0..1 | markdown | Why this value set is defined |
| .copyright | 0..1 | markdown | Use and/or publishing restrictions |
| .compose | 0..1 | BackboneElement | Content logical definition of the value set (CLD) |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .lockedDateΣ | 0..1 | date | Fixed date for references with no specified version (transitive) |
| .inactiveΣ | 0..1 | boolean | Whether inactive codes are in the value set |
| .includeΣ | 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Σ | 0..1 | uri | The system the codes come from |
| .versionΣ | 0..1 | string | Specific version of the code system referred to |
| .concept | 0..* | BackboneElement | A concept defined in the system |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .code | 1..1 | code | Code or expression from system |
| .display | 0..1 | string | Text to display for this code for this value set in this valueset |
| .designation | 0..* | BackboneElement | Additional representations for this concept |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .language | 0..1 | code | Human language of the designation Bindinglanguages(preferred) |
| .use | 0..1 | Coding | Types of uses of designations Bindingdesignation-use(extensible) |
| .value | 1..1 | string | The text value for this designation |
| .filterΣ | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .propertyΣ | 1..1 | code | A property/filter defined by the code system |
| .opΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Bindingfilter-operator(required) |
| .valueΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
| .valueSetΣ | 0..* | canonical | Select the contents included in this value set |
| .exclude | 0..* | — | Explicitly exclude codes from a code system or other value sets |
| .expansion | 0..1 | BackboneElement | Used when the value set is "expanded" |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .identifier | 0..1 | uri | Identifies the value set expansion (business identifier) |
| .timestamp | 1..1 | dateTime | Time ValueSet expansion happened |
| .total | 0..1 | integer | Total number of codes in the expansion |
| .offset | 0..1 | integer | Offset at which this resource starts |
| .parameter | 0..* | BackboneElement | Parameter that controlled the expansion process |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .name | 1..1 | string | Name as assigned by the client or server |
| .value[x] | 0..1 | string | boolean | integer | decimal | uri | code | dateTime | Value of the named parameter |
| .contains | 0..* | BackboneElement | Codes in the value set |
| .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 | 0..1 | uri | System value for the code |
| .abstract | 0..1 | boolean | If user cannot select this entry |
| .inactive | 0..1 | boolean | If concept is inactive in the code system |
| .version | 0..1 | string | Version in which this code/display is defined |
| .code | 0..1 | code | Code - if blank, this is not a selectable code |
| .display | 0..1 | string | User display for the concept |
| .designation | 0..* | — | Additional representations for this item |
| .contains | 0..* | — | Codes contained under this entry |