TW.GOV.MOHW.TWCORE\臺灣核心-用戶端(TW Core Client)

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 Client)

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

臺灣核心實作指引(TW Core IG)用戶端(Client)之能力聲明

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
發佈者：衛生福利部

Client的FHIR RESTful功能要求

臺灣核心-用戶端(TW Core Client) 建議應該(SHOULD)

使用臺灣核心-伺服端(TW Core Server)能力聲明中的查詢參數，支援讀取和查詢一個或多個臺灣核心Profile(s)。

安全性

有關要求和建議，請參閱一般安全注意事項部分。

系統互動能力：

可能可以(MAY)支援交易互動(transaction interaction)。
可能可以(MAY)支援批次互動(batch interaction)。
可能可以(MAY)支援查詢系統互動(search-system interaction)。

Resources或Profiles的RESTful功能

共有十類Resources支援查詢，查詢參數如表列：

Resources型別 Profile 支援的Profiles 支援的查詢參數支援 _includes(未來視情況新增) 支援 _revincludes(未來視情況新增) 支援Operations(未來視情況新增)

Condition 臺灣核心-病情、問題或診斷(TW Core Condition) - _id, clinical-status, code, subject, onset-date, abatement-date, severity - - -

DiagnosticReport 臺灣核心-診斷報告(TW Core DiagnosticReport) - _id, status, subject, category, code, date - - -

Encounter 臺灣核心-就醫事件(TW Core Encounter) - _id, class, date, identifier, location, subject, status - - -

Medication 臺灣核心-藥品(TW Core Medication) - _id, code - - -

MedicationRequest 臺灣核心-藥品處方(TW Core MedicationRequest) - _id, status, intent, subject, medication, encounter, authoredon - - -

Observation 臺灣核心-檢驗檢查(TW Core Observation Laboratory Result 臺灣核心-生命體徵(TW Core Observation Vital Signs),
臺灣核心-血壓(TW Core Observation Blood Pressure),
臺灣核心-身體質量指數(TW Core Observation BMI) _id, category, code, date, performer, status, subject - - -

Organization 臺灣核心-機構(TW Core Organization) 臺灣核心-政府機構(TW Core Organization Government),
臺灣核心-醫事機構(TW Core Organization Hospital Department),
臺灣核心-公司行號(TW Core Organization Company) _id, identifier, name, type - - -

Patient 臺灣核心-病人(TW Core Patient) - _id, birthdate, gender, identifier, name - - $everything

Practitioner 臺灣核心-健康照護服務提供人員(TW Core Practitioner) - _id, identifier, name - - -

Procedure 臺灣核心-處置(TW Core Procedure) - _id, code, status, subject, date - - -

Resources型別	Profile	支援的Profiles	支援的查詢參數	支援 `_includes`(未來視情況新增)	支援 `_revincludes`(未來視情況新增)	支援Operations(未來視情況新增)
Condition	臺灣核心-病情、問題或診斷(TW Core Condition)	-	_id, clinical-status, code, subject, onset-date, abatement-date, severity	-	-	-
DiagnosticReport	臺灣核心-診斷報告(TW Core DiagnosticReport)	-	_id, status, subject, category, code, date	-	-	-
Encounter	臺灣核心-就醫事件(TW Core Encounter)	-	_id, class, date, identifier, location, subject, status	-	-	-
Medication	臺灣核心-藥品(TW Core Medication)	-	_id, code	-	-	-
MedicationRequest	臺灣核心-藥品處方(TW Core MedicationRequest)	-	_id, status, intent, subject, medication, encounter, authoredon	-	-	-
Observation	臺灣核心-檢驗檢查(TW Core Observation Laboratory Result	臺灣核心-生命體徵(TW Core Observation Vital Signs), 臺灣核心-血壓(TW Core Observation Blood Pressure), 臺灣核心-身體質量指數(TW Core Observation BMI)	_id, category, code, date, performer, status, subject	-	-	-
Organization	臺灣核心-機構(TW Core Organization)	臺灣核心-政府機構(TW Core Organization Government), 臺灣核心-醫事機構(TW Core Organization Hospital Department), 臺灣核心-公司行號(TW Core Organization Company)	_id, identifier, name, type	-	-	-
Patient	臺灣核心-病人(TW Core Patient)	-	_id, birthdate, gender, identifier, name	-	-	$everything
Practitioner	臺灣核心-健康照護服務提供人員(TW Core Practitioner)	-	_id, identifier, name	-	-	-
Procedure	臺灣核心-處置(TW Core Procedure)	-	_id, code, status, subject, date	-	-	-

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
可能可以(MAY)支援 create, update, patch, delete

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/Condition?_id=[id],
GET [base]/Condition/[id]

建議應該(SHOULD) clinical-status token GET [base]/Condition?clinical-status=[code]

建議應該(SHOULD) code token GET [base]/Condition?code={system|}[code]

建議應該(SHOULD) subject reference GET [base]/Condition?subject={Type/}[id]

建議應該(SHOULD) onset-date date GET [base]/Condition?onset-date={gt|lt|ge|le}[date]

建議應該(SHOULD) abatement-date date GET [base]/Condition?abatement-date={gt|lt|ge|le}[date]

建議應該(SHOULD) severity token GET [base]/Condition?severity={system|}[code]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Condition?_id=[id]`, `GET [base]/Condition/[id]`
建議應該(SHOULD)	clinical-status	token	`GET [base]/Condition?clinical-status=[code]`
建議應該(SHOULD)	code	token	`GET [base]/Condition?code={system\|}[code]`
建議應該(SHOULD)	subject	reference	`GET [base]/Condition?subject={Type/}[id]`
建議應該(SHOULD)	onset-date	date	`GET [base]/Condition?onset-date={gt\|lt\|ge\|le}[date]`
建議應該(SHOULD)	abatement-date	date	`GET [base]/Condition?abatement-date={gt\|lt\|ge\|le}[date]`
建議應該(SHOULD)	severity	token	`GET [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
可能可以(MAY)支援 create, update, patch, delete

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/DiagnosticReport?_id=[id],
GET [base]/DiagnosticReport/[id]

建議應該(SHOULD) status token GET [base]/DiagnosticReport?status=[code]

建議應該(SHOULD) subject reference GET [base]/DiagnosticReport?subject={Type/}[id]

建議應該(SHOULD) category token GET [base]/DiagnosticReport?category={system|}[code]

建議應該(SHOULD) code token GET [base]/DiagnosticReport?code={system|}[code]

建議應該(SHOULD) date date GET [base]/DiagnosticReport?date={gt|lt|ge|le}[date]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/DiagnosticReport?_id=[id]`, `GET [base]/DiagnosticReport/[id]`
建議應該(SHOULD)	status	token	`GET [base]/DiagnosticReport?status=[code]`
建議應該(SHOULD)	subject	reference	`GET [base]/DiagnosticReport?subject={Type/}[id]`
建議應該(SHOULD)	category	token	`GET [base]/DiagnosticReport?category={system\|}[code]`
建議應該(SHOULD)	code	token	`GET [base]/DiagnosticReport?code={system\|}[code]`
建議應該(SHOULD)	date	date	`GET [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
可能可以(MAY)支援 create, update, patch, delete

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/Encounter?_id=[id],
GET [base]/Encounter/[id]

建議應該(SHOULD) class token GET [base]/Encounter?class=[code]

建議應該(SHOULD) date date GET [base]/Encounter?date={gt|lt|ge|le}[date]

建議應該(SHOULD) identifier token GET [base]/Encounter?identifier={system|}[code]

建議應該(SHOULD) location reference GET [base]/Encounter?location={Type/}[id]

建議應該(SHOULD) subject reference GET [base]/Encounter?subject={Type/}[id]

建議應該(SHOULD) status token GET [base]/Encounter?status=[code]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Encounter?_id=[id]`, `GET [base]/Encounter/[id]`
建議應該(SHOULD)	class	token	`GET [base]/Encounter?class=[code]`
建議應該(SHOULD)	date	date	`GET [base]/Encounter?date={gt\|lt\|ge\|le}[date]`
建議應該(SHOULD)	identifier	token	`GET [base]/Encounter?identifier={system\|}[code]`
建議應該(SHOULD)	location	reference	`GET [base]/Encounter?location={Type/}[id]`
建議應該(SHOULD)	subject	reference	`GET [base]/Encounter?subject={Type/}[id]`
建議應該(SHOULD)	status	token	`GET [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
可能可以(MAY)支援 create, update, patch, delete

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/Medication?_id=[id],
GET [base]/Medication/[id]

建議應該(SHOULD) code token GET [base]/Medication?code={system|}[code]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Medication?_id=[id]`, `GET [base]/Medication/[id]`
建議應該(SHOULD)	code	token	`GET [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
可能可以(MAY)支援 create, update, patch, delete

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/MedicationRequest?_id=[id],
GET [base]/MedicationRequest/[id]

建議應該(SHOULD) status token GET [base]/MedicationRequest?status=[code]

建議應該(SHOULD) intent token GET [base]/MedicationRequest?intent={system|}[code]

建議應該(SHOULD) subject reference GET [base]/MedicationRequest?subject={Type/}[id]

建議應該(SHOULD) medication reference GET [base]/MedicationRequest?medication={Type/}[id]

建議應該(SHOULD) encounter reference GET [base]/MedicationRequest?encounter={Type/}[id]

建議應該(SHOULD) authoredon date GET [base]/MedicationRequest?authoredon={gt|lt|ge|le}[date]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/MedicationRequest?_id=[id]`, `GET [base]/MedicationRequest/[id]`
建議應該(SHOULD)	status	token	`GET [base]/MedicationRequest?status=[code]`
建議應該(SHOULD)	intent	token	`GET [base]/MedicationRequest?intent={system\|}[code]`
建議應該(SHOULD)	subject	reference	`GET [base]/MedicationRequest?subject={Type/}[id]`
建議應該(SHOULD)	medication	reference	`GET [base]/MedicationRequest?medication={Type/}[id]`
建議應該(SHOULD)	encounter	reference	`GET [base]/MedicationRequest?encounter={Type/}[id]`
建議應該(SHOULD)	authoredon	date	`GET [base]/MedicationRequest?authoredon={gt\|lt\|ge\|le}[date]`

Observation

預期的遵從度： 建議應該(SHOULD)
Profile：臺灣核心-檢驗檢查(TW Core Observation Laboratory Result)
支援的Profiles：臺灣核心-生命體徵(TW Core Observation Vital Signs), 臺灣核心-血壓(TW Core Observation Blood Pressure), 臺灣核心-身體質量指數(TW Core Observation BMI)
支援的參照政策(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) _id token GET [base]/Observation?_id=[id],
GET [base]/Observation/[id]

建議應該(SHOULD) category token GET [base]/Observation?category={system|}[code]

建議應該(SHOULD) code token GET [base]/Observation?code={system|}[code]

建議應該(SHOULD) date date GET [base]/Observation?date={gt|lt|ge|le}[date]

建議應該(SHOULD) performer reference GET [base]/Observation?performer={Type/}[id]

建議應該(SHOULD) status token GET [base]/Observation?status=[code]

建議應該(SHOULD) subject reference GET [base]/Observation?subject={Type/}[id]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Observation?_id=[id]`, `GET [base]/Observation/[id]`
建議應該(SHOULD)	category	token	`GET [base]/Observation?category={system\|}[code]`
建議應該(SHOULD)	code	token	`GET [base]/Observation?code={system\|}[code]`
建議應該(SHOULD)	date	date	`GET [base]/Observation?date={gt\|lt\|ge\|le}[date]`
建議應該(SHOULD)	performer	reference	`GET [base]/Observation?performer={Type/}[id]`
建議應該(SHOULD)	status	token	`GET [base]/Observation?status=[code]`
建議應該(SHOULD)	subject	reference	`GET [base]/Observation?subject={Type/}[id]`

Organization

預期的遵從度： 建議應該(SHOULD)
Profile：臺灣核心-機構(TW Core Organization)
支援的Profiles：臺灣核心-政府機構(TW Core Organization Government), 臺灣核心-醫事機構(TW Core Organization Hospital Department), 臺灣核心-公司行號(TW Core Organization Company)
支援的參照政策(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) _id token GET [base]/Organization?_id=[id],
GET [base]/Organization/[id]

建議應該(SHOULD) identifier token GET [base]/Organization?identifier={system|}[code]

建議應該(SHOULD) name string GET [base]/Organization?name=[name]

建議應該(SHOULD) type token GET [base]/Organization?type={system|}[code]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Organization?_id=[id]`, `GET [base]/Organization/[id]`
建議應該(SHOULD)	identifier	token	`GET [base]/Organization?identifier={system\|}[code]`
建議應該(SHOULD)	name	string	`GET [base]/Organization?name=[name]`
建議應該(SHOULD)	type	token	`GET [base]/Organization?type={system\|}[code]`

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
可能可以(MAY)支援 create, update, patch, delete

操作定義摘要

建議應該(SHOULD)支援 $everything

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/Patient?_id=[id],
GET [base]/Patient/[id]

建議應該(SHOULD) birthdate date GET [base]/Patient?birthdate=[birthdate]

建議應該(SHOULD) gender token GET [base]/Patient?gender=[code]

建議應該(SHOULD) identifier token GET [base]/Patient?identifier={system|}[code]

建議應該(SHOULD) name string GET [base]/Patient?name=[name]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Patient?_id=[id]`, `GET [base]/Patient/[id]`
建議應該(SHOULD)	birthdate	date	`GET [base]/Patient?birthdate=[birthdate]`
建議應該(SHOULD)	gender	token	`GET [base]/Patient?gender=[code]`
建議應該(SHOULD)	identifier	token	`GET [base]/Patient?identifier={system\|}[code]`
建議應該(SHOULD)	name	string	`GET [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
可能可以(MAY)支援 create, update, patch, delete

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/Practitioner?_id=[id],
GET [base]/Practitioner/[id]

建議應該(SHOULD) identifier token GET [base]/Practitioner?identifier={system|}[code]

建議應該(SHOULD) name string GET [base]/Practitioner?name=[name]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Practitioner?_id=[id]`, `GET [base]/Practitioner/[id]`
建議應該(SHOULD)	identifier	token	`GET [base]/Practitioner?identifier={system\|}[code]`
建議應該(SHOULD)	name	string	`GET [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
可能可以(MAY)支援 create, update, patch, delete

查詢參數摘要

遵從度參數類型範例

建議應該(SHOULD) _id token GET [base]/Procedure?_id=[id],
GET [base]/Procedure/[id]

建議應該(SHOULD) code token GET [base]/Procedure?code={system|}[code]

建議應該(SHOULD) status token GET [base]/Procedure?status=[code]

建議應該(SHOULD) subject reference GET [base]/Procedure?subject={Type/}[id]

建議應該(SHOULD) date date GET [base]/Procedure?date={gt|lt|ge|le}[date]

遵從度	參數	類型	範例
建議應該(SHOULD)	_id	token	`GET [base]/Procedure?_id=[id]`, `GET [base]/Procedure/[id]`
建議應該(SHOULD)	code	token	`GET [base]/Procedure?code={system\|}[code]`
建議應該(SHOULD)	status	token	`GET [base]/Procedure?status=[code]`
建議應該(SHOULD)	subject	reference	`GET [base]/Procedure?subject={Type/}[id]`
建議應該(SHOULD)	date	date	`GET [base]/Procedure?date={gt\|lt\|ge\|le}[date]`