ValueSet - FHIR v0.0.82

This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

6.13.12 Resource ValueSet - Formal Definitions

Formal definitions for the elements in the ValueSet resource.

ValueSet
Definition	A value set specifies a set of codes drawn from one or more code systems.
Control	1..1
Invariants	Defined on this element Inv-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes (xpath: not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:define))) Inv-5: Value set SHALL contain either a define, a compose, or an expansion element (xpath: exists(f:define) or exists(f:compose) or exists(f:expansion)) Inv-7: A defined code system (if present) SHALL have a different identifier to the value set itself (xpath: not(exists(f:define)) or (f:define/f:system/@value != f:identifier/@value))
ValueSet.identifier
Definition	The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).
Control	0..1
Type	string
Summary	true
ValueSet.version
Definition	The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
Control	0..1
Type	string
Summary	true
Comments	There may be multiple resource versions of the value set that have the same identifier.
ValueSet.name
Definition	A free text natural language name describing the value set.
Control	1..1
Type	string
Requirements	Support human navigation.
Summary	true
Comments	Not expected to be unique.
ValueSet.publisher
Definition	The name of the individual or organization that published the value set.
Control	0..1
Type	string
Requirements	Helps establish the "authority/credibility" of the value set. May also allow for contact.
Summary	true
Comments	Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
ValueSet.telecom
Definition	Contacts of the publisher to assist a user in finding and communicating with the publisher.
Control	0..*
Type	Contact
Summary	true
Comments	May be a web site, an email address, a telephone number (tel:), etc.
ValueSet.description
Definition	A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.
Control	1..1
Type	string
Requirements	Human understandability.
Summary	true
Comments	The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.
ValueSet.copyright
Definition	A copyright statement relating to the value set and/or its contents.
Control	0..1
Type	string
Comments	Frequently, the copyright differs between the value set, and codes that are included. The copyright statement should clearly differentiate between these when required.
ValueSet.status
Definition	The status of the value set.
Control	1..1
Binding	ValueSetStatus: The lifecycle status of a Value Set or Concept Map (see http://hl7.org/fhir/valueset-status for values)
Type	code
Is Modifier	true
Requirements	Identify when/if the value set should be used.
Summary	true
Comments	Allows filtering of valuesets that are appropriate for use vs. not.
ValueSet.experimental
Definition	This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Control	0..1
Type	boolean
Summary	true
Comments	Allows filtering of valuesets that are appropriate for use vs. not.
ValueSet.extensible
Definition	Whether this is intended to be used with an extensible binding or not.
Control	0..1
Type	boolean
Requirements	It is not required to say whether this intent applies.
ValueSet.date
Definition	The date that the value set status was last changed.
Control	0..1
Type	dateTime
Requirements	Need to know when a value set was first legal for use or became withdrawn or replaced.
Summary	true
Comments	Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set.
ValueSet.define
Definition	When value set defines its own codes.
Control	0..1
Summary	true
Invariants	Defined on this element Inv-3: Within a code system definition, all the codes SHALL be unique (xpath: count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)) Inv-8: Codes must be unique (xpath: count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))) Affect this element Inv-5: Value set SHALL contain either a define, a compose, or an expansion element (xpath: exists(f:define) or exists(f:compose) or exists(f:expansion))
ValueSet.define.system
Definition	URI to identify the code system.
Control	1..1
Type	uri
Summary	true
ValueSet.define.version
Definition	The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.
Control	0..1
Type	string
Summary	true
ValueSet.define.caseSensitive
Definition	If code comparison is case sensitive when codes within this system are compared to each other.
Control	0..1
Type	boolean
Summary	true
Comments	If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.
ValueSet.define.concept
Definition	Concepts in the code system.
Control	0..*
ValueSet.define.concept.code
Definition	Code that identifies concept.
Control	1..1
Type	code
ValueSet.define.concept.abstract
Definition	If this code is not for use as a real concept.
Control	0..1
Type	boolean
ValueSet.define.concept.display
Definition	Text to Display to the user.
Control	0..1
Type	string
ValueSet.define.concept.definition
Definition	The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.
Control	0..1
Type	string
ValueSet.define.concept.concept
Definition	Child Concepts (is-a / contains).
Control	0..*
Type	See ValueSet.define.concept
ValueSet.compose
Definition	When value set includes codes from elsewhere.
Control	0..1
Invariants	Defined on this element Inv-1: A value set composition SHALL have an include or an import (xpath: exists(f:include) or exists(f:import)) Affect this element Inv-5: Value set SHALL contain either a define, a compose, or an expansion element (xpath: exists(f:define) or exists(f:compose) or exists(f:expansion))
ValueSet.compose.import
Definition	Includes the contents of the referenced value set as a part of the contents of this value set.
Control	0..*
Type	uri
Summary	true
Comments	The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a literal reference to a value set definition (not an expansion). If the reference is a logical one, it may not reference a actual FHIR value set resource; in this case, the referenced definition of a set of coded values needs to be clear about how versions are resolved.
Invariants	Affect this element Inv-1: A value set composition SHALL have an include or an import (xpath: exists(f:include) or exists(f:import))
ValueSet.compose.include
Definition	Include one or more codes from a code system.
Control	0..*
Summary	true
Comments	If there are no codes or filters, the entire code system is included.
Invariants	Affect this element Inv-1: A value set composition SHALL have an include or an import (xpath: exists(f:include) or exists(f:import))
ValueSet.compose.include.system
Definition	The code system from which the selected codes come from.
Control	1..1
Type	uri
Summary	true
Comments	See [[Coding.system]] for further documentation.
ValueSet.compose.include.version
Definition	The version of the code system that the codes are selected from.
Control	0..1
Type	string
Summary	true
Comments	This is used when selecting the descendents of a concept - they may change between versions. If no version is specified, then the exact contents of the value set may not be known until a context of use binds it to a particular version.
ValueSet.compose.include.code
Definition	Specifies a code or concept to be included or excluded. The list of codes is considered ordered, though the order may not have any particular significance.
Control	0..*
Type	code
Comments	Expressions are allowed if defined by the underlying code system.
ValueSet.compose.include.filter
Definition	Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.
Control	0..*
Comments	Selecting codes by specifying filters based on properties 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.
ValueSet.compose.include.filter.property
Definition	A code that identifies a property defined in the code system.
Control	1..1
Type	code
ValueSet.compose.include.filter.op
Definition	The kind of operation to perform as a part of the filter criteria.
Control	1..1
Binding	FilterOperator: The kind of operation to perform as a part of a property based filter (see http://hl7.org/fhir/filter-operator for values)
Type	code
ValueSet.compose.include.filter.value
Definition	The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.
Control	1..1
Type	code
Comments	Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.
ValueSet.compose.exclude
Definition	Exclude one or more codes from the value set.
Control	0..*
Type	See ValueSet.compose.include
Comments	Usually this is used to selectively exclude codes that were included by subsumption in the inclusions.
Invariants	Affect this element Inv-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes (xpath: not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:define)))
ValueSet.expansion
Definition	When value set is an expansion.
Control	0..1
Invariants	Affect this element Inv-5: Value set SHALL contain either a define, a compose, or an expansion element (xpath: exists(f:define) or exists(f:compose) or exists(f:expansion))
ValueSet.expansion.identifier
Definition	An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.
Control	0..1
Type	Identifier
ValueSet.expansion.timestamp
Definition	Time valueset expansion happened.
Control	1..1
Type	instant
ValueSet.expansion.contains
Definition	Codes in the value set.
Control	0..*
Invariants	Defined on this element Inv-6: SHALL have a code or a display (xpath: exists(f:code) or exists(f:display))
ValueSet.expansion.contains.system
Definition	System value for the code.
Control	0..1
Type	uri
ValueSet.expansion.contains.code
Definition	Code - if blank, this is not a choosable code.
Control	0..1
Type	code
Invariants	Affect this element Inv-6: SHALL have a code or a display (xpath: exists(f:code) or exists(f:display))
ValueSet.expansion.contains.display
Definition	User display for the concept.
Control	0..1
Type	string
Invariants	Affect this element Inv-6: SHALL have a code or a display (xpath: exists(f:code) or exists(f:display))
ValueSet.expansion.contains.contains
Definition	Codes contained in this concept.
Control	0..*
Type	See ValueSet.expansion.contains