TW Coding - Definitions - 臺灣核心實作指引(TW Core IG) v0.3.1

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ and changes regularly. See the Directory of published versions

Data Type Profile: CodingTW - Detailed Descriptions

Active as of 2024-11-11

Definitions for the Coding-tw data type profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. Coding
Definition	由專門術語系統（terminology system）所定義之代碼的參照
Short	由專門術語系統（terminology system）定義的代碼
Comments	代碼可以在列舉清單（enumerations）或代碼清單（code lists）中非常隨意地定義，直至有非常正式的定義，例如：SNOMED CT—更多資訊見HL7 v3核心原則（Core Principles ）。編碼的排序是未定義的因而必須沒有（SHALL NOT）被用來推斷意義。一般來說，最多只有一個編碼值（coding values）會被標記為UserSelected = true。
2. Coding.id
Definition	resource中資料項目的唯一ID（用於內部參照），這可以是任何不含空格的字串。
Short	唯一可識別ID，以供資料項目間相互參照。
4. Coding.extension
Definition	可用於表示不屬於此資料項目基本定義的附加資訊。為了擴充的使用安全和可管理，對擴充的定義和使用有一套嚴格的管理。儘管任何實作者都可以定義一個擴充，但作為擴充定義的一部分，有一套要求必須（SHALL）滿足。
Short	擴充的資料項目
Comments	無論使用或定義擴充的機構或管轄區，任何應用程式、專案或標準使用擴充都不背負任何污名（stigma）。使用擴充是允許FHIR規範為每個人保留一個核心的簡易性。
6. Coding.system
Definition	定義代碼中符號意義的代碼系統識別
Short	專門術語系統（terminology system）的識別
Comments	URI可以是一個OID（urn:oid:...）或一個UUID（urn:uuid:...）；OID和UUID 必須（SHALL）參照HL7 OID註冊中心；否則，URI應該來自HL7的FHIR定義的特殊URI列表，或者它應該參照一些明確建立的系统定義。
Must Support	true
Requirements	需要明確說明符號定義的來源
8. Coding.version
Definition	選擇此代碼時使用的代碼系統版本；請注意，一個維護良好的代碼系統不需要版本報告，因為代碼的意義在不同系統版本中是一致的；然而，不能始終保證這點，當不能保證意義一致時，必須（SHALL）將版本資訊也一併作交換。
Short	系統的版本—如果相關的話
Comments	如果專門術語沒有明確定義應該使用什麼字串來識別代碼系統的版本，建議使用版本正式發布的日期（用FHIR日期格式表示）作為版本日期。
Note	This is a business version Id, not a resource version Id (see discussion)
10. Coding.code
Definition	系統定義的語法之符號；符號可能是一個預先定義的代碼，也可能是代碼系統定義的語法中的表達式（如後組合配對／後組合式）。
Short	系統定義的語法之符號
Must Support	true
Requirements	需要參照系統中的一個特定代碼
12. Coding.display
Definition	遵循系統的規則以呈現代碼含義的表示法
Short	由系統定義的表示法
Must Support	true
Requirements	需要能為不了解此系統的讀者呈現可讀的代碼含義
14. Coding.userSelected
Definition	表明此編碼是由使用者直接選擇，例如：從可用項目（代碼或顯示名稱）的清單中選擇。
Short	此編碼是否由使用者直接選擇？
Comments	在一系列備選方案中，直接選擇的代碼是新翻譯最合適的起點；關於「直接選擇」的確切意義，存在模糊不清之處，可能需要貿易夥伴的同意，以更完整澄清此資料項目的使用及其後果。
Requirements	已被確定為一個臨床安全準則—此確切的系統／代碼對(code pair)是被明確選擇的，而不是由系統根據一些規則或是程式語言處理判斷。

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

0. Coding
Definition	由專門術語系統（terminology system）所定義之代碼的參照 A reference to a code defined by a terminology system.
Short	由專門術語系統（terminology system）定義的代碼A reference to a code defined by a terminology system
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.
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Coding.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.
Short	唯一可識別ID，以供資料項目間相互參照。Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Coding.extension
Definition	可用於表示不屬於此資料項目基本定義的附加資訊。為了擴充的使用安全和可管理，對擴充的定義和使用有一套嚴格的管理。儘管任何實作者都可以定義一個擴充，但作為擴充定義的一部分，有一套要求必須（SHALL）滿足。 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.
Short	擴充的資料項目Additional content defined by implementations
Comments	無論使用或定義擴充的機構或管轄區，任何應用程式、專案或標準使用擴充都不背負任何污名（stigma）。使用擴充是允許FHIR規範為每個人保留一個核心的簡易性。 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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	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())
Slicing	This element introduces a set of slices on `Coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Coding.system
Definition	定義代碼中符號意義的代碼系統識別 The identification of the code system that defines the meaning of the symbol in the code.
Short	專門術語系統（terminology system）的識別Identity of the terminology system
Comments	URI可以是一個OID（urn:oid:...）或一個UUID（urn:uuid:...）；OID和UUID 必須（SHALL）參照HL7 OID註冊中心；否則，URI應該來自HL7的FHIR定義的特殊URI列表，或者它應該參照一些明確建立的系统定義。 The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Control	0..1
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Requirements	需要明確說明符號定義的來源 Need to be unambiguous about the source of the definition of the symbol.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Coding.version
Definition	選擇此代碼時使用的代碼系統版本；請注意，一個維護良好的代碼系統不需要版本報告，因為代碼的意義在不同系統版本中是一致的；然而，不能始終保證這點，當不能保證意義一致時，必須（SHALL）將版本資訊也一併作交換。 The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short	系統的版本—如果相關的話Version of the system - if relevant
Comments	如果專門術語沒有明確定義應該使用什麼字串來識別代碼系統的版本，建議使用版本正式發布的日期（用FHIR日期格式表示）作為版本日期。 Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note	This is a business version Id, not a resource version Id (see discussion)
Control	0..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Coding.code
Definition	系統定義的語法之符號；符號可能是一個預先定義的代碼，也可能是代碼系統定義的語法中的表達式（如後組合配對／後組合式）。 A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short	系統定義的語法之符號Symbol in syntax defined by the system
Control	0..1
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Requirements	需要參照系統中的一個特定代碼 Need to refer to a particular code in the system.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Coding.display
Definition	遵循系統的規則以呈現代碼含義的表示法 A representation of the meaning of the code in the system, following the rules of the system.
Short	由系統定義的表示法Representation defined by the system
Control	0..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Requirements	需要能為不了解此系統的讀者呈現可讀的代碼含義 Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Coding.userSelected
Definition	表明此編碼是由使用者直接選擇，例如：從可用項目（代碼或顯示名稱）的清單中選擇。 Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short	此編碼是否由使用者直接選擇？If this coding was chosen directly by the user
Comments	在一系列備選方案中，直接選擇的代碼是新翻譯最合適的起點；關於「直接選擇」的確切意義，存在模糊不清之處，可能需要貿易夥伴的同意，以更完整澄清此資料項目的使用及其後果。 Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control	0..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	已被確定為一個臨床安全準則—此確切的系統／代碼對(code pair)是被明確選擇的，而不是由系統根據一些規則或是程式語言處理判斷。 This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Invariants	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

0. Coding
Definition	由專門術語系統（terminology system）所定義之代碼的參照
Short	由專門術語系統（terminology system）定義的代碼
Comments	代碼可以在列舉清單（enumerations）或代碼清單（code lists）中非常隨意地定義，直至有非常正式的定義，例如：SNOMED CT—更多資訊見HL7 v3核心原則（Core Principles ）。編碼的排序是未定義的因而必須沒有（SHALL NOT）被用來推斷意義。一般來說，最多只有一個編碼值（coding values）會被標記為UserSelected = true。
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. Coding.id
Definition	resource中資料項目的唯一ID（用於內部參照），這可以是任何不含空格的字串。
Short	唯一可識別ID，以供資料項目間相互參照。
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Coding.extension
Definition	可用於表示不屬於此資料項目基本定義的附加資訊。為了擴充的使用安全和可管理，對擴充的定義和使用有一套嚴格的管理。儘管任何實作者都可以定義一個擴充，但作為擴充定義的一部分，有一套要求必須（SHALL）滿足。
Short	擴充的資料項目
Comments	無論使用或定義擴充的機構或管轄區，任何應用程式、專案或標準使用擴充都不背負任何污名（stigma）。使用擴充是允許FHIR規範為每個人保留一個核心的簡易性。
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	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()`)
Slicing	This element introduces a set of slices on `Coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Coding.system
Definition	定義代碼中符號意義的代碼系統識別
Short	專門術語系統（terminology system）的識別
Comments	URI可以是一個OID（urn:oid:...）或一個UUID（urn:uuid:...）；OID和UUID 必須（SHALL）參照HL7 OID註冊中心；否則，URI應該來自HL7的FHIR定義的特殊URI列表，或者它應該參照一些明確建立的系统定義。
Control	0..1
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Requirements	需要明確說明符號定義的來源
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Coding.version
Definition	選擇此代碼時使用的代碼系統版本；請注意，一個維護良好的代碼系統不需要版本報告，因為代碼的意義在不同系統版本中是一致的；然而，不能始終保證這點，當不能保證意義一致時，必須（SHALL）將版本資訊也一併作交換。
Short	系統的版本—如果相關的話
Comments	如果專門術語沒有明確定義應該使用什麼字串來識別代碼系統的版本，建議使用版本正式發布的日期（用FHIR日期格式表示）作為版本日期。
Note	This is a business version Id, not a resource version Id (see discussion)
Control	0..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Coding.code
Definition	系統定義的語法之符號；符號可能是一個預先定義的代碼，也可能是代碼系統定義的語法中的表達式（如後組合配對／後組合式）。
Short	系統定義的語法之符號
Control	0..1
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Requirements	需要參照系統中的一個特定代碼
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Coding.display
Definition	遵循系統的規則以呈現代碼含義的表示法
Short	由系統定義的表示法
Control	0..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
Summary	true
Requirements	需要能為不了解此系統的讀者呈現可讀的代碼含義
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. Coding.userSelected
Definition	表明此編碼是由使用者直接選擇，例如：從可用項目（代碼或顯示名稱）的清單中選擇。
Short	此編碼是否由使用者直接選擇？
Comments	在一系列備選方案中，直接選擇的代碼是新翻譯最合適的起點；關於「直接選擇」的確切意義，存在模糊不清之處，可能需要貿易夥伴的同意，以更完整澄清此資料項目的使用及其後果。
Control	0..1
Type	boolean
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	已被確定為一個臨床安全準則—此確切的系統／代碼對(code pair)是被明確選擇的，而不是由系統根據一些規則或是程式語言處理判斷。
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)