臺灣核心實作指引(TW Core IG)
0.1.1 - Trial Use

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.1.1: Releases) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: 臺灣核心-伺服端(TW Core Server)

Official URL: https://twcore.mohw.gov.tw/ig/twcore/CapabilityStatement/CapabilityStatementTWCoreServer Version: 0.1.1
Active as of 2022-08-31 Computable Name: CapabilityStatementTWCoreServer

臺灣核心實作指引(TW Core IG)伺服端(Server)之能力聲明

  • 2023/8/25異動說明： 各Profile及查詢參數的強制程度，從 必須(SHALL) 改為 建議應該(SHOULD)，因實務專案未必需要滿足每個Profile及其查詢參數的要求，有的專案只需部分滿足要求即可達成專案目標，各專案可依其需求於繼承TW core IG之專案IG另行設定強制程度。

Raw OpenAPI-Swagger Definition file | Download

  • 實作指引版本：0.1.1
  • FHIR版本：4.0.1
  • 發佈日：2022-08-31
  • 發佈者：衛生福利部

Server的FHIR RESTful功能要求

  • 臺灣核心-伺服端(TW Core Server) 必須(SHALL)
    1. 可透過FHIR RESTful API查詢的Resources
    2. 根據FHIR規範實作RESTful
    3. HTTP回傳狀態碼
      • (Status 400)：無效參數(invalid parameter)
      • (Status 401/4xx)：未經授權的請求(unauthorized request)
      • (Status 403)：未充分授權的資料存取範圍(insufficient premission scope)
      • (Status 404)：未知的resource(unknown resource)
    4. Server提供的API操作皆支援JSON格式
  • 臺灣核心-伺服端(TW Core Server) 建議應該(SHOULD)
    1. Server提供的API操作皆支援XML格式
    2. 可識別每個新增到Server的實例(instance)之 meta.profile是否為TW Core Profiles Defining URL，並確認實例是否依循profile製作。【註：實例是指依據profile實作，將真實資料以JSON、XML或Turtle格式存放的檔案】
    3. 支援每個profile的查詢參數
  • 安全性
    1. Server必須(SHALL)透過回傳 HTTP 401「未授權」， HTTP 403「禁止」，或 HTTP 404 「未找到」，來拒絕任何未經授權的請求
  • 系統互動能力：
    • 可能可以(MAY)支援交易(transaction)
    • 可能可以(MAY)支援批次(batch)
    • 可能可以(MAY)支援查詢系統(search-system)

Resources或Profiles的RESTful功能

Condition

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-病情、問題或診斷(TW Core Condition)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Condition?_id=[id],
    GET [base]/Condition/[id]
    建議應該(SHOULD)clinical-statustokenGET [base]/Condition?clinical-status=[code]
    建議應該(SHOULD)codetokenGET [base]/Condition?code={system|}[code]
    建議應該(SHOULD)subjectreferenceGET [base]/Condition?subject={Type/}[id]
    建議應該(SHOULD)onset-datedateGET [base]/Condition?onset-date={gt|lt|ge|le}[date]
    建議應該(SHOULD)abatement-datedateGET [base]/Condition?abatement-date={gt|lt|ge|le}[date]
    建議應該(SHOULD)severitytokenGET [base]/Condition?severity={system|}[code]

DiagnosticReport

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-診斷報告(TW Core DiagnosticReport)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/DiagnosticReport?_id=[id],
    GET [base]/DiagnosticReport/[id]
    建議應該(SHOULD)statustokenGET [base]/DiagnosticReport?status=[code]
    建議應該(SHOULD)subjectreferenceGET [base]/DiagnosticReport?subject={Type/}[id]
    建議應該(SHOULD)categorytokenGET [base]/DiagnosticReport?category={system|}[code]
    建議應該(SHOULD)codetokenGET [base]/DiagnosticReport?code={system|}[code]
    建議應該(SHOULD)datedateGET [base]/DiagnosticReport?date={gt|lt|ge|le}[date]

Encounter

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-就醫事件(TW Core Encounter)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Encounter?_id=[id],
    GET [base]/Encounter/[id]
    建議應該(SHOULD)classtokenGET [base]/Encounter?class=[code]
    建議應該(SHOULD)datedateGET [base]/Encounter?date={gt|lt|ge|le}[date]
    建議應該(SHOULD)identifiertokenGET [base]/Encounter?identifier={system|}[code]
    建議應該(SHOULD)locationreferenceGET [base]/Encounter?location={Type/}[id]
    建議應該(SHOULD)subjectreferenceGET [base]/Encounter?subject={Type/}[id]
    建議應該(SHOULD)statustokenGET [base]/Encounter?status=[code]

Medication

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-藥品(TW Core Medication)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Medication?_id=[id],
    GET [base]/Medication/[id]
    建議應該(SHOULD)codetokenGET [base]/Medication?code={system|}[code]

MedicationRequest

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-藥品處方(TW Core MedicationRequest)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/MedicationRequest?_id=[id],
    GET [base]/MedicationRequest/[id]
    建議應該(SHOULD)statustokenGET [base]/MedicationRequest?status=[code]
    建議應該(SHOULD)intenttokenGET [base]/MedicationRequest?intent={system|}[code]
    建議應該(SHOULD)subjectreferenceGET [base]/MedicationRequest?subject={Type/}[id]
    建議應該(SHOULD)medicationreferenceGET [base]/MedicationRequest?medication={Type/}[id]
    建議應該(SHOULD)encounterreferenceGET [base]/MedicationRequest?encounter={Type/}[id]
    建議應該(SHOULD)authoredondateGET [base]/MedicationRequest?authoredon={gt|lt|ge|le}[date]

Observation

Organization

Patient

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-病人(TW Core Patient)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 操作定義摘要
    • 建議應該(SHOULD)支援 $everything
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Patient?_id=[id],
    GET [base]/Patient/[id]
    建議應該(SHOULD)birthdatedateGET [base]/Patient?birthdate=[birthdate]
    建議應該(SHOULD)gendertokenGET [base]/Patient?gender=[code]
    建議應該(SHOULD)identifiertokenGET [base]/Patient?identifier={system|}[code]
    建議應該(SHOULD)namestringGET [base]/Patient?name=[name]

Practitioner

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-健康照護服務提供人員(TW Core Practitioner)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Practitioner?_id=[id],
    GET [base]/Practitioner/[id]
    建議應該(SHOULD)identifiertokenGET [base]/Practitioner?identifier={system|}[code]
    建議應該(SHOULD)namestringGET [base]/Practitioner?name=[name]

Procedure

  • 預期的遵從度： 建議應該(SHOULD)
  • Profile： 臺灣核心-處置(TW Core Procedure)
  • 支援的參照政策(Reference policy)： resolves，Server會嘗試將邏輯參照(logical reference)解析為文字參照，意即轉換Reference.identifier為Reference.reference(但如果解析失敗，Server仍然會接收這個resource，請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-type、 read、 vread、 create、 update、 delete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
    • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Procedure?_id=[id],
    GET [base]/Procedure/[id]
    建議應該(SHOULD)codetokenGET [base]/Procedure?code={system|}[code]
    建議應該(SHOULD)statustokenGET [base]/Procedure?status=[code]
    建議應該(SHOULD)subjectreferenceGET [base]/Procedure?subject={Type/}[id]
    建議應該(SHOULD)datedateGET [base]/Procedure?date={gt|lt|ge|le}[date]