臺灣核心實作指引(TW Core IG)
0.3.2 - Ci-Build Trial Use
臺灣核心實作指引(TW Core IG)
0.3.2 - Ci-Build Trial Use
臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.2 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
| Official URL: https://twcore.mohw.gov.tw/ig/twcore/ImplementationGuide/tw.gov.mohw.twcore | Version: 0.3.2 | |||
| Active as of 2024-12-20 | Computable Name: TWCore | |||
臺灣核心實作指引（Taiwan Core Implementation Guide，簡稱TW core IG）採用HL7® FHIR® standard（Fast Healthcare Interoperability Resources）IG建置方法，在FHIR R4.0.1之標準基礎上，參考了國際病人摘要（International Patient Summary，IPS）1.1.0-CI Build及美國核心實作指引（US Core Implementation Guide），進一步定義適用於臺灣健康照護資料交換需求的Resources（類似資料表）、其中的資料項目（意即欄位）、基數（意即0..1、0..*、1..1或1..*）、資料類型（文字、日期時間、代碼等）、可綁定的代碼（及其綁定的強制程度）及查詢參數等，旨在提供健康照護資訊系統開發與實作者以TW Core IG為基礎，再進一步訂定其實務專案所需之資料交換格式以應用於專案中。TW Core IG的實作方式有兩種：
TW Core IG由衛生福利部(以下簡稱衛福部)資訊處2022年3月招標之「111年度智慧健康雲專案辦公室營運案專案」經費支應下建置，TW Core IG註冊於國際平臺及衛生福利部資訊處之IG管理平臺以供查找與參考。
鑑於TW Core IG設計之初，FHIR R5處於投票階段、國際應用多採用 R4 、以及R5相關配套工具尚未成熟，故TW Core IG的設計主要以FHIR R4.0.1 為基礎，並同時參考其他國家作法以規劃TW Core IG 網站。為使制訂之IG符合臺灣的實作需求，TW Core IG 內容將在未來的版本中持續更新，各版本亦將附有版本異動說明。
衛福部資訊處的長期任務：
關於實務專案型FHIR IG是否需要繼承最新版本TW Core IG或者要等TW Core IG持續建置版本 (CI-build) 正式定版後作繼承？通常，各專案可依據各自專案的需求決定，但 IG 設計師需審慎評估，以決定是否繼承最新版TW Core IG：
(1) 須留意TW Core IG的CI-build版本是否影響專案資料欄位或值集範圍設計，建議可預先在設計階段納入CI-build的設計概念及內容，待CI-Build發布新版時可直接繼承，以減少更新繼承對規格設計造成影響、
(2) 須評估專案型IG是否需要申請註冊於衛生福利部資訊處 IG 管理平臺以供各界參閱以及讓您的專案IG出現於國際HL7提供的線上免費驗證工具 (https://validator.fhir.org/) 中的IG驗證清單中，增加驗證的方便性。若要申請註冊且無特殊理由下，則建議使用審查期間最新版之TW Core IG版本。
不論如何，基於全國健康照護資料標準化及促進資料可互通，「強力建議」實務專案型IG 繼承最新版TW Core IG，以確保您的IG規格與全國一致，亦可避免後續人工檢核專案IG與TW Core IG是否一致之工作量。
2024年5月起依據衛生福利部資訊處電子病歷標準發展工作小組決議，預計每年正式更版一至二次，由於資料標準化是一個持續演進的過程，TW Core IG 亦會持續接受各界意見並評估適用性後放修改於TW Core IG持續建置版本 (CI-build) ，經確認後才會更新為正式版本，需請 IG 設計師 留意此一異動對您所設計IG之影響。
DRAFT 0 此Resource或Profile（規範文件） 已被發佈於目前的建置，這個等級意即草稿。
FMM 1 滿足DRAFT 0條件，而且此規範文件在建置的過程沒有任何的警語，負責的工作小組已指明他們認為這份規範文件基本上已完成並可供實作使用。
FMM 2 滿足FMM 1條件，而且此規範文件已被測試，並成功支援至少三套獨立系統之間的可互操作性（意即至少有三套系統實作此規範成功地互通資料），這些系統利用大部分的規範文件（例如至少80%的核心資料），使用基於此規範文件的至少一個聲明範圍的半真實資料及情境（例如在聯測）。這些互操作結果要求被報告及被工作小組接受。
FMM 3 滿足FMM 2條件，而且此規範文件已被工作小组驗證應遵從的《Conformance Resource Quality Guidelines》；已經通過一輪正式投票；至少有10位來自至少3家機構不同的實作者提出意見，並造成至少一項實質性的改變。
FMM 4 滿足FMM 3條件，而且此規範文件已正式出版（例如：FHIR IG v1.0.0），並已實際應用於多個雛型專案。同時，負責的工作小組同意此規範文件足夠穩定，在後續的非向下相容（non-backward compatible）的異動中需與實作者協商與諮詢。
FMM 5 滿足FMM 4條件，而且此規範文件於在FMM 1以上等級（意即：試用等級）的兩個正式出版品發佈週期中出版，並已實際應用於至少五套獨立的產品系統。
Normative（規範） 此規範文件已被認定為穩定，不再作修改。
本版本TW Core IG 中所有Profiles的FMM等級如下：
| 成熟度 | TW Core Profiles名稱 | 數量 |
|---|---|---|
| FMM1 | BundleDocument、CarePlan、CareTeam、Coverage、ImplantableDevice、Goal、Immunization、MedicationStatement、ObservationAverageBloodPressure、ObservationCareExperiencePreference、ObservationClinicalResult、ObservationOccupation、ObservationPregnancyIntent、ObservationPregnancyStatus、ObservationScreeningAssessment、ObservationSexualOrientation、ObservationSimple、ObservationSmokingStatus、ObservationBloodPressure、ObservationBMI、ObservationTreatmentInterventionPrference、ObservationPediatricBMIforAge、ObservationPediatricWeightforHeight、ObservationBodyTemperature、ObservationBodyWeight、ObservationHeadCircumference、ObservationHeartRate、ObservationPulseOximetry、ObservationRespiratoryRate、ObservationPediatricHeadOccipitalFrontalCircumferencePercentile、OrganizationGovt、OrganizationHosp、OrganizationCo、PractitionerRole、Procedure、Provenance、QuestionnaireResponse、RelatedPerson、ServiceRequest、Specimen | 40 |
| FMM2 | AllergyIntolerance、BundleMessage、DocumentReference、ImagingStudy、Location、MedicationDispense | 6 |
| FMM3 | Bundle、Composition、Condition、DiagnosticReport、Encounter、Media、Medication、MedicationRequest、ObservationLaboratoryResult、ObservationVitalSigns、Organization、Patient、Practitioner、Specimen、CodingTW、CodeableConceptTW、AddressTW | 17 |
TW Core IG之網站架構圖如下圖所示。各功能說明如下：
| 英文名 | 中文名 | 說明 |
|---|---|---|
| Name | 名稱 | resource的資料項目名稱（意即XML元素名稱；JSON或RDF屬性名稱）。有些名稱末端為[x]，圖示為![multipleBirth[x]範例](icon_choice.gif){kind=icon} ，意即可以選擇適用的資料類型表述該資料項目內容值,故需依據資料類型填入適當的內容值，例如Patient.multipleBirth[x]。![multipleBirth[x]範例](index/multipleX.png)
如果系統只知病人是否多胞胎，則資料項目名稱為multipleBirthBoolean，內容值為「true」；如果系統中有病人多胞胎之出生順序為第2序位，則資料項目名稱為multipleBirthInteger，內容值為「2」。更多符號說明，請參閱FHIR官網相關說明。 |
| Flags | 標記 | 一組有關影響實作者如何操作資料項目的資訊，範例如下。 |
 |
必須支援（MustSupport），表示用戶端（Client）所傳送之資料項目，伺服端（Server）必須有能力接收並儲存此資料項目。繼承使用時可再依據專案需求，對MS做出延伸定義，但必須於應用說明說明其延伸定義的具體說明。詳可參閱MustSupport。 | |
 |
表示此資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。詳可參閱Modifier。 | |
 |
表示此資料項目為摘要的一部分，詳可參閱Summary searches。 | |
 |
表示此資料項目受規範設定的限制（constraints）影響，例如：Patient.name的限制為「name.text（完整中文姓名）」或name.family（英文姓）或者兩者必須填寫」，詳可參閱Constraints。
 |
|
| Card. | 基數 | 此資料項目允許出現在這個resource的最小至最大次數，意即例如某一資料項目的基數若為0..1，表示可不填寫或至多填入1筆；若為1..1，表示必須（只能）填入1筆；若為0..*，表示可不填寫或填入多筆（不限筆數）；若為1..*，表示至少要填入1筆或填入多筆（不限筆數）。 |
| Type | 資料類型 | 資料項目的資料類型（可超連結至該型別的定義），例如：boolean、integer、dateTime等。 |
| Description &Constraints | 描述與限制 | 此資料項目的描述及詳細的限制。尤其編碼的資料項目可使用何種代碼填寫，如果有特定需要綁定的代碼，則會以Binding陳述。 |
| 英文名 | 中文名 | 說明 |
|---|---|---|
| Required | 要求使用 | 應填入值集中的其中一個代碼 |
| Extensible | 可擴充 | 應填入值集中適合的代碼，確定無適合的代碼才可以使用其他值集的代碼來表示。 |
| Preferred | 鼓勵使用 | 鼓勵使用值集中的代碼，但不強制一定要使用此值集，你也可使用其他值集的代碼或單純以文字表示。 |
| Example | 範例 | 可參考值集，但此值集只是針對這個欄位的一個可能值的範例，不預期也不鼓勵使用者一定要使用此值集的代碼。 |
FHIR使用RFC 2119中定義的遵從度動詞必須（SHALL）、建議應該（SHOULD）和可能可以（MAY）。而FHIR與RFC 2119不同的是，FHIR允許不同的應用程式因使用可選功能的方式而無法達到可互操作性，特別是：
1. 必須（SHALL）：所有實作絕對要遵從要求。
2. 必須沒有（SHALL NOT）：所有實作絕對禁止的要求。
3. 建議應該（SHOULD）/建議不應該（SHOULD NOT）：實作者在特定實作的情境下考慮的最佳或建議實作方法；雖然忽略一個項目可能有正當理由，但在選擇不同的程序之前，必須了解並慎重衡量所有含義。
4. 可能可以（MAY）：這是實作者真正可選的要求；可根據實作者的決定使用或不使用，不會造成任何影響。
（資料來源：Versions - FHIR v4.3.0 （hl7.org））
FHIR的新版本的發佈週期約為18-24個月，此頻率主要基於需向實作者諮詢、開發和審查新內容、以及ANSI批准的標準所需的正式投票和核對過程所需的時間，這個發佈週期也確保了有機會將實作者對標準規範早期版本的回饋意見納入後續版本，在滿足實作者需求的情況下，偶爾也會出現時間較短的有限範圍的發佈。
每個新版本都有一個獨特的版本號。FHIR的版本政策是基於Semantic versioning（或可閱讀下表精簡整理），但由於FHIR是一個標準規範，而不是一個軟體API，因此有一些區別。
| Major | 當你對API進行不相容的修改時 |
| Minor | 當你以向下相容的方式增加功能時 |
| Patch | 你進行向下相容的錯誤修復時 |
FHIR有單一的開發版本，它經由HL7管理的開發週期，每個主要的開發週期都透過正式投票（或不止一次）後才發佈新的標準規範。從版本控管的角度來看，每份發佈的標準規範都是開發主幹的一個分支，然後隨著HL7對發佈的標準規範的維護，其本身可能會發生進一步的改變（儘管這種改變通常是最小的，僅限於必要的技術修正或安全警示）。
每個FHIR版本由4個部分組成的字串來識別：major.minor.patch-label。 IG的實作亦遵循此規則，其中的major異動將由「電子病歷交換標準工作小組」決定，minor及patch可由相關工作小組討論後作調整：
| 版本 | 定義 | 可能時機 |
|---|---|---|
| major | 當HL7將FHIR作為一個重要的新規格版本發佈時，如FHIR試用版（Trial Use）或標準規範版（Normative），就會增加此序號。 | |
| ● 第1次的試用版（Trial Use）是第0版 | 以0.1.0開始進行版本控管 | |
| ● 第2次發行（DSTU）是第1版 | 當所有profiles為FMM2時 | |
| ● 第3次發行（STU）是第3版（依據實作者要求以統一major序號故跳過「2」） | 當所有profiles為FMM3時 | |
| ● 第4次發行（Normative + STU）是第4版 | 當所有profiles為FMM4時 | |
| ● 第5次發行（STU）是第5版 | 當所有profiles為FMM5時 | |
| minor | 包括微小實質改變的修改（可能包括有限的破壞性改變） | 在既有版本上，新增StructureDefinition內容時 |
| ● 只要有新版本（major）發佈，minor就重置為0，而在開發分支中為1。 | ||
| ● HL7不會對已發佈的版本進行重大改變（技術性修正），所以這些版本總是有一個版本號X.n.0。 | ||
| ● 開發中的版本是持續分析、辯論、投票和反復修改，因此可預期STU內容可能會有改變。 FHIR第4B版（僅STU改變）為4.3.0版本。 | ||
| patch | 表示更新，包括對先前版本的技術性修正 | 針對既有版本的StructureDefinition作修改及刪除時 |
| ● 只要minor版本改變，patch就會被重置為0例如：4.0.1代表對4.0.0版本的第一次技術性修正 。 | ||
| label | 版本末端有一個標籤，代表一個正在建立的標準規範的 「工作 」版本，並正在建立到指定的發行版本；例如，5.0.0-ballot1、5.0.0-snapshot2等。 | 目前仍持續在修訂與新增TW Core IG內容，故label為cibuild。 |
| ● 標籤前端的序號表示在投票、審查結束後的「預期」版本序號。 | ||
| ● label可以是任何字串，然而典型的標籤是： | ||
| ○ 「snapshotN」：由於聯測（connectathon）、投票相依性或其他原因，標準規範的凍結版本。 | ||
| ○ 「ballotN」：在投票過程中使用的凍結版本。 | ||
| ○ 「draftN」：指的是一個為非投票審查或者為了品質保證（QA）目的發佈的凍結版本。 | ||
| ○ 「ci-build」：一個 「特殊」的版本標籤，指的是一個非穩定的版本，隨著每次提交而改變。 | ||
| ○ 「qa-preview」：用於非投票反饋的凍結快照。 | ||
| ○ 「trial-use」：具有「試用」狀態的正式發佈。 | ||
| ○ 「release」：正式發佈版本。 | ||
| ○ 「update」：具有試用狀態且未經投票的 STU 更新。 | ||
| ○ 「normative+trial-use」：同時包含試用與正式內容的混合發佈。 |
| 角色 | 貢獻版次 | 機構名稱 | 姓名 | 所屬單位 | 聯絡方式 |
|---|---|---|---|---|---|
| 作者 | v0.1.1、v0.2.0、v0.2.1、v0.2.2、v0.3.0、v0.3.1、v0.3.2 | 衛生福利部資訊處 | 李麗惠（Li-Hui Lee） | 國立臺北護理健康大學－健康事業管理系 （Department of Health Care Management, National Taipei University of Nursing and Health Sciences） |
cclhlee@gmail.com
cclhlee@ntunhs.edu.tw |
| 作者 | v0.1.1、v0.2.0、v0.2.1、v0.2.2、v0.3.0、v0.3.1、v0.3.2 | 曾鈺珈（Yu-Jia Tseng） | yujia151645@gmail.com | ||
| 作者 | v0.1.1、v0.2.0 | 林伃瑤（Yu-Yao Lin） |
a28485251@gmail.com
082114224@ntunhs.edu.tw |
||
| 作者 | v0.2.0、v0.2.1、v0.2.2、v0.3.0、v0.3.1、v0.3.2 | 李奇安（Chi-An Lee） | ec460520@gmail.com | ||
| 貢獻者 | v0.1.1 | 歐陽渝（Yang-Yu Ou） | ouyangyu0326@gmail.com | ||
| 貢獻者 | v0.1.1、v0.2.0 | 連中岳（Chung-Yueh Lien） | 國立臺北護理健康大學－資訊管理系 （Department of Information Management, National Taipei University of Nursing and Health Sciences） |
chungyueh@ntunhs.edu.tw | |
| 貢獻者 | v0.1.1 | 徐建業（Chien-Yeh Hsu） | cyhsu@ntunhs.edu.tw | ||
| 貢獻者 | v0.1.1 | 陳欣怡（Hsin-Yi Chen） | c86976@gmail.com | ||
| 貢獻者 | v0.1.1 | 郭俐君（Li-Chun Kuo） | lily220487@gmail.com | ||
| 貢獻者 | v0.1.1 | 丁子芸（Tzu-Yun Ting） | aewqoo832456@gmail.com | ||
| 貢獻者 | v0.2.0 | 陳杏宜（Hsin-Yi Chen） | bii901231@gmail.com | ||
| 貢獻者 | v0.2.0 | 蔡姍紜（Shan-Yun Tsai） | appletsai319@gmail.com | ||
| 貢獻者 | v0.2.0 | 黃睿駿（Hrui-Jun Huang） | a27114171@gmail.com | ||
| 貢獻者 | v0.1.1 | 李祥豪（Siang-Hao Lee） | 康統醫學科技股份有限公司（KENKONE） | shvoidlee@gmail.com | |
| 貢獻者 | v0.1.1、v0.2.0 | 李修安（Hsiu-An Lee） | 國家衛生研究院 - 癌症研究所 （National Health Research Institutes - The National Institute of Cancer Research） |
billy72325@gmail.com | |
| 貢獻者 | v0.2.0 | 劉貞沂（Zhen-Yi Liu） | 國家衛生研究院 - 癌症研究所 （National Health Research Institutes - The National Institute of Cancer Research） |
ceo@sita.tech | |
| 貢獻者 | v0.2.0 | 燕洛嫺（Luo-Xian Yan） | 社團法人台灣醫學資訊學會 （Taiwan Association for Medical Information） |
ceo@sita.tech | |
| 貢獻者 | v0.1.1 | 楊宇凡（Lorex L. Yang） | 矽塔資訊服務有限公司（Sitatech） | ceo@sita.tech |