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

An absolute uri that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).

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.

Typically, this is used for values that can go in a v3 II data type.

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.

There may be multiple resource versions of the value set that have the same identifier.

A free text natural language name describing the value set.

Support human navigation.

The name is not expected to be unique. 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.

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 of value set definitions.

Assist in searching for appropriate content.

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

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 Value Set 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.

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

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

Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

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

May be a web site, an email address, a telephone number (tel:), etc.

The name of an individual to contact regarding the value set.

If there is no named individual, the telecom is for the organization as a whole.

Contact details for individual (if a name was provided) or the publisher.

A free text natural language description of the use of the value set - reason for definition, "the semantic space" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.

Human understandability.

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.

Explains why this value set is needed and why it's been constrained as it has.

This element does not describe the usage of the value set (that's done in comments), rather it's for traceability of why the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.

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.

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

The status of the value set.

Identify when/if the value set should be used.

Allows filtering of valuesets that are appropriate for use vs. not.

This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Allows filtering of valuesets that are appropriate for use vs. not.

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

It is not required to say whether this intent applies.

The date that the value set status was last changed.

Need to know when a value set was first legal for use or became withdrawn or replaced.

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.

If a Locked Date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value sets as of the Locked Date.

With a defined Locked Date the value set is considered "Locked". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve.

A definition of an code system, inlined into the value set.

All code systems defined as part of a FHIR value set have an implicit valueset that includes all the code in the code system - the value set in which they are defined.

An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system.

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.

If code comparison is case sensitive when codes within this system are compared to each other.

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.

Concepts in the code system.

Code that identifies concept.

If this code is not for use as a real concept.

Text to Display to the user.

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.

Additional representations for the concept - other languages, aliases, specialised purposes, used for particular purposes, etc.

many concept definition systems support mltiple representations, in multiple languages, and for mltiple purposes.

The language this designation is defined for.

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

A code that details how this designation would be used.

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

The text value for this designation.

Child Concepts (is-a / contains).

When value set includes codes from elsewhere.

Includes the contents of the referenced value set as a part of the contents of this value set. This is an absolute URI that is a reference to ValueSet.uri.

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 also not reference a actual FHIR value set resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved.

Include one or more codes from a code system.

If there are no codes or filters, the entire code system is included. Note that the set of codes hat are included may contain abstract codes.

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

See Coding.system for further documentation.

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

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.

Specifies a concept to be included or excluded.

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

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

Expressions are allowed if defined by the underlying code system.

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.

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.

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

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.

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.

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

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

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.

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

Exclude one or more codes from the value set.

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.

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.

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

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.

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

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

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

A Parameter that controlled the expansion process. These paameters 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.

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

The name of the parameter.

The names are assigned at the discretion of the server.

The value of the parameter.

The codes that are contained in the value set expansion.

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

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

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

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.

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

Code - if blank, this is not a choosable code.

User display for the concept.

Codes contained in this concept.