Skip to main content

CodeSystem

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url0..1uriCanonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
identifier0..*IdentifierAdditional identifier for the code system (business identifier)
version0..1stringBusiness version of the code system (Coding.version)
name0..1stringName for this code system (computer friendly)
title0..1stringName for this code system (human friendly)
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the code system
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for code system (if applicable)
purpose0..1markdownWhy this code system is defined
copyright0..1markdownUse and/or publishing restrictions
caseSensitive0..1booleanIf code comparison is case sensitive
valueSet0..1canonicalCanonical reference to the value set with entire code system
hierarchyMeaning0..1codegrouped-by | is-a | part-of | classified-with
compositional0..1booleanIf code system defines a compositional grammar
versionNeeded0..1booleanIf definitions are not stable
content1..1codenot-present | example | fragment | complete | supplement
supplements0..1canonicalCanonical URL of Code System this adds designations and properties to
count0..1unsignedIntTotal concepts in the code system
filter0..*BackboneElementFilter that can be used in a value set
property0..*BackboneElementAdditional information supplied about each concept
concept0..*BackboneElementConcepts in the code system

Search Parameters

NameTypeDescriptionExpression
contexttokenA use context assigned to the code systemCodeSystem.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the code systemCodeSystem.useContext.value
context-typetokenA type of use context assigned to the code systemCodeSystem.useContext.code
datedateThe code system publication dateCodeSystem.date
descriptionstringThe description of the code systemCodeSystem.description
jurisdictiontokenIntended jurisdiction for the code systemCodeSystem.jurisdiction
namestringComputationally friendly name of the code systemCodeSystem.name
publisherstringName of the publisher of the code systemCodeSystem.publisher
statustokenThe current status of the code systemCodeSystem.status
titlestringThe human-friendly name of the code systemCodeSystem.title
urluriThe uri that identifies the code systemCodeSystem.url
versiontokenThe business version of the code systemCodeSystem.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the code systemCodeSystem.useContext
context-type-valuecompositeA use context type and value assigned to the code systemCodeSystem.useContext
codetokenA code defined in the code systemCodeSystem.concept.code
content-modetokennot-present | example | fragment | complete | supplementCodeSystem.content
identifiertokenExternal identifier for the code systemCodeSystem.identifier
languagetokenA language in which a designation is providedCodeSystem.concept.designation.language
supplementsreferenceFind code system supplements for the referenced code systemCodeSystem.supplements
systemuriThe system for any codes defined by this code system (same as 'url')CodeSystem.url