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

This page is part of the 臺灣核心實作指引(TW Core IG) (v0.2.2: Releases) based on FHIR (HL7® FHIR® Standard) 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.2.2
Active as of 2024-03-21 Computable Name: CapabilityStatementTWCoreServer

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

Raw OpenAPI-Swagger Definition file | Download

  • 實作指引版本:0.2.2
  • FHIR版本:4.0.1
  • 發佈日:2024-03-21
  • 發佈者:衛生福利部

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功能

AllergyIntolerance

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-過敏或不耐症(TW Core AllergyIntolerance)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
  • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/AllergyIntolerance?_id=[id],
    GET [base]/AllergyIntolerance/[id]
    建議應該(SHOULD)clinical-statustokenGET [base]/AllergyIntolerance?clinical-status=[code]

Bundle

Composition

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-臨床文件架構(TW Core Composition)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
  • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Composition?_id=[id],
    GET [base]/Composition/[id]
    建議應該(SHOULD)statustokenGET [base]/Composition?status=[code]
    建議應該(SHOULD)typetokenGET [base]/Composition?type=[code]
    建議應該(SHOULD)subjectreferenceGET [base]/Composition?subject=[subject]

Condition

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-病情、問題或診斷(TW Core Condition)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(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-typereadvreadcreateupdatedelete
    • 可能可以(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]

DocumentReference

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

Encounter

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-就醫事件(TW Core Encounter)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(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]

ImagingStudy

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

Location

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-地點(TW Core Location)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
  • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Location?_id=[id],
    GET [base]/Location/[id]
    建議應該(SHOULD)addressstringGET [base]/Location?address=[string]
    建議應該(SHOULD)namestringGET [base]/Location?name=[string]

Media

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-多媒體(TW Core Media)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
  • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Media?_id=[id],
    GET [base]/Media/[id]
    建議應該(SHOULD)statustokenGET [base]/Media?status=[code]
    建議應該(SHOULD)subjectreferenceGET [base]/Media?subject={Type/}[id]

Medication

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-藥品(TW Core Medication)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(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-typereadvreadcreateupdatedelete
    • 可能可以(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]

MedicationDispense

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-配藥或藥品調劑(TW Core MedicationDispense)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(MAY)支援 patch
  • 查詢參數摘要
  • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/MedicationDispense?_id=[id],
    GET [base]/MedicationDispense/[id]
    建議應該(SHOULD)statustokenGET [base]/MedicationDispense?status=[code]
    建議應該(SHOULD)subjectreferenceGET [base]/MedicationDispense?subject={Type/}[id]
    建議應該(SHOULD)medicationreferenceGET [base]/MedicationDispense?medication={Type/}[id]

MedicationStatement

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

MessageHeader

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

Observation

Organization

Patient

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-病人(TW Core Patient)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(MAY)支援 patch
  • 操作定義摘要
    • 建議應該(SHOULD)支援 $everything
  • 查詢參數摘要
  • 遵從度參數類型範例
    建議應該(SHOULD)_idtokenGET [base]/Patient?_id=[id],
    GET [base]/Patient/[id]
    建議應該(SHOULD)birthdatedateGET [base]/Patient?birthdate={gt|lt|ge|le}[date]
    建議應該(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-typereadvreadcreateupdatedelete
    • 可能可以(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]

PractitionerRole

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

Procedure

  • 預期的遵從度: 建議應該(SHOULD)
  • Profile: 臺灣核心-處置或手術(TW Core Procedure)
  • 支援的參照政策(Reference policy)resolves,Server會嘗試將邏輯參照(logical reference)解析為文字參照,意即轉換Reference.identifier為Reference.reference(但如果解析失敗,Server仍然會接收這個resource,請參閱 logical)。
  • Profile
    • 建議應該(SHOULD)支援 search-typereadvreadcreateupdatedelete
    • 可能可以(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]

Specimen

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