臺灣重大傷病實作指引
1.0.0 - STU1.0.0
臺灣重大傷病實作指引
1.0.0 - STU1.0.0
This page is part of the 臺灣重大傷病實作指引 (v1.0.0: STU1.0.0) 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://nhicore.nhi.gov.tw/ci/CapabilityStatement/CapabilityStatementTWCIServer | Version: 1.0.0 | |||
| Active as of 2025-06-11 | Computable Name: CapabilityStatementTWCIServer | |||
臺灣健保重大傷病實作指引(TWCI IG)伺服端(Server)之能力聲明
Raw OpenAPI-Swagger Definition file | Download
json, xmlserver臺灣重大傷病-伺服端(TWCI 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是否為TWCI Profiles Defining URL，並確認實例是否依循Profile製作。
【註：實例是指依據Profile實作，將真實資料以JSON、XML或Turtle格式存放的檔案】
臺灣重大傷病-伺服端(TWCI Server)建議應該(SHOULD)：
(1)Server提供的API操作皆支援XML格式
安全性：
(1)Server必須(SHALL)透過回傳 HTTP 401「未授權」， HTTP 403「禁止」，或 HTTP 404 「未找到」，來拒絕任何未經授權的請求。
共有六類Resources支援查詢，查詢參數如表列：
| Resource型別 | Profile | Create | Read | VRead | Delete | Update | 支援的查詢參數 |
|---|---|---|---|---|---|---|---|
| Bundle | 重大傷病申請證明-Bundle TWCI | y | y | y | y | _id | |
| Questionnaire | 重大傷病申請書-Questionnaire TWCI | y | y | y | y | ||
| QuestionnaireResponse | 重大傷病申請書回覆-QuestionnaireResponse TWCI | y | y | y | y | ||
| Task | 重大傷病申請-Task TWCI | y | y | y | y | period, patient, authored-on, modified, identifier, status | |
| Patient | 病人資訊-Patient TWCI | y | y | y | y | name, identifier | |
| Condition | 重大傷病-Condition TWCI | y | y | y | y |
resolvescreate, read, vread, update.| 遵從度 | 參數 | 類型 | 範例 |
|---|---|---|---|
| 必須（SHALL） | _id | token | GET [base]/Bundle?_id=[id]GET [base]/Bundle/[id] |
resolvescreate, read, vread, update.resolvescreate, read, vread, update.| 遵從度 | 參數 | 類型 | 範例 |
|---|---|---|---|
| 必須（SHALL） | patient.identifier | reference, token | GET [base]/Task?patient.identifier=[code]實作請參考查詢參數 |
| 必須（SHALL） | patient.name | reference, string | GET [base]/Task?patient.name=[string]實作請參考查詢參數 |
| 必須（SHALL） | period | date | GET [base]/Task?period={gt|lt|ge|le}[date]{&period={gt|lt|ge|le}[date]} |
| 必須（SHALL） | modified | date | GET [base]/Task?modified={gt|lt|ge|le}[date]{&modified={gt|lt|ge|le}[date]} |
| 必須（SHALL） | identifier | token | GET [base]/Task?identifier=[code] |
| 必須（SHALL） | authored-on | date | GET [base]/Task?authored-on={gt|lt|ge|le}[date]{&authored-on={gt|lt|ge|le}[date]} |
| 必須（SHALL） | status | token | GET [base]/Task?status=[code] |
| 遵從度 | 參數 | 類型 | 範例 |
|---|---|---|---|
| 必須（SHALL） | identifier | token | GET [base]/Patient?identifier=[code]實作請參考查詢參數 |
| 必須（SHALL） | name | string | GET [base]/Patient?name=[string]實作請參考查詢參數 |
resolvescreate, read, vread, update.