This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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
(No assigned work group) | Maturity Level: N/A | Ballot Status: Informative |
Extensions: | |
valueset-definition | definition : A display name that describes the meaning of this code when used as part of this value set. |
valueset-comments | 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 names for the valueset. |
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. |
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 | workflowStatus : 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 | 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. |
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. |
valueset-author | author : User or Org actually involved in creating the value set content. |
valueset-comment | comment : Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group. |
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-ordinalValue | ordinalValue : 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 | 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 it's absence. |
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 |