Current Build
Vocabulary Work GroupMaturity Level: 5 Trial UseCompartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ValueSet resource.

ValueSet
Definition

A value set specifies a set of codes drawn from one or more code systems.

Control1..1
InvariantsDefined on this element
vsd-5: Value set SHALL contain at least one of a compose or an expansion element (expression : compose.exists() or expansion.exists(), xpath: exists(f:compose) or exists(f:expansion))
ValueSet.url
Definition

An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see Technical and Business Versions.

Control0..1
Typeuri
Requirements

Allows the value set to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.

ValueSet.identifier
Definition

A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this value set outside of FHIR, where it is not possible to use the logical URI.

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 value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version].

ValueSet.name
Definition

A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.

ValueSet.title
Definition

A short, descriptive, user-friendly title for the value set.

Control0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

ValueSet.status
Definition

The status of this value set. Enables tracking the life-cycle of the content.

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

Allows filtering of value sets that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired value set without due consideration.

ValueSet.experimental
Definition

A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set.

Summarytrue
Comments

Allows filtering of value set that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental value set in production.

ValueSet.date
Definition

The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').

Control0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

ValueSet.publisher
Definition

The name of the individual or organization that published the value set.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the value set. May also allow for contact.

Summarytrue
Comments

Usually an organization, but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.

ValueSet.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

ValueSet.description
Definition

A free text natural language description of the value set from a consumer's perspective.

Control0..1
Typemarkdown
Alternate NamesScope; Purpose
Comments

This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). 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. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.

ValueSet.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate value set instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

ValueSet.jurisdiction
Definition

A legal or geographic region in which the value set is intended to be used.

Control0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.

ValueSet.immutable
Definition

If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.

Control0..1
Typeboolean
Summarytrue
Comments

Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example "All specializations of ACT in ActClassCode" - Where there's no safe way to express the "Purpose" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.

ValueSet.purpose
Definition

Explaination of why this value set is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Comments

This element does not describe the usage of the value set Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.

ValueSet.copyright
Definition

A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.

Control0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.

Alternate NamesLicense; Restrictions
Comments

null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.

ValueSet.extensible
Definition

Whether this is intended to be used with an extensible binding or not.

Control0..1
Typeboolean
Requirements

It is not required to say whether this intent applies.

Summarytrue
ValueSet.compose
Definition

A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).

Control0..1
Alternate NamesContent Logical Definition
InvariantsAffect this element
vsd-5: Value set SHALL contain at least one of a compose or an expansion element (expression : compose.exists() or expansion.exists(), xpath: exists(f:compose) or exists(f:expansion))
ValueSet.compose.lockedDate
Definition

If a locked date is defined, then the Content Logical Definition must be evaluated using the current version as of the locked date for referenced code system(s) and value set instances where ValueSet.compose.include.version is not defined.

Control0..1
Typedate
Summarytrue
Comments

With a defined lockedDate the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.

ValueSet.compose.inactive
Definition

Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable ExpansionProfile (but generally, inactive codes would be expected to be included).

Control0..1
Typeboolean
Summarytrue
Comments

Note that in the FHIR terminology framework, "deprecated" does not mean inactive, but in some code systems (e.g. LOINC, deprecated means inactive). Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.

ValueSet.compose.include
Definition

Include one or more codes from a code system or other value set(s).

Control1..*
Summarytrue
Comments

All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.

InvariantsDefined on this element
vsd-1: A value set include/exclude SHALL have a value set or a system (expression : valueSet.exists() or system.exists(), xpath: exists(f:valueSet) or exists(f:system))
vsd-2: A value set with concepts or filters SHALL include a system (expression : (concept.exists() or filter.exists()) implies system.exists(), xpath: not(exists(f:concept) or exists(f:filter)) or exists(f:system))
vsd-3: Cannot have both concept and filter (expression : concept.empty() or filter.empty(), xpath: not(exists(f:concept)) or not(exists(f:filter)))
ValueSet.compose.include.system
Definition

An absolute URI which is the code system from which the selected codes come from.

Control0..1
Typeuri
Summarytrue
Comments

If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.

InvariantsAffect this element
vsd-1: A value set include/exclude SHALL have a value set or a system (expression : valueSet.exists() or system.exists(), xpath: exists(f:valueSet) or exists(f:system))
vsd-2: A value set with concepts or filters SHALL include a system (expression : (concept.exists() or filter.exists()) implies system.exists(), xpath: not(exists(f:concept) or exists(f:filter)) or exists(f:system))
ValueSet.compose.include.version
Definition

The version of the code system that the codes are selected from.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

This is used when selecting the descendants 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.concept
Definition

Specifies a concept to be included or excluded.

Control0..*
Comments

The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.

InvariantsAffect this element
vsd-3: Cannot have both concept and filter (expression : concept.empty() or filter.empty(), xpath: not(exists(f:concept)) or not(exists(f:filter)))
ValueSet.compose.include.concept.code
Definition

Specifies a code for the concept to be included or excluded.

Control1..1
Typecode
Comments

Expressions are allowed if defined by the underlying code system.

ValueSet.compose.include.concept.display
Definition

The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.

Control0..1
Typestring
Comments

The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.

ValueSet.compose.include.concept.designation
Definition

Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.

Control0..*
ValueSet.compose.include.concept.designation.language
Definition

The language this designation is defined for.

Control0..1
Terminology BindingCommon Languages (Extensible but limited to ??)
Typecode
Comments

In the absence of a language, the resource language applies.

ValueSet.compose.include.concept.designation.use
Definition

A code that details how this designation would be used.

Control0..1
Terminology BindingDesignation Use (Extensible)
TypeCoding
Comments

If no use is provided, the designation can be assumed to be suitable for general display to a human user.

ValueSet.compose.include.concept.designation.value
Definition

The text value for this designation.

Control1..1
Typestring
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.

Control0..*
Is Modifiertrue
Summarytrue
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.

InvariantsAffect this element
vsd-3: Cannot have both concept and filter (expression : concept.empty() or filter.empty(), xpath: not(exists(f:concept)) or not(exists(f:filter)))
ValueSet.compose.include.filter.property
Definition

A code that identifies a property defined in the code system.

Control1..1
Typecode
Summarytrue
ValueSet.compose.include.filter.op
Definition

The kind of operation to perform as a part of the filter criteria.

Control1..1
Terminology BindingFilterOperator (Required)
Typecode
Summarytrue
ValueSet.compose.include.filter.value
Definition

The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.

Control1..1
Typecode
Summarytrue
Comments

Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.

ValueSet.compose.include.valueSet
Definition

Selects concepts found in this value set. This is an absolute URI that is a reference to ValueSet.url.

Control0..*
Typeuri
Summarytrue
Comments

The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.

InvariantsAffect this element
vsd-1: A value set include/exclude SHALL have a value set or a system (expression : valueSet.exists() or system.exists(), xpath: exists(f:valueSet) or exists(f:system))
ValueSet.compose.exclude
Definition

Exclude one or more codes from the value set based on code system filters and/or other value sets.

Control0..*
TypeSee ValueSet.compose.include
Comments

Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.

InvariantsAffect this element
vsd-2: A value set with concepts or filters SHALL include a system (expression : (concept.exists() or filter.exists()) implies system.exists(), xpath: not(exists(f:concept) or exists(f:filter)) or exists(f:system))
ValueSet.expansion
Definition

A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Control0..1
Comments

Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.

InvariantsAffect this element
vsd-5: Value set SHALL contain at least one of a compose or an expansion element (expression : compose.exists() or expansion.exists(), xpath: 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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control1..1
Typeuri
Comments

Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).

ValueSet.expansion.timestamp
Definition

The time at which the expansion was produced by the expanding system.

Control1..1
TypedateTime
Comments

This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.

ValueSet.expansion.total
Definition

The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.

Control0..1
Typeinteger
Comments

Paging only applies to flat expansions.

ValueSet.expansion.offset
Definition

If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present.

Control0..1
Typeinteger
Meaning if MissingPaging is not being used
Comments

Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.

ValueSet.expansion.parameter
Definition

A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.

Control0..*
Comments

The server decides which parameters to include here, but at a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any).

ValueSet.expansion.parameter.name
Definition

The name of the parameter.

Control1..1
Typestring
Comments

The names are assigned at the discretion of the server.

ValueSet.expansion.parameter.value[x]
Definition

The value of the parameter.

Control0..1
Typestring|boolean|integer|decimal|uri|code
[x] NoteSee Choice of Data Types for further information about how to use [x]
ValueSet.expansion.contains
Definition

The codes that are contained in the value set expansion.

Control0..*
InvariantsDefined on this element
vsd-10: Must have a system if a code is present (expression : code.empty() or system.exists(), xpath: exists(f:system) or not(exists(f:code)))
vsd-6: SHALL have a code or a display (expression : code.exists() or display.exists(), xpath: exists(f:code) or exists(f:display))
vsd-9: Must have a code if not abstract (expression : code.exists() or abstract = true, xpath: exists(f:code) or (f:abstract/@value = true()))
ValueSet.expansion.contains.system
Definition

An absolute URI which is the code system in which the code for this item in the expansion is defined.

Control0..1
Typeuri
ValueSet.expansion.contains.abstract
Definition

If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.

Control0..1
Typeboolean
Default Valuefalse
Comments

This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.

ValueSet.expansion.contains.inactive
Definition

If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data.

Control0..1
Typeboolean
Default Valuefalse
Comments

This should only have a value if the concept is inactive.

ValueSet.expansion.contains.version
Definition

The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

The exact value of the version string is specified by the system from which the code is derived.

ValueSet.expansion.contains.code
Definition

The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.

Control0..1
Typecode
InvariantsAffect this element
vsd-6: SHALL have a code or a display (expression : code.exists() or display.exists(), xpath: exists(f:code) or exists(f:display))
ValueSet.expansion.contains.display
Definition

The recommended display for this item in the expansion.

Control0..1
Typestring
InvariantsAffect this element
vsd-6: SHALL have a code or a display (expression : code.exists() or display.exists(), xpath: exists(f:code) or exists(f:display))
ValueSet.expansion.contains.designation
Definition

Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.

Control0..*
TypeSee ValueSet.compose.include.concept.designation
Comments

The designations provided must be based on the value set and code system definitions.

ValueSet.expansion.contains.contains
Definition

Other codes and entries contained under this entry in the hierarchy.

Control0..*
TypeSee ValueSet.expansion.contains
Comments

If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.