旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引
1.0.0 - ci-build

This page is part of the 旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引 (v1.0.0: Releases Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

應用說明

Official URL: https://vacc.cdc.gov.tw/vacc/ImplementationGuide/tw.gov.mohw.cdc.vacc Version: 1.0.0
Active as of 2024-09-23 Computable Name: VACC

專案介紹

旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引(VACC IG)採用HL7® FHIR® standard（Fast Healthcare Interoperability Resources）IG建置方法，在FHIR R4.0.1之標準基礎上，繼承TW Core IG V 0.2.1 (2024-04-09)，進一步定義適用於「旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引(以下簡稱本專案)」資料需求的Resources（類似資料表）、其中的資料項目（意即欄位）、基數（意即0..1、0..*、1..1或1..*）及資料類型（文字、日期時間、代碼等）等。

專案背景

衛生福利部疾病管制署(Centers for Disease Control，CDC，以下簡稱本署)推動運用API介接作業模式，進行疫苗接種或開立藥品相關資料之自動交換與資料核對修正作業，透過API介接，將旅遊醫學門診執行疫苗接種或開立藥品的紀錄資料上傳至本署，並接收及紀錄配發具時效性之單次查詢代碼，並以單次查詢代碼查詢該案資料上傳疾病管制署之狀態，強化資料除錯管控效能，提升資料正確完整性，降低醫療院所人工作業負擔，完善預防接種數位化作業管理及服務品質與效能。

專案範圍

架構圖

一、接種/開立藥品紀錄應用程式介面－VACC1-1:合約院所上傳或修改疫苗接種/開立藥品紀錄。

二、接種/開立藥品紀錄應用程式介面－VACC1-2:查詢所上傳之疫苗接種/開立藥品紀錄寫入VACC系統的狀態。

三、接種/開立藥品紀錄應用程式介面－VACC1-3:刪除疫苗接種/開立藥品紀錄。

四、接種/開立藥品及其證書歷程查詢應用程式介面－VACC2:合約院所查詢VACC系統中個案的疫苗接種/開立藥品紀錄，以作為疫苗接種或開立黃皮書之依據。

五、疫苗/藥品庫存查詢應用程式介面－VACC3:合約院所查詢VACC系統中院所的疫苗及藥品庫存相關資料，包括疫苗名稱(代號)、批號、包裝樣式/劑量、數量、生效日期等，VACC系統回饋該院所庫存之疫苗及藥品的批號及其數量，降低上傳個案疫苗接種及開立藥品紀錄時，因庫存不足造成錯誤情形。

六、NIIS預注資料查詢應用程式介面－VACC4:合約院所查詢NIIS系統中個案的的所有疫苗接種資料，讓合約院所可以取得該個案CoV接種紀錄，以作為開立黃皮書之依據。

七、開立證書應用程式介面－VACC5-1:合約院所上傳疫苗接種紀錄的證書資料。

八、開立證書應用程式介面－VACC5-2:合約院所刪除疫苗接種紀錄的證書資料。

IG use case

API作業流程

一、接種/開立藥品紀錄應用程式介面－VACC1-1

請留意新增成功時，系統會回覆一組所上傳Bundl的id，此id請務必記住，因於VACC1-2做查詢時會需要使用到

  1. 合約院所呼叫 API: HISVaccinationAndMedicineRecord 多筆新增或修改、單筆修改疫苗接種/開立藥品紀錄，VACC系統會回覆是否成功上傳之訊息(格式：接種疫苗/開立藥品紀錄API-新增多筆紀錄（Bundle Upload POST VACC1-1）、接種疫苗/開立藥品紀錄API-修改多筆/單筆紀錄（Bundle Upload PUT VACC1-1）)。
  2. VACC系統檢核資料正確性，回覆處理結果：合約院所新增或修改疫苗接種/開立藥品紀錄成功訊息與VACC1-2所需Bundle的id(格式：CDC回覆院所上傳/修改（Bundle Response VACC1-1）)。
  3. VACC系統檢核資料正確性，回覆處理結果：合約院所新增或修改疫苗接種/開立藥品紀錄失敗格式(格式：CDC回覆院所上傳/修改（Bundle Response VACC1-1）)。
  4. 合約院所可依照VACC系統回覆訊息做資料修正。
合約院所VACC系統1多筆新增或修改、單筆修改疫苗接種/開立藥品紀錄(API: HISVaccinationAndMedicineRecord；格式:Bundle Upload POST VACC1-1、Bundle Upload PUT VACC1-1、Bundle Upload Single VACC1-1)alt[上傳成功]2回覆上傳或修改成功訊息與VACC1-2所需Bundle的id(格式：Bundle Response VACC1-1)[上傳失敗]3回覆上傳或修改失敗訊息(格式：Bundle Response VACC1-1)4異常資料修正


二、接種/開立藥品紀錄應用程式介面－VACC1-2
  1. 合約院所呼叫 API: HISQueryRecordStatus 使用VACC1-1上傳成功所取得的Bundl的id與操作定義($confirm)查詢所上傳之疫苗接種/開立藥品紀錄寫入VACC系統狀態。
    • 語法：GET [base]/Bundle/[id]/$confirm（此id即為VACC1-1上傳疫苗接種/開立藥品紀錄成功時，系統所回覆Bundle的id）。
    • 實作操作定義語法請參考Bundle-confirm
  2. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢疫苗接種/開立藥品紀錄成功訊息與內容(格式：院所查詢接種疫苗/開立藥品紀錄上傳狀態CDC完整回覆（Bundle Upload Stuts Check Response VACC1-2）)。
  3. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢疫苗接種/開立藥品紀錄失敗訊息(格式：院所查詢接種疫苗/開立藥品紀錄上傳狀態CDC完整回覆（Bundle Upload Stuts Check Response VACC1-2）)。
  4. 合約院所可依照VACC系統回覆訊息做查詢資料修正。
合約院所VACC系統1使用VACC1-1上傳成功所取得的Bundl的id與操作定義($confirm)查詢所上傳之疫苗接種/開立藥品紀錄寫入VACC系統狀態(API: HISQueryReclrdStatus)alt[查詢成功]2回覆查詢成功訊息與查詢內容(格式：Bundle Upload Stuts Check Response VACC1-2)[查詢失敗]3回覆查詢失敗訊息(格式：Bundle Upload Stuts Check Response VACC1-2)4查詢資料修正
三、接種/開立藥品紀錄應用程式介面－VACC1-3
  1. 合約院所呼叫 API: HISQueryRecordStatus 刪除疫苗接種/開立藥品紀錄(格式：疫苗/藥品紀錄、證書歷程刪除（Bundle Batch Delete VACC1-3/VACC5-2）)。
  2. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所刪除疫苗接種/開立藥品紀錄成功訊息與內容(格式：CDC回覆院所刪除（Bundle Delete Response VACC1-3/5-2）)。
  3. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所刪除疫苗接種/開立藥品紀錄失敗訊息(格式：CDC回覆院所刪除（Bundle Delete Response VACC1-3/5-2）)。
  4. 合約院所可依照VACC系統回覆訊息做刪除資料修正。
合約院所VACC系統1刪除疫苗接種/開立藥品紀錄(API: HISQueryReclrdStatus；格式：Bundle Batch Delete VACC1-3/VACC5-2)alt[查詢成功]2回覆刪除成功訊息與查詢內容(格式：Bundle Delete Response VACC1-3/5-2)[查詢失敗]3回覆刪除失敗訊息(格式：Bundle Delete Response VACC1-3/5-2)4刪除資料修正
四、接種/開立藥品及其證書歷程查詢應用程式介面－VACC2
  1. 合約院所呼叫 API: QryVaccData 查詢個案疫苗接種/開立藥品紀錄內容。(格式：接種/開立藥品及其證書歷程查詢應用程式介面-個案記錄查詢（Bundle Batch Query VACC2）)
  2. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢個案疫苗接種/開立藥品紀錄成功訊息(格式：CDC回覆院所查詢接種疫苗/開立藥品紀錄（Bundle Batch Query Response VACC2）)。
  3. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢個案疫苗接種/開立藥品紀錄失敗訊息(格式：CDC回覆院所查詢接種疫苗/開立藥品紀錄（Bundle Batch Query Response VACC2）)。
  4. 合約院所可依照VACC系統回覆訊息做查詢參數修正。
合約院所VACC系統1查詢個案疫苗接種/開立藥品紀錄(API: QryVaccData ；格式：Bundle Batch Query VACC2)alt[查詢成功]2回覆查詢內容(格式：Bundle Batch Query Response VACC2)[查詢失敗]3回覆查詢失敗訊息 (格式：Bundle Batch Query Response VACC2)4查詢參數修正


五、疫苗/藥品庫存查詢應用程式介面－VACC3
  1. 合約院所呼叫 API: QryVacStockQty 使用查詢參數(SupplyDelivery.supplier)查詢VACC系統中院所的疫苗及藥品庫存相關資料。
  2. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢VACC系統中院所的疫苗及藥品庫存相關資料成功訊息與內容(格式：CDC回覆院所查詢庫存（Bundle Search SupplyDelivery VACC3）)。
  3. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢VACC系統中院所的疫苗及藥品庫存相關資料失敗訊息(格式：CDC回覆院所查詢庫存（Bundle Search SupplyDelivery VACC3）)。
  4. 合約院所可依照VACC系統回覆訊息做查詢資料修正。
合約院所VACC系統1使用查詢參數(SupplyDelivery.supplier)查詢VACC系統中院所的疫苗及藥品庫存相關資料(API: QryVacStockQty)alt[查詢成功]2回覆查詢成功訊息與查詢內容(格式：Bundle Search SupplyDelivery VACC3)[查詢失敗]3回覆查詢失敗訊息(格式：Bundle Search SupplyDelivery VACC3)4查詢資料修正


六、NIIS系統疫苗接種資料查詢應用程式介面－VACC4
  1. 合約院所呼叫 API: QryNIISVaccData 使用查詢參數(Immunization.patient)查詢NIIS系統中個案的的所有疫苗接種資料。
  2. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢NIIS系統中個案的的所有疫苗接種資料成功訊息與內容(格式：CDC回覆院所查詢個案接種疫苗紀錄（Bundle Search Vaccine VACC4）)。
  3. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所查詢NIIS系統中個案的的所有疫苗接種資料失敗訊息(格式：CDC回覆院所查詢個案接種疫苗紀錄（Bundle Search Vaccine VACC4）)。
  4. 合約院所可依照VACC系統回覆訊息做查詢資料修正。
合約院所VACC系統1使用查詢參數(Immunization.patient)查詢NIIS系統中個案的所有疫苗接種資料(API: QryNIISVaccData)alt[查詢成功]2回覆查詢成功訊息與查詢內容(格式：Bundle Search Vaccine VACC4)[查詢失敗]3回覆查詢失敗訊息(格式：Bundle Search Vaccine VACC4)4查詢資料修正


七、開立證書應用程式介面－VACC5-1
  1. 合約院所呼叫 API: HISResAddIssueData 多筆新增或修改疫苗接種/開立藥品紀錄的證書資料，VACC系統會回覆是否成功上傳之訊息(格式:開立證書應用程式介面-新增多筆紀錄（Bundle Upload Composition VACC5-1）)。
  2. VACC系統檢核資料正確性，回覆處理結果：合約院所上傳疫苗接種/開立藥品紀錄的證書資料成功訊息(格式：CDC回覆院所上傳疫苗證書資料完整回覆（Bundle Upload Composition Response VACC5-1）)。
  3. VACC系統檢核資料正確性，回覆處理結果：合約院所上傳疫苗接種/開立藥品紀錄的證書資料失敗格式(格式：CDC回覆院所上傳疫苗證書資料完整回覆（Bundle Upload Composition Response VACC5-1）)。
  4. 合約院所可依照VACC系統回覆訊息做資料修正。
合約院所VACC系統1上傳證書資料(API: HISResAddIssueData；格式:Bundle Upload Composition VACC5-1)alt[上傳成功]2回覆上傳成功訊息(格式：Bundle Upload Composition Response VACC5-1)[上傳失敗]3回覆上傳失敗訊息(格式：Bundle Upload Composition Response VACC5-1)4異常資料修正


八、開立證書應用程式介面－VACC5-2
  1. 合約院所呼叫 API: HISQueryRecordStatus 刪除疫苗接種紀錄的證書資料(格式：疫苗/藥品紀錄、證書歷程刪除（Bundle Batch Delete VACC1-3/VACC5-2）)。
  2. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所刪除疫苗接種紀錄的證書資料成功訊息與內容(格式：CDC回覆院所刪除（Bundle Delete Response VACC1-3/5-2）)。
  3. VACC系統檢核查詢資料正確性，回覆處理結果：合約院所刪除疫苗接種紀錄的證書資料失敗訊息(格式：CDC回覆院所刪除（Bundle Delete Response VACC1-3/5-2）)。
  4. 合約院所可依照VACC系統回覆訊息做刪除資料修正。
合約院所VACC系統1刪除疫苗接種紀錄的證書資料(API: HISQueryReclrdStatus；格式：Bundle Batch Delete VACC1-3/VACC5-2)alt[查詢成功]2回覆刪除成功訊息與查詢內容(格式：Bundle Delete Response VACC1-3/5-2)[查詢失敗]3回覆刪除失敗訊息(格式：Bundle Delete Response VACC1-3/5-2)4刪除資料修正


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

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

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

作者與貢獻者

角色 姓名 機構 聯絡方式
作者-IG 李麗惠（Li-Hui Lee） 國立臺北護理健康大學-健康事業管理系 cclhlee@gmail.com
cclhlee@ntunhs.edu.tw
作者-IG 李奇安（Chi-An Lee） 國立臺北護理健康大學-健康事業管理系 ec460520@gmail.com
作者-系統規格書 凌網資訊