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

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.1.1: 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: CodingTW - JSON Profile

Active as of 2023-08-30

JSON representation of the Coding-tw data type profile.

Raw json | Download


{
  "resourceType" : "StructureDefinition",
  "id" : "Coding-tw",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Placeholder</div>"
  },
  "url" : "https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Coding-tw",
  "version" : "0.1.1",
  "name" : "CodingTW",
  "title" : "TW Coding",
  "status" : "active",
  "date" : "2023-08-30T12:27:08+08:00",
  "contact" : [
    {
      "name" : "衛生福利部",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.mohw.gov.tw/"
        },
        {
          "system" : "email",
          "value" : "CCYU@mohw.gov.tw"
        }
      ]
    }
  ],
  "description" : "此臺灣Coding Profile說明本IG如何進一步定義FHIR的Coding資料類型以呈現Coding  [[*FMM1*](http://build.fhir.org/versions.html#maturity)]",
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "v2",
      "uri" : "http://hl7.org/v2",
      "name" : "HL7 v2 Mapping"
    },
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    },
    {
      "identity" : "orim",
      "uri" : "http://hl7.org/orim",
      "name" : "Ontological RIM Mapping"
    }
  ],
  "kind" : "complex-type",
  "abstract" : false,
  "type" : "Coding",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Coding",
  "derivation" : "constraint",
  "snapshot" : {
    "element" : [
      {
        "id" : "Coding",
        "path" : "Coding",
        "short" : "由專門術語系統(terminology system)定義的代碼",
        "definition" : "由專門術語系統(terminology system)所定義之代碼的參照",
        "comment" : "代碼可以在列舉清單(enumerations)或代碼清單(code lists)中非常隨意地定義,直至有非常正式的定義,例如:SNOMED CT—更多資訊見HL7 v3核心原則(Core Principles )。編碼的排序是未定義的因而 **必須沒有(SHALL NOT)** 被用來推斷意義。一般來說,最多只有一個編碼值(coding values)會被標記為UserSelected = true。",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Coding",
          "min" : 0,
          "max" : "*"
        },
        "condition" : [
          "ele-1"
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          },
          {
            "identity" : "v2",
            "map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
          },
          {
            "identity" : "rim",
            "map" : "CV"
          },
          {
            "identity" : "orim",
            "map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
          }
        ]
      },
      {
        "id" : "Coding.id",
        "path" : "Coding.id",
        "representation" : [
          "xmlAttr"
        ],
        "short" : "唯一可識別ID,以供資料項目間相互參照。",
        "definition" : "resource中資料項目的唯一ID(用於內部參照),這可以是任何不含空格的字串。",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Element.id",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl" : "string"
              }
            ],
            "code" : "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier" : false,
        "isSummary" : false,
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        ]
      },
      {
        "id" : "Coding.extension",
        "path" : "Coding.extension",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "url"
            }
          ],
          "description" : "Extensions are always sliced by (at least) url",
          "rules" : "open"
        },
        "short" : "擴充的資料項目",
        "definition" : "可用於表示不屬於此資料項目基本定義的附加資訊。為了擴充的使用安全和可管理,對擴充的定義和使用有一套嚴格的管理。儘管任何實作者都可以定義一個擴充,但作為擴充定義的一部分,有一套要求 **必須(SHALL)** 滿足。",
        "comment" : "無論使用或定義擴充的機構或管轄區,任何應用程式、專案或標準使用擴充都不背負任何污名(stigma)。使用擴充是允許FHIR規範為每個人保留一個核心的簡易性。",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Element.extension",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Extension"
          }
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key" : "ext-1",
            "severity" : "error",
            "human" : "Must have either extensions or value[x], not both",
            "expression" : "extension.exists() != value.exists()",
            "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "Coding.system",
        "path" : "Coding.system",
        "short" : "專門術語系統(terminology system)的識別",
        "definition" : "定義代碼中符號意義的代碼系統識別",
        "comment" : "URI可以是一個OID(urn:oid:...)或一個UUID(urn:uuid:...);OID和UUID **必須(SHALL)** 參照HL7 OID註冊中心;否則,URI應該來自HL7的FHIR定義的特殊URI列表,或者它應該參照一些明確建立的系统定義。",
        "requirements" : "需要明確說明符號定義的來源",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Coding.system",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport" : true,
        "isModifier" : false,
        "isSummary" : true,
        "mapping" : [
          {
            "identity" : "v2",
            "map" : "C*E.3"
          },
          {
            "identity" : "rim",
            "map" : "./codeSystem"
          },
          {
            "identity" : "orim",
            "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
          }
        ]
      },
      {
        "id" : "Coding.version",
        "path" : "Coding.version",
        "short" : "系統的版本—如果相關的話",
        "definition" : "選擇此代碼時使用的代碼系統版本;請注意,一個維護良好的代碼系統不需要版本報告,因為代碼的意義在不同系統版本中是一致的;然而,不能始終保證這點,當不能保證意義一致時, **必須(SHALL)** 將版本資訊也一併作交換。",
        "comment" : "如果專門術語沒有明確定義應該使用什麼字串來識別代碼系統的版本,建議使用版本正式發布的日期(用FHIR日期格式表示)作為版本日期。",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Coding.version",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier" : false,
        "isSummary" : true,
        "mapping" : [
          {
            "identity" : "v2",
            "map" : "C*E.7"
          },
          {
            "identity" : "rim",
            "map" : "./codeSystemVersion"
          },
          {
            "identity" : "orim",
            "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
          }
        ]
      },
      {
        "id" : "Coding.code",
        "path" : "Coding.code",
        "short" : "系統定義的語法之符號",
        "definition" : "系統定義的語法之符號;符號可能是一個預先定義的代碼,也可能是代碼系統定義的語法中的表達式(如後組合配對/後組合式)。",
        "requirements" : "需要參照系統中的一個特定代碼",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Coding.code",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport" : true,
        "isModifier" : false,
        "isSummary" : true,
        "mapping" : [
          {
            "identity" : "v2",
            "map" : "C*E.1"
          },
          {
            "identity" : "rim",
            "map" : "./code"
          },
          {
            "identity" : "orim",
            "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
          }
        ]
      },
      {
        "id" : "Coding.display",
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean" : true
          }
        ],
        "path" : "Coding.display",
        "short" : "由系統定義的表示法",
        "definition" : "遵循系統的規則以呈現代碼含義的表示法",
        "requirements" : "需要能為不了解此系統的讀者呈現可讀的代碼含義",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Coding.display",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport" : true,
        "isModifier" : false,
        "isSummary" : true,
        "mapping" : [
          {
            "identity" : "v2",
            "map" : "C*E.2 - but note this is not well followed"
          },
          {
            "identity" : "rim",
            "map" : "CV.displayName"
          },
          {
            "identity" : "orim",
            "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
          }
        ]
      },
      {
        "id" : "Coding.userSelected",
        "path" : "Coding.userSelected",
        "short" : "此編碼是否由使用者直接選擇?",
        "definition" : "表明此編碼是由使用者直接選擇,例如:從可用項目(代碼或顯示名稱)的清單中選擇。",
        "comment" : "在一系列備選方案中,直接選擇的代碼是新翻譯最合適的起點;關於「直接選擇」的確切意義,存在模糊不清之處,可能需要貿易夥伴的同意,以更完整澄清此資料項目的使用及其後果。",
        "requirements" : "已被確定為一個臨床安全準則—此確切的系統/代碼對(code pair)是被明確選擇的,而不是由系統根據一些規則或是程式語言處理判斷。",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Coding.userSelected",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean"
          }
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "hasValue() or (children().count() > id.count())",
            "xpath" : "@value|f:*|h:div",
            "source" : "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier" : false,
        "isSummary" : true,
        "mapping" : [
          {
            "identity" : "v2",
            "map" : "Sometimes implied by being first"
          },
          {
            "identity" : "rim",
            "map" : "CD.codingRationale"
          },
          {
            "identity" : "orim",
            "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map;   fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [     fhir:source \"true\";     fhir:target dt:CDCoding.codingRationale\\#O   ]"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "Coding",
        "path" : "Coding",
        "short" : "由專門術語系統(terminology system)定義的代碼",
        "definition" : "由專門術語系統(terminology system)所定義之代碼的參照",
        "comment" : "代碼可以在列舉清單(enumerations)或代碼清單(code lists)中非常隨意地定義,直至有非常正式的定義,例如:SNOMED CT—更多資訊見HL7 v3核心原則(Core Principles )。編碼的排序是未定義的因而 **必須沒有(SHALL NOT)** 被用來推斷意義。一般來說,最多只有一個編碼值(coding values)會被標記為UserSelected = true。"
      },
      {
        "id" : "Coding.id",
        "path" : "Coding.id",
        "short" : "唯一可識別ID,以供資料項目間相互參照。",
        "definition" : "resource中資料項目的唯一ID(用於內部參照),這可以是任何不含空格的字串。"
      },
      {
        "id" : "Coding.extension",
        "path" : "Coding.extension",
        "short" : "擴充的資料項目",
        "definition" : "可用於表示不屬於此資料項目基本定義的附加資訊。為了擴充的使用安全和可管理,對擴充的定義和使用有一套嚴格的管理。儘管任何實作者都可以定義一個擴充,但作為擴充定義的一部分,有一套要求 **必須(SHALL)** 滿足。",
        "comment" : "無論使用或定義擴充的機構或管轄區,任何應用程式、專案或標準使用擴充都不背負任何污名(stigma)。使用擴充是允許FHIR規範為每個人保留一個核心的簡易性。"
      },
      {
        "id" : "Coding.system",
        "path" : "Coding.system",
        "short" : "專門術語系統(terminology system)的識別",
        "definition" : "定義代碼中符號意義的代碼系統識別",
        "comment" : "URI可以是一個OID(urn:oid:...)或一個UUID(urn:uuid:...);OID和UUID **必須(SHALL)** 參照HL7 OID註冊中心;否則,URI應該來自HL7的FHIR定義的特殊URI列表,或者它應該參照一些明確建立的系统定義。",
        "requirements" : "需要明確說明符號定義的來源",
        "mustSupport" : true
      },
      {
        "id" : "Coding.version",
        "path" : "Coding.version",
        "short" : "系統的版本—如果相關的話",
        "definition" : "選擇此代碼時使用的代碼系統版本;請注意,一個維護良好的代碼系統不需要版本報告,因為代碼的意義在不同系統版本中是一致的;然而,不能始終保證這點,當不能保證意義一致時, **必須(SHALL)** 將版本資訊也一併作交換。",
        "comment" : "如果專門術語沒有明確定義應該使用什麼字串來識別代碼系統的版本,建議使用版本正式發布的日期(用FHIR日期格式表示)作為版本日期。"
      },
      {
        "id" : "Coding.code",
        "path" : "Coding.code",
        "short" : "系統定義的語法之符號",
        "definition" : "系統定義的語法之符號;符號可能是一個預先定義的代碼,也可能是代碼系統定義的語法中的表達式(如後組合配對/後組合式)。",
        "requirements" : "需要參照系統中的一個特定代碼",
        "mustSupport" : true
      },
      {
        "id" : "Coding.display",
        "path" : "Coding.display",
        "short" : "由系統定義的表示法",
        "definition" : "遵循系統的規則以呈現代碼含義的表示法",
        "requirements" : "需要能為不了解此系統的讀者呈現可讀的代碼含義",
        "mustSupport" : true
      },
      {
        "id" : "Coding.userSelected",
        "path" : "Coding.userSelected",
        "short" : "此編碼是否由使用者直接選擇?",
        "definition" : "表明此編碼是由使用者直接選擇,例如:從可用項目(代碼或顯示名稱)的清單中選擇。",
        "comment" : "在一系列備選方案中,直接選擇的代碼是新翻譯最合適的起點;關於「直接選擇」的確切意義,存在模糊不清之處,可能需要貿易夥伴的同意,以更完整澄清此資料項目的使用及其後果。",
        "requirements" : "已被確定為一個臨床安全準則—此確切的系統/代碼對(code pair)是被明確選擇的,而不是由系統根據一些規則或是程式語言處理判斷。"
      }
    ]
  }
}