This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
Extensions: | |
valueset-definition | A definition for this code : A display name that describes the meaning of this code when used as part of this value set. |
valueset-comments | Comment 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-otherName | Alternative names : Human readable names for the valueset. |
valueset-sourceReference | Where 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-keyWord | Descriptors and key terms for search : Word or words used in an information retrieval system to indicate the content of the value set. |
valueset-usage | Who 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-workflowStatus | Indicates 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-effectiveDate | When 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-expirationDate | When 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-author | User or Org actually involved in creating the value set content : User or Org actually involved in creating the value set content. |
valueset-comment | Human-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-expansion | Reference to a trusted expansion : Indicates an authoritative source for performing value set expansions. |
valueset-history | What 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-label | E.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-ordinalValue | Comparison 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-conceptOrder | Appearance order for user selection : Identifies the relative order in which concepts within the value set should be presented to a user. |
valueset-systemName | Code system name : The human-readable name for the code system. |
valueset-systemRef | Where to find code system : The formal URI for the code system. I.e. ValueSet.codeSystem.system (or its equivalent). |
valueset-caseSensitive | If code is case sensitive : If this a case sensitive code. |
valueset-reference | Url 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-expansionSource | ValueSet definition used to generate this expansion (logical URL) : The logical URL of the ValueSet definition that was used to generate this expansion. |
valueset-unclosed | The expansion is incomplete (because post-coordination) : Marks that the expansion is incomplete, and other values that those listed may be valid. This may be used because post-coordinated codes are allowed, and no finite expansion can be produced. |
valueset-toocostly | The expansion is incomplete because the full expansion is too large : 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 | A 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-warning | Extra warning about the correct use of the value set : An extra warning about the correct use of the value set. |
valueset-system | Code system resource : Allows a direct reference to the code system for FHIR query. |
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 | XML / JSON |
effective | date | Optional Extensions Element | f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate'] | /f:#effectiveDate | XML / JSON |
end | date | Optional Extensions Element | f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-expirationDate'] | /f:#expirationDate | XML / JSON |
keyword | string | Optional Extensions Element | f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-keyWord'] | /f:#keyWord | XML / JSON |
workflow | token | Optional Extensions Element | f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-workflowStatus'] | /f:#workflowStatus | XML / JSON |