FHIR R4
Vocabulary Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the CodeSystem resource.

CodeSystem
Element IdCodeSystem
Definition

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.

Cardinality0..*
TypeDomainResource
Invariants
Defined on this element
csd-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1Rule Within a code system definition, all the codes SHALL be uniqueconcept.code.combine($this.descendants().concept.code).isDistinct()
CodeSystem.url
Element IdCodeSystem.url
Definition

An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.

Cardinality0..1
Typeuri
Requirements

Allows the code system to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

CodeSystem.identifier
Element IdCodeSystem.identifier
Definition

A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.

CodeSystem.version
Element IdCodeSystem.version
Definition

The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version].

CodeSystem.name
Element IdCodeSystem.name
Definition

A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
CodeSystem.title
Element IdCodeSystem.title
Definition

A short, descriptive, user-friendly title for the code system.

Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

CodeSystem.status
Element IdCodeSystem.status
Definition

The date (and optionally time) when the code system resource was created or revised.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of code systems that are appropriate for use versus not.

CodeSystem.experimental
Element IdCodeSystem.experimental
Definition

A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Cardinality0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system.

Summarytrue
Comments

Allows filtering of code systems that are appropriate for use versus not.

CodeSystem.date
Element IdCodeSystem.date
Definition

The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.

Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

CodeSystem.publisher
Element IdCodeSystem.publisher
Definition

The name of the organization or individual that published the code system.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the code system. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the code system. This item SHOULD be populated unless the information is available from context.

CodeSystem.contact
Element IdCodeSystem.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

CodeSystem.description
Element IdCodeSystem.description
Definition

A free text natural language description of the code system from a consumer's perspective.

Cardinality0..1
Typemarkdown
Alternate NamesScope; Purpose
Comments 此元素与DomainResource.text中生成的叙述文字不同,它侧重于描述为什么创建此编码系统、不适用场景、临床使用说明、文献参考、手工纸质使用的示例等详细信息。如果资源的上下文中不能获得以上信息,则应提供此元素。
CodeSystem.useContext
Element IdCodeSystem.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

CodeSystem.jurisdiction
Element IdCodeSystem.jurisdiction
Definition 使用编码系统的地理区域范围或法规约定的区域范围。
Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments使用时可能会超出最初设计或打算使用的管辖范围。
CodeSystem.purpose
Element IdCodeSystem.purpose
Definition

Explanation of why this code system is needed and why it has been designed as it has.

Cardinality0..1
Typemarkdown
Comments

This element does not describe the usage of the code system. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this code system.

CodeSystem.copyright
Element IdCodeSystem.copyright
Definition 此编码系统及其相关内容的版权声明。版权声明通常是对编码系统的使用和发布的法律限制。
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the code system and/or its content.

Alternate NamesLicense; Restrictions
Comments

... Sometimes, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required.

CodeSystem.caseSensitive
Element IdCodeSystem.caseSensitive
Definition 对此系统中的编码进行对比时,是否区分大小写。
Cardinality0..1
Typeboolean
Summarytrue
Comments 此元素主要用于对验证的支持。如不提供此元素则应遵循波斯特尔定律:创建编码时使用正确的大小写,使用编码时不区分大小写。
CodeSystem.valueSet
Element IdCodeSystem.valueSet
Definition 此编码系统的值域集,此编码系统的所有编码概念都包含在其中。
Cardinality0..1
Typecanonical(ValueSet)
Summarytrue
Comments 值集全集的定义必须包括本编码系统中的所有编码,且只能包括本编码系统中的编码,且其永恒性只能为真,即ValueSet.immutable=“true”。
CodeSystem.hierarchyMeaning
Element IdCodeSystem.hierarchyMeaning
Definition 概念的层级关系的含义。
Cardinality0..1
Terminology BindingCodeSystemHierarchyMeaning (Required)
Typecode
Summarytrue
Comments 注意,有些编码系统可能使用属性来表示其它的层次结构,或根本没有层次结构。
CodeSystem.compositional
Element IdCodeSystem.compositional
Definition 编码系统定义了一个动态的组合编码(post-coordination)语法。

The code system defines a compositional (post-coordination) grammar.

Cardinality0..1
Typeboolean
Alternate Namesgrammar
Summarytrue
Comments 注意,编码系统资源只定义是否存动态的组合编码语法,并不说明语法的具体内容。
CodeSystem.versionNeeded
Element IdCodeSystem.versionNeeded
Definition 用于表示编码系统的不同版本之间的稳定性与兼容性。如果为true,则在引用此编码系统时必须指定版本。
Cardinality0..1
Typeboolean
Summarytrue
Comments 最佳实践是编码系统不重新定义概念,如果重新定义概念,则创建新的编码系统实例。但有时却办不到,所以有些编码系统可能被定义为“versionNeeded”。

大多数编码系统偶尔会在新版本中改进概念显示的名称。有些验证过概念显示名称的上下文可能要求为某些编码系统指定版本,这种情况而不使用此元素。

CodeSystem.content
Element IdCodeSystem.content
Definition 在此资源实例中定义的概念和编码在整个编码系统中的内容范围。
Cardinality1..1
Terminology BindingCodeSystemContentMode (Required)
Typecode
Summarytrue
CodeSystem.supplements
Element IdCodeSystem.supplements
Definition 此编码系统附录的官方URL,此附录提供更多的名称(语言)和属性。
Cardinality0..1
Typecanonical(CodeSystem)
Summarytrue
Comments 附录最常见的用途是添加额外的语言支持。
CodeSystem.count
Element IdCodeSystem.count
Definition 编码系统定义的概念总数。如果编码系统具有组合语法,则此计数由系统管理员定义。
Cardinality0..1
TypeunsignedInt
Summarytrue
Comments 此资源中定义的概念数不能比总数多,但可能比总数少,其几个原因可参阅content元素。
CodeSystem.filter
Element IdCodeSystem.filter
Definition 此筛选器是为值域集准备的,当值域集使用ValueSet.compose.include.filter来选择此编码系统中的概念时需要定义此元素。
Cardinality0..*
Summarytrue
Comments 注意,需要术语引擎对值域集自定义概念选择表示式的支持,在编码系统中定义的筛选器才有意义。由于这个原因,它们通常只出现在高级术语系统中。
CodeSystem.filter.code
Element IdCodeSystem.filter.code
Definition 当值域集使用ValueSet.compose.include.filter来选择此编码系统中的概念时,ValueSet.compose.include.filter.property中填写的此code中的值。
Cardinality1..1
Typecode
Summarytrue
CodeSystem.filter.description
Element IdCodeSystem.filter.description
Definition 描述如何或为什么使用此筛选器。
Cardinality0..1
Typestring
Summarytrue
CodeSystem.filter.operator
Element IdCodeSystem.filter.operator
Definition可与筛选器一起使用的运算符。
Cardinality1..*
Terminology BindingFilterOperator (Required)
Typecode
Summarytrue
CodeSystem.filter.value
Element IdCodeSystem.filter.value
Definition 描述筛选器的值用来做什么。
Cardinality1..1
Typestring
Summarytrue
CodeSystem.property
Element IdCodeSystem.property
Definition 属性用于提供有此概念相关的更多附加信息。
Cardinality0..*
Summarytrue
CodeSystem.property.code
Element IdCodeSystem.property.code
Definition 用于标识属性的编码。此编码可用在此资源内部(CodeSystem.concept.property.code),也可用在外部,如:用于属性筛选器(filter)。
Cardinality1..1
Typecode
Summarytrue
CodeSystem.property.uri
Element IdCodeSystem.property.uri
Definition 指向属性表示的意思。常使用“概念属性”编码系统的官方地址:http://hl7.org/fhir/concept-properties。
Cardinality0..1
Typeuri
Summarytrue
CodeSystem.property.description
Element IdCodeSystem.property.description
Definition 属性的描述——为什么如此定义,以及如何使用它的值。
Cardinality0..1
Typestring
Summarytrue
CodeSystem.property.type
Element IdCodeSystem.property.type
Definition 属性值的类型。“编码”类型的属性值是某个编码系统定义的概念,即引用另一个定义的概念。
Cardinality1..1
Terminology BindingPropertyType (Required)
Typecode
Summarytrue
CodeSystem.concept
Element IdCodeSystem.concept
Definition 编码系统中的概念。概念定义天然的具有层次关系,但是必须参阅CodeSystem.hierarchyMeaning的定义来确定层次关系的含义。
Cardinality0..*
Comments 如果为空,则表示此编码系统资源不是用来表示编码系统的内容的,其CodeSystem.content的值应为“not-present”。
CodeSystem.concept.code
Element IdCodeSystem.concept.code
Definition 概念的编码(表示为文本符号),它是在编码系统中标识概念唯一性的代码。
Cardinality1..1
Typecode
CodeSystem.concept.display
Element IdCodeSystem.concept.display
Definition 一个自然语言描述的可读强的字符串,是概念的显示在界面上的推荐默认方式。
Cardinality0..1
Typestring
CodeSystem.concept.definition
Element IdCodeSystem.concept.definition
Definition 概念的正式定义。由于遗留系统的普遍存在,不强制要求提供正式定义。但是,强烈建议对概念进行正式的定义,否则,就没有与概念相关联的正式含义,容易产生岐意。
Cardinality0..1
Typestring
CodeSystem.concept.designation
Element IdCodeSystem.concept.designation
Definition 概念的其他称谓方式-其他语言、别名、专业目的、用于特殊用途等。
Cardinality0..*
Requirements

Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes.

Comments

Concepts have both a display and an array of designation. The display is equivalent to a special designation with an implied designation.use of "primary code" and a language equal to the Resource Language.

CodeSystem.concept.designation.language
Element IdCodeSystem.concept.designation.language
Definition定义此称谓的语言。
Cardinality0..1
Terminology BindingCommon Languages (Preferred but limited to All Languages)
Typecode
Comments

In the absence of a language, the resource language applies.

CodeSystem.concept.designation.use
Element IdCodeSystem.concept.designation.use
Definition 用编码来详细说明如何使用该称谓。
Cardinality0..1
Terminology BindingDesignation Use (Extensible)
TypeCoding
Comments

If no use is provided, the designation can be assumed to be suitable for general display to a human user.

CodeSystem.concept.designation.value
Element IdCodeSystem.concept.designation.value
Definition

The text value for this designation.

Cardinality1..1
Typestring
CodeSystem.concept.property
Element IdCodeSystem.concept.property
Definition

A property value for this concept.

Cardinality0..*
CodeSystem.concept.property.code
Element IdCodeSystem.concept.property.code
Definition 引用自CodeSystem.property.code的属性编码。
Cardinality1..1
Typecode
CodeSystem.concept.property.value[x]
Element IdCodeSystem.concept.property.value[x]
Definition

The value of this property.

Cardinality1..1
Typecode|Coding|string|integer|boolean|dateTime|decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
CodeSystem.concept.concept
Element IdCodeSystem.concept.concept
Definition 定义概念的子级要概念。以形成概念的层级结构。父概念与子概念之间可以有几种不同的关系(is-a/contains/categorizes)。-请参见CodeSystem.hierarchyMeaning。
Cardinality0..*
TypeSee CodeSystem.concept