Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. 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

4.8.24 CodeSystem HL7 Extensions

Vocabulary Work GroupMaturity Level: N/AStandards Status: Informative
Defines common extensions used with or related to the CodeSystem resource

4.8.24.1 Content

Profiles:
Shareable CodeSystemEnforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets
Extensions:
codesystem-concept-commentsconcept-comments :

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

codesystem-otherNameotherName :

Human readable names for the codesystem.

codesystem-sourceReferencesourceReference :

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-keyWordkeyWord :

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

codesystem-usageusage :

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

codesystem-workflowStatusworkflowStatus :

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-effectiveDateeffectiveDate :

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.

codesystem-expirationDateexpirationDate :

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.

codesystem-authorauthor :

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

codesystem-trusted-expansiontrusted-expansion :

Indicates an authoritative source for performing value set expansions.

codesystem-historyhistory :

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

codesystem-labellabel :

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

codesystem-conceptOrderconceptOrder :

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

codesystem-mapmap :

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

codesystem-replacedbyreplacedby :

A code that replaces this - use this code instead.

codesystem-warningwarning :

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

codesystem-alternatealternate :

An additional code that may be used to represent the concept.

4.8.24.2 Search Parameters

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

NameTypeDescriptionPathsSource
authorstringOptional Extensions Elementf:CodeSystem/f:extension[@url='http://hl7.org/fhir/StructureDefinition/codesystem-author'] | /f:#authorXML / JSON
effectivedateOptional Extensions Elementf:CodeSystem/f:extension[@url='http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate'] | /f:#effectiveDateXML / JSON
enddateOptional Extensions Elementf:CodeSystem/f:extension[@url='http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate'] | /f:#expirationDateXML / JSON
keywordstringOptional Extensions Elementf:CodeSystem/f:extension[@url='http://hl7.org/fhir/StructureDefinition/codesystem-keyWord'] | /f:#keyWordXML / JSON
workflowtokenOptional Extensions Elementf:CodeSystem/f:extension[@url='http://hl7.org/fhir/StructureDefinition/codesystem-workflowStatus'] | /f:#workflowStatusXML / JSON