This page is part of the FHIR Specification (v0.06: DSTU 1 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Resource ValueSet - Content 2.8

Status: Approved infrastructure resource. Draft for comment

Value Set - a set of defined codes from one or more code systems that may be bound to a context.

The resource name as it appears in a RESTful URL is /valueset/

A value set specifies a set of codes drawn from one or more code systems. Value sets don't actually define the code themselves - they just define what codes are included or excluded from the set. Value sets are defined to control what codes or concepts can be used in a particular context.

A value set resource is directly mappable to a CTS2 value set definition and an automated transform should be possible in order to use a CTS2 server to provide value set functionality

Resource Content 2.8.1

UML Image

<ValueSet xmlns="http://hl7.org/fhir">
 <name><!-- 1..1 string Informal name for this value set --></name>
 <author>  <!-- 1..1 (Organisation or individual) -->
  <name><!-- 1..1 string Name of the recognised author --></name>
  <reference><!-- 0..1 uri Author contact --></reference>
 </author>
 <description><!-- 1..1 string Human language description of the value set --></description>
 <status><!-- 1..1 code draft | testing | production | withdrawn | superseded --></status>
 <date><!-- 1..1 dateTime Date for given status --></date>
 <identifier><!-- 1..1 id Logical id to reference this value set --></identifier>
 <version><!-- 1..1 id Logical id for this version of the value set --></version>
 <restricts><!-- 0..* uri Can replace these value sets when profiling --></restricts>
 <import><!-- 0..* uri Import the contents of another value set --></import>
 <include>  <!-- 0..* Include one or more codes from a code system -->
  <system><!-- 1..1 uri The system the codes come from --></system>
  <version><!-- 0..1 string Specific version of the code system referred to --></version>
  <mode><!-- 1..1 code code | children | descendants | all --></mode>
  <code><!-- 0..* code Code or concept --></code>
  <filter>  <!-- 0..* Select codes/concepts by their properties -->
   <property><!-- 1..1 code A property defined by the code system  --></property>
   <op><!-- 1..1 code = | is_a | is_not_a | regex --></op>
   <value><!-- 1..1 code Code from the system, or regex criteria --></value>
  </filter>
 </include>
 <exclude><!-- 0..* Content as for ValueSet.include Explicitly exclude codes --></exclude>
 <extension><!-- 0..* Extension  See Extensions  --></extension>
 <text><!-- 1..1 Narrative Text summary of resource (for human interpretation) --></text>
</ValueSet>

Alternate definitions: Schema/Schematron, RDF (to do), XML, XMI (to do), Resource Profile

Terminology Bindings

Path	Details	Strength
ValueSet.status	The lifecycle status of a Value Set (see http://hl7.org/fhir/valueset-status for values)	complete/required
ValueSet.include.mode	The way in which the code is selected (see http://hl7.org/fhir/code-selection-mode for values)	complete/required
ValueSet.include.filter.op	The kind of operation to perform as part of a property based filter (see http://hl7.org/fhir/filter-operator for values)	complete/required

Path

Details

Strength

ValueSet.status

The lifecycle status of a Value Set (see http://hl7.org/fhir/valueset-status for values)

complete/required

ValueSet.include.mode

The way in which the code is selected (see http://hl7.org/fhir/code-selection-mode for values)

complete/required

ValueSet.include.filter.op

The kind of operation to perform as part of a property based filter (see http://hl7.org/fhir/filter-operator for values)

complete/required

Constraints

A value set with only one import must also have an include and/or an exclude (xpath: count(f:import)!=1 or exists(f:include) or exists(f:exclude))
A value set must have an include or an import (xpath: exists(f:include) or exists(f:import))
A selection criteria must have at least one code or filter (xpath on /include: count(f:code|f:filter)!=0)

Notes: 2.8.2

The content of the value set is a union of all the import and include statements and then with any excluded codes eliminated
A value set needs to do something. It can't simply include an existing value set without also including additional content or excluding content
The point of declaring that this value set restricts another is that this value set can then replace the other in a profile without changing the meaning. Declaring this explicitly allows profile tools to reason about the relationship without having to compute the relationship, which might not be possible for a profile tool
The identifier and version elements may be used to reference this value set in a design, a profile, a CDA template or V3 message (valueSet and valueSetVersion). These different contexts may make additional restrictions on the possible values of these elements
Using the property filters is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party
Within an include or exclude criterion, multiple filters and concept selections are intersected. In other words, all the conditions specified must be true.

Search Parameters 2.8.3

Search Parameters for RESTful searches. The standard parameters also apply. See Searching for more information.

$page : integer	Starting offset of the first record to return in the search set	single
$count : integer	Number of return records requested. The server is not bound to conform	single
$id : token	The logical resource id associated with the resource (must be supported by all servers)	single
name : string	a portion of the name of the value set	union
identifier : token	the identifier of the value set	union
version : token	the version identifier of the value set	union
status : token	the status of the value set	union
system : token	a code system included or excluded in the value set	union
code : token	a code contained in the include or exclude list of the value set (but not including descendant codes)	union
restricts : token	a value set listed in the restricts list	union
import : token	a value set listed in the import list	union

(See Searching).

This is an old version of FHIR retained for archive purposes. Do not use for anything else
Implementers are welcome to experiment with the content defined here, but should note that the contents are subject to change without prior notice.
© HL7.org 2011 - 2012. FHIR v0.06 generated on Tue, Dec 4, 2012 00:03+1100. License