Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

Vocabulary icon Work Group Maturity Level : N/A Standards Status : Informative
Defines common Core profiles and extensions used with or related to defined for the ValueSet resource
Profiles :
Shareable ValueSet ShareableValueSet Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets
PublishableValueSet Defines and enforces the minimum expectations for publication and distribution of a value set, typically as part of an artifact repository or implementation guide publication
ComputableValueSet Defines a computable value set as one that SHALL have an expression-based definition (i.e. a value set defined intensionally using expressions of the code systems involved) and MAY have an expansion included. The expression-based definition SHALL be represented in only one of three ways; using the compose element, using the expression extension, or using the rules-text extension to provide a step-by-step process for expanding the value set definition
ExecutableValueSet Defines an executable value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an executable value set, a computable definition of the value set must be obtained to compute the updated expansion.
Extensions :
valueset-concept-definition concept-definition :

A definition that describes the meaning of this code when used as part of this value set.

valueset-concept-comments concept-comments :

A comment that explains how this code is used in this context (where the value set is expected to be used).

valueset-otherName otherName :

Human readable Natural language names identifying the value set. These names should be usable as an identifier for the valueset. module by machine processing applications such as code generation.

valueset-sourceReference sourceReference :

This text is intended to act as a citation to work done elsewhere that is not part of the current stewarding process where the referenced source is in some way a basis of the current value set definition.

valueset-keyWord keyWord :

Word or words used in an information retrieval system to indicate the content of the value set. (deprecated)

valueset-usage usage :

Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.

valueset-workflowStatus valueset-workflowStatusDescription workflowStatus workflowStatusDescription :

Workflow Status is used to represent details of the value set development process while in a single Activity Status.

valueset-activityStatusDate activityStatusDate : The date when the associated Value Set Definition Version activity status is in effect. valueset-effectiveDate effectiveDate :

This is the first date-time when the value set version becomes active, so this value is present on Inactive value set versions as well. The start Date_time is expected to be as of 0001 UTC of the Effective Date. (deprecated)

valueset-expirationDate expirationDate :

The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value SHALL present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. (deprecated)

valueset-author author :

The entity or set of entities that create and may modify the Value Set Definition content. The name of a group or an individual, along with contact details. (deprecated)

valueset-steward steward :

The entity that is responsible for the content of the Value Set Definition. This is a textual description of the organizational entity responsible for the content and maintenance. (deprecated)

valueset-trusted-expansion trusted-expansion :

Indicates an authoritative source for performing value set expansions.

valueset-label label :

The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion.

valueset-conceptOrder conceptOrder :

Identifies the relative order in which concepts within the value set should be presented to a user.

valueset-systemName systemName : The human-readable name for the code system. valueset-systemRef systemRef :

The formal URI for the code system. I.e. ValueSet.codeSystem.system (or its equivalent).

valueset-caseSensitive caseSensitive :

If this a case sensitive code.

valueset-reference reference :

A logical reference (e.g. a reference to ValueSet.url) that identifies the value set/version that identifies the set of possible coded values this coding was chosen from or constrained by.

valueset-expansionSource expansionSource :

The logical URL of the ValueSet definition that was used to generate this expansion.

valueset-unclosed unclosed :

Marks that the expansion is incomplete, and values other than those listed may be valid. This may be used because post-coordinated codes are allowed, and no practical expansion can be produced.

valueset-toocostly toocostly :

Marks that the expansion is incomplete, because the full value set is too large to represent, and the client asked for an incomplete fragment.

valueset-map map :

A reference to a concept map that is relevant for the interpretation of this value set.

valueset-warning warning :

An extra warning about the correct use of the value set.

valueset-system system :

Allows a direct reference to the code system for FHIR query.

valueset-supplement supplement :

This extension declares that a value set depends on a particular supplement and should not be used in its absence.

valueset-parameterSource parameterSource :

Declares what the source of this parameter is.

valueset-expand-rules expand-rules : Defines how concepts are processed into the expansion when it's for UI presentation. valueset-expand-group expand-group : This extension declares a group of concepts that is generated into the ValueSet.expansion.contains hierarchy when the expansion is generated for a UI. THere is no inherent assigned meaning to the hierarchy; it is used to help the user navigate the concepts. Each group has a display and/or a code, and a list of members, which are either concepts in the value set, or other groups (by code). valueset-deprecated deprecated :

if ture, indicates that the concept is deprecated from the value set - that is, it should not be used, and is planned to be withdrawn.

valueset-special-status special-status :

A special note for implementers about the status of the resource.

valueset-extensible extensible :

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

valueset-authoritativeSource authoritativeSource :

A reference to the authoritative accessible, persisted source of truth of the entire Value Set Definition, including textual information and available versions.

valueset-expression expression :

An expression that provides an alternative definition of the content of the value set. set (compose). There are two different ways to use this expression extension: If both an expression (this extension) and a compose element is present, the compose is understood to the make the same statement as the expression. If there is no compose, the expression is the only definition of the value set, and the value set can only be processed by a server that understands the expression syntax, it that the expression is computable.

valueset-rules-text rules-text :

An expression that provides an alternative definition of the content of the value set in some form that is not computable - e.g instructions that could only be followed by a human.

valueset-otherTitle otherTitle :

Human readable titles for the valueset.

valueset-systemTitle systemTitle :

The human-readable name for the code system.

valueset-systemName systemName :

The human-readable name for the code system.

valueset-compose-createdBy createdBy :

User who created the compose for the ValueSet.

valueset-compose-creationDate creationDate :

Date the compose was created.

valueset-compose-include-valueSetTitle valueset-compose-include-valueSetTitle :

Human readable name for the included Value Set.

Search parameters defined by this package. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Paths Source
author string Optional Extensions Element f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-author'] | /f:#author CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-author').value XML / JSON
effective date Optional Extensions Element f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate'] | /f:#effectiveDate CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate').value XML / JSON
end date Optional Extensions Element f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-expirationDate'] | /f:#expirationDate CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-expirationDate').value XML / JSON
keyword string Optional Extensions Element f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-keyWord'] | /f:#keyWord CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-keyWord').value XML / JSON
workflow token Optional Extensions Element f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-workflowStatus'] | /f:#workflowStatus CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/valueset-workflowStatus').value XML / JSON