Skip to main content

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.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
identifier0..*IdentifierAdditional identifier for the value set (business identifier)
version0..1stringBusiness version of the value set
name0..1stringName for this value set (computer friendly)
title0..1stringName for this value set (human friendly)
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the value set
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for value set (if applicable)
immutable0..1booleanIndicates whether or not any change to the content logical definition may occur
purpose0..1markdownWhy this value set is defined
copyright0..1markdownUse and/or publishing restrictions
compose0..1BackboneElementContent logical definition of the value set (CLD)
expansion0..1BackboneElementUsed when the value set is "expanded"

Search Parameters

NameTypeDescriptionExpression
contexttokenA use context assigned to the value setValueSet.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the value setValueSet.useContext.value
context-typetokenA type of use context assigned to the value setValueSet.useContext.code
datedateThe value set publication dateValueSet.date
descriptionstringThe description of the value setValueSet.description
jurisdictiontokenIntended jurisdiction for the value setValueSet.jurisdiction
namestringComputationally friendly name of the value setValueSet.name
publisherstringName of the publisher of the value setValueSet.publisher
statustokenThe current status of the value setValueSet.status
titlestringThe human-friendly name of the value setValueSet.title
urluriThe uri that identifies the value setValueSet.url
versiontokenThe business version of the value setValueSet.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the value setValueSet.useContext
context-type-valuecompositeA use context type and value assigned to the value setValueSet.useContext
identifiertokenExternal identifier for the value setValueSet.identifier
codetokenThis special parameter searches for codes in the value set. See additional notes on the ValueSet resourceValueSet.expansion.contains.code
expansionuriIdentifies the value set expansion (business identifier)ValueSet.expansion.identifier
referenceuriA code system included or excluded in the value set or an imported value setValueSet.compose.include.system