臺灣社政領域基礎實作指引
0.0.1 - ci-build

臺灣社政領域基礎實作指引, published by 衛生福利部社會及家庭署. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/sfaassn2025-source/base/ and changes regularly. See the Directory of published versions

CapabilityStatement: TWSS Base IG 伺服端能力聲明

Official URL: https://sfaa.gov.tw/base/CapabilityStatement/CapabilityStatementTWSSBaseServer Version: 0.0.1
Draft as of 2026-07-14 Computable Name: CapabilityStatementTWSSBaseServer

TWSS Base IG 伺服端能力聲明。

Raw OpenAPI-Swagger Definition file | Download

TWSS Base IG 伺服端能力聲明

  • 發布日期:2026-07-14
  • 版本:0.0.1
  • 狀態:draft
  • Publisher:衛生福利部社會及家庭署

臺灣社家署基礎-伺服端(TWSS Base Server)必須(SHALL)

  1. 可透過 FHIR RESTful API 查詢、新增及更新本能力聲明列出的 Resources。
  2. 根據 FHIR 規範實作 RESTful API。
  3. 使用適當的 HTTP 回傳狀態碼,包括請求成功、無效參數、未經授權、未充分授權的資料存取範圍,以及未知的 Resource。
  4. Server 提供的 API 操作支援 JSON 格式。
  5. 可識別新增至 Server 的實例之 meta.profile 是否為 TWSS Base Profiles Defining URL,並確認實例是否依循 Profile 製作。

Resources或Profiles的RESTful功能

Summary

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

Resource型別ProfileCreateReadVReadDeleteUpdate支援的查詢參數
Claim支援的Profiles
  補助申請或核付明細-Claim TWSS Base
yyyy_id, identifier, patient, created
ClaimResponse支援的Profiles
  補助審核或核付結果-ClaimResponse TWSS Base
yyyy_id, identifier, patient, request, created
Condition支援的Profiles
  健康與障礙狀況-Condition TWSS Base
yyyy_id, patient, code, severity, recorded-date
Coverage支援的Profiles
  補助資格或補助案件-Coverage TWSS Base
yyyy_id, identifier, patient, type
DocumentReference支援的Profiles
  共用公文-DocumentReference TWSS Base
yyy_id, patient, type, date
EpisodeOfCare支援的Profiles
  個案服務案件-EpisodeOfCare TWSS Base
yyyy_id, identifier, patient, status, type, date
Location支援的Profiles
  服務地點及托育地址-Location TWSS Base
yyyy_id, name
Observation支援的Profiles
  身心障礙證明狀態 Observation TWSS Base
  機構查核結果 Observation TWSS Base
  裁罰法規依據 Observation TWSS Base
  服務人教育經歷 Observation TWSS Base
  服務人受訓課程 Observation TWSS Base
  裁定日期 Observation TWSS Base
yyyy_id, patient, code, date
Organization支援的Profiles
  醫療院所 Organization TWSS Base
  機構資料-Organization TWSS Base
yyyy_id, identifier, name, type
Patient支援的Profiles
  個案資料-Patient TWSS Base
yyyy_id, identifier, name
Practitioner支援的Profiles
  人員資料-Practitioner TWSS Base
yyyy_id, identifier, name
PractitionerRole支援的Profiles
  人員角色-PractitionerRole TWSS Base
yyyy_id, practitioner, organization, role
RelatedPerson支援的Profiles
  關係人資料-RelatedPerson TWSS Base
yyyy_id, patient, identifier, name
ServiceRequest支援的Profiles
  申請或服務請求-ServiceRequest TWSS Base
  個案通報-ServiceRequest TWSS Base
  個案轉介-ServiceRequest TWSS Base
yyyy_id, identifier, patient, status, category, code, authored
Task支援的Profiles
  個案服務評估審核-Task TWSS Base
  個案受理與評估-Task TWSS Base
  個案轉介受理-Task TWSS Base
  個案轉介處理-Task TWSS Base
yyyy_id, patient, status, business-status
Encounter支援的Profiles
  個案實際服務-Encounter TWSS Base
  個案評估或服務接觸-Encounter TWSS Base
  個案會談-Encounter TWSS Base
  個案會議-Encounter TWSS Base
  安置服務-Encounter TWSS Base
yyyy_id, patient, status, date
CarePlan支援的Profiles
  個案服務計畫-CarePlan TWSS Base
yyy_id, patient, status
QuestionnaireResponse支援的Profiles
  社福評估回覆-QuestionnaireResponse TWSS Base
yyy_id, patient, status, questionnaire, authored
Questionnaire支援的Profiles
  社福評估表單-Questionnaire TWSS Base
y
Provenance支援的Profiles
  資料建立與修改歷程-Provenance TWSS Base
yyyy_id, target, recorded, agent

預期的遵從度:建議應該(SHOULD)Claim

Core FHIR Resource
Claim
支援的參照政策(Reference policy)
resolves

支援的Profiles
補助申請或核付明細-Claim TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, patient, created。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Claim/[id]
建議應該(SHOULD)identifiertokenGET [base]/Claim?identifier=[value]
建議應該(SHOULD)patientreferenceGET [base]/Claim?patient=[value]
建議應該(SHOULD)createddateGET [base]/Claim?created=[value]

預期的遵從度:建議應該(SHOULD)ClaimResponse

Core FHIR Resource
ClaimResponse
支援的參照政策(Reference policy)
resolves

支援的Profiles
補助審核或核付結果-ClaimResponse TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, patient, request, created。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/ClaimResponse/[id]
建議應該(SHOULD)identifiertokenGET [base]/ClaimResponse?identifier=[value]
建議應該(SHOULD)patientreferenceGET [base]/ClaimResponse?patient=[value]
建議應該(SHOULD)requestreferenceGET [base]/ClaimResponse?request=[value]
建議應該(SHOULD)createddateGET [base]/ClaimResponse?created=[value]

預期的遵從度:建議應該(SHOULD)Condition

Core FHIR Resource
Condition
支援的參照政策(Reference policy)
resolves

支援的Profiles
健康與障礙狀況-Condition TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, patient, code, severity, recorded-date。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Condition/[id]
建議應該(SHOULD)patientreferenceGET [base]/Condition?patient=[value]
建議應該(SHOULD)codetokenGET [base]/Condition?code=[value]
建議應該(SHOULD)severitytokenGET [base]/Condition?severity=[value]
建議應該(SHOULD)recorded-datedateGET [base]/Condition?recorded-date=[value]

預期的遵從度:建議應該(SHOULD)Coverage

Core FHIR Resource
Coverage
支援的參照政策(Reference policy)
resolves

支援的Profiles
補助資格或補助案件-Coverage TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, patient, type。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Coverage/[id]
建議應該(SHOULD)identifiertokenGET [base]/Coverage?identifier=[value]
建議應該(SHOULD)patientreferenceGET [base]/Coverage?patient=[value]
建議應該(SHOULD)typetokenGET [base]/Coverage?type=[value]

預期的遵從度:建議應該(SHOULD)EpisodeOfCare

Core FHIR Resource
EpisodeOfCare
支援的參照政策(Reference policy)
resolves

支援的Profiles
個案服務案件-EpisodeOfCare TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, patient, status, type, date。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/EpisodeOfCare/[id]
建議應該(SHOULD)identifiertokenGET [base]/EpisodeOfCare?identifier=[value]
建議應該(SHOULD)patientreferenceGET [base]/EpisodeOfCare?patient=[value]
建議應該(SHOULD)statustokenGET [base]/EpisodeOfCare?status=[value]
建議應該(SHOULD)typetokenGET [base]/EpisodeOfCare?type=[value]
建議應該(SHOULD)datedateGET [base]/EpisodeOfCare?date=[value]

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

Core FHIR Resource
Location
支援的參照政策(Reference policy)
resolves

支援的Profiles
服務地點及托育地址-Location TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, name。

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

預期的遵從度:建議應該(SHOULD)Observation

Core FHIR Resource
Observation
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, patient, code, date。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Observation/[id]
建議應該(SHOULD)patientreferenceGET [base]/Observation?patient=[value]
建議應該(SHOULD)codetokenGET [base]/Observation?code=[value]
建議應該(SHOULD)datedateGET [base]/Observation?date=[value]

預期的遵從度:建議應該(SHOULD)Organization

Core FHIR Resource
Organization
支援的參照政策(Reference policy)
resolves

支援的Profiles
醫療院所 Organization TWSS Base
機構資料-Organization TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, name, type。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Organization/[id]
建議應該(SHOULD)identifiertokenGET [base]/Organization?identifier=[value]
建議應該(SHOULD)namestringGET [base]/Organization?name=[value]
建議應該(SHOULD)typetokenGET [base]/Organization?type=[value]

預期的遵從度:建議應該(SHOULD)Patient

Core FHIR Resource
Patient
支援的參照政策(Reference policy)
resolves

支援的Profiles
個案資料-Patient TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, name。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Patient/[id]
建議應該(SHOULD)identifiertokenGET [base]/Patient?identifier=[value]
建議應該(SHOULD)namestringGET [base]/Patient?name=[value]

預期的遵從度:建議應該(SHOULD)Practitioner

Core FHIR Resource
Practitioner
支援的參照政策(Reference policy)
resolves

支援的Profiles
人員資料-Practitioner TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, name。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Practitioner/[id]
建議應該(SHOULD)identifiertokenGET [base]/Practitioner?identifier=[value]
建議應該(SHOULD)namestringGET [base]/Practitioner?name=[value]

預期的遵從度:建議應該(SHOULD)PractitionerRole

Core FHIR Resource
PractitionerRole
支援的參照政策(Reference policy)
resolves

支援的Profiles
人員角色-PractitionerRole TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, practitioner, organization, role。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/PractitionerRole/[id]
建議應該(SHOULD)practitionerreferenceGET [base]/PractitionerRole?practitioner=[value]
建議應該(SHOULD)organizationreferenceGET [base]/PractitionerRole?organization=[value]
建議應該(SHOULD)roletokenGET [base]/PractitionerRole?role=[value]

預期的遵從度:建議應該(SHOULD)RelatedPerson

Core FHIR Resource
RelatedPerson
支援的參照政策(Reference policy)
resolves

支援的Profiles
關係人資料-RelatedPerson TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, patient, identifier, name。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/RelatedPerson/[id]
建議應該(SHOULD)patientreferenceGET [base]/RelatedPerson?patient=[value]
建議應該(SHOULD)identifiertokenGET [base]/RelatedPerson?identifier=[value]
建議應該(SHOULD)namestringGET [base]/RelatedPerson?name=[value]

預期的遵從度:建議應該(SHOULD)ServiceRequest

Core FHIR Resource
ServiceRequest
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, identifier, patient, status, category, code, authored。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/ServiceRequest/[id]
建議應該(SHOULD)identifiertokenGET [base]/ServiceRequest?identifier=[value]
建議應該(SHOULD)patientreferenceGET [base]/ServiceRequest?patient=[value]
建議應該(SHOULD)statustokenGET [base]/ServiceRequest?status=[value]
建議應該(SHOULD)categorytokenGET [base]/ServiceRequest?category=[value]
建議應該(SHOULD)codetokenGET [base]/ServiceRequest?code=[value]
建議應該(SHOULD)authoreddateGET [base]/ServiceRequest?authored=[value]

預期的遵從度:建議應該(SHOULD)Task

Core FHIR Resource
Task
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, patient, status, business-status。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Task/[id]
建議應該(SHOULD)patientreferenceGET [base]/Task?patient=[value]
建議應該(SHOULD)statustokenGET [base]/Task?status=[value]
建議應該(SHOULD)business-statustokenGET [base]/Task?business-status=[value]

預期的遵從度:建議應該(SHOULD)Encounter

Core FHIR Resource
Encounter
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, patient, status, date。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/Encounter/[id]
建議應該(SHOULD)patientreferenceGET [base]/Encounter?patient=[value]
建議應該(SHOULD)statustokenGET [base]/Encounter?status=[value]
建議應該(SHOULD)datedateGET [base]/Encounter?date=[value]

預期的遵從度:建議應該(SHOULD)CarePlan

Core FHIR Resource
CarePlan
支援的參照政策(Reference policy)
未宣告

支援的Profiles
個案服務計畫-CarePlan TWSS Base
能力摘要
支援 create, read, update 操作;查詢參數:_id, patient, status。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/CarePlan/[id]
建議應該(SHOULD)patientreferenceGET [base]/CarePlan?patient=[value]
建議應該(SHOULD)statustokenGET [base]/CarePlan?status=[value]

預期的遵從度:建議應該(SHOULD)QuestionnaireResponse

Core FHIR Resource
QuestionnaireResponse
支援的參照政策(Reference policy)
未宣告

支援的Profiles
社福評估回覆-QuestionnaireResponse TWSS Base
能力摘要
支援 create, read, update 操作;查詢參數:_id, patient, status, questionnaire, authored。

Search Parameters
遵從度參數類型範例
建議應該(SHOULD)_idtokenGET [base]/QuestionnaireResponse/[id]
建議應該(SHOULD)patientreferenceGET [base]/QuestionnaireResponse?patient=[value]
建議應該(SHOULD)statustokenGET [base]/QuestionnaireResponse?status=[value]
建議應該(SHOULD)questionnairereferenceGET [base]/QuestionnaireResponse?questionnaire=[value]
建議應該(SHOULD)authoreddateGET [base]/QuestionnaireResponse?authored=[value]

預期的遵從度:建議應該(SHOULD)Questionnaire

Core FHIR Resource
Questionnaire
支援的參照政策(Reference policy)
未宣告

支援的Profiles
社福評估表單-Questionnaire TWSS Base
能力摘要
支援 read 操作;查詢參數:未定義。

Search Parameters
遵從度參數類型範例
此 Resource 未定義查詢參數。

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

Core FHIR Resource
DocumentReference
能力摘要
支援 create、read、update 操作;查詢參數:_id、patient、type、date。

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

Core FHIR Resource
Provenance
支援的參照政策(Reference policy)
resolves

支援的Profiles
資料建立與修改歷程-Provenance TWSS Base
能力摘要
支援 create, read, vread, update 操作;查詢參數:_id, target, recorded, agent。

Search Parameters
遵從度參數類型範例
必須(SHALL)_idtokenGET [base]/Provenance/[id]
必須(SHALL)targetreferenceGET [base]/Provenance?target=[value]
必須(SHALL)recordeddateGET [base]/Provenance?recorded=[value]
必須(SHALL)agentreferenceGET [base]/Provenance?agent=[value]