Page Status: draft updated 2025-01-23

ValueSet

Page index

Introduction

The ValueSet resource represents a set of codes that is used in a specific context.

The codes in a value set are a combination of codes from one or many code systems. The value set can include all codes in a code system, or only a subset of the codes from the code system. See Terminologies for more information on value sets.

Coded values are used in many different resources. Elements of type 'CodeableConcept', 'code' or 'Coding' are bound to a value set in a profile. However when data is exchanged in run time, coded values are described by the code and the code system, not by the value set.

Regarding information about how the "must support"-property is used in the Swedish National Catalog of Organization, Offerings and Contracts, please refer to the page Resources.

Overview

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlΣ0..1uri
identifierΣ0..*Identifier
versionΣ0..1string
nameΣ I0..1string
titleΣ0..1string
statusΣ ?!1..1codeBinding
experimentalΣ0..1boolean
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
description0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
immutableΣ0..1boolean
purpose0..1markdown
copyright0..1markdown
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lockedDateΣ0..1date
inactiveΣ0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
systemΣ I0..1uri
versionΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code1..1code
display0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language0..1codeBinding
use0..1CodingBinding
value1..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
propertyΣ1..1code
opΣ1..1codeBinding
valueΣ1..1string
valueSetΣ I0..*canonical(ValueSet)
excludeI0..*see (include)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifier0..1uri
timestamp1..1dateTime
total0..1integer
offset0..1integer
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
name1..1string
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueDecimaldecimal
valueUriuri
valueCodecode
valueDateTimedateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
system0..1uri
abstract0..1boolean
inactive0..1boolean
version0..1string
codeI0..1code
displayI0..1string
designation0..*see (designation)
contains0..*see (contains)
Command 'dict' could not render: File not found for subject: =
Command 'xml' could not render: File not found for subject: =
Command 'json' could not render: File not found for subject: =

Details

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes Only GET
Insert (POST) no
Update (PUT) no
Delete (DEL) no
Operation (GET, POST) yes Only GET

Query operations

Supported Queries

  1. GET .../ValueSet returns a Bundle of all ValueSets.
  2. GET .../ValueSet/[LogicalId] returns the ValueSet with the given logical ID.

Search parameters

Parameter Description Comment
ValueSet/[id] A read based on the ID of an ValueSet.

Other operations

Operation name HTTP verbs Comment
$validate-code GET This operation checks if a code exists in the current version of a specific value set. This is a standard operation in FHIR, see $validate-code for more information.