STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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: R4 R3 R2

6.24.16 ValueSet HL7 Extensions

Defines common extensions used with or related to the ValueSet resource

6.24.16.1 Content

Extensions:
valueset-definitionA definition for this code :

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

valueset-commentsComment about the use of this code in this context :

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

valueset-otherNameAlternative names :

Human readable names for the valueset.

valueset-sourceReferenceWhere did this content come from :

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-keyWordDescriptors and key terms for search :

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

valueset-usageWho has used and how? :

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

valueset-workflowStatusIndicates the state of development of the value set :

Workflow Status is used to represent details of the value set development process while the value set has an Activity Status of Preliminary. The development of a value set often follows a formal workflow process from initiation to completion, and this element carries the state variable for this state machine. The assumption is that when first created a value set would have a workflow state of Draft. Additional workflow states may be used.

valueset-effectiveDateWhen the value set version becomes Active and is available for use :

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.

valueset-expirationDateWhen the value set version should no longer be used :

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 MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date.

valueset-authorUser or Org actually involved in creating the value set content :

User or Org actually involved in creating the value set content.

valueset-commentHuman-specified notes and other documentation :

Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.

valueset-trusted-expansionReference to a trusted expansion :

Indicates an authoritative source for performing value set expansions.

valueset-historyWhat has happened over time :

Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.

valueset-labelE.g. "(a)", "1.", etc. :

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

valueset-ordinalValueComparison value for ordinal codes :

A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score).

valueset-conceptOrderAppearance order for user selection :

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

valueset-systemNameCode system name :

The human-readable name for the code system.

valueset-systemRefWhere to find code system :

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

valueset-caseSensitiveIf code is case sensitive :

If this a case sensitive code.

valueset-oidOID assigned to the value set or code system :

The OID assigned the same object as the URI points to. Examples include OIDs assigned to code systems like SNOMED CT (urn:oid:2.16.840.1.113883..6.96) or LOINC (urn:oid:2.16.840.1.113883.6.1), value sets like AdministrativeGender (urn:oid:2.16.840.1.113883.11.1), identification systems like SSN (urn:oid:2.16.840.1.113883.4.1) etc.

valueset-referenceUrl of Value set the code was chosen from :

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-expansionSourceValueSet definition used to generate this expansion (logical URL) :

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

valueset-unclosedThe expansion is incomplete :

Marks that the expansion is incomplete, abd other values that those listed may be valid.

valueset-mapA concept map relevant to interpret this value set :

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

valueset-warningExtra warning about the correct use of the value set :

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

6.24.16.2 Search Parameters

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

NameTypeDescriptionPathsSource
authorstringf:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-author'] | /f:#authorXML / JSON
effectivedatef:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate'] | /f:#effectiveDateXML / JSON
enddatef:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-expirationDate'] | /f:#expirationDateXML / JSON
keywordstringf:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-keyWord'] | /f:#keyWordXML / JSON
workflowtokenf:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-workflowStatus'] | /f:#workflowStatusXML / JSON