臺灣核心-用戶端(TW Core Client) - 臺灣核心實作指引(TW Core IG) v0.3.1

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ and changes regularly. See the Directory of published versions

CapabilityStatement: 臺灣核心-用戶端(TW Core Client)

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

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

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement CapabilityStatementTWCoreClient

臺灣核心-用戶端（TW Core Client）

Implementation Guide Version: 0.3.1
FHIR Version: 4.0.1
Supported Formats: json, xml
Supported Patch Formats: application/json-patch+json
Published on: 2024-08-31
Published by: 衛生福利部

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

https://twcore.mohw.gov.tw/ig/twcore/ImplementationGuide/tw.gov.mohw.twcore

FHIR RESTful Capabilities

Mode: `client`

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

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

安全性：

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

系統互動能力：

可能可以（MAY）支援交易（transaction interaction）
可能可以（MAY）支援批次（batch interaction）
可能可以（MAY）支援查詢系統（search-system interaction）

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	V-R	S	U	P	C	D	Searches	Operations
AllergyIntolerance	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/AllergyIntolerance-twcore	y	y	y	y	y	y	y	_id, clinical-status
Bundle	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Bundle-twcore Additional supported profiles: TW Core Bundle Document TW Core Bundle Message	y	y	y	y	y	y	y	_id, identifier
CarePlan	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/CarePlan-twcore	y	y	y	y	y	y	y	patient, category, date, status
CareTeam	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/CareTeam-twcore	y	y	y	y	y	y	y	patient, status, role
Composition	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Composition-twcore	y	y	y	y	y	y	y	_id, status, type, subject
Condition	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Condition-twcore	y	y	y	y	y	y	y	clinical-status, code, subject, onset-date, abatement-date, severity, _id
Coverage	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Coverage-twcore	y	y	y	y	y	y	y	patient
Device	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Device-twcore	y	y	y	y	y	y	y	patient, type, status
DiagnosticReport	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/DiagnosticReport-twcore	y	y	y	y	y	y	y	status, subject, category, code, date, _id
DocumentReference	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/DocumentReference-twcore	y	y	y	y	y	y	y	_id, status, subject
Encounter	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Encounter-twcore	y	y	y	y	y	y	y	class, date, identifier, location, subject, status, _id
Goal	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Goal-twcore	y	y	y	y	y	y	y	patient, lifecycle-status, target-date, description
ImagingStudy	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/ImagingStudy-twcore	y	y	y	y	y	y	y	_id, status, subject, encounter, started
Immunization	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Immunization-twcore	y	y	y	y	y	y	y	patient, status, date
Location	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Location-twcore	y	y	y	y	y	y	y	_id, address, name
Media	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Media-twcore	y	y	y	y	y	y	y	_id, status, subject
Medication	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Medication-twcore	y	y	y	y	y	y	y	_id, code
MedicationRequest	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/MedicationRequest-twcore	y	y	y	y	y	y	y	_id, status, intent, subject, encounter, authoredon
MedicationDispense	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/MedicationDispense-twcore	y	y	y	y	y	y	y	_id, status, subject, medication
MedicationStatement	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/MedicationStatement-twcore	y	y	y	y	y	y	y	_id, status, subject, medication
MessageHeader	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/MessageHeader-twcore	y	y	y	y	y	y	y	_id, author, sender
Observation	Supported Profiles TW Core Observation Average Blood Pressure TW Core Observation Care Experience Preference TW Core Observation Clinical Result TW Core Observation Laboratory Result TW Core Observation Occupation TW Core Observation Pregnancy Intent TW Core Observation Pregnancy Status TW Core Observation Screening Assessment TW Core Observation Sexual Orientation TW Core Simple Observation TW Core Observation Smoking Status TW Core Observation Treatment Intervention Preference TW Core Observation Vital Signs TW Core Pediatric BMI for Age Observation TW Core Observation Blood Pressure TW Core Observation BMI TW Core Observation Body Height TW Core Observation Body Temperature TW Core Observation Body Weight TW Core Observation Head Circumference TW Core Observation Heart Rate TW Core Observation Pulse Oximetry TW Core Observation Respiratory Rate TW Core Observation Pediatric Head Occipital Frontal Circumference Percentile	y	y	y	y	y	y	y	_id, category, code, date, performer, status, subject, _lastUpdated, patient
Organization	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Organization-twcore Additional supported profiles: TW Core Organization Government TW Core Organization Hospital Department TW Core Organization Company	y	y	y	y	y	y	y	_id, identifier, name, type
Patient	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Patient-twcore	y	y	y	y	y	y	y	_id, birthdate, gender, identifier, name	`$everything`
Practitioner	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Practitioner-twcore	y	y	y	y	y	y	y	_id, identifier, name
PractitionerRole	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/PractitionerRole-twcore	y	y	y	y	y	y	y	_id, identifier, specialty
Procedure	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Procedure-twcore	y	y	y	y	y	y	y	_id, code, status, subject, date
Provenance	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Provenance-twcore	y	y	y	y	y	y	y
QuestionnaireResponse	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/QuestionnaireResponse-twcore	y	y	y	y	y	y	y	_id, patient, status, authored, questionnaire
RelatedPerson	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/RelatedPerson-twcore	y	y	y	y	y	y	y	_id, patient, name
ServiceRequest	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/ServiceRequest-twcore	y	y	y	y	y	y	y	_id, patient, category, authored, status, code
Specimen	https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Specimen-twcore	y	y	y	y	y	y	y	_id, status, identifier, subject

Resource Conformance: SHOULDAllergyIntolerance

Base System Profile
TW Core AllergyIntolerance

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type	Documentation
SHOULD	_id	`token`
SHOULD	clinical-status	`token`

Resource Conformance: SHOULDBundle

Base System Profile
TW Core Bundle

Profile Conformance
SHOULD

Reference Policy
resolves

Supported Profiles

TW Core Bundle Document
TW Core Bundle Message

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type	Documentation
SHOULD	_id	`token`
SHOULD	identifier	`token`

Resource Conformance: SHOULDCarePlan

Base System Profile
TW Core CarePlan

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	patient	`reference`
SHOULD	category	`token`
SHOULD	date	`date`
SHOULD	status	`token`

Resource Conformance: SHOULDCareTeam

Base System Profile
TW Core CareTeam

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	patient	`reference`
SHOULD	status	`token`
SHOULD	role	`token`

Resource Conformance: SHOULDComposition

Base System Profile
TW Core Composition

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	status	`token`
SHOULD	type	`token`
SHOULD	subject	`reference`

Resource Conformance: SHOULDCondition

Base System Profile
TW Core Condition

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	clinical-status	`token`
SHOULD	code	`token`
SHOULD	subject	`reference`
SHOULD	onset-date	`date`
SHOULD	abatement-date	`date`
SHOULD	severity	`token`
SHOULD	_id	`token`

Resource Conformance: SHALLCoverage

Base System Profile
TW Core Coverage

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`

Resource Conformance: SHALLDevice

Base System Profile
TW Core Implantable Device

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`reference`
SHOULD	type	`token`
SHOULD	status	`token`

Resource Conformance: SHOULDDiagnosticReport

Base System Profile
TW Core DiagnosticReport

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	status	`token`
SHOULD	subject	`reference`
SHOULD	category	`token`
SHOULD	code	`token`
SHOULD	date	`date`
SHOULD	_id	`token`

Resource Conformance: SHOULDDocumentReference

Base System Profile
TW Core DocumentReference

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	status	`token`
SHOULD	subject	`reference`

Resource Conformance: SHOULDEncounter

Base System Profile
TW Core Encounter

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	class	`token`
SHOULD	date	`date`
SHOULD	identifier	`token`
SHOULD	location	`reference`
SHOULD	subject	`reference`
SHOULD	status	`token`
SHOULD	_id	`token`

Resource Conformance: SHALLGoal

Base System Profile
TW Core Goal

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`reference`
SHOULD	lifecycle-status	`token`
SHOULD	target-date	`date`
SHOULD	description	`token`

Resource Conformance: SHOULDImagingStudy

Base System Profile
TW Core ImagingStudy

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	status	`token`
SHOULD	subject	`reference`
SHOULD	encounter	`reference`
SHOULD	started	`date`

Resource Conformance: SHALLImmunization

Base System Profile
TW Core Immunization

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHALL	patient	`reference`
SHOULD	status	`token`
SHOULD	date	`date`

Resource Conformance: SHOULDLocation

Base System Profile
TW Core Location

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	address	`string`
SHOULD	name	`string`

Resource Conformance: SHOULDMedia

Base System Profile
TW Core Media

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	status	`token`
SHOULD	subject	`reference`

Resource Conformance: SHOULDMedication

Base System Profile
TW Core Medication

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type	Documentation
SHOULD	_id	`token`
SHOULD	code	`token`

Resource Conformance: SHOULDMedicationRequest

Base System Profile
TW Core MedicationRequest

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	status	`token`
SHOULD	intent	`token`
SHOULD	subject	`reference`
SHOULD	encounter	`reference`
SHOULD	authoredon	`date`

Resource Conformance: SHOULDMedicationDispense

Base System Profile
TW Core MedicationDispense

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	status	`token`
SHOULD	subject	`reference`
SHOULD	medication	`reference`

Resource Conformance: SHOULDMedicationStatement

Base System Profile
TW Core MedicationStatement

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	status	`token`
SHOULD	subject	`reference`
SHOULD	medication	`reference`

Resource Conformance: SHOULDMessageHeader

Base System Profile
TW Core MessageHeader

Profile Conformance
SHOULD

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	author	`reference`
SHOULD	sender	`reference`

Resource Conformance: SHOULDObservation

Core FHIR Resource
Observation

Reference Policy
resolves

Interaction summary

SHOULD support search-type, read, vread.
MAY support create, update, delete, patch.

Supported Profiles

Search Parameters

Conformance	Parameter	Type
SHOULD	_id	`token`
SHOULD	category	`token`
SHOULD	code	`token`
SHOULD	date	`date`
SHOULD	performer	`reference`
SHOULD	status	`token`
SHOULD	subject	`reference`
SHOULD	_lastUpdated	`date`
SHOULD	patient	`reference`