全國性預防接種資訊登錄與上傳實作指引
0.0.1 - ci-build Taiwan, Province of China flag

全國性預防接種資訊登錄與上傳實作指引, published by 衛福部疾病管制署. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hyweb-cdc/niis/ and changes regularly. See the Directory of published versions

應用說明

Official URL: https://twniis.cdc.gov.tw/twniis/ImplementationGuide/tw.gov.mohw.cdc.twniis Version: 0.0.1
Active as of 2026-09-03 Computable Name: TWNIIS

專案介紹

全國性預防接種資訊登錄與上傳實作指引(NIIS IG)採用HL7® FHIR® standard(Fast Healthcare Interoperability Resources)IG建置方法,在FHIR R4.0.1之標準基礎上,繼承TW Core IG V 0.3.2 (2024-12-12),進一步定義適用於「全國性預防接種資訊登錄與上傳實作指引(以下簡稱本專案)」資料需求的Resources(類似資料表)、其中的資料項目(意即欄位)、基數(意即0..1、0..*、1..1或1..*)及資料類型(文字、日期時間、代碼等)等。

專案背景

衛生福利部疾病管制署(Centers for Disease Control,CDC,以下簡稱本署)推動運用API介接作業模式,進行全國預防接種資訊相關資料之自動交換與資料核對修正作業,透過API介接,將全國預防接種資訊登錄與上傳至本署,強化資料除錯管控效能,提升資料正確完整性,降低醫療院所人工作業負擔,完善全國預防接種數位化作業管理及服務品質與效能。

專案範圍

架構圖

全國預防接種資訊之檢驗結果登錄與上傳

IG use case

API作業流程

院所端呼叫 UpldExamRslt 服務,上傳麻疹/德國麻疹或孕婦 B 型肝炎檢驗結果並登錄至 NIIS 系統。

  1. 合約院所呼叫 API: UpldExamRslt,以合約院所上傳檢驗報告(Bundle Request Reporting NIIS)格式,多筆或單筆新增、修改、刪除麻疹/德國麻疹或孕婦 B 型肝炎檢驗結果。
  2. NIIS 系統檢核資料正確性;若檢核通過,回覆 HTTP 200 OK,並以CDC回覆合約院所上傳/修改/刪除(Bundle Response NIIS)格式回覆新增、修改、刪除檢驗結果成功訊息。
  3. NIIS 系統檢核資料正確性;若檢核未通過,回覆 HTTP 400 Bad Request,並以系統回應訊息(OperationOutcome NIIS)格式回覆錯誤訊息。
  4. 合約院所可依照 NIIS 系統回覆訊息進行資料修正。
合約院所 NIIS系統 合約院所NIIS系統1多筆或單筆之新增、修改、刪除檢驗結果(API: UpldExamRslt;格式:Bundle Request Reporting NIIS)alt[情況1:200 OK]2回覆新增、修改、刪除檢驗結果成功訊息(HTTP 200 OK;格式:Bundle Response NIIS)[情況2:400 Bad Request]3回覆新增、修改、刪除檢驗結果失敗訊息(HTTP 400 Bad Request;格式:OperationOutcome NIIS)4異常資料修正


如何閱讀這個實作指引(IG)

NIIS IG之網站架構圖如下圖所示。各功能說明如下:

IG架構圖
  • 應用說明:NIIS IG介紹及背景說明。
  • 視覺化邏輯模型:NIIS IG邏輯模型架構視覺化圖。
  • 規範文件
    • 能力聲明 :應用NIIS IG於建置業務目的使用的FHIR Server時,該FHIR Server必須及建議應該支援的資料存取功能。
    • 邏輯模型 :NIIS IG的所有邏輯模型(Logical Models),邏輯模型會定義相應情境下使用的所有資料欄位。為了便於實作者快速理解,資料欄位會使用易於理解的命名,實作者再透過邏輯模型中的功能頁籤「Mappings」瞭解各資料欄位實際使用本IG的哪個Profiles的哪個資料項目(element)。
    • FHIR Profiles
      • NIIS IG的所有Profiles之定義與範例。
      • 各資料項目不同實作強制程度的Terminology。
    • 專門術語 :NIIS IG所使用的專門術語,包括代碼系統(Code Systems)及值集(Value Sets)。
  • 範例:NIIS IG所定義Profiles之範例檔。
  • 定義與範例檔下載:實作者若不偏好使用FHIR RESTful API驗證資料是否符合Profiles,可直接下載所需的格式驗證檔,包括XML、JSON及Turtle三種格式,亦可於此下載完整範例檔。
  • 安全性:主要說明採用NIIS IG網站進行實作時,有關資料存取授權的作法。
  • 版本異動:若NIIS IG網站的版本有所異動,皆可透過異動說明頁得以瞭解版本間的異動差異。

作者與貢獻者

角色 姓名
作者-IG 李奇安(Chi-An Lee)
作者-系統規格書 凌網資訊