ValueSet - FHIR v3.4.0
Current Build
Vocabulary Work GroupMaturity Level: 5 Normative Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ValueSet resource.

ValueSet
Element IdValueSet
Definition

A ValueSet resource instances 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.

Control1..1
TypeDomainResource
Invariants
Defined on this element
vsd-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-11Rule Status must = 'active' if expansion is present and compose is absentstatus='active' or compose.exists() or expansion.empty()
ValueSet.url
Element IdValueSet.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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.

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.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

ValueSet.identifier
Element IdValueSet.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, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.

ValueSet.version
Element IdValueSet.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
Element IdValueSet.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 alphanumeric type name to ensure that it is machine-processing 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.

Invariants
Affect this element
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ValueSet.title
Element IdValueSet.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
Element IdValueSet.status
Definition

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

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of value sets that are appropriate for use versus not.See also the valueset-workflowStatus extension for additional status information related to the editorial process.

Invariants
Affect this element
vsd-11Rule Status must = 'active' if expansion is present and compose is absentstatus='active' or compose.exists() or expansion.empty()
ValueSet.experimental
Element IdValueSet.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
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 sets that are appropriate for use versus not.

ValueSet.date
Element IdValueSet.date
Definition

The date (and optionally time) when the value set was published. The date must change 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
Element IdValueSet.publisher
Definition

The name of the organization or individual 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
Element IdValueSet.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
Element IdValueSet.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 value set is presumed to be the predominant language in the place the value set 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
Element IdValueSet.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 that all or any of the contexts apply.

ValueSet.jurisdiction
Element IdValueSet.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
Element IdValueSet.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
Element IdValueSet.purpose
Definition

Explanation 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
Element IdValueSet.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

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

ValueSet.compose
Element IdValueSet.compose
Definition

A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).

Control0..1
Alternate NamesContent Logical Definition; CLD
Invariants
Affect this element
vsd-11Rule Status must = 'active' if expansion is present and compose is absentstatus='active' or compose.exists() or expansion.empty()
ValueSet.compose.lockedDate
Element IdValueSet.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
Element IdValueSet.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 $expand parameters (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
Element IdValueSet.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'.

Invariants
Defined on this element
vsd-1Rule A value set include/exclude SHALL have a value set or a systemvalueSet.exists() or system.exists()
vsd-2Rule A value set with concepts or filters SHALL include a system(concept.exists() or filter.exists()) implies system.exists()
vsd-3Rule Cannot have both concept and filterconcept.empty() or filter.empty()
ValueSet.compose.include.system
Element IdValueSet.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.

Invariants
Affect this element
vsd-1Rule A value set include/exclude SHALL have a value set or a systemvalueSet.exists() or system.exists()
vsd-2Rule A value set with concepts or filters SHALL include a system(concept.exists() or filter.exists()) implies system.exists()
ValueSet.compose.include.version
Element IdValueSet.compose.include.version
Definition

The version of the code system that the codes are selected from, or the special version "*" for all versions.

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 might not be known until a context of use binds it to a particular version. The special value "*" means all version; It is at server discrection regarding expansions and which versions must be supported.

ValueSet.compose.include.concept
Element IdValueSet.compose.include.concept
Definition

Specifies a concept to be included or excluded.

Control0..*
Comments

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

Invariants
Affect this element
vsd-3Rule Cannot have both concept and filterconcept.empty() or filter.empty()
ValueSet.compose.include.concept.code
Element IdValueSet.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
Element IdValueSet.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
Element IdValueSet.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..*
Comments

Concepts have both a display and an array of designation. The display is equivalent to a special designation with a n implied designation.use of "primary code" and a language equal to the Resource Language.

ValueSet.compose.include.concept.designation.language
Element IdValueSet.compose.include.concept.designation.language
Definition

The language this designation is defined for.

Control0..1
Terminology BindingCommon Languages (Preferred but limited to All Languages)
Typecode
Comments

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

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

A code that represents types of uses of designations.

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
Element IdValueSet.compose.include.concept.designation.value
Definition

The text value for this designation.

Control1..1
Typestring
ValueSet.compose.include.filter
Element IdValueSet.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..*
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.

Invariants
Affect this element
vsd-3Rule Cannot have both concept and filterconcept.empty() or filter.empty()
ValueSet.compose.include.filter.property
Element IdValueSet.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
Element IdValueSet.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
Element IdValueSet.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
Typestring
Summarytrue
Comments

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

ValueSet.compose.include.valueSet
Element IdValueSet.compose.include.valueSet
Definition

Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.

Control0..*
Typecanonical(ValueSet)
Summarytrue
Comments

The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a direct reference to a value set definition using ValueSet.url. The reference might 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.

Invariants
Affect this element
vsd-1Rule A value set include/exclude SHALL have a value set or a systemvalueSet.exists() or system.exists()
ValueSet.compose.exclude
Element IdValueSet.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.

Invariants
Affect this element
vsd-2Rule A value set with concepts or filters SHALL include a system(concept.exists() or filter.exists()) implies system.exists()
ValueSet.expansion
Element IdValueSet.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.

Invariants
Affect this element
vsd-11Rule Status must = 'active' if expansion is present and compose is absentstatus='active' or compose.exists() or expansion.empty()
ValueSet.expansion.identifier
Element IdValueSet.expansion.identifier
Definition

An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.

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

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

ValueSet.expansion.timestamp
Element IdValueSet.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
Element IdValueSet.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
Element IdValueSet.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
Element IdValueSet.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 all of the parameters that affect the $expand operation. If the expansion will be persisted all of these parameters SHALL be included. If the codeSystem on the server has a specified version then this version SHALL be provided as a parameter in the expansion (note that not all code systems have a version).

ValueSet.expansion.parameter.name
Element IdValueSet.expansion.parameter.name
Definition

Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.

Control1..1
Typestring
Comments

The names are assigned at the discretion of the server.

ValueSet.expansion.parameter.value[x]
Element IdValueSet.expansion.parameter.value[x]
Definition

The value of the parameter.

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

The codes that are contained in the value set expansion.

Control0..*
Invariants
Defined on this element
vsd-6Rule SHALL have a code or a displaycode.exists() or display.exists()
vsd-9Rule Must have a code if not abstractcode.exists() or abstract = true
vsd-10Rule Must have a system if a code is presentcode.empty() or system.exists()
ValueSet.expansion.contains.system
Element IdValueSet.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
Element IdValueSet.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
Meaning if MissingIf this is not populated, systems can assume that the concept it not abstract. This SHALL always be populated for abstract concepts
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
Element IdValueSet.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. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).

Control0..1
Typeboolean
Comments

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

ValueSet.expansion.contains.version
Element IdValueSet.expansion.contains.version
Definition

The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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
Element IdValueSet.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
Invariants
Affect this element
vsd-6Rule SHALL have a code or a displaycode.exists() or display.exists()
ValueSet.expansion.contains.display
Element IdValueSet.expansion.contains.display
Definition

The recommended display for this item in the expansion.

Control0..1
Typestring
Invariants
Affect this element
vsd-6Rule SHALL have a code or a displaycode.exists() or display.exists()
ValueSet.expansion.contains.designation
Element IdValueSet.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
Element IdValueSet.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.