臺灣健保癌症用藥事前審查實作指引
1.0.1 - release

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

CapabilityStatement: 臺灣癌藥事前審查-伺服端(TWPAS Server)

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

臺灣癌藥事前審查-伺服端(TWPAS Server)

  • 實作指引版本:1.0.1
  • FHIR版本:4.0.1
  • 支援格式:json
  • 發佈日:2024-12-06
  • 發佈者:衛生福利部中央健康保險署

必須(SHALL)支援以下實作指引

Server的FHIR RESTful功能要求

模式: 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或Profiles的RESTful功能

Summary

共有十八類Resources支援查詢,查詢參數如表列:

Resource型別ProfileCreateReadVReadDeleteUpdate支援的查詢參數
Bundle事前審查-Bundle TWPASyyyy_id
Claim事前審查-Claim TWPASyyyyidentifier, patient, func-type
ClaimResponse事前審查結果-ClaimResponse TWPASyyyyadjudication-reason, request.patient.name, request.patient.identifier, request.identifier, request.func-type.service-type, created, disposition
Organization支援的Profiles
   機構-Organization TWPAS
   基因檢測機構-Organization Genetic Testing TWPAS
   TW Core Organization Government
yyyy
Encounter就醫科別-Encounter TWPASyyyyservice-type
Patient病人資訊-Patient TWPASyyyyname, identifier
Practitioner醫事人員-Practitioner TWPASyyyy
ImagingStudyDICOM影像-ImagingStudy TWPASyyyy
Media非DICOM影像-Media TWPASyyyy
DiagnosticReport支援的Profiles
   影像報告-DiagnosticReport Image TWPAS (疾病資訊)
   檢查報告-DiagnosticReport TWPAS (疾病資訊)
yyyy
Observation支援的Profiles
   癌症分期量表-Observation Cancer Stage TWPAS (疾病資訊)
   基因資訊-Observation Diagnostic TWPAS
   檢驗檢查-Observation Laboratory Result TWPAS (評估資訊)
   病人狀態評估-Observation Patient Assessment TWPAS (評估資訊)
   治療後疾病狀態評估-Observation Treatment Assessment TWPAS (結果資訊)
yyyy
MedicationRequest支援的Profiles
   用藥品項-MedicationRequest Treat TWPAS (治療資訊)
   事前審查品項-MedicationRequest Apply TWPAS (申請項目)
yyyy
Procedure放射治療-Procedure TWPASyyyy
Substance放射治療總劑量-Substance TWPASyyyy
Specimen基因檢測檢體-Specimen TWPASyyyy
DocumentReference文件參照-DocumentReferenceyyyy
Coverage健保事前審查計畫-Coverageyyyy
OperationOutcome系統回應訊息-OperationOutcome TWPASyyyy

預期的遵從度: 必須(SHALL)Bundle

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

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

預期的遵從度: 必須(SHALL)Claim

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

Search Parameters
遵從度參數類型範例
必須(SHALL)identifiertokenGET [base]/Claim?identifier=[code]

實作請參考查詢參數

必須(SHALL)patienttokenGET [base]/Claim?patient={Type/}[id]

實作請參考查詢參數

必須(SHALL)func-typereferenceGET [base]/Claim?func-type={system|}[code]

實作請參考查詢參數

 

預期的遵從度: 必須(SHALL)ClaimResponse

Core FHIR Resource
ClaimResponse
支援的參照政策(Reference policy)
resolves
能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

Search Parameters
遵從度參數類型範例
必須(SHALL)adjudication-reasontokenGET [base]/ClaimResponse?adjudication-reason=[code]

實作請參考查詢參數

必須(SHALL)request.patient.namereference, stringGET [base]/ClaimResponse?request.patient.name=[string]

實作請參考查詢參數

必須(SHALL)request.patient.identifierreference, tokenGET [base]/ClaimResponse?request.patient.identifier=[code]

實作請參考查詢參數

必須(SHALL)request.identifierreference, tokenGET [base]/ClaimResponse?request.identifier=[code]

實作請參考查詢參數

必須(SHALL)request.func-typereference, tokenGET [base]/ClaimResponse?request.func-type={system|}[code]

實作請參考查詢參數

必須(SHALL)created + dispositiondate, stringGET [base]/ClaimResponse?created={gt|lt|ge|le}[date]{&created={gt|lt|ge|le}[date]}&disposition=[已受理|審畢結果]

實作請參考查詢參數

 

預期的遵從度: 必須(SHALL)Organization

Core FHIR Resource
Organization
支援的參照政策(Reference policy)
resolves
能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Encounter

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

Search Parameters
遵從度參數類型範例
必須(SHALL)service-typetokenGET [base]/Encounter?service-type={system|}[code]

實作請參考查詢參數

 

預期的遵從度: 必須(SHALL)Patient

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

Search Parameters
遵從度參數類型範例
必須(SHALL)namestringGET [base]/Patient?name=[string]

實作請參考查詢參數

必須(SHALL)identifiertokenGET [base]/Patient?identifier=[code]

實作請參考查詢參數

 

預期的遵從度: 必須(SHALL)Practitioner

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)ImagingStudy

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Media

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)DiagnosticReport

Core FHIR Resource
DiagnosticReport
支援的參照政策(Reference policy)
resolves
能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Observation

預期的遵從度: 必須(SHALL)MedicationRequest

Core FHIR Resource
MedicationRequest
支援的參照政策(Reference policy)
resolves
能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Procedure

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Substance

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Specimen

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)DocumentReference

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Coverage

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.

預期的遵從度: 必須(SHALL)Operationoutcome

支援的參照政策(Reference policy)
resolves

能力摘要
  • 必須(SHALL)支援 create, read, vread, delete.