Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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 Core

Vocabulary icon Work GroupMaturity Level: N/AStandards Status: Informative
Core profiles and extensions defined for the CodeSystem resource

4.8.24.1 Content

Profiles:
ShareableCodeSystemEnforces the minimum information set for the code system metadata required by HL7 and other organizations that share and publish code systems
PublishableCodeSystemDefines 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-commentsCSConceptComments :

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

codesystem-otherNameCSOtherName :

Human readable names for the codesystem.

codesystem-sourceReferenceCSSourceReference :

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

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

codesystem-usageCSUsage :

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

codesystem-workflowStatusCSWorkflowStatus :

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-trusted-expansionCSTrustedExpansion :

Indicates an authoritative source for performing value set expansions.

codesystem-historyCSHistory :

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

codesystem-labelCSLabel :

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

codesystem-conceptOrderCSConceptOrder :

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

codesystem-mapCSMap :

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

codesystem-replacedbyCSReplacedby :

A code that replaces this - use this code instead.

codesystem-warningCSWarning :

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

codesystem-authoritativeSourceCSAuthoritativeSource :

A reference to the authoritative, human readable, source of truth for the code system information.

codesystem-alternateCSAlternate :

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

codesystem-use-markdownCSUseMarkdown :

If true, the definitions of the concepts can be treated and rendered as markdown for improved presentation.

codesystem-properties-modeCSPropertiesMode :

The extent to which the properties of the code system (including the filters) are represented in this resource instance.

terminology-resource-identifier-metadataTxResourceIdentifierMetadata :

Additional metadata in identifier elements for terminology resources.

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 ElementCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-author').valueXML / JSON
effectivedateOptional Extensions ElementCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate'.value)XML / JSON
enddateOptional Extensions ElementCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate').valueXML / JSON
keywordstringOptional Extensions ElementCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-keyWord').valueXML / JSON
workflowtokenOptional Extensions ElementCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-workflowStatus').valueXML / JSON