臺灣重大傷病實作指引
1.0.2 - ci-build

臺灣重大傷病實作指引, published by 衛生福利部中央健康保險署. This guide is not an authorized publication; it is the continuous build for version 1.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TWNHIFHIR/ci/ and changes regularly. See the Directory of published versions

## CapabilityStatement: 臺灣重大傷病-伺服端(TWCI Server)

Official URL: https://nhicore.nhi.gov.tw/ci/CapabilityStatement/CapabilityStatementTWCIServer | Version: 1.0.2
Active as of 2025-11-07 | Computable Name: CapabilityStatementTWCIServer

臺灣健保重大傷病實作指引(TWCI IG)伺服端(Server)之能力聲明

Raw OpenAPI-Swagger Definition file | Download

## 臺灣重大傷病-伺服端(TWCI Server)

- 實作指引版本：1.0.2
- FHIR版本：4.0.1
- 支援格式：`json`, `xml`
- 發佈日：2025-11-07
- 發佈者：衛生福利部中央健康保險署

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

- 臺灣重大傷病實作指引 (TWCI IG)

## Server的FHIR RESTful功能要求

### 模式：`server`

臺灣重大傷病-伺服端(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或Profiles的RESTful功能

#### Summary

共有六類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 |

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

Profile
重大傷病申請證明-Bundle TWCI
支援的參照政策（Reference policy）
`resolves`

能力摘要

- SHALL 支援 `create`, `read`, `vread`, `update`.

Search Parameters

遵從度 | 參數 | 類型 | 範例
--- | --- | --- | ---
必須（SHALL） | _id | `token` | `GET [base]/Bundle?_id=[id]` `GET [base]/Bundle/[id]`

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

Profile
重大傷病申請書-Questionnaire TWCI
支援的參照政策（Reference policy）
`resolves`

能力摘要

- SHALL 支援 `create`, `read`, `vread`, `update`.

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

Profile
重大傷病申請書回覆-QuestionnaireResponse TWCI
支援的參照政策（Reference policy）
`resolves`
能力摘要

- SHALL 支援 `create`, `read`, `vread`, `update`.

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

Profile
重大傷病申請-Task TWCI
支援的參照政策（Reference policy）
`resolves`
能力摘要

- SHALL 支援 `create`, `read`, `vread`, `update`.

Search Parameters

遵從度 | 參數 | 類型 | 範例
--- | --- | --- | ---
必須（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） Patient

Profile
病人資訊-Patient TWCI
支援的參照政策（Reference policy）
`resolves`
能力摘要

- SHALL 支援 `create`, `read`, `vread`, `update`.

Search Parameters

遵從度 | 參數 | 類型 | 範例
--- | --- | --- | ---
必須（SHALL） | identifier | `token` | `GET [base]/Patient?identifier=[code]` 實作請參考查詢參數
必須（SHALL） | name | `string` | `GET [base]/Patient?name=[string]` 實作請參考查詢參數

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

Profile
重大傷病-Condition TWCI
支援的參照政策（Reference policy）
`resolves`
能力摘要

- SHALL 支援 `create`, `read`, `vread`, `update`.