旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引
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

CapabilityStatement: 臺灣接種疫苗或開立藥品紀錄上傳-伺服端(VACC Server)

Official URL: https://vacc.cdc.gov.tw/vacc/CapabilityStatement/CapabilityStatementVACCServer Version: 1.0.0
Active as of 2024-05-03 Computable Name: CapabilityStatementVACCServer

臺灣接種疫苗或開立藥品紀錄上傳實作指引(VACC IG)伺服端(Server)之能力聲明

Raw OpenAPI-Swagger Definition file | Download

臺灣接種疫苗或開立藥品紀錄上傳-伺服端(VACC Server)

  • 實作指引版本：1.0.0
  • FHIR版本：4.0.1
  • 支援格式：json
  • 發佈日：2024-05-03
  • 發佈者：衛福部疾病管制署

必須（SHALL）支援以下實作指引

Server的FHIR RESTful功能要求

模式：server

臺灣接種疫苗或開立藥品紀錄上傳-伺服端(VACC Server)必須（SHALL）：
(1)支援本實作指引中所有profiles
(2)根據FHIR規範實作RESTful
(3)回傳狀態碼
   ①(Status 400)：無效參數(invalid parameter)
   ②(Status 401/4xx)：未經授權的請求(unauthorized request)
   ③(Status 403)：未充分授權的資料存取範圍(insufficient premission scope)
   ④(Status 404)：未知的resource(unknown resource)
(4)支援JSON格式
(5)可識別每個新增到Server的實例(instance)之meta.profile是否為臺灣接種疫苗或開立藥品紀錄上傳Profiles Defining URL，並確認實例是否依循Profile製作。

臺灣接種疫苗或開立藥品紀錄上傳-伺服端建議應該(SHOULD)：
(1)支援XML格式。

Resources或Profiles的RESTful功能

Summary

共有十類Resources支援查詢，查詢參數如表列：

Resource型別Profile支援的ProfileCreateUpdateReadDelete查詢參數操作定義
Bundle接種疫苗/開立藥品紀錄API-新增多筆紀錄（Bundle Upload POST VACC1-1）
接種疫苗/開立藥品紀錄API-修改多筆/單筆紀錄（Bundle Upload PUT VACC1-1）
CDC回覆院所上傳/修改（Bundle Response VACC1-1）
院所查詢接種疫苗/開立藥品紀錄上傳狀態CDC完整回覆（Bundle Upload Stuts Check Response VACC1-2）
疫苗/藥品紀錄、證書歷程刪除（Bundle Batch Delete VACC1-3/VACC5-2）
CDC回覆院所刪除（Bundle Delete Response VACC1-3/5-2）
接種/開立藥品及其證書歷程查詢應用程式介面-個案記錄查詢（Bundle Batch Query VACC2）
CDC回覆院所查詢接種疫苗/開立藥品紀錄（Bundle Batch Query Response VACC2）
CDC回覆院所查詢庫存（Bundle Search SupplyDelivery VACC3）
CDC回覆院所查詢個案接種疫苗紀錄（Bundle Search Vaccine VACC4）
開立證書應用程式介面-新增多筆紀錄（Bundle Upload Composition VACC5-1）
CDC回覆院所上傳疫苗證書資料完整回覆（Bundle Upload Composition Response VACC5-1）		yyyy_id, identifier$confirm
Composition疫苗接種並開立證書（Vaccinate & Issue Cert VACC）
已接種疫苗之證書開立（Issue Certificate VACC）		yyyy_id, patient
ImmunizationVACC系統疫苗紀錄（Immunization VACC）
NIIS系統疫苗紀錄（Immunization NIIS）		yyyy_id, patient
Medication藥品資料（Medication VACC）yyy_id
MedicationAdministration開立藥品紀錄（MedicationAdministration VACC）yyyy_id, patient
Observation個案出境資料（Observation VACC）yyy_id, patient
OperationOutcome系統回應訊息（OperationOutcome VACC）yyy_id
Organization疫苗/藥品廠牌（Brand Of Vaccine Organization VACC/NIIS）
接種機構（Vaccination Organization VACC/NIIS）		yyy_id
Patient個案資料（Patient VACC）yyy_id, patient, birthdate
SupplyDelivery庫存資料（SupplyDelivery VACC）yyy_id, supplier

預期的遵從度： 必須（SHALL）Bundle

Core FHIR Resource
Bundle
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read, delete.

支援的Profiles

接種疫苗/開立藥品紀錄API-新增多筆紀錄（Bundle Upload POST VACC1-1）
接種疫苗/開立藥品紀錄API-修改多筆/單筆紀錄（Bundle Upload PUT VACC1-1）
CDC回覆院所上傳/修改（Bundle Response VACC1-1）
院所查詢接種疫苗/開立藥品紀錄上傳狀態CDC完整回覆（Bundle Upload Stuts Check Response VACC1-2）
疫苗/藥品紀錄、證書歷程刪除（Bundle Batch Delete VACC1-3/VACC5-2）
CDC回覆院所刪除（Bundle Delete Response VACC1-3/5-2）
接種/開立藥品及其證書歷程查詢應用程式介面-個案記錄查詢（Bundle Batch Query VACC2）
CDC回覆院所查詢接種疫苗/開立藥品紀錄（Bundle Batch Query Response VACC2）
CDC回覆院所查詢庫存（Bundle Search SupplyDelivery VACC3）
CDC回覆院所查詢個案接種疫苗紀錄（Bundle Search Vaccine VACC4）
開立證書應用程式介面-新增多筆紀錄（Bundle Upload Composition VACC5-1）
CDC回覆院所上傳疫苗證書資料完整回覆（Bundle Upload Composition Response VACC5-1）

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Bundle?_id=[id]
GET [base]/Bundle/[id]
DELETE [base]/Bundle/[id]
必須（SHALL）identifiertokenGET [base]/Bundle?identifier={system|}[code]
Operation Definition
遵從度操作定義範例
必須（SHALL）$confirm[base]/Bundle/[id](即為QueryCode)/$confirm

預期的遵從度： 必須（SHALL）Composition

Core FHIR Resource
疫苗接種並開立證書（Vaccinate & Issue Cert VACC）
已接種疫苗之證書開立（Issue Certificate VACC）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read, delete.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Composition?_id=[id]
GET [base]/Composition/[id]
DELETE [base]/Composition/[id]
必須（SHALL）patientredreferenceGET [base]/Composition?patient.identifier=[code]&patient.birthdate=[date]

預期的遵從度： 必須（SHALL）Immunization

Profile
疫苗（Immunization VACC）
NIIS疫苗（Immunization NIIS）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read, delete.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Immunization?_id=[id]
GET [base]/Immunization/[id]
DELETE [base]/Immunization/[id]
必須（SHALL）patientredreferenceGET [base]/Immunization?patient.identifier=[code]&patient.birthdate=[date]&vaccine-code.system=[system]

預期的遵從度： 必須（SHALL）Medication

Core FHIR Resource
藥品資料（Medication VACC）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Medication?_id=[id]
GET [base]/Medication/[id]
DELETE [base]/Medication/[id]

預期的遵從度： 必須（SHALL）MedicationAdministration

Profile
開立藥品紀錄（MedicationAdministration VACC）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read, delete.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/MedicationAdministration?_id=[id]
GET [base]/MedicationAdministration/[id]
DELETE [base]/MedicationAdministration/[id]
必須（SHALL）patientredreferenceGET [base]/MedicationAdministration?patient.identifier=[code]&patient.birthdate=[date]

預期的遵從度： 必須（SHALL）Observation

Core FHIR Resource
個案出境資料（Observation VACC）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Observation?_id=[id]
GET [base]/Observation/[id]

預期的遵從度： 必須（SHALL）OperationOutcome

Profile
系統回應訊息(OperationOutcome VACC)
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read.

預期的遵從度： 必須（SHALL）Organization

Core FHIR Resource
疫苗/藥品廠牌（Brand Of Vaccine Organization VACC/NIIS）
接種機構（Vaccination Organization VACC/NIIS）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Organization?_id=[id]
GET [base]/Organization/[id]

預期的遵從度： 必須（SHALL）Patient

Core FHIR Resource
個案資料（Patient VACC）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/Patient?_id=[id]
GET [base]/Patient/[id]
必須（SHALL）identifiertokenGET [base]/Patient?identifier={system|}[code]
必須（SHALL）birthdatetokenGET [base]/Patient?birthdate={gt|lt|ge|le}[date]

預期的遵從度： 必須（SHALL）SupplyDelivery

Core FHIR Resource
庫存資料（SupplyDelivery VACC）
支援的參照政策（Reference policy）
resolves
能力摘要
  • 必須（SHALL）支援 create, update, read.

Search Parameters
遵從度參數類型範例
必須（SHALL）_idtokenGET [base]/SupplyDelivery?_id=[id]
GET [base]/SupplyDeliverys/[id]
必須（SHALL）supplierredreferenceGET [base]/SupplyDelivery?supplier=identifier.[id]