ValueSet
A 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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 16 of 18 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
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) |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
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)Binding (extensible): jurisdiction |
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) |
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 |
includeRequiredΣ | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) |
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 |
codeRequired | 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 |
language | 0..1 | code | Human language of the designationBinding (preferred): languages |
use | 0..1 | Coding | Types of uses of designationsBinding (extensible): designation-use |
valueRequired | 1..1 | string | The text value for this designation |
filterΣ | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) |
propertyRequiredΣ | 1..1 | code | A property/filter defined by the code system |
opRequiredΣ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | existsBinding (required): filter-operator |
valueRequiredΣ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists |
valueSetΣ | 0..* | canonical(ValueSet) | Select the contents included in this value set |
exclude | 0..* | Same as ValueSet.compose.include | Explicitly exclude codes from a code system or other value sets |
expansion | 0..1 | BackboneElement | Used when the value set is "expanded" |
identifier | 0..1 | uri | Identifies the value set expansion (business identifier) |
timestampRequired | 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 |
nameRequired | 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 |
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..* | Same as ValueSet.compose.include.concept.designation | Additional representations for this item |
contains | 0..* | Same as ValueSet.expansion.contains | Codes contained under this entry |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/ValueSet?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
code | token | This special parameter searches for codes in the value set. See additional notes on the ValueSet resource ValueSet.expansion.contains.code | ValueSet.compose.include.concept.code | ||
context | token | A use context assigned to the value set (ValueSet.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the value set (ValueSet.useContext.value.ofType(Quantity)) | (ValueSet.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the value set ValueSet.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the value set ValueSet.useContext | ||
context-type-value | composite | A use context type and value assigned to the value set ValueSet.useContext | ||
date | date | The value set publication date ValueSet.date | ||
description | string | The description of the value set ValueSet.description | ||
expansion | uri | Identifies the value set expansion (business identifier) ValueSet.expansion.identifier | ||
identifier | token | External identifier for the value set ValueSet.identifier | ||
jurisdiction | token | Intended jurisdiction for the value set ValueSet.jurisdiction | ||
name | string | Computationally friendly name of the value set ValueSet.name | ||
publisher | string | Name of the publisher of the value set ValueSet.publisher | ||
reference | uri | A code system included or excluded in the value set or an imported value set ValueSet.compose.include.system | ||
status | token | The current status of the value set ValueSet.status | ||
title | string | The human-friendly name of the value set ValueSet.title | ||
url | uri | The uri that identifies the value set ValueSet.url | ||
version | token | The business version of the value set ValueSet.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken