This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - 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 Work Group | Maturity Level: N/A | Standards Status: Informative |
Profiles: | |
ShareableCodeSystem | Enforces the minimum information set for the code system metadata required by HL7 and other organizations that share and publish code systems |
PublishableCodeSystem | Defines and enforces the minimum expectations for publication and distribution of a code system, typically as part of an artifact repository or implementation guide publication |
Extensions: | |
codesystem-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). |
codesystem-otherName | otherName : Human readable names for the codesystem. |
codesystem-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. |
codesystem-keyWord | keyWord : Word or words used in an information retrieval system to indicate the content of the value set. (deprecated) |
codesystem-usage | usage : Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in. |
codesystem-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. |
codesystem-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) |
codesystem-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 MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date. (deprecated) |
codesystem-author | author : User or Org actually involved in creating the value set content. (deprecated) |
codesystem-trusted-expansion | trusted-expansion : Indicates an authoritative source for performing value set expansions. |
codesystem-history | history : Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes. |
codesystem-label | label : The label to list in front of a code when presenting a list of possible values in a questionnaire-like fashion. |
codesystem-conceptOrder | conceptOrder : Identifies the relative order in which concepts within the value set should be presented to a user. |
codesystem-map | map : A reference to a concept map that is relevant for the interpretation of this value set. |
codesystem-replacedby | replacedby : A code that replaces this - use this code instead. |
codesystem-warning | warning : An extra warning about the correct use of the value set. |
codesystem-authoritativeSource | authoritativeSource : A reference to the authoritative, human readable, source of truth for the code system information. |
codesystem-alternate | alternate : An additional code that may be used to represent the concept. |
codesystem-use-markdown | use-markdown : If true, the definitions of the concepts can be treated and rendered as markdown for improved presentation. |
codesystem-properties-mode | properties-mode : The extent to which the properties of the code system (including the filters) are represented in this resource instance. |
terminology-resource-identifier-metadata | terminologyResourceIdentifierMetadata : Additional metadata in identifier elements for terminology resources. |
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 | CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-author').value | XML / JSON |
effective | date | Optional Extensions Element | CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate'.value) | XML / JSON |
end | date | Optional Extensions Element | CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate').value | XML / JSON |
keyword | string | Optional Extensions Element | CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-keyWord').value | XML / JSON |
workflow | token | Optional Extensions Element | CodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-workflowStatus').value | XML / JSON |