HL7 FHIR Implementation Guide: HealthBank IG Release 0.1.0 - TW | STU1
0.1.0 - ci-build

HL7 FHIR Implementation Guide: HealthBank IG Release 0.1.0 - TW | STU1 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: HealthBank Core Bundle

Official URL: https://ig.dicom.tw/healthbank/StructureDefinition/Bundle-HealthBank | Version: 0.1.0
Draft as of 2024-08-16 | Computable Name: HealthBankCoreBundle

此健康存摺-資料交換基本單位（HealthBank Bundle） Profile說明本IG如何進一步定義FHIR的Bundle Resource以呈現資料交換基本單位的詳細資料。

Usage:

- This Resource Profile is not used by any profiles in this Implementation Guide

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from TWCoreBundle

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle |  | 0..* | TWCoreBundle | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合
id |  | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄，通常又稱為邏輯性ID。
meta |  | 0..1 | Meta | 此Bundle Resource的metadata
implicitRules |  | 0..1 | uri | 創建此內容所依據的一組規則
language |  | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。
Additional Bindings | Purpose
AllLanguages | Max Binding
Example Value: zh-TW
identifier | S | 0..1 | Identifier | 一組Resources的資料交換基本單位（Bundle）的識別碼。
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型；應填入所綁定值集中的其中一個代碼。
timestamp | S | 0..1 | instant | 組成Bundle的時間。
total |  | 0..1 | unsignedInt | 查詢時符合條件的總筆數
link |  | 0..* | BackboneElement | 與此Bundle相關的連結
relation |  | 1..1 | string | 參見 [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)
url |  | 1..1 | uri | 連結的參照細節
entry |  | 0..* | BackboneElement | 在bundle中的條目 - 將會有一個resource或資訊，這個重複的資料項目順序：對於type為「document」和「message」的bundles，第一個resource是特殊的（必須分別是Composition或MessageHeader）。對於所有bundles，條目順序的意義取決於bundle的type。
link |  | 0..* |  | 與本條目相關的連結
fullUrl |  | 0..1 | uri | Resource的 URI（絕對 URL 伺服器地址或 UUID/OID 的 URI）
resource |  | 0..1 | Resource | Bundle中的resource
search |  | 0..1 | BackboneElement | 查詢有關的資訊
mode |  | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因；應填入所綁定值集中的其中一個代碼。
score |  | 0..1 | decimal | 查詢排名（0至1之間）
request |  | 0..1 | BackboneElement | 其他執行資訊（transaction/batch/history）
method |  | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
url |  | 1..1 | uri | 此Bundle HTTP 對應的 URL
ifNoneMatch |  | 0..1 | string | 用於管理緩存當前狀態
ifModifiedSince |  | 0..1 | instant | 用於管理緩存當前狀態
ifMatch |  | 0..1 | string | 用於管理更新衝突
ifNoneExist |  | 0..1 | string | 用於有條件建立
response |  | 0..1 | BackboneElement | 執行結果（transaction/batch/history）
status |  | 1..1 | string | 狀態回應代碼（文字選填）
location |  | 0..1 | uri | 位置（如果操作返回位置）
etag |  | 0..1 | string | resource的 Etag（如果有相關）
lastModified |  | 0..1 | instant | 修改時之伺服器日期時間
outcome |  | 0..1 | Resource | 帶提示和警告的OperationOutcome（用於batch/transaction）
signature |  | 0..1 | Signature | 數位簽章
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Bundle.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Bundle.type | required | BundleType `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` from the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` from the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` from the FHIR Standard

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | C | 0..* | TWCoreBundle | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 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
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄，通常又稱為邏輯性ID。
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則
language |  | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。
Additional Bindings | Purpose
AllLanguages | Max Binding
Example Value: zh-TW
identifier | S Σ | 0..1 | Identifier | 一組Resources的資料交換基本單位（Bundle）的識別碼。
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型；應填入所綁定值集中的其中一個代碼。
timestamp | S Σ | 0..1 | instant | 組成Bundle的時間。
total | Σ C | 0..1 | unsignedInt | 查詢時符合條件的總筆數
link | Σ | 0..* | BackboneElement | 與此Bundle相關的連結
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
relation | Σ | 1..1 | string | 參見 [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)
url | Σ | 1..1 | uri | 連結的參照細節
entry | Σ C | 0..* | 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 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 | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
link | Σ | 0..* | See link (Bundle) | 與本條目相關的連結
fullUrl | Σ | 0..1 | uri | Resource的 URI（絕對 URL 伺服器地址或 UUID/OID 的 URI）
resource | Σ | 0..1 | Resource | Bundle中的resource
search | Σ C | 0..1 | BackboneElement | 查詢有關的資訊
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
mode | Σ | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因；應填入所綁定值集中的其中一個代碼。
score | Σ | 0..1 | decimal | 查詢排名（0至1之間）
request | Σ C | 0..1 | BackboneElement | 其他執行資訊（transaction/batch/history）
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
url | Σ | 1..1 | uri | 此Bundle HTTP 對應的 URL
ifNoneMatch | Σ | 0..1 | string | 用於管理緩存當前狀態
ifModifiedSince | Σ | 0..1 | instant | 用於管理緩存當前狀態
ifMatch | Σ | 0..1 | string | 用於管理更新衝突
ifNoneExist | Σ | 0..1 | string | 用於有條件建立
response | Σ C | 0..1 | BackboneElement | 執行結果（transaction/batch/history）
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
status | Σ | 1..1 | string | 狀態回應代碼（文字選填）
location | Σ | 0..1 | uri | 位置（如果操作返回位置）
etag | Σ | 0..1 | string | resource的 Etag（如果有相關）
lastModified | Σ | 0..1 | instant | 修改時之伺服器日期時間
outcome | Σ | 0..1 | Resource | 帶提示和警告的OperationOutcome（用於batch/transaction）
signature | Σ | 0..1 | Signature | 數位簽章
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Bundle.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Bundle.type | required | BundleType `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` from the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` from the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl 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-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | C | 0..* | TWCoreBundle | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 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
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄，通常又稱為邏輯性ID。
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則
language |  | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。
Additional Bindings | Purpose
AllLanguages | Max Binding
Example Value: zh-TW
identifier | S Σ | 0..1 | Identifier | 一組Resources的資料交換基本單位（Bundle）的識別碼。
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型；應填入所綁定值集中的其中一個代碼。
timestamp | S Σ | 0..1 | instant | 組成Bundle的時間。
total | Σ C | 0..1 | unsignedInt | 查詢時符合條件的總筆數
link | Σ | 0..* | BackboneElement | 與此Bundle相關的連結
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
relation | Σ | 1..1 | string | 參見 [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)
url | Σ | 1..1 | uri | 連結的參照細節
entry | Σ C | 0..* | 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 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
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
link | Σ | 0..* | See link (Bundle) | 與本條目相關的連結
fullUrl | Σ | 0..1 | uri | Resource的 URI（絕對 URL 伺服器地址或 UUID/OID 的 URI）
resource | Σ | 0..1 | Resource | Bundle中的resource
search | Σ C | 0..1 | BackboneElement | 查詢有關的資訊
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
mode | Σ | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因；應填入所綁定值集中的其中一個代碼。
score | Σ | 0..1 | decimal | 查詢排名（0至1之間）
request | Σ C | 0..1 | BackboneElement | 其他執行資訊（transaction/batch/history）
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
url | Σ | 1..1 | uri | 此Bundle HTTP 對應的 URL
ifNoneMatch | Σ | 0..1 | string | 用於管理緩存當前狀態
ifModifiedSince | Σ | 0..1 | instant | 用於管理緩存當前狀態
ifMatch | Σ | 0..1 | string | 用於管理更新衝突
ifNoneExist | Σ | 0..1 | string | 用於有條件建立
response | Σ C | 0..1 | BackboneElement | 執行結果（transaction/batch/history）
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
status | Σ | 1..1 | string | 狀態回應代碼（文字選填）
location | Σ | 0..1 | uri | 位置（如果操作返回位置）
etag | Σ | 0..1 | string | resource的 Etag（如果有相關）
lastModified | Σ | 0..1 | instant | 修改時之伺服器日期時間
outcome | Σ | 0..1 | Resource | 帶提示和警告的OperationOutcome（用於batch/transaction）
signature | Σ | 0..1 | Signature | 數位簽章
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Bundle.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Bundle.type | required | BundleType `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` from the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` from the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl 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-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from TWCoreBundle

Summary

Must-Support: 2 elements

Differential View

This structure is derived from TWCoreBundle

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle |  | 0..* | TWCoreBundle | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合
id |  | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄，通常又稱為邏輯性ID。
meta |  | 0..1 | Meta | 此Bundle Resource的metadata
implicitRules |  | 0..1 | uri | 創建此內容所依據的一組規則
language |  | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。
Additional Bindings | Purpose
AllLanguages | Max Binding
Example Value: zh-TW
identifier | S | 0..1 | Identifier | 一組Resources的資料交換基本單位（Bundle）的識別碼。
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型；應填入所綁定值集中的其中一個代碼。
timestamp | S | 0..1 | instant | 組成Bundle的時間。
total |  | 0..1 | unsignedInt | 查詢時符合條件的總筆數
link |  | 0..* | BackboneElement | 與此Bundle相關的連結
relation |  | 1..1 | string | 參見 [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)
url |  | 1..1 | uri | 連結的參照細節
entry |  | 0..* | BackboneElement | 在bundle中的條目 - 將會有一個resource或資訊，這個重複的資料項目順序：對於type為「document」和「message」的bundles，第一個resource是特殊的（必須分別是Composition或MessageHeader）。對於所有bundles，條目順序的意義取決於bundle的type。
link |  | 0..* |  | 與本條目相關的連結
fullUrl |  | 0..1 | uri | Resource的 URI（絕對 URL 伺服器地址或 UUID/OID 的 URI）
resource |  | 0..1 | Resource | Bundle中的resource
search |  | 0..1 | BackboneElement | 查詢有關的資訊
mode |  | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因；應填入所綁定值集中的其中一個代碼。
score |  | 0..1 | decimal | 查詢排名（0至1之間）
request |  | 0..1 | BackboneElement | 其他執行資訊（transaction/batch/history）
method |  | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
url |  | 1..1 | uri | 此Bundle HTTP 對應的 URL
ifNoneMatch |  | 0..1 | string | 用於管理緩存當前狀態
ifModifiedSince |  | 0..1 | instant | 用於管理緩存當前狀態
ifMatch |  | 0..1 | string | 用於管理更新衝突
ifNoneExist |  | 0..1 | string | 用於有條件建立
response |  | 0..1 | BackboneElement | 執行結果（transaction/batch/history）
status |  | 1..1 | string | 狀態回應代碼（文字選填）
location |  | 0..1 | uri | 位置（如果操作返回位置）
etag |  | 0..1 | string | resource的 Etag（如果有相關）
lastModified |  | 0..1 | instant | 修改時之伺服器日期時間
outcome |  | 0..1 | Resource | 帶提示和警告的OperationOutcome（用於batch/transaction）
signature |  | 0..1 | Signature | 數位簽章
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Bundle.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Bundle.type | required | BundleType `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` from the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` from the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` from the FHIR Standard

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | C | 0..* | TWCoreBundle | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 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
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄，通常又稱為邏輯性ID。
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則
language |  | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。
Additional Bindings | Purpose
AllLanguages | Max Binding
Example Value: zh-TW
identifier | S Σ | 0..1 | Identifier | 一組Resources的資料交換基本單位（Bundle）的識別碼。
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型；應填入所綁定值集中的其中一個代碼。
timestamp | S Σ | 0..1 | instant | 組成Bundle的時間。
total | Σ C | 0..1 | unsignedInt | 查詢時符合條件的總筆數
link | Σ | 0..* | BackboneElement | 與此Bundle相關的連結
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
relation | Σ | 1..1 | string | 參見 [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)
url | Σ | 1..1 | uri | 連結的參照細節
entry | Σ C | 0..* | 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 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 | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
link | Σ | 0..* | See link (Bundle) | 與本條目相關的連結
fullUrl | Σ | 0..1 | uri | Resource的 URI（絕對 URL 伺服器地址或 UUID/OID 的 URI）
resource | Σ | 0..1 | Resource | Bundle中的resource
search | Σ C | 0..1 | BackboneElement | 查詢有關的資訊
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
mode | Σ | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因；應填入所綁定值集中的其中一個代碼。
score | Σ | 0..1 | decimal | 查詢排名（0至1之間）
request | Σ C | 0..1 | BackboneElement | 其他執行資訊（transaction/batch/history）
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
url | Σ | 1..1 | uri | 此Bundle HTTP 對應的 URL
ifNoneMatch | Σ | 0..1 | string | 用於管理緩存當前狀態
ifModifiedSince | Σ | 0..1 | instant | 用於管理緩存當前狀態
ifMatch | Σ | 0..1 | string | 用於管理更新衝突
ifNoneExist | Σ | 0..1 | string | 用於有條件建立
response | Σ C | 0..1 | BackboneElement | 執行結果（transaction/batch/history）
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
status | Σ | 1..1 | string | 狀態回應代碼（文字選填）
location | Σ | 0..1 | uri | 位置（如果操作返回位置）
etag | Σ | 0..1 | string | resource的 Etag（如果有相關）
lastModified | Σ | 0..1 | instant | 修改時之伺服器日期時間
outcome | Σ | 0..1 | Resource | 帶提示和警告的OperationOutcome（用於batch/transaction）
signature | Σ | 0..1 | Signature | 數位簽章
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Bundle.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Bundle.type | required | BundleType `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` from the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` from the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl 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-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | C | 0..* | TWCoreBundle | 此IG將非FHIR標準的健康存摺JSON格式與目前次世代數位醫療平台採用的FHIR國際標準整合 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
id | Σ | 0..1 | id | 不重複的ID用以識別儲存在特定FHIR Server中的Bundle紀錄，通常又稱為邏輯性ID。
meta | Σ | 0..1 | Meta | 此Bundle Resource的metadata
implicitRules | ?!Σ | 0..1 | uri | 創建此內容所依據的一組規則
language |  | 0..1 | code | 用以表述Bundle Resource內容的語言。 Binding: CommonLanguages (preferred): 人類語言；鼓勵使用CommonLanguages代碼表中的代碼，但不強制一定要使用此代碼表，你也可使用其他代碼表的代碼或單純以文字表示。
Additional Bindings | Purpose
AllLanguages | Max Binding
Example Value: zh-TW
identifier | S Σ | 0..1 | Identifier | 一組Resources的資料交換基本單位（Bundle）的識別碼。
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Bundle類型；應填入所綁定值集中的其中一個代碼。
timestamp | S Σ | 0..1 | instant | 組成Bundle的時間。
total | Σ C | 0..1 | unsignedInt | 查詢時符合條件的總筆數
link | Σ | 0..* | BackboneElement | 與此Bundle相關的連結
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
relation | Σ | 1..1 | string | 參見 [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1)
url | Σ | 1..1 | uri | 連結的參照細節
entry | Σ C | 0..* | 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 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
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
link | Σ | 0..* | See link (Bundle) | 與本條目相關的連結
fullUrl | Σ | 0..1 | uri | Resource的 URI（絕對 URL 伺服器地址或 UUID/OID 的 URI）
resource | Σ | 0..1 | Resource | Bundle中的resource
search | Σ C | 0..1 | BackboneElement | 查詢有關的資訊
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
mode | Σ | 0..1 | code | match | include | outcome Binding: SearchEntryMode (required): Resource出現在Bundle中的原因；應填入所綁定值集中的其中一個代碼。
score | Σ | 0..1 | decimal | 查詢排名（0至1之間）
request | Σ C | 0..1 | BackboneElement | 其他執行資訊（transaction/batch/history）
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
method | Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): 應填入所綁定值集中的其中一個代碼。
url | Σ | 1..1 | uri | 此Bundle HTTP 對應的 URL
ifNoneMatch | Σ | 0..1 | string | 用於管理緩存當前狀態
ifModifiedSince | Σ | 0..1 | instant | 用於管理緩存當前狀態
ifMatch | Σ | 0..1 | string | 用於管理更新衝突
ifNoneExist | Σ | 0..1 | string | 用於有條件建立
response | Σ C | 0..1 | BackboneElement | 執行結果（transaction/batch/history）
id |  | 0..1 | string | 唯一可識別ID，以供資料項目間相互參照。
extension |  | 0..* | Extension | 擴充的資料項目
modifierExtension | ?!Σ | 0..* | Extension | 此擴充的資料項目可能會完全修正或改變其他資料項目的意涵，需特別留意。
status | Σ | 1..1 | string | 狀態回應代碼（文字選填）
location | Σ | 0..1 | uri | 位置（如果操作返回位置）
etag | Σ | 0..1 | string | resource的 Etag（如果有相關）
lastModified | Σ | 0..1 | instant | 修改時之伺服器日期時間
outcome | Σ | 0..1 | Resource | 帶提示和警告的OperationOutcome（用於batch/transaction）
signature | Σ | 0..1 | Signature | 數位簽章
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Bundle.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Bundle.type | required | BundleType `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` from the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` from the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
bdl-4 | error | Bundle | entry.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-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl 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-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from TWCoreBundle

Summary

Must-Support: 2 elements

Other representations of profile: CSV, Excel, Schematron