This page is part of the 臺灣癌症用藥事前審查實作指引(TWPAS IG) (v1.0.1: Release) 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://twcore.mohw.gov.tw/ig/pas/CapabilityStatement/CapabilityStatementTWPASServer | Version: 1.0.1 | |||
Active as of 2024-12-06 | Computable Name: CapabilityStatementTWPASServer |
臺灣健保癌症用藥事前審查實作指引(TWPAS IG)伺服端(Server)之能力聲明
Raw OpenAPI-Swagger Definition file | Download
json
server
臺灣癌藥事前審查-伺服端(TWPAS 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是否為TWPAS Profiles Defining URL,並確認實例是否依循Profile製作。
【註:實例是指依據Profile實作,將真實資料以JSON、XML或Turtle格式存放的檔案】
臺灣癌藥事前審查-伺服端(TWPAS Server)建議應該(SHOULD):
(1)Server提供的API操作皆支援XML格式
安全性:
(1)Server必須(SHALL)透過回傳 HTTP 401「未授權」, HTTP 403「禁止」,或 HTTP 404 「未找到」,來拒絕任何未經授權的請求。
共有十八類Resources支援查詢,查詢參數如表列:
resolves
create
, read
, vread
, delete
.遵從度 | 參數 | 類型 | 範例 |
---|---|---|---|
必須(SHALL) | _id | token | GET [base]/Bundle?_id=[id] GET [base]/Bundle/[id] |
resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.遵從度 | 參數 | 類型 | 範例 |
---|---|---|---|
必須(SHALL) | adjudication-reason | token | GET [base]/ClaimResponse?adjudication-reason=[code] 實作請參考查詢參數 |
必須(SHALL) | request.patient.name | reference, string | GET [base]/ClaimResponse?request.patient.name=[string] 實作請參考查詢參數 |
必須(SHALL) | request.patient.identifier | reference, token | GET [base]/ClaimResponse?request.patient.identifier=[code] 實作請參考查詢參數 |
必須(SHALL) | request.identifier | reference, token | GET [base]/ClaimResponse?request.identifier=[code] 實作請參考查詢參數 |
必須(SHALL) | request.func-type | reference, token | GET [base]/ClaimResponse?request.func-type={system|}[code] 實作請參考查詢參數 |
必須(SHALL) | created + disposition | date, string | GET [base]/ClaimResponse?created={gt|lt|ge|le}[date]{&created={gt|lt|ge|le}[date]}&disposition=[已受理|審畢結果] 實作請參考查詢參數 |
resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.遵從度 | 參數 | 類型 | 範例 |
---|---|---|---|
必須(SHALL) | service-type | token | GET [base]/Encounter?service-type={system|}[code] 實作請參考查詢參數 |
resolves
create
, read
, vread
, delete
.遵從度 | 參數 | 類型 | 範例 |
---|---|---|---|
必須(SHALL) | name | string | GET [base]/Patient?name=[string] 實作請參考查詢參數 |
必須(SHALL) | identifier | token | GET [base]/Patient?identifier=[code] 實作請參考查詢參數 |
resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.resolves
create
, read
, vread
, delete
.