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

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.2 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

Resource Profile: TW Core Bundle Document

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/Bundle-document-twcore Version: 0.3.2
Active as of 2025-02-04 Computable Name: TWCoreBundleDocument

此臺灣核心-資料交換基本單位-文件(TW Core Bundle Document) Profile說明本IG如何進一步定義臺灣核心-資料交換基本單位(TW Core Bundle) Profile以呈現 Bundle 文件 的詳細資料。

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* TWCoreBundle 包含resourceBundle
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... implicitRules ?!Σ 0..1 uri 創建此內容所依據的一組規則
ele-1: All FHIR elements must have a @value or children
... identifier SΣ 1..1 Identifier 一組Resources的資料交換基本單位(Bundle)的識別碼。
ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Bundle類型;應填入所綁定值集中的其中一個代碼。


ele-1: All FHIR elements must have a @value or children
Required Pattern: document
... Slices for entry ΣC 1..* BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entry:TWCoreComposition SΣC 1..1 BackboneElement 在bundle中的條目 - 將會有一個resource或資訊,這個重複的資料項目順序:對於type為「document」和「message」的bundles,第一個resource是特殊的(必須分別是Composition或MessageHeader)。對於所有bundles,條目順序的意義取決於bundle的type。
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 TWCoreComposition 將一組resources組成一份連貫的臨床聲明,並附有臨床證明。

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: document
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:TWCoreCompositionmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:TWCoreCompositionfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單,請參閱TW Core Server能力聲明

建議應該支援以下查詢參數:

  1. 建議應該(SHOULD) 支援透過查詢參數 _id 查詢所有Bundle:
    (如何透過token查詢)
    GET [base]/Bundle?_id=[id]
    GET [base]/Bundle/[id]

    例子:
    (1) GET [base]/Bundle?_id=bun-document-example
    (2) GET [base]/Bundle/bun-document-example

  2. 建議應該(SHOULD) 支援透過查詢參數 identifier 查詢所有Bundle:
    (如何透過token查詢)
    GET [base]/Bundle?identifier={system|}[code]

    例子:
    (1) GET [base]/Bundle?identifier=https://www.cdc.gov.tw/|01010905170415100000000