臺灣核心實作指引(TW Core IG)
0.1.0 - Trial Use

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.1.0: Releases) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Data Type Profile: CodeableConceptTW - Detailed Descriptions

Active as of 2023-07-05

Definitions for the CodeableConcept-tw data type profile.

Guidance on how to interpret the contents of this table can be found here.

1. CodeableConcept
2. CodeableConcept.id
Definition

resource中資料項目的唯一ID(用於內部參照)。這可以是任何不含空格的字串。

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

3. CodeableConcept.extension
Definition

擴充的資料項目

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

4. CodeableConcept.coding
Definition

由專門術語系統(terminology system)所定義之代碼的參照

A reference to a code defined by a terminology system.

TypeCoding(CodingTW)
Must Supporttrue
Requirements

允許代碼系統中的替代編碼,以及翻譯到其他編碼系統。

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

代碼可以在列舉清單(enumerations)或代碼清單(code lists)中非常隨意地定義,直至有非常正式的定義,例如:SNOMED CT—更多資訊見HL7 v3核心原則(Core Principles )。編碼的排序是未定義的因而 必須沒有(SHALL NOT) 被用來推斷意義。一般來說,最多只有一個編碼值(coding values)會被標記為UserSelected = true。

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

5. CodeableConcept.text
Definition

輸入資料的使用者所見/所選/所說的人類可讀文字表述,和(或)其代表使用者的預期含義。

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Must Supporttrue
Requirements

專門術語中的代碼並不總是能捕捉人類使用的細微差別的正確意義,或者根本就沒有合適的代碼;這些情況下,文字表述被用來捕捉來源的全部意義。

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

很多時候,此文字表述與其中一個代碼的顯示名稱相同。

Very often the text is the same as a displayName of one of the codings.

Guidance on how to interpret the contents of this table can be found here.

1. CodeableConcept
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control0..* This element is affected by the following invariants: ele-1
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. CodeableConcept.id
Definition

resource中資料項目的唯一ID(用於內部參照)。這可以是任何不含空格的字串。

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. CodeableConcept.extension
Definition

擴充的資料項目

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CodeableConcept.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. CodeableConcept.coding
Definition

由專門術語系統(terminology system)所定義之代碼的參照

A reference to a code defined by a terminology system.

Control0..* This element is affected by the following invariants: ele-1
TypeCoding(CodingTW)
Must Supporttrue
Requirements

允許代碼系統中的替代編碼,以及翻譯到其他編碼系統。

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

代碼可以在列舉清單(enumerations)或代碼清單(code lists)中非常隨意地定義,直至有非常正式的定義,例如:SNOMED CT—更多資訊見HL7 v3核心原則(Core Principles )。編碼的排序是未定義的因而 必須沒有(SHALL NOT) 被用來推斷意義。一般來說,最多只有一個編碼值(coding values)會被標記為UserSelected = true。

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. CodeableConcept.text
Definition

輸入資料的使用者所見/所選/所說的人類可讀文字表述,和(或)其代表使用者的預期含義。

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Must Supporttrue
Summarytrue
Requirements

專門術語中的代碼並不總是能捕捉人類使用的細微差別的正確意義,或者根本就沒有合適的代碼;這些情況下,文字表述被用來捕捉來源的全部意義。

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

很多時候,此文字表述與其中一個代碼的顯示名稱相同。

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. CodeableConcept
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control0..* This element is affected by the following invariants: ele-1
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

2. CodeableConcept.id
Definition

resource中資料項目的唯一ID(用於內部參照)。這可以是任何不含空格的字串。

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. CodeableConcept.extension
Definition

擴充的資料項目

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CodeableConcept.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. CodeableConcept.coding
Definition

由專門術語系統(terminology system)所定義之代碼的參照

Control0..* This element is affected by the following invariants: ele-1
TypeCoding(CodingTW)
Must Supporttrue
Requirements

允許代碼系統中的替代編碼,以及翻譯到其他編碼系統。

Comments

代碼可以在列舉清單(enumerations)或代碼清單(code lists)中非常隨意地定義,直至有非常正式的定義,例如:SNOMED CT—更多資訊見HL7 v3核心原則(Core Principles )。編碼的排序是未定義的因而 必須沒有(SHALL NOT) 被用來推斷意義。一般來說,最多只有一個編碼值(coding values)會被標記為UserSelected = true。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. CodeableConcept.text
Definition

輸入資料的使用者所見/所選/所說的人類可讀文字表述,和(或)其代表使用者的預期含義。

Control0..1
Typestring
Must Supporttrue
Summarytrue
Requirements

專門術語中的代碼並不總是能捕捉人類使用的細微差別的正確意義,或者根本就沒有合適的代碼;這些情況下,文字表述被用來捕捉來源的全部意義。

Comments

很多時候,此文字表述與其中一個代碼的顯示名稱相同。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))