Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - 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 Terminology Infrastructure 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 Extensions : workflow token Optional Extensions Element f:ValueSet/f:extension[@url='http://hl7.org/fhir/StructureDefinition/valueset-workflowStatus'] | /f:#workflowStatus XML / JSON
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
valueset-concept-definition PublishableValueSet concept-definition : A definition that describes Defines and enforces the meaning of this code when used as part minimum expectations for publication and distribution of this value set. valueset-concept-comments concept-comments : A comment that explains how this code is used in this context (where the a 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 set, typically 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 artifact repository or standards that the author has utilized the value set in. implementation guide publication
valueset-workflowStatus ComputableValueSet workflowStatus : Workflow Status is used to represent details of the value set development process while in Defines 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. 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 computable value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. valueset-author author : The entity or set of entities one that create and may modify the Value Set Definition content. The name of a group or SHALL have an individual, along with contact details. valueset-steward steward : The entity that is responsible for the content of the Value Set Definition. This is expression-based definition (i.e. a textual description value set defined intensionally using expressions of the organizational entity responsible for the content code systems involved) and maintenance. valueset-trusted-expansion trusted-expansion : Indicates MAY have an authoritative source for performing value set expansions. valueset-label label : expansion included. The label to list expression-based definition SHALL be represented in front of a code when presenting a list only one of possible values in a questionnaire-like fashion. valueset-conceptOrder conceptOrder : Identifies three ways; using the relative order in which concepts within compose element, using the value set should be presented expression extension, or using the rules-text extension to provide a user. valueset-systemName systemName : The human-readable name for the code system. valueset-systemRef systemRef : The formal URI step-by-step process 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 expanding 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 ExecutableValueSet toocostly : Marks that the expansion is incomplete, because the full Defines an executable value set is too large to represent, and the client asked for as one that SHALL have an incomplete fragment. valueset-map map : A reference to expansion included, as well as a concept map that is relevant for the interpretation of this value set. valueset-warning warning : An extra usage warning about the correct use of indicating the value set. valueset-system system : Allows expansion is a direct reference to the code system point-in-time snapshot and must be maintained over time for FHIR query. valueset-supplement supplement : This extension declares that a production usage. The 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 specifies the ValueSet.expansion.contains hierarchy timestamp when the expansion is generated for a UI. THere is no inherent assigned meaning to was produced, SHOULD contain the hierarchy; it is parameters used to help the user navigate for the concepts. Each group has a display and/or a code, expansion, and a list of members, which are either concepts in SHALL contain the value set, or other groups (by code). valueset-deprecated deprecated : if ture, indicates codes that the concept is deprecated from are obtained by evaluating 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 definition. If 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. There are two different ways to use this expression extension: If both ONLY an expression and a compose element is present, the compose is understood the make the same statement as the expression. If there is no compose, the expression is the only definition of the executable value set, and the value set can only be processed by a server that understands the expression syntax, it that is computable. valueset-rules-text rules-text : An expression that provides an alternative computable definition of the content of the value set in some form that is not computable - e.g instructions that could only must be followed by a human. 4.9.18.2 Search Parameters 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 obtained to compute the updated expansion.