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

An absolute URL 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. An absolute URL 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.

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. 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 an HL7 v3 II data type. Typically, this is used for values that can go in an HL7 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. 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. 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. A free text natural language name describing the value set.

Support human navigation. 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 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 status of the value set. The status of the value set.

Identify when/if the value set should be used. Identify when/if the value set should be used.

Allows filtering of value set instances that are appropriate (or not) for use. Allows filtering of value set instances that are appropriate (or not) for use.

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

Allows filtering of value sets that are appropriate for use vs. not. Allows filtering of value sets that are appropriate for use vs. not.

The name of the individual or organization that published the value set. 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. 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. 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. Contacts to assist a user in finding and communicating with the publisher.

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

The name of an individual to contact regarding the value set. 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. 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. Contact details for individual (if a name was provided) or the publisher.

The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition'). The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition').

Need to know when a value set was first legal for use or became withdrawn or replaced. 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. Additional specific dates may be added as extensions. 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.

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 set instances as of the locked date. 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 set instances as of the locked date.

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

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

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

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

This element does not describe the usage of the value set (that is 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. This element does not describe the usage of the value set (that is 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. 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 the codes that are included. The copyright statement should clearly differentiate between these when required. Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.

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

It is not required to say whether this intent applies. It is not required to say whether this intent applies.

A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly. A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.

An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system. 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 reference is not required to point to any specific kind of definition, but the more information that can be provided, the more useful it is for implementers. Best practice is to resolve to a computable definition of the code system (either a value set, or some other format). Terminology servers MAY validate this reference (e.g. when accepting PUT/POST), and MAY make additional rules about what kind of content it refers to. ValueSet.codeSystem.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. Note This is a business versionId, not a resource identifier (see discussion ) Control 0..1 Type 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 an actual FHIR ValueSet 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.

If code comparison is case sensitive when codes within this system are compared to each other. Include one or more codes from a code system.

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.codeSystem.concept 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.

A code - a text symbol - that uniquely identifies the concept within the code system. An absolute URI which is the code system from which the selected codes come from.

See ''Coding.system'' for further documentation.

A human readable string that is the recommended default way to present this concept to a user. Control 0..1 The version of the code system that the codes are selected from.

Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes. 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.

The language this designation is defined for. Specifies a concept to be included or excluded.

In the absence of a language, the resource language applies. ValueSet.codeSystem.concept.designation.use Definition A code that details how this designation would be used. Control 0..1 Binding Designation Use: Details of how a designation would be used. ( Extensible ) Type Coding 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.

Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts. Specifies a code for the concept to be included or excluded.

A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set. Control 0..1 Invariants Defined on this element vsd-1 : A value set composition SHALL have an include or an import (xpath: exists(f:include) or exists(f:import)) Affect this element vsd-5 : Value set SHALL contain at least one of a codeSystem, a compose, or an expansion element (xpath: exists(f:codeSystem) or exists(f:compose) or exists(f:expansion)) Expressions are allowed if defined by the underlying code system.

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 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 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 an actual FHIR ValueSet 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. Invariants Affect this element vsd-1 : A value set composition SHALL have an include or an import (xpath: exists(f:include) or exists(f:import)) 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.

Include one or more codes from a code system. Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.

An absolute URI which is the code system from which the selected codes come from. The language this designation is defined for.

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. In the absence of a language, the resource language applies.

Specifies a concept to be included or excluded. A code that details how this designation would be used.

Expressions are allowed if defined by the underlying code system. If no use is provided, the designation can be assumed to be suitable for general display to a human user.

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 text value for this designation.

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. 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. 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. 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 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 a regex match on the literal string of the property value. 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.

Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example. 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. 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. 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. 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. 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. 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). 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. The time at which the expansion was produced by the expanding system.

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

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

Paging only applies to flat expansions. Paging only applies to flat expansions.

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

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

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

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). 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).

The name of the parameter. The name of the parameter.

The names are assigned at the discretion of the server. The names are assigned at the discretion of the server.

The value of the parameter. The value of the parameter.

The codes that are contained in the value set expansion. 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. 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. 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 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. 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.

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 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. The exact value of the version string is specified by the system from which the code is derived.

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

The recommended display for this item in the expansion. The recommended display for this item in the expansion.

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

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