臺灣健保署基礎實作指引
0.0.1 - ci-build
臺灣健保署基礎實作指引
0.0.1 - ci-build
臺灣健保署基礎實作指引, 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/TWNHIFHIR/base/ and changes regularly. See the Directory of published versions
| Official URL: https://nhicore.nhi.gov.tw/base/CapabilityStatement/CapabilityStatementTWNHIBASEServer | Version: 0.0.1 | |||
| Active as of 2025-11-07 | Computable Name: CapabilityStatementTWNHIBASEServer | |||
臺灣健保署基礎實作指引(TWNHIBASE IG)伺服端(Server)之能力聲明
Raw OpenAPI-Swagger Definition file | Download
jsonserver臺灣健保署基礎-伺服端(TWNHIBASE Server)必須(SHALL)：
(1)可透過FHIR RESTful API查詢、新增及刪除Resources
(2)根據FHIR規範實作RESTful API
(3)HTTP回傳狀態碼
①(Status 2xx)：請求成功
②(Status 400)：無效參數（invalid parameter）
③(Status 401/4xx)：未經授權的請求（unauthorized request）
④(Status 403)：未充分授權的資料存取範圍（insufficient premission scope）
⑤(Status 404)：未知的resource（unknown resource）
(4)Server提供的API操作皆支援JSON格式
(5)可識別每個新增到Server的實例（instance）之meta.profile是否為TWNHIBASE Profiles Defining URL，並確認實例是否依循Profile製作。
【註：實例是指依據Profile實作，將真實資料以JSON、XML或Turtle格式存放的檔案】
臺灣健保署基礎-伺服端(TWNHIBASE Server)建議應該(SHOULD)：
(1)Server提供的API操作皆支援XML格式
安全性：
(1)Server必須(SHALL)透過回傳 HTTP 401「未授權」， HTTP 403「禁止」，或 HTTP 404 「未找到」，來拒絕任何未經授權的請求。
共有七類Resources支援查詢，查詢參數如表列：
| Resource型別 | Profile | Create | Read | VRead | Delete | Update | 支援的查詢參數 |
|---|---|---|---|---|---|---|---|
| Claim | 事前審查-Claim TWNHIBASE | y | y | y | y | patient | |
| Organization | 支援的Profiles 機構-Organization TWNHIBASE 基因檢測機構-Organization Genetic Testing TWNHIBASE TW Core Organization Government | y | y | y | y | ||
| Patient | 病人資訊-Patient TWNHIBASE | y | y | y | y | name, identifier | |
| Observation | 基因資訊-Observation Diagnostic TWNHIBASE | y | y | y | y | ||
| Specimen | 基因檢測檢體-Specimen TWNHIBASE | y | y | y | y | ||
| DocumentReference | 文件參照-DocumentReference TWNHIBASE | y | y | y | y | ||
| Coverage | 健保事前審查計畫-Coverage TWNHIBASE | y | y | y | y |
resolvescreate, read, vread, update.| 遵從度 | 參數 | 類型 | 範例 |
|---|---|---|---|
| 建議應該（SHOULD） | patient | token | GET [base]/Claim?patient={Type/}[id] |
resolvescreate, read, vread, update.resolvescreate, read, vread, update.| 遵從度 | 參數 | 類型 | 範例 |
|---|---|---|---|
| 建議應該（SHOULD） | name | string | GET [base]/Patient?name=[string] |
| 建議應該（SHOULD） | identifier | token | GET [base]/Patient?identifier=[code] |
resolvescreate, read, vread, update.resolvescreate, read, vread, update.resolvescreate, read, vread, update.resolvescreate, read, vread, update.